【Spring Cloud Alibaba】1.3 Nacos与Spring Cloud整合入门示例

于 2023-12-01 11:13:48 发布
阅读量564 收藏
点赞数
分类专栏： # Spring Cloud 知识集锦 文章标签： spring cloud spring 后端 nacos
文章来源：作者冰点(icepip.blog.csdn.com)
本文链接：https://blog.csdn.net/wangshuai6707/article/details/134709095
版权

文章目录

0. 引言

随着微服务架构的广泛应用，服务的注册与发现变得尤为重要。Spring Cloud为微服务应用提供了一套完整的构建工具，而Nacos则是阿里巴巴开源的一个更易于构建云原生应用的动态服务发现、配置管理和服务管理平台。

Nacos提供了一站式的服务注册与发现解决方案，它的出现让微服务的管理变得更加方便和快捷。而Spring Cloud作为当前微服务框架中的佼佼者，能够与Nacos完美整合，为开发者提供了强大的功能支持。

在这篇博文中，将深入探讨如何将Nacos与Spring Cloud进行整合，通过实际的代码示例。

本文主要内容包括Nacos与Spring Cloud的基本介绍，Nacos服务注册与发现的实现，Spring Cloud与Nacos的整合操作，以及 与open feign集成 ，负载均衡引入 ribbon。后续我们把ribbon 替换为LoadBalance。

1. Nacos在服务发现与配置管理的应用

Nacos（Naming and Configuration Service）是阿里巴巴开源的一款动态服务发现、配置和服务管理平台，具有以下几点在服务发现与配置管理的应用：

  1. 服务发现和服务健康检查: Nacos支持基于DNS和RPC的服务发现。客户端只需要使用简单的DNS查询或HTTP / gRPC请求，就可以发现、路由和负载均衡到其他服务。Nacos还提供服务健康检查功能，可以在服务实例出现故障时自动下线服务。

  2. 动态配置服务: Nacos提供了一个中央化和外部化的动态配置服务。应用程序或服务无需在启动时完成所有配置，可以在运行时从Nacos获取和更新配置。这使得应用程序或服务更具弹性。

  3. 服务元数据和流量管理: Nacos允许你通过元数据将服务分类、管理和发现。你可以通过权重路由、覆盖路由、流量切分等方式进行精细化的流量管理。

  4. 易于集成: Nacos提供了丰富的API和SDK，可以轻松地与其他系统集成，如Kubernetes、Spring Cloud、Dubbo等。

在这里插入图片描述

1. 添加依赖

注意：版本 2.1.x.RELEASE 对应的是 Spring Boot 2.1.x 版本。版本 2.0.x.RELEASE 对应的是 Spring Boot 2.0.x 版本，版本 1.5.x.RELEASE 对应的是 Spring Boot 1.5.x 版本。

<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<groupId>com.icepip.project</groupId>
	<artifactId>springcloud-service-demo1</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<name>springcloud-alibaba-nacos-demo1</name>
	<description>springcloud-alibaba-nacos-demo1</description>
	<properties>
		<java.version>8</java.version>
		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
		<spring-cloud.version>2021.0.7</spring-cloud.version>
		<spring-boot.version>2.7.12</spring-boot.version>
	</properties>
	<dependencies>
		<dependency>
			<groupId>com.alibaba.cloud</groupId>
			<artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
		</dependency>
		<dependency>
			<groupId>com.alibaba.cloud</groupId>
			<artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>

		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-actuator</artifactId>
		</dependency>

	</dependencies>
	<dependencyManagement>
	<dependencies>
		<dependency>
			<groupId>com.alibaba.cloud</groupId>
			<artifactId>spring-cloud-alibaba-dependencies</artifactId>
			<version>2021.0.5.0</version>
			<type>pom</type>
			<scope>import</scope>
		</dependency>
	<dependency>
		<groupId>org.springframework.cloud</groupId>
		<artifactId>spring-cloud-dependencies</artifactId>
		<version>${spring-cloud.version}</version>
		<type>pom</type>
		<scope>import</scope>
	</dependency>
	<dependency>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-dependencies</artifactId>
		<version>${spring-boot.version}</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>

配置中心需要的依赖

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

服务发现需要的依赖

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

2. application.properties

