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/zh-hk/n/303299.html