Nacos系列：基於Nacos的配置中心

前言

在看正文之前，我想請你回顧一下自己待過的公司都是怎麼管理配置的，我想應該會有以下幾種方式：

1、硬編碼
沒有什麼配置不配置的，直接寫在代碼裏面，比如使用常量類
優勢：對開發友好，開發清楚地知道代碼需要用到什麼配置
劣勢：涉及祕鑰等敏感配置直接暴露給開發人員，不安全；如果想修改配置必須重新發版，比較麻煩

2、外部化配置文件
Spring項目經常會在resoures目錄下放很多配置文件，各個環境對應不同的配置文件，通過SVN管理
優勢：配置文件外部化，支持多環境配置管理，修改配置只需重啓服務，無需發版
劣勢：系統龐大時，配置文件很多，多人開發，配置格式不統一，維護麻煩；敏感配置不需要暴露給開發人員，降低風險，但開發經常要和運維溝通怎麼修改配置，溝通不恰當容易引發生產事故；而且，如果應用部署在多臺機器，對運維來說，修改配置也是非常頭疼的事情（當然也可以引入NFS系統來解決一部分問題）

3、數據庫
配置信息存儲在數據庫中，靈活修改
優勢：可以靈活管理配置，無需重啓服務
劣勢：界面不友好，配置沒有版本管理，一旦出現問題，回滾或定位問題都比較麻煩；此外，數據庫必須要保證高可用，避免因此而造成生產故障

4、配置中心
微服務基礎架構體系中的一個不可或缺的基礎組件
優勢：集中化管理，敏感配置可控；多版本存儲，方便追溯；界面友好，修改配置一鍵發佈；即使面對多集羣也能從容應對，十分淡定
劣勢：引入組件，增加系統風險；如果是中途切換成配置中心，也會增加研發接入成本；配置中心也需要保證高可用，否則容易造成大面積影響

以上幾種管理配置文件的方式，我想都會有公司在用，不要因爲配置中心有諸多優點，就盲目引進項目中，我覺得應該遵守以下兩個原則：

• 做人做事，要知道自己幾斤幾兩

釋義：沒深入研究過的技術，就不要隨便拿到公司項目中來試水啦，恐怕到時候坑夠你填的，要不然就是你有信心玩得轉它。

• 殺只雞而已，你拿牛刀來做甚？

釋義：小團隊小項目選擇簡單的配置管理方式就好了，要什麼配置中心，純屬沒事找事。

總而言之，我們必須從實際出發，實事求是，選擇適合自己的技術棧。

關於爲什麼需要有配置中心，我推薦一篇文章給你看，講得比較透徹：《微服務架構爲什麼需要配置中心？》

另外，我覺得對開發本身來說，是寧願自己管理自己代碼的配置的，交給運維總是會有各種各樣的問題，至於敏感配置，說實話，開發人員要真想做點“壞事”，那攔得住嗎？但是，從公司的角度來講，把服務器的配置管理交給運維同事是符合常理的，系統需要穩定且安全地運行，這是對客戶的負責，從這一方面去思考，這麼做是合情合理的。

Okay，我就囉嗦到這裏吧，下面正式介紹Nacos作爲配置中心是怎麼使用的。

Nacos 結合 Spring

添加 maven 依賴：

<dependency>
    <groupId>com.alibaba.nacos</groupId>
    <artifactId>nacos-spring-context</artifactId>
    <version>${nacos-spring-context.version}</version>
</dependency>

使用 @EnableNacosConfig 開啓 Nacos Spring 的配置管理功能

@Configuration
@EnableNacosConfig(globalProperties = @NacosProperties(serverAddr = "127.0.0.1:8848"))
@NacosPropertySource(dataId = "nacos.spring.config", autoRefreshed = true)
public class NacosConfig {
}

其中：

@Configuration：Spring的註解，配置應用上下文
@EnableNacosConfig：Nacos的註冊，啓用 Nacos Spring 的配置管理服務
@NacosProperties：全局和自定義Nacos屬性的統一註解
@NacosPropertySource：加載數據源
globalProperties：全局 Nacos 屬性
serverAddr：Nacos Server服務器地址
dataId：配置的數據集ID
autoRefreshed：是否開啓配置動態更新

再寫一個Controller類，來驗證Nacos的配置管理功能，代碼如下：

package com.learn.nacos;

import com.alibaba.nacos.api.annotation.NacosInjected;
import com.alibaba.nacos.api.config.ConfigService;
import com.alibaba.nacos.api.config.annotation.NacosValue;
import com.alibaba.nacos.api.exception.NacosException;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseBody;

@Controller
@RequestMapping(value = "config")
public class NacosConfigController {
     @NacosInjected
     private ConfigService configService;

     @NacosValue(value = "${useLocalCache:false}", autoRefreshed = true)
     private boolean useLocalCache;

     @RequestMapping(value = "/get", method = RequestMethod.GET)
     @ResponseBody
     public boolean get() {
         return useLocalCache;
     }

     @RequestMapping(method = RequestMethod.GET)
     @ResponseBody
     public ResponseEntity<String> publish(@RequestParam String dataId,
                                           @RequestParam(defaultValue = "DEFAULT_GROUP") String group,
                                           @RequestParam String content) throws NacosException {
         boolean result = configService.publishConfig(dataId, group, content);
         if (result) {
             return new ResponseEntity<String>("Success", HttpStatus.OK);
         }
         return new ResponseEntity<String>("Fail", HttpStatus.INTERNAL_SERVER_ERROR);
     }
}

