SpringBoot2 整合Nacos組件,環境搭建和入門案例詳解

本文源碼:GitHub·點這裏 || GitEE·點這裏java

1、Nacos基礎簡介

一、概念簡介

Nacos 是構建以「服務」爲中心的現代應用架構,如微服務範式、雲原生範式等服務基礎設施。聚焦於發現、配置和管理微服務。Nacos提供一組簡單易用的特性集,幫助開發者快速實現動態服務發現、服務配置、服務元數據及流量管理。敏捷構建、交付和管理微服務平臺。git

二、關鍵特性

  • 動態配置服務
  • 服務發現和服務健康監測
  • 動態 DNS 服務
  • 服務及其元數據管理

三、專業術語解釋

  • 命名空間

用於進行租戶粒度的配置隔離。不一樣的命名空間下,能夠存在相同的 Group 或 Data ID 的配置。github

  • 配置集

一組相關或者不相關的配置項的集合稱爲配置集。在系統中,一個配置文件一般就是一個配置集,包含了系統各個方面的配置。spring

  • 配置集 ID

Nacos 中的某個配置集的ID。配置集ID是組織劃分配置的維度之一。DataID一般用於組織劃分系統的配置集。數據庫

  • 配置分組

Nacos 中的一組配置集,是組織配置的維度之一。經過一個有意義的字符串對配置集進行(Group)分組,從而區分 Data ID 相同的配置集。api

  • 配置快照

Nacos 的客戶端 SDK 會在本地生成配置的快照。當客戶端沒法鏈接到 Nacos Server 時,可使用配置快照顯示系統的總體容災能力。springboot

  • 服務註冊

存儲服務實例和服務負載均衡策略的數據庫。架構

  • 服務發現

使用服務名對服務下的實例的地址和元數據進行探測,並以預先定義的接口提供給客戶端進行查詢。app

  • 元數據

Nacos數據(如配置和服務)描述信息,如服務版本、權重、容災策略、負載均衡策略等。負載均衡

四、Nacos生態圈

Nacos 無縫支持一些主流的開源框架生態:

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

2、Nacos環境搭建

一、環境版本

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

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

二、環境包下載

這裏直接下載打包好的文件,也能夠下載源碼本身打包。

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

下載文件:nacos-server-1.1.4.zip

三、啓動環境

  • 啓動文件地址:nacos\bin
  • 啓動文件:startup.cmd
  • 關閉文件:shutdown.cmd

啓動後登錄,帳戶密碼默認:nacos/nacos ;首頁效果以下:

3、整合SpringBoot2

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

一、新建配置

二、核心依賴

<!-- 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>

三、Yml配置文件

這裏把項目做爲服務註冊到Nacos中。

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

四、啓動類配置

啓動類關聯配置中心的dataId標識。

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

五、核心配置類

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);
    }
}

啓動成功後查詢服務列表:

六、基礎API用例

這裏演示兩個基礎用法:上述步驟1的配置內容讀取,步驟4的服務列表讀取。基於swagger2管理測試接口。

@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 ;
    }
}

4、源代碼地址

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

相關文章
相關標籤/搜索