Spring Cloud Alibaba之Nacos

與牛競技發表於2022-12-28
SpringCloud

目錄結構：

　　一、Spring Cloud Alibaba簡介

　　二、使用版本情況

　　三、什麼是Nacos？

　　四、Nacos執行環境部署

　　五、Nacos註冊中心

　　六、Nacos名稱空間和分組

　　七、Nacos配置中心

　　八、基於profile多環境配置

　　九、Nacos配置中心動態重新整理

　　十、Nacos資料持久化

　　十一、Nacos叢集部署

一、Spring Cloud Alibaba簡介：

Spring Cloud Alibaba是Spring Cloud下的一個子專案，Spring Cloud Alibaba為分散式應用程式開發提供了一站式解決方案，它包含開發分散式應用程式所需的所有元件，使您可以輕鬆地使用Spring Cloud開發應用程式，使用Spring Cloud Alibaba，您只需要新增一些註解和少量配置即可將Spring Cloud應用程式整合Alibaba的分散式解決方案，並使用Alibaba中介軟體構建分散式應用程式系統。

二、使用版本情況

1、專案所使用的的版本

Spring Cloud Alibaba Version Spring Cloud Version Spring Boot Version
2.2.9.RELEASE Spring Cloud Hoxton.SR12 2.3.12.RELEASE

2、Spring Cloud Alibaba 版本及其自身所適配的各元件對應版本：

Spring Cloud Alibaba Version Nacos Version Sentinel Version Seata Version RocketMQ Version Dubbo Version
2.2.9.RELEASE 2.0.4 1.8.5 1.5.2 4.9.4 2.7.13

三、什麼是Nacos？

Nacos是阿里巴巴2018年7月推出來的一個開源專案，是一個構建微服務應用的服務註冊與發現、配置管理平臺；

Nacos 屬於Spring Cloud Alibaba下的一個元件；

Nacos 約等於 Spring Cloud Eureka（註冊中心）+ Spring Cloud Config（配置中心）

Nacos官網：https://nacos.io/

四、Nacos執行環境部署

服務端（部署一個nacos-server）+ 客戶端（你的各個服務）

步驟：

　　1、下載Nacos的二進位制壓縮包

　　下載地址：https://github.com/alibaba/nacos/releases

　　2、解壓下載下來的Nacos的二進位制壓縮包　　

　　tar -zxvf nacos-server-2.0.4.tar.gz

　　3、啟動nacos server

　　[root@localhost bin]# ./startup.sh -m standalone

　　注：單機環境必須帶-m standalone引數啟動，否則無法啟動，不帶引數啟動的是叢集環境

　　4、訪問nacos的web客戶端地址：http://ip地址:8848/nacos

　　使用預設的使用者名稱：nacos、密碼：nacos

　　5、關閉nacos server

　　[root@localhost bin]# ./shutdown.sh

五、Nacos註冊中心

Nacos註冊中心可以說是類似於Eureka-server的功能

微服務開發是controller呼叫controller，呼叫者是服務消費者，被呼叫者是服務提供者，服務消費者和服務提供者是相對概念，服務消費者也可以被另一個服務呼叫，那麼此時的服務消費者也是一個服務提供者；

在實際開發中，我們會把所有服務都註冊到nacos註冊中心上，由nacos去維護和管理我們的所有服務。

5.1、實現服務提供者

1、pom.xml 檔案中引入Nacos Discovery Starter依賴

<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
    <version>2.2.9.RELEASE</version>
</dependency>

2、配置檔案application.yml中新增Nacos Server地址

spring:
  cloud:
    nacos:
      discovery:
        server-addr: http://ip地址:8848/nacos
        username: nacos
        password: nacos

  application:
    name: nacos-provider

注意：如果不想使用Nacos作為你的服務註冊與發現，可以將spring.cloud.nacos.discovery.enabled 設定為 false。

3、啟動專案，此時就可以在Nacos的web管控臺上看到註冊上來的服務資訊了；

 5.2、實現服務消費者

消費者應用比提供者應用要稍微複雜一點，因為在消費端需要去呼叫提供者提供的REST服務，此時需要用到RestTemplate、OpenFeign及負載均衡Spring Cloud LoadBalancer。

