nacos对应springboot版本指南

一、springboot集成nacos

在使用nacos之前，需要将nacos的依赖添加到springboot项目中的pom.xml文件中。


<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
    <version>2.2.1.RELEASE</version>
</dependency>

除此之外，还需要在代码中添加一些注解，让springboot知道要使用nacos。例如：


@SpringBootApplication
@EnableDiscoveryClient
public class DemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}

其中，@EnableDiscoveryClient注解是让springboot知道需要启动nacos的服务注册和发现功能。

二、springboot nacos配置中心

在使用nacos的配置中心功能之前，需要将nacos的配置添加到springboot项目的bootstrap.yml文件中。下面是一个例子：


spring:
  cloud:
    nacos:
      config:
        server-addr: localhost:8848
        namespace: b575fe23-748c-44c2-8ef1-cd8f8e90431b

其中，server-addr是nacos服务部署的地址和端口，namespace是nacos命名空间。命名空间的作用是区分配置信息，可以通过多个命名空间管理多个项目的配置。

接下来，在代码中可以通过@Value(“${配置项名称}”)注解来获取nacos中的配置信息。例如：


@RestController
public class ConfigController {
 
    @Value("${user.name}")
    private String name;
 
    @GetMapping("/config")
    public String getConfig() {
        return "Hello, " + name + "!";
    }
}

其中，${user.name}是在nacos中配置的一个配置项的名称。通过@Value注解，可以将配置项的值注入到代码中。

三、springboot接入nacos

除了配置中心和服务注册发现，nacos还提供了其他功能，例如作为消息总线、动态路由和服务保护等功能。使用这些功能需要将对应的依赖添加到pom.xml文件中，例如：


<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
    <version>2.2.1.RELEASE</version>
</dependency>

<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
    <version>2.2.1.RELEASE</version>
</dependency>

<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-ribbon</artifactId>
    <version>2.2.1.RELEASE</version>
</dependency>

然后，在代码中使用对应的注解来接入nacos的其他功能。例如，使用@SentinelResource注解和Sentinel实现服务保护：


@RestController
public class TestController {
 
    @GetMapping("/hello")
    @SentinelResource(value = "hello", blockHandler = "handleHello")
    public String hello() {
        return "Hello, world!";
    }
 
    public String handleHello(BlockException ex) {
        return "限流了！";
    }
}

在这个例子中，@SentinelResource注解实现了服务保护。如果访问/hello接口的流量超过了预设的阈值，就会触发Sentinel的限流策略。

四、nacos版本与springboot兼容

nacos与springboot的版本要求可以在nacos的官方文档中查看。例如，nacos 1.4.1版本与springboot 2.4.x版本兼容。如果不满足版本兼容性，可能会出现一些不兼容的问题。

五、springboot配置nacos集群

如果需要将nacos部署在集群环境中，需要在配置文件中添加以下内容：


spring:
  cloud:
    nacos:
      discovery:
        server-addr: ${nacos.server-addr:localhost:8848}

其中，${nacos.server-addr}指定了nacos集群节点的地址和端口。如果有多个节点，可以使用逗号分隔。例如：


spring:
  cloud:
    nacos:
      discovery:
        server-addr: 192.168.0.1:8848,192.168.0.2:8848,192.168.0.3:8848

六、springboot读取nacos配置

除了使用@Value注解注入nacos配置信息，还可以使用nacos提供的配置API读取配置信息。例如：


@Autowired
private ConfigService configService;

public String getNacosConfig(String dataId, String group) throws NacosException {
    return configService.getConfig(dataId, group, 5000);
}

其中，ConfigService是nacos提供的配置API，可以使用@Autowired注入。getNacosConfig方法就是通过ConfigService读取配置信息。

七、springboot nacos注册中心

在使用nacos的服务注册和发现功能时，需要在代码中添加一些注解来指定服务注册信息。例如：


@RestController
@RequestMapping("/provider")
public class HelloController {

    @GetMapping("/hello")
    @SentinelResource(value = "hello", blockHandler = "handleHello")
    public String hello() {
        return "Hello, world!";
    }
}

@Service
public class HelloServiceImpl implements HelloService {

    @Override
    public String sayHello() {
        return "Hello, world!";
    }
}

@Component
public class ServiceProvider {
 
    @Autowired
    private DiscoveryClient discoveryClient;
 
    @Autowired
    private HelloService helloService;
 
    @PostConstruct
    public void register() throws Exception {
        ServiceInstance serviceInstance = discoveryClient.getLocalServiceInstance();
        String serviceName = serviceInstance.getServiceId();
        String serviceId = serviceInstance.getInstanceId();
        int port = serviceInstance.getPort();
 
        if(discoveryClient.getInstances(serviceName).isEmpty()) {
            RegisterInstanceRequest request = new RegisterInstanceRequest();
            request.setServiceName(serviceName);
            request.setInstanceId(serviceId);
            request.setIp(serviceInstance.getHost());
            request.setPort(port);
            request.setMetadata(new HashMap());
            Instance instance = new Instance();
            instance.setServiceName(serviceName);
            instance.setInstanceId(serviceId);
            instance.setIp(serviceInstance.getHost());
            instance.setPort(port);
            instance.setMetadata(new HashMap());
            instance.setHealthy(true);
            request.setInstance(instance);
            discoveryClient.registerInstance(serviceName, serviceId, serviceInstance.getHost(), port, new HashMap());
        }
    }
}

其中，@Service注解用于声明一个服务，@Component用于声明一个组件。

八、springboot集成nacos配置中心

springboot的官方文档中提供了一个示例，展示了如何将springboot集成nacos配置中心。下面是一个简化版：


/**
 * 读取nacos配置的DataSource
 */
@ConfigurationProperties(prefix = "spring.datasource")
public class DataSourceProperties {

    private String driverClassName;
    private String url;
    private String username;
    private String password;
    
    // ...
}

/**
 * 配置nacos的数据源
 */
@Configuration
public class NacosConfiguration {

    @Bean
    public DataSource dataSource() throws SQLException {
        Properties properties = new Properties();
        properties.setProperty("driverClassName", dataSourceProperties.getDriverClassName());
        properties.setProperty("url", dataSourceProperties.getUrl());
        properties.setProperty("username", dataSourceProperties.getUsername());
        properties.setProperty("password", dataSourceProperties.getPassword());
        return DruidDataSourceFactory.createDataSource(properties);
    }
}

/**
 * 读取nacos配置的DataSource
 */
@SpringBootApplication
@RefreshScope
@RestController
public class DemoApplication {

    @Autowired
    private DataSourceProperties properties;

    @RequestMapping("/test")
    public String test() {
        return "DataSource URL: " + properties.getUrl();
    }
}

/**
 * nacos配置中心的配置
 */
spring.cloud.nacos.config.server-addr=127.0.0.1:8848
spring.cloud.nacos.config.namespace=ae314565-bf0f-4f77-9cd4-8313f4d42e9c
spring.cloud.nacos.config.prefix=database
spring.cloud.nacos.config.file-extension=properties
spring.cloud.nacos.config.group=test-group

以上代码演示了如何将nacos配置中心中的参数注入到springboot项目中。

原创文章，作者：小蓝，如若转载，请注明出处：https://www.506064.com/n/303299.html