SpringBoot应用集成微服务组件Nacos

前情提要

版本不在于有多新，在于与当前场景环境匹配正常，稳中求快。万一你用了比较新的版本，遇到问题怎么办？有问题，那就找李元芳吧！开个玩笑。你可以去 nacos 的github仓库issues提问、追问选择解决方案，促进开源社区的和谐发展。

本篇是个人nacos系列文章第二篇springboot项目集成微服务组件nacos。

整体思路，个人nacos系列博文一共分为三篇：

基础篇：《MySQL数据库与Nacos搭建监控服务》，Nacos与MySQL基本介绍。
• 开发篇：《开发篇：springboot与微服务组件nacos》，从代码开始构建，集成微服务组件。
• 运维篇：《运维篇：nacos prometheus grafana》，服务监控篇，主要以Linux发行版为主。

骚话环节

那天我听说程序员之间还相互鄙视，其中不能忍的终极鄙视：有女朋友的程序员鄙视没有女朋友的程序员。这不能忍，打不过怎么办，问就是加入吧。

使用稳定版本。此次在Linux发行版操作系统中全程使用root用户进行测试避免权限问题带来的干扰，如果使用普通用户请自行测试提权赋予所有者或者所属组权限。

直接进入今天的主题springboot项目集成微服务组件nacos。

springboot与微服务组件nacos

必备环境，前置条件尽量保持一致：

JDK版本： JDK17
• 开发工具和项目构建工具：STS4 & Maven3.6
• Springboot版本：Springboot2.7.x
• 服务监控三件套：Nacos2.x、Prometheus2.3.x、Grafana9.3.x
• 开发测试环境：Linux（centos-stream-9）云服务器或者VMware搭建环境

tips：做实验时请检查是否关安装防火墙管理工具，关闭防火墙服务或者开启相应端口，或者放通云服务器安全组。

企业中生产环境，唯稳，稳中求快。

Nacos服务快速启动

https://blog.cnwangk.top/2023/03/30/MySQL数据库与Nacos搭建监控服务/

根据个人或者团队开发环境，可以选择框架开发环境：spring、springboot以及springcloud集成nacos。

值得注意的地方

Nacos原生形式部署。
1. Nacos Docker形式部署。
2. Nacos Kubernetes形式部署。

至于用哪种方式，根据实际业务场景分析，选择符合个人或者公司业务场景的最佳方式。

单机模式：用于测试和单机试用。
• 集群模式：用于生产环境，确保高可用。
• 多集群模式：用于多数据中心场景。

高可用环境准备

建议支撑环境：部署JDK，需要 1.8 及其以上版本
• 建议硬件配置：2核 CPU / 4G 内存 及其以上
• 建议软件配置：生产环境 3 个节点 及其以上

1、预备环境准备

推荐选用 Linux/Unix/Mac。

• Maven 3.2.x+ 。

你可以通过源码和发行包两种方式来获取 Nacos。

个人推荐：下载发行包。关于版本，使用稳定版本（通常有GA标识），个人习惯使用官方推荐的上一个小版本。有特殊需求可以下载源码包，修改源码重新编译。

git clone命令，值得注意的是你需要部署Git环境：

git clone https://github.com/alibaba/nacos.git
cd nacos/
mvn -Prelease-nacos -Dmaven.test.skip=true clean install -U  
ls -al distribution/target/
// change the $version to your actual path
cd distribution/target/nacos-server-$version/nacos/bin

​

nacos发行包下载地址：

• https://github.com/alibaba/nacos/releases/tag/2.1.1

unzip nacos-server-$version.zip 或者 tar -zxvf nacos-server-$version.tar.gz
cd nacos/bin

$version指具体nacos版本号，比如具体版本：nacos-server-2.1.1。

• Linux平台建议下载以 .tar.gz 结尾的压缩包：nacos-server-2.1.1.tar.gz。

3、修改配置文件

注意：修改conf目录下的application.properties文件。设置其中的nacos.core.auth.plugin.nacos.token.secret.key值，详情可查看鉴权-自定义密钥：

注意，文档中的默认值SecretKey012345678901234567890123456789012345678901234567890123456789和VGhpc0lzTXlDdXN0b21TZWNyZXRLZXkwMTIzNDU2Nzg=为公开默认值，可用于临时测试，实际使用时请务必更换为自定义的其他有效值。

4、启动服务器

