spring cloud nacos配置管理--- 学习笔记

恋旧的人迟早会溺死在回忆中

已于 2023-02-23 09:14:16 修改

阅读量130

点赞数 1

于 2023-01-28 21:37:35 首次发布

本文链接：https://blog.csdn.net/weixin_57392053/article/details/128772739

版权

nacos 同时被 2 个专栏收录

4 篇文章 0 订阅

订阅专栏

Spring cloud

4 篇文章 0 订阅

订阅专栏

Spring cloud集成nacos配置管理

接上篇一笔记补充记录（Spring cloud 集成nacos实现服务注册、发现和调用 — 详细笔记）现在做配置管理（获取配置以及自动更新）

所谓的配置管理就是项目的配置（yml文件、properties文件等）从nacos获取、项目共享配置以及配置热更新

先了解一下spring项目启动的时候干了什么事。下图：

项目启动后就读取本地文件、创建spring容器并注入了bean对象

拉取配置就是拉取到远程配置中心的配置文件之后，和本地的配置文件进行合并，但是我们要如何能在读取本地配置文件之前就拿到呢？
在这里插入图片描述
bootstrap.yml文件优先级更高，所以我们可以把拉取配置所需要的配置（nacos地址、服务名称等）放在bootstrap里面，拉取到之后与本地的application文件进行合并

注：截图来自b站黑马程序员视频内容

一、配置拉取

1、首先，在nacos服务中心新建配置

dataid格式：
官方解释：
在这里插入图片描述
举个例子，像下面这个图片的配置

他的DataId就为：orderService.yaml
如果有配置yml环境的话就是这样：orderService-dev.yaml

这里我们新建一个配置orderService.yml里面就有一个name属性，在后面我们需要获取到这个name属性的值。
在这里插入图片描述

2、创建工程（一个父工程，两个子工程代表两个服务）

项目结构
在这里插入图片描述

3、写配置和测试代码

因为拉取配置不需要两个项目子项目，所以只写order_service即可
父工程（普通的maven项目）
pom.xml文件

<?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">
    <modelVersion>4.0.0</modelVersion>
    <!-- 改为pom打包方式，可以让子工程集成，便于管理，
    后面更改相关版本就不用去挨个找一个一个改了-->
    <packaging>pom</packaging>
    <!--    spring boot父依赖-->
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.5.1</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <!--    这个父组件的域id、工程名、版本-->
    <groupId>space.ikiku</groupId>
    <artifactId>cloud</artifactId>
    <version>1.0-SNAPSHOT</version>
    <!--    整个cloud工程的依赖版本管理-->
    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <maven.compiler.source>1.8</maven.compiler.source>
        <maven.compiler.target>1.8</maven.compiler.target>
        <junit.version>4.12</junit.version>
        <mysql-connector.version>8.0.28</mysql-connector.version>
        <log4j.version>1.2.17</log4j.version>
        <lombok.version>1.18.12</lombok.version>
        <velocity-engine-core.version>2.2</velocity-engine-core.version>
        <spring-cloud.version>2020.0.5</spring-cloud.version>
        <mybatis-plus-boot-starte.version>3.5.2</mybatis-plus-boot-starte.version>
        <mybatis-plus-generator.version>3.5.2</mybatis-plus-generator.version>
        <springfox-swagger-ui.version>2.9.2</springfox-swagger-ui.version>
        <springfox-swagger2.version>2.9.2</springfox-swagger2.version>
    </properties>
    <!-- 子工程-->
    <modules>
        <module>user_service</module>
        <module>order_service</module>
    </modules>
    <!--    dependencyManagement 里只是声明依赖并不实现引入，
    因此子项目需要显示的声明需要用的依赖。-->
    <dependencyManagement>
        <dependencies>
            <!--Spring Cloud Alibaba 的版本信息-->
            <dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-alibaba-dependencies</artifactId>
                <version>2021.1</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <!--Spring Cloud 的版本信息-->
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring-cloud.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <dependencies>
        <!--        swagger注解依赖-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>${springfox-swagger2.version}</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>${springfox-swagger-ui.version}</version>
        </dependency>
        <!--        Spring cloud官方提供的客户端负载均衡器-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-loadbalancer</artifactId>
        </dependency>
<!--        lombok-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
<!--        mybatis-plus-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>${mybatis-plus-boot-starte.version}</version>
        </dependency>
<!--        mp代码生成器-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
            <version>${mybatis-plus-generator.version}</version>
        </dependency>
<!--        mysql驱动-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
        <!--        加载bootstrap.yml-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-bootstrap</artifactId>
        </dependency>
    </dependencies>
</project>

子工程（order_service）
pom.xml文件

