SpringCloud Nacos 实现配置中心与注册中心

SpringCloud+Nacos 配置中心与注册中心应用

1. 版本说明

序号	名称	版本号
1	spring-boot	2.1.1.RELEASE
2	spring-cloud	Greenwich.RELEASE
3	spring-cloud-alibaba	2.1.2.RELEASE

引入pom

......

	<parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.1.RELEASE</version>
    </parent>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <java.version>1.8</java.version>
        <spring-cloud.version>Greenwich.RELEASE</spring-cloud.version>
        <spring-cloud-alibaba.version>2.1.2.RELEASE</spring-cloud-alibaba.version>
    </properties>

......

    <dependencyManagement>
            <dependencies>
                <dependency>
                    <groupId>org.springframework.cloud</groupId>
                    <artifactId>spring-cloud-dependencies</artifactId>
                    <version>${spring-cloud.version}</version>
                    <type>pom</type>
                    <scope>import</scope>
                </dependency>
                <!-- 引入SpringCloud alibaba -->
                <dependency>
                    <groupId>com.alibaba.cloud</groupId>
                    <artifactId>spring-cloud-alibaba-dependencies</artifactId>
                    <version>${spring-cloud-alibaba.version}</version>
                    <type>pom</type>
                    <scope>import</scope>
                </dependency>
            </dependencies>
        </dependencyManagement>
......

2. Nacos配置中心

2.1 引入pom

 <dependency>
     <groupId>org.springframework.cloud</groupId>
     <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
 </dependency>

2.2 修改bootsrap.yml

# 此处为自定义，配置中心和注册中心共同属性，下文引入即可
nacos:
  group: demo
  # 配置中心地址
  # nacos 服务地址 nginx 代理的地址
  server-addr: http://10.100.124.240:9948
  # 命名空间
  namespace: dev

spring:
  profiles:
    active: dev
  application:
    name: nacos-demo-test
  cloud:
    nacos:
      server-addr: ${nacos.server-addr}
      config:
      # 默认  ${spring.cloud.nacos.server-addr}
      #  server-addr:
        file-extension: yaml
        prefix: ${spring.application.name}
      # dataID  ${prefix}-${spring.profiles.active}.${file-extension}
      # 命名空间 默认 public
        namespace: ${nacos.namespace}
      # 配置组  默认 DEFAULT_GROUP
        group: ${nacos.group}
      # 共享配置(公共配置)
        shared-configs:
          - data-id: nacos-demo.yaml
            # 可自定义
            group: ${nacos.group}
            refresh: true
            

2.3 重要解释

• Nacos Config 数据结构

Nacos Config 主要通过 dataId 和 group 来唯一确定一条配置.

Nacos Client 从 Nacos Server 端获取数据时，调用的是此接口 ConfigService.getConfig(String dataId, String group, long timeoutMs)。

• Spring Cloud 应用获取数据

dataId，在 Nacos Config Starter 中，dataId 的拼接格式如下

${prefix} - ${spring.profiles.active} . ${file-extension}

1. prefix 默认为 spring.application.name 的值，也可以通过配置项 spring.cloud.nacos.config.prefix来配置。

2. spring.profiles.active 即为当前环境对应的 profile，详情可以参考 Spring Boot文档

   注意，当 activeprofile 为空时，对应的连接符 - 也将不存在，dataId 的拼接格式变成 {prefix}.{file-extension}

3. file-extension 为配置内容的数据格式，可以通过配置项 spring.cloud.nacos.config.file-extension来配置。 目前只支持 properties 类型。

group

1. group 默认为 DEFAULT_GROUP，可以通过 spring.cloud.nacos.config.group 配置。

• 自动注入

Nacos Config Starter 实现了 org.springframework.cloud.bootstrap.config.PropertySourceLocator接口，并将优先级设置成了最高。

在 Spring Cloud 应用启动阶段，会主动从 Nacos Server 端获取对应的数据，并将获取到的数据转换成 PropertySource 且注入到 Environment 的 PropertySources 属性中，所以使用 @Value 注解也能直接获取 Nacos Server 端配置的内容。

• 动态刷新

Nacos Config Starter 默认为所有获取数据成功的 Nacos 的配置项添加了监听功能，在监听到服务端配置发生变化时会实时触发 org.springframework.cloud.context.refresh.ContextRefresher 的 refresh 方法 。

如果需要对 Bean 进行动态刷新，给类添加 @RefreshScope 或 @ConfigurationProperties注解。

• Endpoint 信息查看

Springboot支持这一点，Nacos Config也同时可以使用Endpoint来暴露信息。

