Nacos 学习笔记：SpringBoot 整合 Nacos

我不是女神ヾ 2022-11-21 11:59 241阅读 0赞

### Nacos 学习笔记：SpringBoot 整合 Nacos ###

*  创建干净的 SpringBoot 项目
 *  获取 Nacos 上的配置信息
 *   *  1、编码方式读取配置
     *  2、注解方式读取配置
     *   *  2.1. 添加依赖
         *  2.2. 添加配置
         *  2.3. 启动类
         *  2.4. 添加控制器 ConfigController
 *  服务发现
 *   *  1. 添加依赖
     *  2. 添加配置 application.yml
     *  3. 添加启动类
     *  4. 添加配置类，注册服务
     *  4. 添加控制器
     *  5. Nacos上添加配置信息
     *  6. 启动SpringBoot项目
     *  7. 调用服务
 *  参考资料

学习中使用的是 `windows`

# 创建干净的 SpringBoot 项目 #

1.  SpringBoot 版本 `2.3.5.RELEASE`
2.  添加 Nacos 客户端依赖

<dependency>
                <groupId>com.alibaba.nacos</groupId>
                <artifactId>nacos-client</artifactId>
                <version>1.1.3</version>
            </dependency>

# 获取 Nacos 上的配置信息 #

*  public

jerry:
      msg: 大家好。这里是 public

*  test

jerry:
      msg: 大家好。这里是 test

## 1、编码方式读取配置 ##

监听配置变化也包括了

package com.jerry.nacosconfig;
    
    import com.alibaba.nacos.api.NacosFactory;
    import com.alibaba.nacos.api.config.ConfigService;
    import com.alibaba.nacos.api.config.listener.Listener;
    import com.alibaba.nacos.api.exception.NacosException;
    
    import java.util.Properties;
    import java.util.concurrent.Executor;
    
    public class NacosConfigMain { 
        public static void main(String[] args) throws NacosException, InterruptedException { 
            // nacos 服务地址
            String serverAddr = "127.0.0.1:8848";
            // 命名空间。通常用来区分环境。不填默认：public(保留空间)
            String namespace = "7b7a1fe9-79c9-4a5a-9bb0-7ce9f3edc3d5";
            // 组。通常对应项目。默认：DEFAULT_GROUP
            String group = "DEFAULT_GROUP";
            // 通常对应配置文件
            String dataId = "application.yml";
    
            // Properties 封装一下
            Properties properties = new Properties();
            properties.put("serverAddr", serverAddr);
            properties.put("namespace", namespace);
    
            // 创建配置服务
            ConfigService configService = NacosFactory.createConfigService(properties);
            // 按照 dataId, group 获取配置内容。响应超时 6 秒
            String config = configService.getConfig(dataId, group, 6000);
            System.out.println(config);
    
            // 监听配置变化
            configService.addListener(dataId, group, new Listener() { 
                @Override
                public Executor getExecutor() { 
                    return null;
                }
    
                @Override
                public void receiveConfigInfo(String configInfo) { 
                    System.out.println(configInfo);
                }
            });
    
            // 拖着进程 一天后结束。方便演示监听效果
            Thread.sleep(86400 * 1000);
    
        }
    }

## 2、注解方式读取配置 ##

正常来说来我们肯定是使用注解的方式，不可能手写代码去

jerry:
      msg: 大家好。这里是 test
      msg2: 我是 msg2

### 2.1. 添加依赖 ###

`pom.xml`

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>[2.2,2.3)</version> 
            <relativePath/> 
        </parent>
    
        <groupId>com.jerry</groupId>
        <artifactId>nacos-config-demo</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <name>${artifactId}</name>
        <description>学习 nacos 配置管理</description>
    
        <properties>
            <java.version>1.8</java.version>
            <nacos.version>[0.2,0.3)</nacos.version>
        </properties>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            
    
    
    
    
    
    		
            <dependency>
                <groupId>com.alibaba.boot</groupId>
                <artifactId>nacos-config-spring-boot-starter</artifactId>
                <version>${nacos.version}</version>
            </dependency>
        </dependencies>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </build>
    </project>