該Controller類提供了兩個HTTP接口
讀取配置：http://127.0.0.1:8080/config/get
發佈配置：http://127.0.0.1:8080/config?dataId=XXX&content=XXX

發佈配置還可以通過 Nacos Open API：curl -X POST "http://127.0.0.1:8848/nacos/v1/cs/configs?dataId=XXX&group=XXX&content=XXX 發佈配置，你也可以用Postman工具模擬POST請求進行配置發佈，我這裏主要是爲了方便驗證問題，採用了這種方式。

在驗證之前，請先確保 Nacos Server 已經啓動，Nacos Server 的安全及啓動方式詳見：《Nacos系列：歡迎來到Nacos的世界！》

啓動Tomcat，觀察Console控制檯

20:50:13.646 [RMI TCP Connection(5)-127.0.0.1] WARN com.alibaba.nacos.spring.core.env.AnnotationNacosPropertySourceBuilder - There is no content for NacosPropertySource from dataId[nacos.spring.config] , groupId[DEFAULT_GROUP] , properties[{encode=${nacos.encode:UTF-8}, namespace=${nacos.namespace:}, contextPath=${nacos.context-path:}, endpoint=${nacos.endpoint:}, serverAddr=${nacos.server-addr:}, secretKey=${nacos.secret-key:}, accessKey=${nacos.access-key:}, clusterName=${nacos.cluster-name:}}].

20:50:17.825 [RMI TCP Connection(5)-127.0.0.1] INFO com.alibaba.nacos.spring.context.event.LoggingNacosConfigMetadataEventListener - Nacos Config Metadata : dataId='nacos.spring.config', groupId='DEFAULT_GROUP', beanName='nacosConfig', bean='null', beanType='class com.learn.nacos.NacosConfig', annotatedElement='null', xmlResource='null', nacosProperties='{serverAddr=127.0.0.1:8848, encode=UTF-8}', nacosPropertiesAttributes='{encode=${nacos.encode:UTF-8}, namespace=${nacos.namespace:}, contextPath=${nacos.context-path:}, endpoint=${nacos.endpoint:}, serverAddr=${nacos.server-addr:}, secretKey=${nacos.secret-key:}, accessKey=${nacos.access-key:}, clusterName=${nacos.cluster-name:}}', source='org.springframework.core.type.classreading.AnnotationMetadataReadingVisitor@66e4d430', timestamp='1550753413647'

我們先通過http://127.0.0.1:8080/config?dataId=nacos.spring.config&content=useLocalCache=true發佈一個dataId爲nacos.spring.config且配置內容爲useLocalCache=true的配置集，觀察Nacos控制檯的變化

再通過http://127.0.0.1:8080/config/get讀取配置

然後在Nacos控制檯將useLocalCache的值改爲false，併發布配置

再次訪問http://127.0.0.1:8080/config/get

Nacos 結合 Spring Boot

添加 Starter 依賴：

<dependency>
    <groupId>com.alibaba.boot</groupId>
    <artifactId>nacos-config-spring-boot-starter</artifactId>
    <version>0.2.1</version>
</dependency>

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

在application.properties中添加如下配置信息：

nacos.config.server-addr=127.0.0.1:8848

添加NacosConfigApplication啓動類

@SpringBootApplication
@NacosPropertySource(dataId = "nacos.springboot.config", autoRefreshed = true)
public class NacosConfigApplication {
     public static void main(String[] args) {
         SpringApplication.run(NacosConfigApplication.class, args);
     }
}

如果你看過我的上一篇文章：《Nacos系列：基於Nacos的註冊中心》，那麼你應該知道 Spring Boot 實現方式和 Spring 的沒太大差別，所以我就不再細說了，請參考我的源碼示例或者官網資料學習。

這裏說下我在學習過程中遇到的一個問題，在application.properties添加配置文件的時候，不小心將nacos.config.server-addr寫成了nacos.discovery.server-addr，結果啓動項目時，一直報錯：

ERROR 9028 --- [           main] o.s.b.d.LoggingFailureAnalysisReporter   : 

------

APPLICATION FAILED TO START

------

Description:

client error: invalid param. null

Action:

please check your client configuration

剛開始一直找不到原因，後面跟着官網代碼示例複覈，才發現是配置問題導致的，呵呵噠，自己給自己挖坑。

後語

我挺喜歡Nacos的，既然做服務發現和管理，又能做配置管理，這兩者本質沒多大區別，Nacos把這兩者統一起來，一舉兩得，我覺得沒什麼不好，要不然你引入了Zookeeper作爲註冊中心，還要引入Apollo作爲配置中心，無端增加學習成本。就像之前聽音樂，我一般用網易雲音樂就好，後面因爲搞了版權的事，不得不下載了蝦米和QQ音樂，我就聽個歌而已，手機裏裝了三個APP，你說，這叫什麼事兒？

示例源碼

• Nacos + Spring ：learn-nacos-spring-config
• Nacos + Spring Boot ： learn-nacos-springboot-config

代碼已上傳至碼雲和Github上，歡迎下載學習

• Gitee
• Github

參考資料

• 微服務架構爲什麼需要配置中心？
• Nacos Spring 快速開始
• Nacos Spring Boot 快速開始
• SpringBoot使用Nacos配置中心
• Spring Cloud Alibaba基礎教程：使用Nacos作爲配置中心