在maven 中添加 spring-boot-starter-actuator依赖，并在配置中允许 Endpoints 的访问。

1. Spring Boot 1.x 中添加配置 management.security.enabled=false
2. Spring Boot 2.x 中添加配置 management.endpoints.web.exposure.include=*

Spring Boot 1.x 可以通过访问 http://127.0.0.1:8848/nacos_config 来查看 Nacos Endpoint 的信息。

Spring Boot 2.x 可以通过访问 http://127.0.0.1:8848/actuator/nacos-config 来访问。

2.4 更多

配置项	key	默认值	说明
服务端地址	spring.cloud.nacos.config.server-addr
DataId前缀	spring.cloud.nacos.config.prefix		spring.application.name
Group	spring.cloud.nacos.config.group	DEFAULT_GROUP
dataID后缀及内容文件格式	spring.cloud.nacos.config.file-extension	properties	dataId的后缀，同时也是配置内容的文件格式，目前只支持 properties
配置内容的编码方式	spring.cloud.nacos.config.encode	UTF-8	配置的编码
获取配置的超时时间	spring.cloud.nacos.config.timeout	3000	单位为 ms
配置的命名空间	spring.cloud.nacos.config.namespace		常用场景之一是不同环境的配置的区分隔离，例如开发测试环境和生产环境的资源隔离等。
AccessKey	spring.cloud.nacos.config.access-key
SecretKey	spring.cloud.nacos.config.secret-key
相对路径	spring.cloud.nacos.config.context-path		服务端 API 的相对路径
接入点	spring.cloud.nacos.config.endpoint	UTF-8	地域的某个服务的入口域名，通过此域名可以动态地拿到服务端地址
是否开启监听和自动刷新	spring.cloud.nacos.config.refresh.enabled	true

2.5 动态刷新

采用properties注入方式更改，确定配置某一前缀可更改刷新配置，统一管理，统一处理

@RefreshScope
@ConfigurationProperties(prefix = "nacos.refresh")
@Component
@Data
public class RefreshConfig {

    private String test;
    private String name;
    private int port;
}

	@Autowired
    RefreshConfig refreshConfig;
    @GetMapping(value = "getRefreshConfig")
    @ApiOperation(value = "getRefreshConfig", notes = "Nacos 动态刷新", consumes = MediaType.APPLICATION_JSON_UTF8_VALUE)
    public Response getRefreshConfig() {
        return Response.success(TMaps.set("name",refreshConfig.getName())
                .set("test",refreshConfig.getTest())
                .set("port",refreshConfig.getPort()));
    }

3. Nacos 注册中心整合

3.1 引入pom

		<!--nacos 注册中心-->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>

3.2 修改配置

由于引用了nacos配置中心，配置配置在nacos，只需要添加注册中心相关配置即可

spring:
  cloud:
    nacos:
      discovery:
        namespace: ${nacos.namespace}
        group: ${nacos.group}
      # 默认  ${spring.cloud.nacos.server-addr}
      #  server-addr: ${spring.cloud.nacos.server-addr} 服务名默认应用名

3.3 项目启动

• 修改启动类

@SpringBootApplication
@EnableDiscoveryClient
@EnableCircuitBreaker
@EnableFeignClients
@EnableApiDoc
public class PlatformServiceApp {
    public static void main(String[] args) {
        SpringApplication.run(PlatformServiceApp.class, args);
    }
}

java -Dfile.encoding=utf-8 -jar springboot服务

加上编码，否则打包后访问nacos配置文件报错

• 结果验证

• 启动多个节点

  修改端口号，启动服务

查看详情

4. 服务间调用

• 参照以上步骤，新建一个服务

• 用2.5 动态刷新的接口作为服务接口(启动两个服务，同时测试一下负载)

• 开发客户端

  @FeignClient(value = "nacos-demo-test")
  public interface DemoFeignClient {
      @GetMapping(value = "test/getRefreshConfig")
      Response getRefreshConfig();
  }
  
  
  // controller
   @Autowired
      DemoFeignClient demoFeignClient;
      @PostMapping(value = "feign")
      @ApiOperation(value = "FeignDemo", notes = "Nacos 注册中心测试Feign调用", consumes = MediaType.APPLICATION_JSON_UTF8_VALUE)
      public Response sendFeign() {
          return demoFeignClient.getRefreshConfig();
      }
  
  
  

• debug运行，同时测试下负载均衡
  
  之前重写扩展过feign，在此处断点跟踪，已经集成API文档，打开在想文档直接调试
  第一次调用：
  
  第二次调用：
  
  返回结果：