Spring Cloud 集成 Nacos

介绍如何使用 Nacos 来实现 Spring Cloud 分布式环境下的配置管理和服务注册发现。

关于 Nacos Spring Cloud 的详细文档请参看:Nacos ConfigNacos Discovery

通过 Nacos Serverspring-cloud-starter-alibaba-nacos-config 实现配置的动态变更。
通过 Nacos Serverspring-cloud-starter-alibaba-nacos-discovery 实现服务的注册与发现。

启动配置管理

启动 Nacos server 后,即可为 Spring Cloud 应用配置 Nacos 客户端。完整示例代码请参考:nacos-spring-cloud-config-example

(1)添加依赖:

1
2
3
4
5
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
<version>${latest.version}</version>
</dependency>

注意:版本 0.2.x.RELEASE 对应的是 Spring Boot 2.x 版本,版本 0.1.x.RELEASE 对应的是 Spring Boot 1.x 版本

(2)在bootstrap.properties中配置Nacos server的地址和应用名

1
2
3
spring.cloud.nacos.config.server-addr=127.0.0.1:8848

spring.application.name=example

说明:之所以需要配置spring.application.name,是因为它是构成 Nacos 配置管理dataId字段的一部分。

在 Nacos Spring Cloud 中,dataId 的完整格式如下:

1
${prefix}-${spring.profile.active}.${file-extension}
  • prefix默认为spring.application.name的值,也可以通过配置项spring.cloud.nacos.config.prefix来配置
  • spring.profile.active即为当前环境对应的profile,当spring.profile.active为空时,对应的连接符-也将不存在,dataId的拼接格式变成${prefix}.${file-extension}
  • file-exetension为配置内容的数据格式,可以通过配置项spring.cloud.nacos.config.file-extension来配置。目前只支持propertiesyaml类型

(3)通过 Spring Cloud 原生注解@RefreshScope实现配置自动更新:

1
2
3
4
5
6
7
8
9
10
11
12
13
@RestController
@RequestMapping("/config")
@RefreshScope
public class ConfigController {

@Value("${useLocalCache:false}")
private boolean useLocalCache;

@RequestMapping("/get")
public boolean get() {
return useLocalCache;
}
}

(4)首先通过调用 Nacos Open API 向 Nacos Server 发布配置:dataIdexample.properties,内容为useLocalCache=true

1
curl -X POST "http://127.0.0.1:8848/nacos/v1/cs/configs?dataId=example.properties&group=DEFAULT_GROUP&content=useLocalCache=true"

(5)运行 NacosConfigApplication,调用curl http://localhost:8080/config/get,返回内容是 true。

(6)再次调用 Nacos Open API 向 Nacos server 发布配置:dataIdexample.properties,内容为useLocalCache=false

1
curl -X POST "http://127.0.0.1:8848/nacos/v1/cs/configs?dataId=example.properties&group=DEFAULT_GROUP&content=useLocalCache=false"

再次访问http://localhost:8080/config/get,此时返回内容为false,说明程序中的useLocalCache值已经被动态更新。

启动服务发现

通过实现一个简单的 echo service 演示如何在 Spring Cloud 项目中启用 Nacos 的服务发现功能,如下图示:

完整示例代码请参考:nacos-spring-cloud-discovery-example

(1)添加依赖:

1
2
3
4
5
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
<version>${latest.version}</version>
</dependency>

注意:版本 0.2.x.RELEASE 对应的是 Spring Boot 2.x 版本,版本 0.1.x.RELEASE 对应的是 Spring Boot 1.x 版本

(2)配置服务提供者,从而服务提供者可以通过 Nacos 的服务注册发现功能将其服务注册到 Nacos server 上。

首先在application.properties中配置Nacos server的地址:

1
2
3
4
server.port=8070
spring.application.name=service-provider

spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848

然后通过 Spring Cloud 原生注解@EnableDiscoveryClient开启服务注册发现功能:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
@SpringBootApplication
@EnableDiscoveryClient
public class NacosProviderApplication {

public static void main(String[] args) {
SpringApplication.run(NacosProviderApplication.class, args);
}

@RestController
class EchoController {
@RequestMapping(value = "/echo/{string}", method = RequestMethod.GET)
public String echo(@PathVariable String string) {
return "Hello Nacos Discovery " + string;
}
}
}

(3)配置服务消费者,从而服务消费者可以通过 Nacos 的服务注册发现功能从 Nacos server 上获取到它要调用的服务。

首先在application.properties中配置Nacos server的地址:

1
2
3
4
server.port=8080
spring.application.name=service-consumer

spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848

然后通过 Spring Cloud 原生注解@EnableDiscoveryClient开启服务注册发现功能。给RestTemplate实例添加@LoadBalanced注解,开启@LoadBalanced与 Ribbon 的集成:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
@SpringBootApplication
@EnableDiscoveryClient
public class NacosConsumerApplication {

@LoadBalanced
@Bean
public RestTemplate restTemplate() {
return new RestTemplate();
}

public static void main(String[] args) {
SpringApplication.run(NacosConsumerApplication.class, args);
}

@RestController
public class TestController {

private final RestTemplate restTemplate;

@Autowired
public TestController(RestTemplate restTemplate) {this.restTemplate = restTemplate;}

@RequestMapping(value = "/echo/{str}", method = RequestMethod.GET)
public String echo(@PathVariable String str) {
return restTemplate.getForObject("http://service-provider/echo/" + str, String.class);
}
}
}

启动 ProviderApplication 和 ConsumerApplication ,调用http://localhost:8080/echo/2018,返回内容为Hello Nacos Discovery 2018

Powered by AppBlog.CN     浙ICP备14037229号

Copyright © 2012 - 2020 APP开发技术博客 All Rights Reserved.

访客数 : | 访问量 :