1、新增OpenFeign、Nacos Discovery Starter依賴

<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
    <version>2.2.9.RELEASE</version>
</dependency>
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>

2、配置檔案application.yml中新增Nacos Server地址

spring:
  cloud:
    nacos:
      discovery:
        server-addr: http://ip地址:8848/nacos
        username: nacos
        password: nacos

  application:
    name: nacos-consumer

3、新建Feign介面，呼叫服務提供者

// nacos-provider是服務提供者的應用名，也就是註冊到Nacos中的應用名
@FeignClient(value = "nacos-provider")
public interface ProductFeign {
    // 服務提供者對應的controller介面
    @GetMapping("/product/{id}")
    Product getProduct(@PathVariable("id") Integer id);
}

4、服務消費者介面實現類中注入Feign物件，呼叫服務提供者

@Service
public class OrderServiceImpl implements OrderService {
    @Resource
    private OrderDao orderDao;
    @Resource
    private ProductFeign productFeign;
    @Override
    public int addOrder(Integer id) {
        // 注入Feign介面物件，呼叫服務提供者介面
        Product product = productFeign.getProduct(id);
        int result = 0;
        if (product != null) {
            Order order =
                    Order.builder().orderName("我購買的").orderMoney(new BigDecimal(1000)).productId(1).orderStatus(0).memberId(1001).build();
            result = orderDao.addOrder(order);
        }
        return result;
    }
}

六、Nacos名稱空間和分組

6.1、名稱空間：用於隔離每一個微服務的外部應用配置，每一個微服務都可以有自己單獨的配置環境。預設新增的所有服務都在public空間（保留空間）。

 新建名稱空間，每一個服務都可以建立一個名稱空間

 6.2、配置分組：預設所有的配置都屬於：DEFAULT_GROUP

每個微服務建立自己的名稱空間，使用配置分組區分環境：開發環境dev，測試環境test以及生產環境prod等

建立分組：選擇對應的名稱空間，點選“+”建立分組配置

七、Nacos配置中心

Nacos配置中心類似於Spring Cloud Config的功能

Spring Cloud Config 使用git倉庫儲存配置檔案，程式設計師自己建立config-server的伺服器，把各個微服務作為客戶端

Nacos 作為配置中心，配置的資訊儲存到服務端，就是Nacos。Nacos提供用於儲存配置資料功能，為分散式系統中的配置資料提供伺服器端和客戶端支援，使用Spring Cloud Alibaba Nacos Config就可以在Nacos Server集中管理Spring Cloud應用的外部屬性配置；

Spring Cloud Alibaba Nacos config是在啟動的bootstrap階段，將配置載入到Spring環境中；

透過bootstrap.properties（bootstrap.yml）啟動我們的微服務

6.1、基於Nacos配置中心構建微服務應用

步驟：

1、pom檔案中新增Nacos Config依賴

<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
    <version>2.2.9.RELEASE</version>
</dependency>

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-bootstrap</artifactId>
    <version>3.1.5</version>
</dependency>

2、專案配置檔案bootstrap.yml中

Spring Cloud Alibaba Nacos Config會根據名稱空間、DataId、GROUP以及檔案字尾名確定唯一一個配置

spring:
  cloud:
    nacos:
      config:
        server-addr: http://ip地址:8848/nacos
        username: nacos
        password: nacos
        namespace: e769b2bd-5082-4829-82a5-3c98ee6cf758
        group: dev-group
        file-extension: properties

  application:
    name: config-server

3、Nacos中新增外部配置檔案

4、客戶端透過nacos呼叫外部配置檔案，拿到相應的屬性值

@RestController
public class ConfigController {
    @Value("${user.info.username}")
    private String username;
    @Value("${user.info.password}")
    private String password;
    @GetMapping("/user/info")
    public String getUserInfo(){
        return username + ": " + password;
    }
}

八、基於profile多環境配置

nacos配置中心在載入配置的時候，不僅僅載入了以 dataid為 ${spring.application.name}.${file-extension:properties} 的基礎配置，還載入了dataid為 ${spring.application.name}-${profile}.${file-extension:properties} 的基礎配置；

