天天看點

SpringBoot2 整合Nacos元件,環境搭建和入門案例詳解一、Nacos基礎簡介二、Nacos環境搭建三、整合SpringBoot2四、源代碼位址

本文源碼: GitHub·點這裡 || GitEE·點這裡

一、Nacos基礎簡介

1、概念簡介

Nacos 是建構以“服務”為中心的現代應用架構,如微服務範式、雲原生範式等服務基礎設施。聚焦于發現、配置和管理微服務。Nacos提供一組簡單易用的特性集,幫助開發者快速實作動态服務發現、服務配置、服務中繼資料及流量管理。靈活建構、傳遞和管理微服務平台。

2、關鍵特性

  • 動态配置服務
  • 服務發現和服務健康監測
  • 動态 DNS 服務
  • 服務及其中繼資料管理

3、專業術語解釋

  • 命名空間

用于進行租戶粒度的配置隔離。不同的命名空間下,可以存在相同的 Group 或 Data ID 的配置。

  • 配置集

一組相關或者不相關的配置項的集合稱為配置集。在系統中,一個配置檔案通常就是一個配置集,包含了系統各個方面的配置。

  • 配置集 ID

Nacos 中的某個配置集的ID。配置集ID是組織劃配置設定置的次元之一。DataID通常用于組織劃分系統的配置集。

  • 配置分組

Nacos 中的一組配置集,是組織配置的次元之一。通過一個有意義的字元串對配置集進行(Group)分組,進而區分 Data ID 相同的配置集。

  • 配置快照

Nacos 的用戶端 SDK 會在本地生成配置的快照。當用戶端無法連接配接到 Nacos Server 時,可以使用配置快照顯示系統的整體容災能力。

  • 服務注冊

存儲服務執行個體和服務負載均衡政策的資料庫。

  • 服務發現

使用服務名對服務下的執行個體的位址和中繼資料進行探測,并以預先定義的接口提供給用戶端進行查詢。

  • 中繼資料

Nacos資料(如配置和服務)描述資訊,如服務版本、權重、容災政策、負載均衡政策等。

4、Nacos生态圈

Nacos 無縫支援一些主流的開源架構生态:

  • Spring Cloud 微服務架構 ;
  • Dubbo RPC架構 ;
  • Kubernetes 容器應用 ;

二、Nacos環境搭建

1、環境版本

這裡在Windos環境下搭建Nacos單個服務。

  • Nacos版本:官方推薦的穩定版本為1.1.4。
  • 基礎環境:JDK 1.8+;Maven 3.2.x

2、環境包下載下傳

這裡直接下載下傳打包好的檔案,也可以下載下傳源碼自己打包。

https://github.com/alibaba/nacos/releases

下載下傳檔案:nacos-server-1.1.4.zip

3、啟動環境

  • 啟動檔案位址:

    nacos\bin

  • 啟動檔案:

    startup.cmd

  • 關閉檔案:

    shutdown.cmd

啟動後登陸,賬戶密碼預設:nacos/nacos ;首頁效果如下:

SpringBoot2 整合Nacos元件,環境搭建和入門案例詳解一、Nacos基礎簡介二、Nacos環境搭建三、整合SpringBoot2四、源代碼位址

三、整合SpringBoot2

注意:版本 0.2.x.RELEASE 對應的是 Spring Boot 2.x 版本,版本 0.1.x.RELEASE 對應的是 Spring Boot 1.x 版本。

1、建立配置

SpringBoot2 整合Nacos元件,環境搭建和入門案例詳解一、Nacos基礎簡介二、Nacos環境搭建三、整合SpringBoot2四、源代碼位址

2、核心依賴

<!-- Nacos 元件依賴 -->
<dependency>
    <groupId>com.alibaba.boot</groupId>
    <artifactId>nacos-discovery-spring-boot-starter</artifactId>
    <version>0.2.3</version>
</dependency>
<dependency>
    <groupId>com.alibaba.boot</groupId>
    <artifactId>nacos-config-spring-boot-starter</artifactId>
    <version>0.2.3</version>
</dependency>           

3、Yml配置檔案

這裡把項目作為服務注冊到Nacos中。

nacos:
  config:
    server-addr: 127.0.0.1:8848
  discovery:
    server-addr: 127.0.0.1:8848           

4、啟動類配置

啟動類關聯配置中心的dataId辨別。

@EnableSwagger2
@SpringBootApplication
@NacosPropertySource(dataId = "WARE_ID", autoRefreshed = true)
public class Application7017 {
    public static void main(String[] args) {
        SpringApplication.run(Application7017.class,args) ;
    }
}           

5、核心配置類

import com.alibaba.nacos.api.annotation.NacosInjected;
import com.alibaba.nacos.api.exception.NacosException;
import com.alibaba.nacos.api.naming.NamingService;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Configuration;
import javax.annotation.PostConstruct;
@Configuration
public class NacosConfig {
    @Value("${server.port}")
    private int serverPort;
    @Value("${spring.application.name}")
    private String applicationName;
    @NacosInjected
    private NamingService namingService;
    @PostConstruct
    public void registerInstance() throws NacosException {
        namingService.registerInstance(applicationName, "127.0.0.1", serverPort);
    }
}           

啟動成功後查詢服務清單:

SpringBoot2 整合Nacos元件,環境搭建和入門案例詳解一、Nacos基礎簡介二、Nacos環境搭建三、整合SpringBoot2四、源代碼位址

6、基礎API用例

這裡示範兩個基礎用法:上述步驟1的配置内容讀取,步驟4的服務清單讀取。基于swagger2管理測試接口。

SpringBoot2 整合Nacos元件,環境搭建和入門案例詳解一、Nacos基礎簡介二、Nacos環境搭建三、整合SpringBoot2四、源代碼位址
@Api("Nacos接口管理")
@RestController
@RequestMapping("/nacos")
public class NacosController {

    @NacosValue(value = "${MyName:null}", autoRefreshed = true)
    private String myName;
    @NacosValue(value = "${project:null}", autoRefreshed = true)
    private String project;

    @ApiOperation(value="查詢配置資訊")
    @GetMapping(value = "/info")
    public String info () {
        return myName+":"+project;
    }

    @NacosInjected
    private NamingService namingService;

    @ApiOperation(value="查詢服務清單")
    @GetMapping(value = "/getServerList")
    public List<Instance> getServerList (@RequestParam String serviceName) {
        try {
            return namingService.getAllInstances(serviceName) ;
        } catch (Exception e){
            e.printStackTrace();
        }
        return null ;
    }
}           

四、源代碼位址

GitHub·位址
https://github.com/cicadasmile/middle-ware-parent
GitEE·位址
https://gitee.com/cicadasmile/middle-ware-parent