Springboot 項目集成 Nacos 實現服務注冊發現與配置管理

作者：鴨血粉絲 2021-04-18 07:33:20

開發前端

我們通過使用 SpringBoot 項目集成 Nacos 來給大家演示一下是如何使用 Nacos 來實現服務發現和配置管理的。

[[393779]]

本文轉載自微信公眾號「Java極客技術」，作者鴨血粉絲。轉載本文請聯系Java極客技術公眾號。

Hello 大家好，我是阿粉，前面的文章給大家介紹了一下如何在本地搭建微服務環境下的服務注冊中心和配置管理中心 Nacos，今天通過

我們通過使用 SpringBoot 項目集成 Nacos 來給大家演示一下是如何使用 Nacos 來實現服務發現和配置管理的。

啟動 Nacos 服務

啟動完本地搭建的 Nacos 服務后，我們可以看到，目前的服務管理下面的服務列表里面在三個命名空間下都沒有服務，這是正常的，因為目前我們還沒有服務接入Nacos。

Nacos 服務啟動成功后，我們再創建兩個 SpringBoot 項目，一個用于接入 Nacos 服務注冊與發現和配置中心作為服務提供者 Producer，另一個只接入 Nacos的服務注冊與發現，調用 Producer 獲取配置中心的參數，我們叫做Consumer。

服務提供者 Producer

1.我們首先創建一個 SpringBoot 的項目，bootstrap.properties 文件內容如下：

spring.application.name=producer 
 
#######################配置中心配置################################# 
# 指定的命名空間，只會在對應的命名空間下查找對應的配置文件 
spring.cloud.nacos.config.namespace=caeser-adsys-naming 
spring.cloud.nacos.config.file-extension=properties 
# 配置的分組名稱 
spring.cloud.nacos.config.group=TEST1 
# 配置文件，數組形式，可以多個，依次遞增 
spring.cloud.nacos.config.ext-config[0].data-id=com.example.properties 
spring.cloud.nacos.config.ext-config[0].group=TEST1 
# 配置中心的地址 
spring.cloud.nacos.config.server-addr=127.0.0.1:8848 
#啟用自動刷新對應的配置文件 
spring.cloud.nacos.config.ext-config[0].refresh=true 
######################服務注冊發現配置################################## 
 
# 服務集群名稱 
spring.cloud.nacos.discovery.cluster-name=TEST1_GROUP 
# 服務注冊中心的地址 
spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848 
# 服務的命名空間 
spring.cloud.nacos.discovery.namespace=caeser-adsys-naming

2.application.properties 的文件內容如下，主要就是一個端口，其他配置根據情況自行添加或刪除就好：

# 服務啟動的端口 
server.port=8080 
spring.main.allow-bean-definition-overriding=true 
# tomcat 配置 
server.tomcat.max-threads=500 
spring.mvc.servlet.load-on-startup=1 
spring.servlet.multipart.max-file-size=40MB 
spring.servlet.multipart.max-request-size=100MB 
# 日志配置 
logging.level.root=info 
logging.level.com.alibaba=error 
logging.pattern.console=%clr{[%level]}{green} [%d{yyyy-MM-dd HH:mm:ss}] %clr{[${PID:-}]}{faint} %clr{[%thread]}{magenta} %clr{[%-40.40logger{80}:%line]}{cyan} %msg%n

3.在啟動類上面增加如下注解

package com.ziyou.nacos.demo.producer; 
 
import org.springframework.boot.SpringApplication; 
import org.springframework.boot.autoconfigure.SpringBootApplication; 
import org.springframework.cache.annotation.EnableCaching; 
import org.springframework.cloud.client.discovery.EnableDiscoveryClient; 
 
@SpringBootApplication(scanBasePackages = "com.ziyou.nacos") 
@EnableDiscoveryClient 
@EnableCaching 
public class ProducerApplication { 
 
    public static void main(String[] args) { 
        SpringApplication.run(ProducerApplication.class, args); 
    } 
}