### 2.2. 添加配置 ###

`application.yml`

nacos:
      config:
        server-addr: 127.0.0.1:8848
        namespace: cd6cae6c-4fca-4bff-b8cb-854035592452 # 不填默认 public

### 2.3. 启动类 ###

`NacosDemoApplication.class`

package com.jerry.nacosconfig;
    
    import com.alibaba.nacos.spring.context.annotation.config.NacosPropertySource;
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    @SpringBootApplication
    @NacosPropertySource(dataId = "application.yml", autoRefreshed = true)
    public class NacosConfigApplication { 
        public static void main(String[] args) { 
            SpringApplication.run(NacosConfigApplication.class, args);
        }
    }

### 2.4. 添加控制器 ConfigController ###

`${jerry.msg: 呵呵达!}` 未获取到配置信息时，使用默认值`呵呵达!`

package com.jerry.nacosconfig.controller;
    
    import com.alibaba.nacos.api.config.annotation.NacosValue;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    @RestController
    @RequestMapping("config")
    public class ConfigController{ 
        @NacosValue(value = "${jerry.msg: 呵呵达!}", autoRefreshed = true)
        private String msg;
        @NacosValue(value = "${jerry.msg2}") // 没加自动刷新
        private String msg2;
    
        @GetMapping("/msg")
        public String msg() {  return msg; }
    
        @GetMapping("/msg2")
        public String msg2() {  return msg2; }
    }

# 服务发现 #

为了理清逻辑，对刚上的项目整理一下。改成一个父子项目。两个`Module` ：`provider-service`，`consumer-service`

## 1. 添加依赖 ##

逻辑上每一个微服务都可以互相调用，并且都可以从`Naocs`读取配置。所以这里我就把依赖都放到父`pom`中，两个`Module`直接继承即可。

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
     	<modelVersion>4.0.0</modelVersion>
        
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>[2.2,2.3)</version> 
            <relativePath/> 
        </parent>
        
        <artifactId>nacos-spring-boot-demo</artifactId>
        <packaging>pom</packaging>
        <name>${artifactId}</name>
        <description>本项目为学习 nacos 做练习之用</description>
        
    	
        <modules>
            <module>provider-service</module>
            <module>consumer-service</module>
        </modules>
    
        <groupId>com.jerry</groupId>
        <artifactId>nacos-demo</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <name>nacos-demo</name>
        <description>本项目为学习 nacos 做练习之用</description>
    
        <properties>
            <java.version>1.8</java.version>
            <nacos.version>0.2.7</nacos.version>
        </properties>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
            </dependency>
    
            
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            
            <dependency>
                <groupId>com.alibaba.boot</groupId>
                <artifactId>nacos-config-spring-boot-starter</artifactId>
                <version>${nacos.version}</version>
            </dependency>
            
            <dependency>
                <groupId>com.alibaba.boot</groupId>
                <artifactId>nacos-discovery-spring-boot-starter</artifactId>
                <version>${nacos.version}</version>
            </dependency>
        </dependencies>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </build>
    </project>

provider 模块 `pom.xml`

consumer 模块 `pom.xml`

## 2. 添加配置 application.yml ##

**注意：**nacos.config.type 默认 properties 格式。这里我们改成了yml，至于启动类与nacos 配置管理上的Data Id记得带扩展名

分别给两个 `Module` 添加配置文件：  
`\provider-service\src\main\resources\application.yml`