<?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>
    <parent>
        <groupId>space.ikiku</groupId>
        <artifactId>cloud</artifactId>
        <version>1.0-SNAPSHOT</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>space.ikiku</groupId>
    <artifactId>order_service</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>order_service</name>
    <description>order_service</description>
    <properties>
        <java.version>8</java.version>
    </properties>
    <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注册、发现依赖-->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>
        <!-- 配置管理依赖-->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

bootstrap.yml文件（对应的远程配置文件DataId为orderService.yaml）

spring:
  application:
    name: orderService
  # 配置nacos地址、配置文件后缀
  cloud:
    nacos:
      config:
        file-extension: yaml
      server-addr: localhost:8848

application.yml文件内容

server:
  port: 8082
  ip: localhost
# 因为我有mybatis-plus的依赖不加会报错
spring:
  datasource:
    url: jdbc:mysql://localhost:3306/cloud_db?allowMultiQueries=true&useUnicode=true&characterEncoding=UTF-8&useSSL=false
    username: root
    password: 123456
    driver-class-name: com.mysql.cj.jdbc.Driver

controller层

package space.ikiku.controller;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @Classname OrderController
 * @Description TODO
 * @Version 1.0.0
 * @Date 2023/1/27 18:31
 * @Created by wlh12
 */
@RestController
@RefreshScope
@RequestMapping("/order")
public class OrderController {
    @Value("${name}")
    private String string;
    @GetMapping("/{id}")
    public String test(@PathVariable("id")String id) {
        return id+":"+string;
    }
}

4、postman测试(http://localhost:8082/order/2)

在这里插入图片描述
和预期相符，完成了配置的拉取

5、配置优先级

此时有一个问题就是当本地配置和远程环境都存在一个属性值时，他会以哪个配置的值为准呢？

修改application.yml文件：

server:
  port: 8082
  ip: localhost
spring:
  datasource:
    url: jdbc:mysql://localhost:3306/cloud_db?allowMultiQueries=true&useUnicode=true&characterEncoding=UTF-8&useSSL=false
    username: root
    password: 123456
    driver-class-name: com.mysql.cj.jdbc.Driver
#本地有一个name，远程nacos配置也有
name: 本地yml

修改远程的配置orderService.yml
在这里插入图片描述

再次测试
在这里插入图片描述
得到了本地配置的值

修改nacos配置中心的配置
在这里插入图片描述
综上可得： 远程配置大于本地配置

二、配置热更新（在第一步的基础上完成）

在从配置获取值的地方加上自动刷新的注解@RefreshScope，我这里加在OrderController上

OrderController

package space.ikiku.controller;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @Classname OrderController
 * @Description TODO
 * @Version 1.0.0
 * @Date 2023/1/27 18:31
 * @Created by wlh12
 */
@RestController
@RefreshScope //开启自动刷新
@RequestMapping("/order")
public class OrderController {
    @Value("${name}")
    private String string;
    @GetMapping("/{id}")
    public String test(@PathVariable("id")String id) {
        return id+":"+string;
    }
}

重启项目再次获取数据
在这里插入图片描述
修改配置

不重启项目直接再次访问

数据是我们修改后的配置里面的数据，热更新成功！

三、多环境配置共享

说明：多环境指的是测试环境、开发环境、上线环境等。共享指的是，上述的环境共享一个配置。
nacos配置命名格式：
${prefix}-$ {spring.profiles.active}.${file-extension}
在这里插入图片描述
看到这个我们就应该知道他是可以拉取到
{prefix}-{spring.profiles.active}.{file-extension}这个和
{prefix}.{file-extension}这两个配置的那我们进行测试

1、nacos中心新增配置（orderService-dev.yml）

在这里插入图片描述

2、修改环境(application.yml)

server:
  port: 8082
  ip: localhost
spring:
  datasource:
    url: jdbc:mysql://localhost:3306/cloud_db?allowMultiQueries=true&useUnicode=true&characterEncoding=UTF-8&useSSL=false
    username: root
    password: 123456
    driver-class-name: com.mysql.cj.jdbc.Driver
  # 为dev开发环境
  profiles:
    active: dev
name: 本地yml

controller层

package space.ikiku.controller;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @Classname OrderController
 * @Description TODO
 * @Version 1.0.0
 * @Date 2023/1/27 18:31
 * @Created by wlh12
 */
@RestController
@RefreshScope
@RequestMapping("/order")
public class OrderController {
    @Value("${name}")
    private String string;
    @GetMapping("/{id}")
    public String test(@PathVariable("id")String id) {
        return id+":"+string;
    }

    /**
     * 获取远程配置的QQ值
     * @return
     */
    @Value("${qq}")
    private String qq;
    @PostMapping("/dev")
    public String dev(){
        return qq;
    }
}