4.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 http://maven.apache.org/xsd/maven-4.0.0.xsd"> 
  <modelVersion>4.0.0</modelVersion> 
 
  <parent> 
    <groupId>org.example</groupId> 
    <artifactId>nacos-demo</artifactId> 
    <version>1.0-SNAPSHOT</version> 
  </parent> 
 
  <artifactId>producer</artifactId> 
  <version>1.0-SNAPSHOT</version> 
 
  <name>producer Maven Webapp</name> 
  <!-- FIXME change it to the project's website --> 
  <url>http://www.example.com</url> 
 
  <properties> 
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> 
    <maven.compiler.source>1.7</maven.compiler.source> 
    <maven.compiler.target>1.7</maven.compiler.target> 
    <spring.maven.plugin.version>2.2.2.RELEASE</spring.maven.plugin.version> 
  </properties> 
 
  <dependencies> 
    <!-- Spring Boot --> 
    <dependency> 
      <groupId>org.springframework.boot</groupId> 
      <artifactId>spring-boot-starter</artifactId> 
      <exclusions> 
        <exclusion> 
          <groupId>org.springframework.boot</groupId> 
          <artifactId>spring-boot-starter-logging</artifactId> 
        </exclusion> 
      </exclusions> 
    </dependency> 
    <dependency> 
      <groupId>org.springframework.boot</groupId> 
      <artifactId>spring-boot-starter-log4j2</artifactId> 
    </dependency> 
    <dependency> 
      <groupId>org.springframework.boot</groupId> 
      <artifactId>spring-boot-starter-web</artifactId> 
    </dependency> 
 
    <!-- nacos 配置中心 --> 
    <dependency> 
      <groupId>com.alibaba.cloud</groupId> 
      <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId> 
    </dependency> 
    <!-- nacos 注冊發現 --> 
    <dependency> 
      <groupId>com.alibaba.cloud</groupId> 
      <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId> 
    </dependency> 
  </dependencies> 
 
  <build> 
    <!--指定下面的目錄為資源文件--> 
    <resources> 
      <!--設置自動替換--> 
      <resource> 
        <directory>src/main/resources</directory> 
        <filtering>true</filtering> 
        <includes> 
          <include>**/**</include> 
        </includes> 
      </resource> 
    </resources> 
    <finalName>producer</finalName> 
    <plugins> 
      <plugin> 
        <groupId>org.springframework.boot</groupId> 
        <artifactId>spring-boot-maven-plugin</artifactId> 
        <version>${spring.maven.plugin.version}</version> 
        <executions> 
          <execution> 
            <goals> 
              <goal>repackage</goal> 
            </goals> 
          </execution> 
        </executions> 
      </plugin> 
    </plugins> 
  </build> 
</project>

5.在 Producer 側提供一個獲取配置里面內容的接口，代碼如下：

package com.ziyou.nacos.demo.producer.controller; 
 
import com.ziyou.nacos.demo.producer.config.UserConfig; 
import org.springframework.beans.factory.annotation.Autowired; 
import org.springframework.web.bind.annotation.GetMapping; 
import org.springframework.web.bind.annotation.RequestMapping; 
import org.springframework.web.bind.annotation.RestController; 
 
/** 
 * <br> 
 * <b>Function：</b><br> 
 * <b>Author：</b>@author ziyou<br> 
 * <b>Date：</b>2021-04-11 19:59<br> 
 * <b>Desc：</b>無<br> 
 */ 
@RestController 
@RequestMapping(value = "producer") 
public class ProducerController { 
 
    private UserConfig userConfig; 
 
    @GetMapping("/getUsername") 
    private String getUsername() { 
        String result = userConfig.getUsername() + "-" + userConfig.getPassword(); 
        System.out.println(result); 
        return result; 
    } 
 
    @Autowired 
    public void setUserConfig(UserConfig userConfig) { 
        this.userConfig = userConfig; 
    } 
}

package com.ziyou.nacos.demo.producer.config; 
 
import org.springframework.beans.factory.annotation.Value; 
import org.springframework.cloud.context.config.annotation.RefreshScope; 
import org.springframework.stereotype.Component; 
 
/** 
 * <br> 
 * <b>Function：</b><br> 
 * <b>Author：</b>@author ziyou<br> 
 * <b>Date：</b>2021-04-11 20:39<br> 
 * <b>Desc：</b>無<br> 
 */ 
@RefreshScope 
@Component 
public class UserConfig { 
    @Value("${username}") 
    private String username; 
    @Value("${password}") 
    private String password; 
 
    public String getUsername() { 
        return username; 
    } 
 
    public void setUsername(String username) { 
        this.username = username; 
    } 
 
    public String getPassword() { 
        return password; 
    } 
 
    public void setPassword(String password) { 
        this.password = password; 
    } 
}

6.啟動 Producer，并且手動調用接口，啟動 Producer 過后，我們在 Nacos 的服務注冊列表可以看如下所示的內容，在 test1 的命名空間下，已經有了我們創建的 Producer 服務。

7.通過手動調用 Producer 的接口 http://127.0.0.1:8080/producer/getUsername 顯示如下內容