Linux/Unix/Mac：执行startup.sh脚本
启动命令（standalone代表着单机模式运行，非集群模式）：

sh startup.sh -m standalone

如果您使用的是ubuntu系统，或者运行脚本报错提示[[符号找不到，可尝试如下运行：

bash startup.sh -m standalone

Windows平台：执行startup.cmd脚本
启动命令（standalone代表着单机模式运行，非集群模式）：

startup.cmd -m standalone

5、关闭服务器

Linux/Unix/Mac：执行shutdown.sh脚本

sh shutdown.sh

Windows平台：执行shutdown.cmd脚本

shutdown.cmd

可以在Windows中使用terminal或者cmd命令行运行shutdown.cmd命令，也可以双击shutdown.cmd运行文件。

以下为个人实战总结，仅供参考

个人开发以及测试环境：

Spring Tool Suite4
• JDK17
• Maven3.6
• Springboot2.7.6
• VMware16 & Linux（Centos-9-Stream）

关于IDE的选择：

可能是入坑最开始接触的 IDE 是eclipse，习惯了。个人小项目偶尔会用VSCode，大型项目更趋向于 eclipse 或者 IntelliJ IDEA。

STS4 开发工具

Linux X86_64、Linux ARM_64
• MACOS X86_64、MACOS ARM_64
• WINDOWS X86_64

官网：https://spring.io/tools

Maven 环境配置

STS4开发工具引入Maven配置

配置完记得点击Apply或者Apply and Close

Maven Repo配置阿里云镜像源

maven版本：apache-maven-3.6.3

配置本地repo仓库存储目录

<localRepository>D:\Maven\repo</localRepository>	

配置mirrors

  <mirrors>
    <mirror>
          <id>aliyunmaven</id>
          <name>aliyun maven</name>
          <!-- 老版本url -->
          <url>http://maven.aliyun.com/nexus/content/groups/public/</url>
          <!-- 新版本url -->
          <!--<url>https://maven.aliyun.com/repository/public/</url>-->
          <mirrorOf>central</mirrorOf>        
    </mirror>
  </mirrors>

阿里云Maven中央仓库为 阿里云云效 提供的公共代理仓库，帮助研发人员提高研发生产效率，使用阿里云Maven中央仓库作为下载源，速度更快更稳定。

在线搜索jar包依赖：https://developer.aliyun.com/mvn/search

Springboot集成nacos服务

关于版本问题，我将官方部分（个人感觉初次使用可能用得上，并非全部）文档引入到本次教程。

tips：sts个性化注解设置，Window---> Preferences--->Java--->Code Style--->Code Templates--->Comments：Types method

springboot项目构建

可能你有疑问，springboot版本如何选择，下图支持最后维护时间可供参考：

项目构建方式有多种，总体上分官网脚手架构建和开发工具构建，此处以官网和STS4为示例。不必纠结，怎么顺手怎么来。

官网构建：https://start.spring.io/
• STS4开发工具构建
• VSCode 开发工具构建
• IntelliJ IDEA工具构建

如果官网访问速度缓慢，你还可以通过阿里云脚手架网站构建：https://start.aliyun.com/

springboot项目之官网构建

第一步

Project：选择Maven作为项目构建方式
1. Language：选择Java作为开发语言
2. Spring Boot：选择springboot2.7.6稳定版本作为构建版本
3. Dependencies：选择pom依赖的jar包

第二步

Project Metadata：项目元数据，Group组名、Artifact工程名、Name项目名称、Description项目描述、Package name包名。
1. Packaging：选择Jar作为默认打包方式。
2. Java：选择JDK17作为Java项目默认构建版本。
3. GENERATE：生成构建项目demo并下载。
4. EXPLORE：展示出构建项目结构清单以及文件具体内容。

springboot项目之STS4工具构建

配置Project步骤一

配置Project步骤二

如下图所示，Spring Boot Version个人选择的是springboot2.7.6稳定版本作为演示，目前最新稳定版本可选为springboot3.0.5。Frequently Used表示官方建议使用到的一些工具，讲几个个人使用过的。

MariaDB Driver是MariaDB数据库驱动，可以看做是MySQL替代产品。Spring Data JPA是对ORM持久化框架Hibernate近一步封装，简化了SQL操作。Spring Data MongoDB是nosql数据库中的一种，其它有Redis，主要用于做缓存使用。Spring Data Redis是nosql数据库中的一种，前面刚好介绍到了。

搜索框Type to search dependencies，可以进行检索需要的依赖，也可以展开下面小箭头选择依赖。比如展开下图上的SQL选项，有多种数据库驱动依赖可供选择使用。

springboot集成微服务nacos

**下面将演示 springboot 项目集成微服务组件 nacos 过程 **。

1、启动示例

示例：application.properties

server.port=8081
server.address=192.168.1.111

示例：application.yml

server:
  port: 8081
  address: 192.168.1.111

springboot启动过程：

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(__ __  __ _ \ \ \ \
( ( \___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___| |_| | | | | || (_| |     
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::                (v2.7.6

2022-10-26 20:13:06.902  INFO 16620 --- [           main] com.test.demo.Application                : Starting Application using Java 17.0.2 on kart with PID 16620 (...
2022-10-26 20:13:08.091  INFO 16620 --- [           main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat initialized with port(s: 8080 (http
...
2022-10-26 20:13:10.260  INFO 16620 --- [           main] c.a.c.n.registry.NacosServiceRegistry    : nacos registry, DEFAULT_GROUP springboot-test 192.168.245.1:8080 register finished
2022-10-26 20:13:10.579  INFO 16620 --- [           main] com.test.demo.Application                : Started Application in 4.45 seconds (JVM running for 5.251

2、配置pom.xml

springbot版本简要说明：springboot GA(General Availability 表示稳定版本，各分支最新稳定版本2.3.12、2.4.13、2.5.14、2.6.14、2.7.10、3.0.5

	<!-- springboot GA(最新稳定版本:2.3.12、2.4.13、2.5.14、2.6.14、2.7.10、3.0.5 -->
	<!-- springboot pom.xml parent父类 -->
	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>2.7.6</version>
		<relativePath/> 
	</parent>

统一版本管理：JDK版本：17，spring-cloud-dependencies版本采用2021.0.4，spring-cloud-alibaba-dependencies版本采用：2021.0.4.0，和我保持一致，可以采用springboot2.7.x进行测试使用。目前，如果使用阿里云脚手架构建，springboot版本推荐不高于2.6.13。在nacos系列博文第一篇《MySQL数据库与Nacos搭建监控服务》中有写到如何构建，这里不在赘述。

	<properties>
		<java.version>17</java.version>
        <spring-cloud-dependencies.version>2021.0.4</spring-cloud-dependencies.version>
		<spring-cloud-alibaba-dependencies.version>2021.0.4.0</spring-cloud-alibaba-dependencies.version>
	</properties>	

pom依赖管理：dependency

微服务：spring cloud依赖
• 微服务：spring cloud alibaba依赖
• 微服务：nacos config依赖、nacos discovery依赖、bootstrap依赖

<!-- 总包管理 -->
	<dependencyManagement>
		<dependencies>
			<!-- spring cloud依赖 -->
			<dependency>
			    <groupId>org.springframework.cloud</groupId>
			    <artifactId>spring-cloud-dependencies</artifactId>
			    <version>${spring-cloud-dependencies.version}</version>
			    <type>pom</type>
			    <scope>import</scope>
			</dependency>
			<!-- spring cloud alibaba依赖 -->
			<dependency>
			    <groupId>com.alibaba.cloud</groupId>
			    <artifactId>spring-cloud-alibaba-dependencies</artifactId>
			    <version>${spring-cloud-alibaba-dependencies.version}</version>
			    <type>pom</type>
			    <scope>import</scope>
			</dependency>
		</dependencies>
	</dependencyManagement>	
<!-- 引入相关依赖 -->	
	<dependencies>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
			<scope>test</scope>
		</dependency>
		<!-- 微服务 nacos config依赖 -->
		<dependency>
   			<groupId>com.alibaba.cloud</groupId>
    		<artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
		</dependency>
		<!-- 微服务 nacos discovery依赖 -->
		<dependency>
			<groupId>com.alibaba.cloud</groupId>
    		<artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
		</dependency>
		<!-- 微服务 bootstrap依赖  -->
		<dependency>
		    <groupId>org.springframework.cloud</groupId>
		    <artifactId>spring-cloud-starter-bootstrap</artifactId>
		</dependency>
	</dependencies>	

3、配置application.properties & application.yml & bootstrap.properties

# api port
server.port=8080
# 开发环境多配置文件设置：dev、prod、test
spring.profiles.active=dev
# 服务名称
spring.application.name=springboot-test
###################################nacos配置#######################################
# nacos 打开监控 配合普罗米修斯进行监控 官方提供了MySQL初始化sql文件 在conf目录下：nacos-mysql.sql
# 暴露metrics数据
management.endpoints.web.exposure.include=*
# nacos 配置注册远程服务地址{config.server-addr和server-addr}
#spring.cloud.nacos.config.server-addr=192.168.245.132:8848
# nacos 配置注册与发现{discovery.server-addr}
spring.cloud.nacos.discovery.server-addr=192.168.245.132:8848
#spring.cloud.nacos.discovery.namespace=public
spring.cloud.nacos.config.file-extension=properties
###################################nacos配置#######################################

bootstrap.properties

#bootstrap.properties基础配置
#服务名称
spring.application.name=springboot-test
#暴露config配置服务地址(动态更新
spring.cloud.nacos.config.server-addr=192.168.245.132:8848
#配置config文件扩展名(properties & yml
spring.cloud.nacos.config.file-extension=properties

4、springboot入口：配置Application.java

@SpringBootApplication：sringboot启动必备注解
• @EnableDiscoveryClient：用于nacos发现客户端注解

@SpringBootApplication	//sringboot启动必备注解
@EnableDiscoveryClient  //用于nacos发现客户端注解
public class Application {
	public static void main(String[] args {
		SpringApplication.run(Application.class, args;
	}
}

TestController类引入测试代码：使用 Spring Cloud 原生注解，开启自动更新。

多属性配置场景，可以通过@Autowired 注解注入自定义配置类。

@RestController
@RefreshScope // Spring Cloud 原生注解 开启自动更新
@RequestMapping(value = "/t"
public class TestController {
	/** 使用动态配置获取测试 --BEGIN-- **/
	@Value("${alibaba.config.discovery}"
	private String discovery;
	
    @Value("${alibaba.config.name}"
	private String name;

	@GetMapping("/getConfig"
	public String getConfig( {
		log.info("getConfig>>>>>>>>>>>";
		return "getConfig>>>>>>>>>>>>" + "发现：" + discovery + ">>>服务名称：" + name;
	}
	
	@Value("${custom.config.find}"
	private String find;
	
	@Value("${custom.config.say}"
	private String say;
	
	@GetMapping("/meet"
	public String meet( {
		log.info("meet>>>>>>>>>>>";
		return "meet>>>>>>>>>>>>" + "偶遇老湿：" + find + ">>>你好：" + say;
	}
	/** 使用动态配置获取测试 --END-- **/
	}
}

可以根据业务情况而定，将多个配置封装到一个类里面，如下所示，新建CustomConf类：

/**
 * desc:对象配置类
 * @Value 
 * @Component @ConfigurationProperties
 */
@Component
@ConfigurationProperties(prefix = "custom"
public class CustomConf {
	private Integer one;
	private Integer two;
	private Integer three;
	private String description;

    // 此处省略掉了 get set 方法，实际需要补上
}

使用到注解：

@Value ：通常情况，使用注解取值。
• @Component ：加入注解，便于被扫描到。
• @ConfigurationProperties：引入配置，通过prefix指定配置前缀。

@Autowired
private CustomConf custom;

@RequestMapping("/custom"
   public String custom( {
       return "[custom] " + custom;
   }

nacos 控制台：新建配置：springboot-test.properties

nacos 控制台：配置详情：配置的比较随意，参考看看就行

运行服务：

nohup：代表脱离终端运行
• &：代表放入后台
• -Dspring.profiles.active=prod：指定为生产环境

[root@Centos9-Stream test]# nohup java -jar -Dspring.profiles.active=prod /opt/workspace/test/springboot-nacos-cloud-0.0.1-SNAPSHOT.jar  > /opt/
workspace/test/springboot-nacos.log 2>&1 &
[1] 4628

测试接口：

http://192.168.245.132:8082/t/getConfig

你也可以使用curl命令请求：

curl -X GET http://192.168.245.132:8082/t/getConfig

得到输出结果：

查看日志验证：

tail -n 5 springboot-nacos.log

至此，springboot集成微服务组件nacos联动完成，详细说明可以参考上一篇文章，文初有说明，这里不在赘述。

实际使用过程中，难免会遇到各种问题，此时不用慌，有详细官方文档可供参考。如下引入了nacos部分文档，解决搭建过程中遇到的问题，提供参考。

nacos版本问题

如果你使用nacos 1.x升级到nacos 2.x版本，建议参考官方兼容性说明与升级文档。

nacos2.0.0版本兼容性说明

目前官网推荐使用nacos2.1.1稳定版，推荐的上一个稳定版本是2.0.3。

使用VIP/nginx请求时，需要配置成TCP转发，不能配置http2转发，否则连接会被nginx断开。

因此如果客户端和服务端之前存在端口转发或防火墙时，需要对端口转发配置和防火墙配置做相应的调整。

nacos升级文档

nacos版本与spring cloud对应关系

由于 Spring Boot 3.0，Spring Boot 2.7~2.4 和 2.4 以下版本之间变化较大，目前企业级客户老项目相关 Spring Boot 版本仍停留在 Spring Boot 2.4 以下，为了同时满足存量用户和新用户不同需求，社区以 Spring Boot 3.0 和 2.4 分别为分界线，同时维护 2022.x、2021.x、2.2.x 三个分支迭代。 为了规避相关构建过程中的依赖冲突问题，我们建议可以通过 云原生应用脚手架 进行项目创建。

2022.x 分支

2021.x 分支

2.2.x 分支

组件版本关系

版本说明：https://github.com/alibaba/spring-cloud-alibaba/wiki/版本说明

排查错误

启动时报错Connection is unregistered.或Client not connected,current status:STARTING.

客户端gRPC无法和服务端创建连接，请先使用telnet ${nacos.server.address}:${nacos.server.grpc.port}进行测试，查看网络是否畅通，服务端端口是否已经正确监听。

Nacos2.0增加了9848，9849端口来进行GRPC通信，我需要在application.properties中额外配置吗？

启动nacos2.0时希望用nginx 代理，9848这个端口怎样处理，要通过nginx暴露出来么？以及docker是否需要映射？

解决版本冲突问题时遇到端口未开放

2022-12-07 20:08:13.792  INFO 17152 --- [t.remote.worker] com.alibaba.nacos.common.remote.client   : [236c02fe-157b-475e-9540-b11bf110f49e_config-0] Fail to connect server, after trying 2 times, last try server is {serverIp = '192.168.245.132', server main port = 8858}, error = unknown
2022-12-07 20:08:16.213 ERROR 17152 --- [           main] c.a.n.c.remote.client.grpc.GrpcClient    : Server check fail, please check server 192.168.245.132 ,port 9858 is available , error ={}

分析问题：检查192.168.245.132服务器的端口9858是否可用。如果参考了上面文档，你会发现我默认端口为8858，nacos2.x使用gRPC通信方式，+1000偏移量检测9858是否可用，由于防火墙或端口转发等原因，需要开发相应端口。

开放相应端口

firewall-cmd --zone=public --add-port=9858/tcp --permanent
firewall-cmd --zone=public --add-port=9859/tcp --permanent

重载firewall-cmd服务

firewall-cmd --reload

查看开放的端口

[root@Centos9-Stream nacos-2.0.4]# firewall-cmd --list-all
public (active
...
ports: 8848/tcp 9001-9010/tcp 8081/tcp 3000/tcp 8082/tcp 8083/tcp 8858/tcp 9858/tcp
...

启动多个nacos server服务导致nacos-server.jar占用 PID 问题

2022-12-07 20:19:02,601 INFO Starting Nacos v2.0.3 on Centos9-Stream with PID 34970 (/usr/local/nacos/target/nacos-server.jar started by root in /usr/local/nacos-2.0.4

参考资料：

springboot2.7.x官方文档：https://docs.spring.io/spring-boot/docs/2.7.10/reference/pdf/spring-boot-reference.pdf
• nacos2.x官方文档：https://nacos.io/zh-cn/docs/v2/quickstart/quick-start.html
• prometheus官方文档：https://prometheus.io/docs/prometheus/2.37/getting_started/
• grafana官方文档：https://grafana.com/docs/grafana/latest/getting-started/

有不足的地方，还望各位大佬轻喷。

END----

一分耕耘，一分收获。

多总结，你会发现，自己的知识宝库越来越丰富。

声明：本文由用户投稿上传，本站不保证内容的真实与正确性，并且不承担相关法律责任，如有侵权请提供版权资料并联系删除！

编程笔记 » SpringBoot应用集成微服务组件Nacos