spring boot 连接nacos集群 springboot 整合nacos

转载

mob6454cc7acbf7 2023-11-30 23:47:42

文章标签 java spring boot Nacos spring 配置参数 文章分类 spring boot 后端开发

前言

前面我们讲了如何在 Windows 环境下安装部署 Nacos，相信各位小伙伴都已经搭建好了自己的 Nacos。接下来，我们就一起来看看如何在 SpringBoot 项目中整合 Nacos 实现注册中心和配置中心。

🍎温馨提示：还没有安装 Nacos 的小伙伴可移步至大聪明教你学Java | Windows 环境下安装部署 Nacos

SpringBoot 整合 Nacos

引入 Maven 依赖

首先，我们还是要引入 Maven 依赖👇

<!--注册中心的依赖-->
<dependency>
    <groupId>com.alibaba.boot</groupId>
    <artifactId>nacos-discovery-spring-boot-starter</artifactId>
    <version>0.2.3</version>
</dependency>

<!-- 配置中心的依赖 -->
<dependency>
    <groupId>com.alibaba.boot</groupId>
    <artifactId>nacos-config-spring-boot-starter</artifactId>
    <version>0.2.3</version>
</dependency>

⭕这里有一点是需要注意的：注册中心和配置中心的依赖版本要根据 SpringBoot 版本来选择。版本 0.2.x.RELEASE 对应的是 Spring Boot 2.x 版本，版本 0.1.x.RELEASE 对应的是 Spring Boot 1.x 版本。 在这里我使用的 SpringBoot 版本是 2.2.4.RELEASE ，所以选择了 0.2.3 版本的注册中心和配置中心。

增加配置

接下来就是在 application.yml 中增加相关的配置👇

server:
  port: 80
  servlet:
    context-path: /
spring:
  application:
    name: NacosDemo
nacos:
  config:
    server-addr: 127.0.0.1:8848
  discovery:
    server-addr: 127.0.0.1:8848

示例代码

首先我们需要在项目启动类上增加两个 Nacos 的注解👇

import com.alibaba.nacos.spring.context.annotation.config.NacosPropertySource;
import com.alibaba.nacos.spring.context.annotation.discovery.EnableNacosDiscovery;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
@EnableNacosDiscovery //注册中心注解 使用nacos
@NacosPropertySource(dataId = "product_config",autoRefreshed = true) //配置中心注解：autoRefreshed 代表自动刷新注解
public class NacosdemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(NacosdemoApplication.class, args);
    }

}

接下来我们需要再增加一个 Nacos 的配置文件👇

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;

/**
 * @program: NacosDemo
 * @description: NacosConfig
 * @author: 庄霸.liziye
 * @create: 2022-04-29 16:39
 **/
@Configuration
public class NacosConfig {
    @Value("${server.port}")
    private int serverPort;
    @Value("${spring.application.name}")
    private String applicationName;
    @NacosInjected
    private NamingService namingService;
    @PostConstruct
    public void registerInstance() throws NacosException {
        namingService.registerInstance(applicationName, "127.0.0.1", serverPort);
    }
}

最后我们写一个模拟获取配置参数的 Controller 类👇

import com.alibaba.nacos.api.config.annotation.NacosValue;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * ConfigController 配置控制器
 * @description: ConfigController
 * @author: 庄霸.liziye
 * @create: 2022-04-29 15:29
 **/
@RestController
@RequestMapping("/test")
public class ConfigController {

    @NacosValue(value = "${productName}",autoRefreshed = true)
    private  String productName;

    @RequestMapping("/productName")
    public String getProductName(){

        return productName;
    }
}

到这里代码已经准备完毕了，既然我们有一个获取配置参数的 Controller，那么我们肯定也少不了要定义一个待获取的配置参数。我们启动 Nacos ，登录它的后台页面，在左侧的配置管理中找到配置列表，在配置列表下创建一个新的配置。

spring boot 连接nacos集群 springboot 整合nacos_spring

spring boot 连接nacos集群 springboot 整合nacos_spring_02

❗❗❗这里一定要注意❗❗❗：在 Nacos 管理页面新增参数时，所填写的 Data ID 值必须要和启动类上 @NacosPropertySource 注解中的 dataId 值是一致的；而且在定义配置内容的时候，配置的名字必须要和 Controller 中定义的名字保持一致。二者中无论哪一个名字不匹配，在启动项目时都会报找不到配置的错误。

到这里，代码和配置都已经准备完毕了，我们启动一下项目看看具体效果… 项目启动后，我们在 Nacos 管理页面左侧找到服务管理下的服务列表，打开服务列表就可以看到我们的项目成功的注册进了 Nacos。

spring boot 连接nacos集群 springboot 整合nacos_java_03