并且我們看下此時 Nacos 的配置中心里面配置文件com.example.properties 里面的內容正是這個，這個時候我們手動把配置里面password 參數的值改成JavaGeek666，再次訪問接口，我們會發現接口的輸出也自動改變了。

修改配置內容如下：

再次訪問結果如下：

服務調用者 Consumer

前面我們已經完成了Producer 的服務注冊與配置動態生效的功能，這個時候基本已經可以使用了，不過我們還需要更進一步通過 Nacos 來實現服務發現，接下來我們創建 Consumer 的 SpringBoot 的項目，配置文件和pom.xml 文件基本一致，只要修改端口以及對應地方，下面貼一下不一樣的地方

1.boostrap.properties 內容如下，因為這里我們只調用Producer 的接口，不需要接入 Nacos 的配置中心，所以這里只配置發服務注冊與發現

spring.application.name=consumer 
 
######################服務注冊發現配置################################## 
spring.cloud.nacos.discovery.cluster-name=TEST1_GROUP 
spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848 
spring.cloud.nacos.discovery.namespace=caeser-adsys-naming

2.啟動類，配置上 feignClient 需要掃描的包路徑

package com.ziyou.nacos.demo.consumer; 
 
import org.springframework.boot.SpringApplication; 
import org.springframework.boot.autoconfigure.SpringBootApplication; 
import org.springframework.cache.annotation.EnableCaching; 
import org.springframework.cloud.openfeign.EnableFeignClients; 
 
/** 
 * <br> 
 * <b>Function：</b><br> 
 * <b>Author：</b>@author ziyou<br> 
 * <b>Date：</b>2021-04-11 17:07<br> 
 * <b>Desc：</b>無<br> 
 */ 
@SpringBootApplication(scanBasePackages = "com.ziyou.nacos") 
@EnableFeignClients(basePackages = {"com.ziyou.nacos.demo.consumer.rpc"}) 
@EnableCaching 
public class ConsumerApplication { 
    public static void main(String[] args) { 
        SpringApplication.run(ConsumerApplication.class, args); 
    } 
}

3.編寫調用 Producer 的接口，FeignClient 里面的 value 就是 Producer 的應用名稱

package com.ziyou.nacos.demo.consumer.rpc; 
 
import org.springframework.cloud.openfeign.FeignClient; 
import org.springframework.stereotype.Component; 
import org.springframework.web.bind.annotation.GetMapping; 
 
/** 
 * <br> 
 * <b>Function：</b><br> 
 * <b>Author：</b>@author ziyou<br> 
 * <b>Date：</b>2021-04-11 20:01<br> 
 * <b>Desc：</b>無<br> 
 */ 
@FeignClient(value = "producer") 
@Component 
public interface IProducerFeign { 
    /** 
     * 獲取生產者名稱接口 
     * 
     * @return 
     */ 
    @GetMapping("/producer/getUsername") 
    String getUsername(); 
 
}

package com.ziyou.nacos.demo.consumer.controller; 
 
import com.ziyou.nacos.demo.consumer.rpc.IProducerFeign; 
import org.springframework.beans.factory.annotation.Autowired; 
import org.springframework.web.bind.annotation.GetMapping; 
import org.springframework.web.bind.annotation.RequestMapping; 
import org.springframework.web.bind.annotation.RestController; 
 
/** 
 * <br> 
 * <b>Function：</b><br> 
 * <b>Author：</b>@author ziyou<br> 
 * <b>Date：</b>2021-04-11 19:59<br> 
 * <b>Desc：</b>無<br> 
 */ 
@RestController 
@RequestMapping(value = "consumer") 
public class TestNacosController { 
 
    private IProducerFeign iProducerFeign; 
 
    @GetMapping("/testNacos") 
    private String testNacos() { 
        return iProducerFeign.getUsername(); 
    } 
 
    @Autowired 
    public void setiProducerFeign(IProducerFeign iProducerFeign) { 
        this.iProducerFeign = iProducerFeign; 
    } 
}

4.啟動Consumer，我們可以看到在 Nacos 如下圖所示

5.調用 Consumer 的接口consumer/testNacos，結果如下圖所示，同樣的如果此時更改了 Nacos 配置文件中的內容，Consumer 這邊也是可以實時更新的，感興趣的小伙伴可以自己試試。

今天主要給大家介紹了一下如何通過 SpringBoot 項目來接入 Naocs 實現服務注冊與發現，以及配置管理和動態刷新，相關的代碼已經上傳到 GitHub 了。

責任編輯：武曉燕來源： Java極客技術

項目 Springboot Nacos