Nacos 学习笔记：Spring-Cloud-Alibaba 整合 Nacos

末蓝、 2022-12-30 13:44 190阅读 0赞

### Nacos 学习笔记：Spring-Cloud-Alibaba 整合 Nacos ###

*  父工程 nacos-spring-cloud-alibaba-demo
 *   *  添加依赖
 *  创建生产者 nacos-spring-cloud-alibaba-provider
 *   *  添加依赖
     *  添加配置
     *   *  本地添加 \`SpringCloud\` 配置文件 bootstrap.yml
         *  线上添加 \`SpringBoot\` 配置文件 nacos-alibaba-provider.yml
     *  添加启动类
     *  添加控制器
 *  创建消费者 nacos-spring-cloud-alibaba-consumer
 *   *  添加依赖
     *  添加配置
     *  添加启动类
     *  添加 FeignClient
     *  添加控制器
 *  参考资料

# 父工程 nacos-spring-cloud-alibaba-demo #

## 添加依赖 ##

\\nacos-spring-cloud-alibaba-demo\\pom.xml  
子项目要使用`Springboot`，但又要继承父项目，所以在父项目中`import`相关依赖，代替继承操作。

<?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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
    
        <groupId>com.jerry</groupId>
        <artifactId>nacos-spring-cloud-alibaba-demo</artifactId>
        <version>1.0</version>
        <packaging>pom</packaging>
    
        <name>${artifactId}</name>
        <description>学习 nacos 配置管理</description>
    
        <modules>
            <module>nacos-spring-cloud-alibaba-provider</module>
            <module>nacos-spring-cloud-alibaba-consumer</module>
        </modules>
    
        <properties>
            <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
            <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
            <java.version>1.8</java.version>
            
            <maven.compiler.source>1.8</maven.compiler.source>
            
            <maven.compiler.target>1.8</maven.compiler.target>
        </properties>
        
        <dependencyManagement>
            <dependencies>
                
                <dependency>
                    <groupId>org.springframework.cloud</groupId>
                    <artifactId>spring-cloud-dependencies</artifactId>
                    <version>Greenwich.RELEASE</version>
                    <type>pom</type>
                    <scope>import</scope>
                </dependency>
                
                <dependency>
                    <groupId>com.alibaba.cloud</groupId>
                    <artifactId>spring-cloud-alibaba</artifactId>
                    <version>2.1.0.RELEASE</version>
                    <type>pom</type>
                    <scope>import</scope>
                </dependency>
                
                <dependency>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-dependencies</artifactId>
                    <version>2.1.3.RELEASE</version>
                    <type>pom</type>
                    <scope>import</scope>
                </dependency>
            </dependencies>
        </dependencyManagement>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </build>
    </project>

# 创建生产者 nacos-spring-cloud-alibaba-provider #

## 添加依赖 ##

`\.\nacos-spring-cloud-alibaba-provider\pom.xml`

<table> 
 <thead> 
  <tr> 
   <th>依赖</th> 
   <th>说明</th> 
   <th>添加与否</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>web服务</td> 
   <td>生产者消费者都要对外提供 restful 接口</td> 
   <td>两个都添加</td> 
  </tr> 
  <tr> 
   <td>服务注册发现</td> 
   <td>生产者消费者都要注册到nacos</td> 
   <td>两个都添加</td> 
  </tr> 
  <tr> 
   <td>配置管理</td> 
   <td>针对本demo只有生产 者读了配置</td> 
   <td>只有生产者添加</td> 
  </tr> 
 </tbody> 
</table>

## 添加配置 ##

### 本地添加 `SpringCloud` 配置文件 bootstrap.yml ###

`\.\nacos-spring-cloud-alibaba-provider\src\main\resources\bootstrap.yml`

server:
      port: 8085
    
    spring:
      application:
        name: nacos-alibaba-provider
      cloud:
        nacos:
          discovery:
            server-addr: 127.0.0.1:8848
          config:
            server-addr: 127.0.0.1:8848
            file-extension: yaml

### 线上添加 `SpringBoot` 配置文件 nacos-alibaba-provider.yml ###

jerry:
      name: 这里是 consumer-service-alibaba

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

## 添加启动类 ##

`com.jerry.nacos.discovery.provider.NacosProviderApplication`

package com.jerry.nacos.discovery.provider;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
    
    /** * @author jerryjin */
    @SpringBootApplication
    @EnableDiscoveryClient
    public class NacosProviderApplication { 
        public static void main(String[] args) { 
            SpringApplication.run(NacosProviderApplication.class, args);
        }
    }

## 添加控制器 ##

`com.jerry.nacos.discovery.provider.controller.ProviderController`

package com.jerry.nacos.discovery.provider.controller;
    
    import com.alibaba.nacos.api.annotation.NacosProperties;
    import org.springframework.beans.factory.annotation.Value;
    import org.springframework.cloud.context.config.annotation.RefreshScope;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    import java.time.LocalDateTime;
    
    /** * @author jerryjin */
    @RestController
    @RefreshScope
    public class ProviderController { 
        @Value("${jerry.name:666}")
        private String name;
        @GetMapping("/hi")
        public String hi(){ 
            return name + " " + LocalDateTime.now().toString();
        }
    }

![在这里插入图片描述][20201225200413488.png]

# 创建消费者 nacos-spring-cloud-alibaba-consumer #

## 添加依赖 ##

`\.\nacos-spring-cloud-alibaba-consumer\pom.xml`

<table> 
 <thead> 
  <tr> 
   <th>依赖</th> 
   <th>说明</th> 
   <th>添加与否</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>web服务</td> 
   <td>生产者消费者都要对外提供 restful 接口</td> 
   <td>两个都添加</td> 
  </tr> 
  <tr> 
   <td>服务注册发现</td> 
   <td>生产者消费者都要注册到nacos</td> 
   <td>两个都添加</td> 
  </tr> 
  <tr> 
   <td>声明式HTTP客户端</td> 
   <td>针对本demo只有消费者使用了 feign 调用别人</td> 
   <td>只有消费者添加</td> 
  </tr> 
 </tbody> 
</table>

## 添加配置 ##

`\.\nacos-spring-cloud-alibaba-consumer\src\main\resources\application.yml`

server:
      port: 8086
    
    spring:
      application:
        name: nacos-alibaba-consumer
      cloud:
        nacos:
          discovery:
            server-addr: 127.0.0.1:8848
    logging:
      level:
        root: info
        org.springframework: info

## 添加启动类 ##

`com.jerry.nacos.discovery.consumer.NacosConsumerApplication`

package  com.jerry.nacos.discovery.consumer;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
    import org.springframework.cloud.openfeign.EnableFeignClients;
    
    /** * @author jerryjin */
    @SpringBootApplication
    @EnableDiscoveryClient
    @EnableFeignClients
    public class NacosConsumerApplication { 
        public static void main(String[] args) { 
            SpringApplication.run(NacosConsumerApplication.class, args);
        }
    }

## 添加 FeignClient ##

消费者通过`Feign`调用生产者的接口：

1.  消费者中定义`interface`。
2.  添加`@FeignClient`注解，值标识`生产者`的`服务名`。例如：`nacos-alibaba-provider`
3.  `interface`中定义胡方法与生产者的`controller`对应。

`com.jerry.nacos.discovery.consumer.client.ProviderClient`

*  @FeignClient(“nacos-alibaba-provider”) // 生产者的服务名 `nacos-alibaba-provider`
 *  接口对应生产者的控制器。

package com.jerry.nacos.discovery.consumer.client;
    
    import org.springframework.cloud.openfeign.FeignClient;
    import org.springframework.web.bind.annotation.GetMapping;
    
    /** * @author jerryjin */
    @FeignClient("nacos-alibaba-provider")
    public interface ProviderClient { 
        @GetMapping("/hi")
        String hi();
    }

## 添加控制器 ##

`com.jerry.nacos.discovery.consumer.controller.ConsumerController`

*  注入 `FeignClient` 直接调用即可。

package com.jerry.nacos.discovery.consumer.controller;
    
    import com.jerry.nacos.discovery.consumer.client.ProviderClient;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    import javax.annotation.Resource;
    
    /** * @author jerryjin */
    @RestController
    public class ConsumerController { 
        @Resource
        ProviderClient providerClient;
        @GetMapping("/hi")
        public String hi(){ 
            String hi = providerClient.hi();
            return "消费者调用了生产者，生产者说：" + hi;
        }
    }

![在这里插入图片描述][20201225202157167.png]

# 参考资料 #

[Nacos Spring Cloud 快速开始][Nacos Spring Cloud]  
[官网：配置项详解：Spring Cloud Alibaba Nacos Config][Spring Cloud Alibaba Nacos Config]  
[官网：Wiki 配置项详解：Spring Cloud Alibaba Nacos Config][Wiki _Spring Cloud Alibaba Nacos Config]

[笑虾CSDN Nacos 学习笔记：SpringBoot 整合 Nacos 配置管理、服务发现][CSDN Nacos _SpringBoot _ Nacos]  
[ 笑虾码云 spring-cloud-alibaba-demo 源码][_ spring-cloud-alibaba-demo]

[SpringCloud官网：7. Declarative REST Client: Feign][SpringCloud_7. Declarative REST Client_ Feign]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p4NTIw_size_16_color_FFFFFF_t_70]: /images/20221120/9acb7df533384ccf81435519e0ef4606.png
[20201225200413488.png]: /images/20221120/85a23db7c4ff43fa942034ccac06b0e3.png
[20201225202157167.png]: https://img-blog.csdnimg.cn/20201225202157167.png
[Nacos Spring Cloud]: https://nacos.io/zh-cn/docs/quick-start-spring-cloud.html
[Spring Cloud Alibaba Nacos Config]: https://github.com/alibaba/spring-cloud-alibaba/blob/master/spring-cloud-alibaba-docs/src/main/asciidoc-zh/nacos-config.adoc
[Wiki _Spring Cloud Alibaba Nacos Config]: https://github.com/alibaba/spring-cloud-alibaba/wiki/Nacos-config
[CSDN Nacos _SpringBoot _ Nacos]: https://jerryjin.blog.csdn.net/article/details/109438467
[_ spring-cloud-alibaba-demo]: https://gitee.com/jerryjin0630/spring-cloud-alibaba-demo
[SpringCloud_7. Declarative REST Client_ Feign]: https://cloud.spring.io/spring-cloud-netflix/multi/multi_spring-cloud-feign.html