在日常開發中如果遇到多套環境下的不同配置，可以透過Spring提供的 ${spring.profiles.active} 配置項來啟用使用某個配置檔案；

1、在Nacos中建立兩個配置檔案

 2、修改專案的配置檔案bootstrap.yml

spring:
  cloud:
    nacos:
      config:
        server-addr: http://192.168.0.130:8848/nacos
        username: nacos
        password: nacos
        namespace: e769b2bd-5082-4829-82a5-3c98ee6cf758
        group: user-group
        file-extension: properties

  application:
    name: config-server
  profiles:
    active: dev

如果需要切換到測試環境，只需要更改 ${spring.profiles.active} 引數配置即可，如下所示：

spring.profiles.active=test

九、Nacos配置中心動態重新整理

Nacos Config Starter 預設為所有獲取資料成功的 Nacos 的配置項新增了監聽功能，在監聽到服務端配置發生變化時會實時觸發org.springframework.cloud.context.refresh.ContextRefresher的refresh 方法；

可以透過配置 spring.cloud.nacos.config.refresh.enabled=false 來關閉動態重新整理；

controller 加上以下註解

@RestController
@RefreshScope
public class ConfigController {
    @Value("${user.info.username}")
    private String username;
    @Value("${user.info.password}")
    private String password;
    @GetMapping("/user/info")
    public String getUserInfo(){
        return username + ": " + password;
    }
}

十、Nacos資料持久化

參考網址：https://nacos.io/zh-cn/docs/deployment.html

Nacos預設情況下是採用apache derby內嵌資料庫進行資料儲存，在單機模式時可以使用nacos嵌入式資料庫實現資料儲存，但是derby資料庫不方便觀察資料儲存的基本情況，從acos 0.7版本開始增加了支援mysql資料來源能力；

具體操作步驟：

第一步：安裝資料庫，版本要求：5.6.5+；

第二步：初始化MySQL資料庫（也就是生成對應的資料庫和表），資料庫初始化檔案： nacos-mysql.sql，該檔案可以在Nacos程式包下的 conf目錄下獲得

第三步：修改 conf/application.properties檔案，增加支援MySQL資料來源配置，新增（目前只支援mysql）資料來源的url、使用者名稱和密碼

#*************** Config Module Related Configurations ***************#
    32    ### If use MySQL as datasource:
    33     spring.datasource.platform=mysql
    34    
    35    ### Count of DB:
    36     db.num=1
    37    
    38    ### Connect URL of DB:
    39     db.url.0=jdbc:mysql://127.0.0.1:3306/nacos_config?characterEncoding=utf8&connectTimeout=1000&socketTimeout=3000&autoReconnect=true&useUnicode=true&useSSL=false&serverTimezone=Asia/Shanghai
    40     db.user.0=root
    41     db.password.0=123456

第四步：然後啟動nacos（還是單機啟動），此時發現nacos所有嵌入式資料庫的資料都寫到了mysql；

十一、Nacos叢集部署

具體配置步驟：

1、準備三個nacos，3個或3個以上Nacos節點才能構成叢集；

2、在Nacos的conf目錄下有一個cluster.conf.example，可以直接把example副檔名去掉來使用，也可以單獨建立一個cluster.conf檔案，然後在該檔案中每行配置一個ip:port；

 埠號需要和對應nacos的檔案application.properties中的埠號一致

3、按照上面nacos持久化的方式配置好資料持久化到MySQL，生產使用建議至少主備模式，或者採用高可用資料庫

4、啟動測試；

叢集下客戶端怎麼連？

第一種：可以在單機的基礎上加多個IP和埠中間用逗號隔開；

spring:
  cloud:
    nacos:
      config:
        server-addr: http://ip地址1:8848/nacos,http://IP地址2:8848/nacos,http://ip地址3:8848/nacos
        username: nacos
        password: nacos
        namespace: e769b2bd-5082-4829-82a5-3c98ee6cf758
        group: user-group
        file-extension: properties

  application:
    name: config-server
  profiles:
    active: dev

第二種：配合Nginx代理我們的Nacos叢集，配置裡就直接寫Nginx的IP和埠即可；

 

相關文章