server.port=10003
spring.application.name=springcloud-alibaba-nacos-demo3
logging.level.com.alibaba.cloud.nacos.configdata=debug
tms.deploy.nacos-server=172.20.3.126:8848
deploy.env=dev
deploy.nacos-user=nacos
deploy.nacos-password=nacos
##############nacos 配置中心-开始##############
spring.cloud.nacos.config.server-addr=${tms.deploy.nacos-server}
# data id 默认的后缀为properties 可以不配置
spring.config.import=nacos:app_${spring.application.name}
spring.cloud.nacos.config.namespace=${deploy.env}
spring.cloud.nacos.config.username=${deploy.nacos-user}
spring.cloud.nacos.config.password=${deploy.nacos-password}
spring.cloud.nacos.config.timeout=3000
spring.cloud.nacos.config.config-retry-time=3000
spring.cloud.nacos.config.file-extension=properties
spring.cloud.nacos.config.enabled=true
spring.cloud.nacos.config.config-long-poll-timeout=30000
spring.cloud.nacos.config.enable-remote-sync-config=true
spring.cloud.nacos.config.import-check.enabled=true
spring.cloud.nacos.config.group=DEFAULT_GROUP
spring.cloud.nacos.config.refresh-behavior=all_beans
spring.cloud.nacos.config.refresh-enabled=true
spring.cloud.nacos.config.max-retry=3
spring.cloud.nacos.config.encode=utf-8
##############nacos 配置中心-结束##############

##############nacos 注册中心##############
spring.cloud.nacos.discovery.server-addr=${tms.deploy.nacos-server}
spring.cloud.nacos.discovery.service=${spring.application.name}
spring.cloud.nacos.discovery.namespace=${tms.deploy.env}
spring.cloud.nacos.discovery.username=${tms.deploy.nacos-user}
spring.cloud.nacos.discovery.password=${tms.deploy.nacos-password}
spring.cloud.nacos.discovery.cluster-name=DEFAULT
spring.cloud.nacos.discovery.register-enabled=true
spring.cloud.nacos.discovery.enabled=true
spring.cloud.nacos.discovery.group=DEFAULT_GROUP
spring.cloud.nacos.discovery.heartbeat-interval=5000
spring.cloud.nacos.discovery.heartbeat-timeout=15000
spring.cloud.nacos.discovery.fail-fast=true
spring.cloud.nacos.discovery.log-name=${spring.application.name}
spring.cloud.nacos.discovery.naming-load-cache-at-start=true
spring.cloud.nacos.discovery.weight=1
spring.cloud.nacos.discovery.secure=false
spring.cloud.nacos.discovery.watch.enabled=false
spring.cloud.nacos.discovery.watch-delay=3000
spring.cloud.nacos.discovery.ephemeral=true
spring.cloud.nacos.discovery.heart-beat-interval=
# 启动时是否加载服务实例信息（默认为 false）
spring.cloud.nacos.discovery.namingLoadCacheAtStart=false
spring.cloud.nacos.discovery.instance-enabled=true

在 Nacos Spring Cloud 中，dataId 的完整格式如下,可以不用管使用默认即可。

${prefix}-${spring.profiles.active}.${file-extension}
  1. prefix 默认为 spring.application.name 的值，也可以通过配置项 spring.cloud.nacos.config.prefix来配置。
  2. spring.profiles.active 即为当前环境对应的 profile，详情可以参考 Spring Boot文档。 注意：当 spring.profiles.active 为空时，对应的连接符 - 也将不存在，dataId 的拼接格式变成 p r e f i x . {prefix}. prefix.{file-extension}
  3. file-exetension 为配置内容的数据格式，可以通过配置项 spring.cloud.nacos.config.file-extension 来配置。目前只支持 properties 和 yaml 类型。

3. 启动类

package com.icepip.project;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;

@SpringBootApplication
@EnableDiscoveryClient
public class Demo1Application {

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

}

2. 完整示例

本节通过实现一个简单的 echo service 演示如何在您的 Spring Cloud 项目中启用 Nacos 的服务发现功能，如下图示:.基于官方示例进行完善。

echo service
在这里插入图片描述

1. 工程结构

在这里插入图片描述

2. 父工程 nacos-spring-cloud-discovery-example

  <modules>
        <module>nacos-spring-cloud-provider-example</module>
        <module>nacos-spring-cloud-consumer-example</module>
    </modules>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
                <version>0.2.2.RELEASE</version>
            </dependency>
            <dependency>
                <groupId>com.alibaba.nacos</groupId>
                <artifactId>nacos-client</artifactId>
                <version>1.1.0</version>
            </dependency>
        </dependencies>
    </dependencyManagement>

3. 服务提供者 nacos-spring-cloud-provider-example

pom
<?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">
    <parent>
        <artifactId>nacos-spring-cloud-discovery-example</artifactId>
        <groupId>com.alibaba.nacos</groupId>
        <version>0.2.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>nacos-spring-cloud-provider-example</artifactId>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
            <exclusions>
                <exclusion>
                    <groupId>com.alibaba.nacos</groupId>
                    <artifactId>nacos-client</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>
            <groupId>com.alibaba.nacos</groupId>
            <artifactId>nacos-client</artifactId>
        </dependency>
        <dependency>
            <groupId>org.hibernate</groupId>
            <artifactId>hibernate-validator</artifactId>
            <version>5.1.0.Final</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <executions>
                    <execution>
                        <goals>
                            <goal>repackage</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
            <plugin>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>