server:
      port: 8081 # 服务端口
    
    spring:
      application:
        name: provider-service # 服务名称
      jackson:
        date-format: yyyy-MM-dd HH:mm:ss # 日期格式化
        time-zone: GMT+8 # 设置时区
    
    nacos:
      config:
        server-addr: 127.0.0.1:9527 # nacos配置地址
        type: yaml # 配置文件格式，不指定默认 properties
        namespace: cd6cae6c-4fca-4bff-b8cb-854035592452 # 不填默认 public
      discovery:
        server-addr: 127.0.0.1:9527 # nacos注册地址

`\consumer-service\src\main\resources\application.yml`

server:
      port: 8082 # 服务端口
    
    spring:
      application:
        name: consumer-service # 服务名称
      jackson:
        date-format: yyyy-MM-dd HH:mm:ss # 日期格式化
        time-zone: GMT+8 # 设置时区
    
    nacos:
      config:
        server-addr: 127.0.0.1:9527 # nacos配置地址
        type: yaml # 配置文件格式，不指定默认 properties
        namespace: cd6cae6c-4fca-4bff-b8cb-854035592452 # 不填默认 public
      discovery:
        server-addr: 127.0.0.1:9527 # nacos注册地址

## 3. 添加启动类 ##

注意： dataId = “consumer-service.yml”  
`com.jerry.consumer.ConsumerApplication`

package com.jerry.consumer;
    
    import com.alibaba.nacos.spring.context.annotation.config.NacosPropertySource;
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    @SpringBootApplication
    @NacosPropertySource(dataId = "consumer-service.yml", autoRefreshed = true)
    public class ConsumerApplication { 
        public static void main(String[] args) { 
            SpringApplication.run(ConsumerApplication.class, args);
        }
    }

`com.jerry.provider.ProviderApplication`

package com.jerry.provider;
    
    import com.alibaba.nacos.spring.context.annotation.config.NacosPropertySource;
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    @SpringBootApplication
    @NacosPropertySource(dataId = "provider-service.yml", autoRefreshed = true)
    public class ProviderApplication { 
        public static void main(String[] args) { 
            SpringApplication.run(ProviderApplication.class, args);
        }
    }

## 4. 添加配置类，注册服务 ##

`com.jerry.consumer.config.NacosRegisterConfig`，`com.jerry.provider.config.NacosRegisterConfig`内容相同。

package com.jerry.provider.config;
    
    import com.alibaba.nacos.api.annotation.NacosInjected;
    import com.alibaba.nacos.api.exception.NacosException;
    import com.alibaba.nacos.api.naming.NamingService;
    import org.springframework.beans.factory.annotation.Value;
    import org.springframework.context.annotation.Configuration;
    import javax.annotation.PostConstruct;
    
    @Configuration
    public class NacosRegisterConfig { 
        /** 注册服务 */
        private static final String CURRENT_SERVER_IP = "127.0.0.1";
    
        @Value("${server.port}")
        private int serverPort;
    
        @Value("${spring.application.name}")
        private String serverName;
    
        @NacosInjected
        private NamingService namingService;
    
        @PostConstruct
        public void registerInstance() throws NacosException { 
            namingService.registerInstance(serverName, CURRENT_SERVER_IP, serverPort, "DEFAULT");
        }
    }

## 4. 添加控制器 ##

*  提供者 `com.jerry.provider.controller.ProviderController`

package com.jerry.provider.controller;
    
    import com.alibaba.nacos.api.config.annotation.NacosValue;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    @RestController
    public class ProviderController { 
        /** 当未读取到配置信息时，使用默认值 '你是谁？' */
        @NacosValue(value = "${jerry.msg:你是谁？}", autoRefreshed = true)
        private String msg;
    
        @GetMapping("/msg")
        public String msg() { 
            return msg;
        }
    }

*  消费者 `com.jerry.consumer.controller.ConsumerController`

