SpringBoot(25) 整合Nacos实现配置管理、服务注册与发现

向右看齐 2023-07-19 12:07 70阅读 0赞

### 一、前言 ###

本文将基于`springboot2.1.8.RELEASE`整合`Nacos`实现`配置管理(动态加载配置)`、`服务注册与发现`

> Nacos文档: [https://nacos.io/zh-cn/docs/what-is-nacos.html][https_nacos.io_zh-cn_docs_what-is-nacos.html]

### 二、`Docker`安装`Nacos` ###

# 单机模式运行【-e MODE=standalone】
    docker run --name nacos_server -d -p 8848:8848 --restart=always -e MODE=standalone -v $PWD/logs:/home/nacos/logs nacos/nacos-server:latest

通过 `IP:8848/nacos` 访问，默认登录账号密码：`nacos/nacos`

ex: [www.zhengqingya.com:8848/nacos][www.zhengqingya.com_8848_nacos]

### 三、`SpringBoot`整合`Nacos` ###

#### 1、`pom.xml`中`引入nacos`相关`依赖` ####

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

#### 2、`application.yml`中配置`nacos` ####

server:
      port: 8080
    
    spring:
      application:
        name: nacos-demo # nacos服务名
    
    # ======================== ↓↓↓↓↓↓ nacos相关配置 ↓↓↓↓↓↓ ===============================
    nacos:
      # 配置管理
      config:
        server-addr: www.zhengqingya.com:8848 # TODO 这里换成自己的ip加端口
      # 服务注册与发现
      discovery:
        server-addr: ${ nacos.config.server-addr}

#### 3、配置管理 ####

###### ①启动类上添加`@NacosPropertySource` ######

// 使用 @NacosPropertySource 加载 `dataId` 为 `application.yml` 的配置源，并开启自动更新
    @NacosPropertySource(dataId = "application.yml", autoRefreshed = true)
    @SpringBootApplication
    public class DemoApplication { 
        public static void main(String[] args) { 
            SpringApplication.run(DemoApplication.class, args);
        }
    }

###### ②新增动态加载配置测试Controller ######

@RestController
    public class HelloController { 
    
        @NacosValue(value = "${helloworld:HelloWorld}", autoRefreshed = true)
        private String hello;
    
        @GetMapping("/hello")
        public String hello() { 
            return hello;
        }
    
    }

###### ③nacos服务端新增配置 ######

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4MjI1NTU4_size_16_color_FFFFFF_t_70]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4MjI1NTU4_size_16_color_FFFFFF_t_70 1]

###### ④ 启动项目，修改配置，刷新页面 ######

启动项目访问[http://127.0.0.1:8080/hello][http_127.0.0.1_8080_hello]，修改nacos服务端配置参数，然后刷新页面，测试是否动态加载配置~  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4MjI1NTU4_size_16_color_FFFFFF_t_70 2]

#### 4、服务注册 ####

###### ①Nacos Api 直接注册服务方式 ######

curl -X PUT 'http://www.zhengqingya.com:8848/nacos/v1/ns/instance?serviceName=example&ip=127.0.0.1&port=8080'`

###### ②Java ######

通过`@PostConstruct`来实现注册服务

@Component
    public class RegisterNacos { 
    
        @NacosInjected
        private NamingService namingService;
    
        @Value("${server.port}")
        private int serverPort;
    
        @Value("${spring.application.name}")
        private String applicationName;
    
        /** * 注册服务 * * @throws NacosException */
        @PostConstruct // 修饰的方法会在服务器加载Servlet的时候运行，并且只会被服务器执行一次！！！
        public void registerInstance() throws NacosException { 
            namingService.registerInstance(applicationName, "127.0.0.1", serverPort);
        }
    
    }

###### ③查看服务 ######

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4MjI1NTU4_size_16_color_FFFFFF_t_70 3]

#### 5、服务发现 ####

@RestController
    @RequestMapping("discovery")
    public class DiscoveryController { 
    
        @NacosInjected
        private NamingService namingService;
    
        /** * 获取实例 * * @param serviceName: 服务名 * @return * @throws NacosException */
        @GetMapping("/getInstance")
        public List<Instance> getInstance(@RequestParam String serviceName) throws NacosException { 
            return namingService.getAllInstances(serviceName);
        }
    
    }

访问[http://127.0.0.1:8080/discovery/getInstance?serviceName=nacos-demo][http_127.0.0.1_8080_discovery_getInstance_serviceName_nacos-demo]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4MjI1NTU4_size_16_color_FFFFFF_t_70 4]

--------------------

### 本文案例demo源码 ###

[https://gitee.com/zhengqingya/java-workspace][https_gitee.com_zhengqingya_java-workspace]

[https_nacos.io_zh-cn_docs_what-is-nacos.html]: https://nacos.io/zh-cn/docs/what-is-nacos.html
[www.zhengqingya.com_8848_nacos]: http://www.zhengqingya.com:8848/nacos
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4MjI1NTU4_size_16_color_FFFFFF_t_70]: /images/20230528/f33e94d98e284224b659751eb99c07dc.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4MjI1NTU4_size_16_color_FFFFFF_t_70 1]: /images/20230528/1768a68e31c948148aebb5a10ff41502.png
[http_127.0.0.1_8080_hello]: http://127.0.0.1:8080/hello
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4MjI1NTU4_size_16_color_FFFFFF_t_70 2]: /images/20230528/6ad0a12b886b4d3f9c8ce44e82c7b28f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4MjI1NTU4_size_16_color_FFFFFF_t_70 3]: /images/20230528/5684ca7411f646e696ed5f439f60b48b.png
[http_127.0.0.1_8080_discovery_getInstance_serviceName_nacos-demo]: http://127.0.0.1:8080/discovery/getInstance?serviceName=nacos-demo
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4MjI1NTU4_size_16_color_FFFFFF_t_70 4]: /images/20230528/f69ef67720484a33b2aeed060602c7af.png
[https_gitee.com_zhengqingya_java-workspace]: https://gitee.com/zhengqingya/java-workspace