Nacos学习之 SpringBoot整合Nacos
在Spring Boot 中使用Nacos
前提条件
需先下载 Nacos 并启动 Nacos serve。
启动服务发现
- 添加依赖。
<dependency> <groupId>com.alibaba.boot</groupId> <artifactId>nacos-discovery-spring-boot-starter</artifactId> <version>${latest.version}</version> </dependency>
- 在 application.properties 中配置 Nacos server 的地址:
nacos.discovery.server-addr=127.0.0.1:8848
- 使用 @NacosInjected 注入 Nacos 的 NamingService 实例:
@Controller @RequestMapping("discovery") public class DiscoveryController { @NacosInjected private NamingService namingService; @RequestMapping(value = "/get", method = GET) @ResponseBody public List<Instance> get(@RequestParam String serviceName) throws NacosException { return namingService.getAllInstances(serviceName); } } @SpringBootApplication public class NacosDiscoveryApplication { public static void main(String[] args) { SpringApplication.run(NacosDiscoveryApplication.class, args); } }
- 启动 NacosDiscoveryApplication,调用 curl http://localhost:8080/discovery/get?serviceName=example,此时返回为空 JSON 数组[]。 说明此时在Nacos Server中并没有example的服务
- 通过调用 Nacos Open API 向 Nacos server 注册一个名称为 example 服务
curl -X PUT http://127.0.0.1:8848/nacos/v1/ns/instance?serviceName=example&ip=127.0.0.1&port=8080
- 再次访问 curl http://localhost:8080/discovery/get?serviceName=example,此时返回内容为:
[ { "instanceId": "127.0.0.1-8080-DEFAULT-example", "ip": "127.0.0.1", "port": 8080, "weight": 1.0, "healthy": true, "cluster": { "serviceName": null, "name": "", "healthChecker": { "type": "TCP" }, "defaultPort": 80, "defaultCheckPort": 80, "useIPPort4Check": true, "metadata": {} }, "service": null, "metadata": {} } ]
启动配置管理
- 添加依赖
<dependency> <groupId>com.alibaba.boot</groupId> <artifactId>nacos-config-spring-boot-starter</artifactId> <version>${latest.version}</version> </dependency>
注意:版本 0.2.x.RELEASE 对应的是 Spring Boot 2.x 版本,版本 0.1.x.RELEASE 对应的是 Spring Boot 1.x 版本。
- 在 application.properties 中配置 Nacos server 的地址:
nacos.config.server-addr=127.0.0.1:8848
- 使用 @NacosPropertySource 加载 dataId 为 example 的配置源,并开启自动更新:
@SpringBootApplication @NacosPropertySource(dataId = "example", autoRefreshed = true) public class NacosConfigApplication { public static void main(String[] args) { SpringApplication.run(NacosConfigApplication.class, args); } }
- 通过 Nacos 的 @NacosValue 注解设置属性值。
@Controller @RequestMapping("config") public class ConfigController { @NacosValue(value = "${useLocalCache:false}", autoRefreshed = true) private boolean useLocalCache; @RequestMapping(value = "/get", method = GET) @ResponseBody public boolean get() { return useLocalCache; } }
- 启动 NacosConfigApplication 调用 curl http://localhost:8080/config/get,返回内容是 false。说明此时在 Nacos Serve服务器中 useLocalCache为false或者是没有值。
- 新增或修改Nacos Serve服务器中 useLocalCache的值为true :通过调用 向 Nacos server 发布配置:dataId 为example,内容为useLocalCache=true
curl -X POST "http://127.0.0.1:8848/nacos/v1/cs/configs?dataId=example&group=DEFAULT_GROUP&content=useLocalCache=true"
- 再次访问http://localhost:8080/config/get,此时返回内容为true,说明程序中的useLocalCache值已经从 Nacos server中拿到最新的配置,并被动态更新了。
Nacos官网文档地址:https://nacos.io/zh-cn/docs/