EchoController
package com.alibaba.nacos.example.spring.cloud;

import com.alibaba.nacos.example.spring.cloud.model.User;
import org.springframework.web.bind.annotation.*;

/**
 * @Author 冰点
 * @Version v1.0.0
 * @Date 2023/11/30 15:17
 */
@RestController
public class EchoController {
    @RequestMapping(value = "/echo/{string}", method = RequestMethod.GET)
    public String echo(@PathVariable String string) {
        return "Hello Nacos Discovery " + string;
    }

    @RequestMapping(value = "/save", method = RequestMethod.POST)
    public User save(@RequestBody User user) {
        user.setName("Nacos-" + user.getName());
        return user;
    }
}
User
package com.alibaba.nacos.example.spring.cloud.model;



public class User {

    private Integer id;

    private String name;

    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
}
NacosProviderApplication
package com.alibaba.nacos.example.spring.cloud;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author xiaojing
 */
@SpringBootApplication
@EnableDiscoveryClient
public class NacosProviderApplication {

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

}
application.properties
server.port=8070
spring.application.name=service-provider
spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848

4. 服务消费者 nacos-spring-cloud-consumer-example

pom
<?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">
    <parent>
        <artifactId>nacos-spring-cloud-discovery-example</artifactId>
        <groupId>com.alibaba.nacos</groupId>
        <version>0.2.0-SNAPSHOT</version>
    </parent>

    <modelVersion>4.0.0</modelVersion>

    <artifactId>nacos-spring-cloud-consumer-example</artifactId>

    <properties>
        <spring-cloud-openfeign.version>2.0.0.RELEASE</spring-cloud-openfeign.version>
        <spring-cloud-netflix.version>2.0.0.RELEASE</spring-cloud-netflix.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-ribbon</artifactId>
            <version>${spring-cloud-netflix.version}</version>
        </dependency>

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
            <version>${spring-cloud-openfeign.version}</version>
        </dependency>

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
            <exclusions>
                <exclusion>
                    <groupId>com.alibaba.nacos</groupId>
                    <artifactId>nacos-client</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>
            <groupId>com.alibaba.nacos</groupId>
            <artifactId>nacos-client</artifactId>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <executions>
                    <execution>
                        <goals>
                            <goal>repackage</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
            <plugin>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>
ConsumerController
@RestController
public class ConsumerController {

    @Autowired
    private ServiceProviderFeignClient serviceProviderFeignClient;

    @GetMapping("/call")
    public String call() {
        return serviceProviderFeignClient.hello("didi");
    }

    @GetMapping("/save")
    public String save() {
        return serviceProviderFeignClient.save(new User("zhangsan", 18));
    }
}
ServiceProviderFeignClient

feign客户端

package com.alibaba.nacos.example.spring.cloud;

import com.alibaba.nacos.example.spring.cloud.model.User;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.stereotype.Service;
import org.springframework.web.bind.annotation.*;

/**
 * @Author 冰点
 * @Version v1.0.0
 * @Date 2023/11/30 14:34
 */
@FeignClient("service-provider")
@Service
public interface ServiceProviderFeignClient {

    @GetMapping("/echo/{id}")
    String hello(@PathVariable("id") String id);

    @RequestMapping(value = "/save", method = RequestMethod.POST)
    public String save(@RequestBody User user);
}


package com.alibaba.nacos.example.spring.cloud.model;



public class User {

    private Integer id;

    private String name;
    public User() {
    }
    public User(String name, int id) {
        this.id=id;
        this.name=name;
    }

    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
}
NacosConsumerApplication
package com.alibaba.nacos.example.spring.cloud;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.cloud.client.loadbalancer.LoadBalanced;
import org.springframework.cloud.openfeign.EnableFeignClients;
import org.springframework.context.annotation.Bean;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestTemplate;

/**
 * @author xiaojing
 */
@SpringBootApplication
@EnableDiscoveryClient
@EnableFeignClients
public class NacosConsumerApplication {

    @LoadBalanced
    @Bean
    public RestTemplate restTemplate() {
        return new RestTemplate();
    }

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

    @RestController
    public class TestController {

        private final RestTemplate restTemplate;

        @Autowired
        public TestController(RestTemplate restTemplate) {this.restTemplate = restTemplate;}

        @RequestMapping(value = "/echo/{str}", method = RequestMethod.GET)
        public String echo(@PathVariable String str) {
            return restTemplate.getForObject("http://service-provider/echo/" + str, String.class);
        }
    }
}


server.port=8080
spring.application.name=service-consumer
spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

冰点.

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值