package com.jerry.consumer.controller;
    
    import com.alibaba.nacos.api.annotation.NacosInjected;
    import com.alibaba.nacos.api.naming.NamingService;
    import com.alibaba.nacos.api.naming.pojo.Instance;
    import org.springframework.http.ResponseEntity;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RestController;
    import org.springframework.web.client.RestTemplate;
    
    @RestController
    public class ConsumerController { 
        /** 服务名称 */
        private static final String SERVER_NAME = "provider-service";
    
        /** 发请求用 */
        private RestTemplate restTemplate = new RestTemplate();
    
        @NacosInjected
        private NamingService namingService;
    
        /** 发现服务，调用服务 */
        @GetMapping("/getmsg")
        public String getMsg() { 
            try { 
                if (namingService != null) { 
                    // 获取服务实例
                    Instance instance = namingService.selectOneHealthyInstance(SERVER_NAME);
                    // 拼接服务url
                    String url = "http://" + instance.getIp() + ":" + instance.getPort() + "/msg";
                    // 调用服务
                    ResponseEntity<String> entity = restTemplate.getForEntity(url, String.class);
                    return entity.getBody();
                }
            } catch (Exception e) { 
                System.out.println("出翔了: {}" + e.getMessage());
            }
            return "凉凉啦！";
        }
    }

## 5. Nacos上添加配置信息 ##

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p4NTIw_size_16_color_FFFFFF_t_70]  
`provider-service.yml` 配置格式:`yaml`

jerry:
      msg: 大家好。我是笨笨，笨笨的笨，笨笨的笨，谢谢！

`consumer-service.yml` 配置格式:`yaml`

jerry:
      msg: 这里是 consumer-service 虽然这次没被用到，但还是顺手创建了一份。

## 6. 启动SpringBoot项目 ##

`alt + 8`打开服务仪表盘，启动两个项目。  
![在这里插入图片描述][20201217144219781.png]  
刷新服务列表，看到两个服务都注册上来了。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p4NTIw_size_16_color_FFFFFF_t_70 1]

## 7. 调用服务 ##

访问`consumer-service`提供的接口  
==》访问`nacos`获取`provider-service`的服务实例  
==》解析出服务的信息，调用`provider-service`的接口  
==》得到结果  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p4NTIw_size_16_color_FFFFFF_t_70 2]  
**然而。。。这只是感受一下Nacos罢了。真正的玩法还是有些区别的，看下一篇吧**

# 参考资料 #

[Nacos Spring Boot 快速开始][Nacos Spring Boot]  
[spring boot 0.2.2 以及 0.1.2版本新功能使用手册][spring boot 0.2.2 _ 0.1.2]

[Nacos 源码仓库包含 demo项目][Nacos _ demo]

[笑虾码云 spring-cloud-alibaba-demo 包含 nacos 项目源码][spring-cloud-alibaba-demo _ nacos]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p4NTIw_size_16_color_FFFFFF_t_70]: /images/20221120/d6526ba46e974d009967e3fbb2350f36.png
[20201217144219781.png]: /images/20221120/62c97e5b74c74e0fbc97b12280ae71d3.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p4NTIw_size_16_color_FFFFFF_t_70 1]: /images/20221120/65ac6786ccfb4b56a533476a0efb1e25.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p4NTIw_size_16_color_FFFFFF_t_70 2]: /images/20221120/408a23281bc443e7a2d7900f4b7f4833.png
[Nacos Spring Boot]: https://nacos.io/zh-cn/docs/quick-start-spring-boot.html
[spring boot 0.2.2 _ 0.1.2]: https://github.com/nacos-group/nacos-spring-boot-project/wiki/spring-boot-0.2.2-%E4%BB%A5%E5%8F%8A-0.1.2%E7%89%88%E6%9C%AC%E6%96%B0%E5%8A%9F%E8%83%BD%E4%BD%BF%E7%94%A8%E6%89%8B%E5%86%8C
[Nacos _ demo]: https://github.com/nacos-group/nacos-spring-boot-project
[spring-cloud-alibaba-demo _ nacos]: https://gitee.com/jerryjin0630/spring-cloud-alibaba-demo