springcloud项目引入naocs2.x

azoon.top

已于 2025-02-12 09:29:23 修改

阅读量1.9k

点赞数 60

分类专栏：微服务justsoso-cloud系列文章标签： spring cloud java spring nacos 注册中心

于 2025-02-10 17:34:58 首次发布

本文链接：https://blog.youkuaiyun.com/qq_45863248/article/details/145543701

版权

微服务justsoso-cloud系列专栏收录该内容

22 篇文章

订阅专栏

在上一篇文章中讲述了如何通过docker安装nacos服务端，本篇文章将会演示如何将nacos引入springcloud项目

一. 确认版本号

这篇文章介绍了如何确认springboot springcloud springcloudalibaba的版本号:手把手教你梳理springcloud与springboot与springcloudalibaba的版本对应关系

二. nacos服务端配置

1. 新增命名空间

命名空间官方解释：用于进行租户粒度的配置隔离。不同的命名空间下，可以存在相同的 Group 或 Data ID 的配置。Namespace 的常用场景之一是不同环境的配置的区分隔离，例如开发测试环境和生产环境的资源（如配置、服务）隔离等。

在这里插入图片描述

2.创建配置

进入刚才创建的命名空间
在这里插入图片描述

3. 创建配置

DATA ID官方解释：Nacos 中的某个配置集的 ID。配置集 ID 是组织划分配置的维度之一。Data ID 通常用于组织划分系统的配置集。一个系统或者应用可以包含多个配置集，每个配置集都可以被一个有意义的名称标识。Data ID 通常采用类 Java 包（如 com.taobao.tc.refund.log.level）的命名规则保证全局唯一性。此命名规则非强制。

Group官方解释：Nacos 中的一组配置集，是组织配置的维度之一。通过一个有意义的字符串（如 Buy 或 Trade ）对配置集进行分组，从而区分 Data ID 相同的配置集。当您在 Nacos 上创建一个配置时，如果未填写配置分组的名称，则配置分组的名称默认采用 DEFAULT_GROUP 。配置分组的常见场景：不同的应用或组件使用了相同的配置类型，如 database_url 配置和 MQ_topic 配置。

一般DATA ID的命名规范是 ${prefix}-${spring.profile.active}.${file-extension}

${prefix}：默认为工程配置中的 spring.application.name 的值，也可以通过 spring.cloud.nacos.config.prefix 来自定义。
${spring.profile.active}：表示当前的环境配置，如 dev、test 或 prod。当 spring.profile.active 为空时，连接符 - 也将不会出现
${file-extension}：表示配置内容的数据格式，通常是 properties 或 yaml，可以通过 spring.cloud.nacos.config.file-extension 来指定。

在这里插入图片描述

注意点：

nacos配置文件内容最好在idea的yml写好剪切过来，防止格式有问题
一定要注意DATAID后面的要写成 xxx.yaml 而不是yml，在bootstrap.yml中，file-extension设为yaml；（我印象着之前DATAID写成xxx.yml没问题，不清楚为什么这次总是出现找不到配置文件的情况）

三. nacos配置中心&注册中心

1. 引入依赖

<!--nacos配置中心客户端-->
<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
</dependency>

<!--nacos注册中心客户端-->
<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>

2. @EnableDiscoveryClient

在这里插入图片描述

3. 配置bootstrap.yaml

为什么要用bootstrap.yaml而不是application.yml？
优先级：bootstrap.properties -> bootstrap.yml -> application.properties -> application.yml
而且如果使用的是application.yml在配置nacos自动刷新会有错误：https://blog.youkuaiyun.com/qq_45863248/article/details/131474805

spring:
  application:
    name: admin
  profiles:
    active: dev
  cloud:
    nacos:
      username: nacos
      password: nacos
      config:
        # nacos服务端
        server-addr: 127.0.0.1:8848
        # 分组
        group: dev
        # 命名空间
        namespace: 26dc328e-87e1-4ebb-9882-e46aa0cfbf0c
        # 配置文件类型
        file-extension: yaml

      discovery:
        # 命名空间
        namespace: 26dc328e-87e1-4ebb-9882-e46aa0cfbf0c
        # 同一个项目下的服务，要在同一个分组下，相互间才能通信
        group: dev
        # nacos服务端
        server-addr: 127.0.0.1:8848

四. 配置动态刷新并测试

1. 在通过@Value获取参数的类上加上@RefreshScope注解

@RestController()
@RequestMapping("/nacos")
@RefreshScope
public class NacosTestController {
    @Value("${server.servlet.context-path}")
    private String contextPath;
    @Value("${server.port}")
    private Integer port;

    @GetMapping("getNacosConfig")
    public String getNacosConfig() {
        return contextPath+":"+port;
    }
}

2. 添加一个测试需要的参数

在这里插入图片描述

3. 浏览器访问查看

在这里插入图片描述

4. 修改nacos中配置的值（别忘了点发布）

在这里插入图片描述

5. 无需重启项目，直接浏览器重新获取

在这里插入图片描述

五. 通用配置抽取

有的时候各个模块/配置文件有很多共同性，可以抽出一些通用代码到一个配置文件，然后各自引用即可，比如mysql,redis配置等；
这里简单演示一下创建公共配置文件后，如何引入；后续博客在引入mysql redis等组件的时候也会用到

1. 添加公用配置yaml

在这里插入图片描述

2. bootstrap.yml引入

在这里插入图片描述

3. 代码测试

在这里插入图片描述

六. 问题汇总

1. 启动报错 No spring.config.import property has been defined

加上spring-cloud-starter-bootstrap依赖即可

<dependency>
   <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-bootstrap</artifactId>
</dependency>

2. 启动报错 com.alibaba.nacos.api.exception.NacosException: http error, code=403,msg=user not found!,dataId=admin-dev.yaml,group=dev,tenant=26dc328e-87e1-4ebb-9882-e46aa0cfbf0c

bootstrap.yml中加入nacos账号密码

spring:
  cloud:
    nacos:
      username: nacos
      password: nacos

在这里插入图片描述