关于nacos:聊聊使用RefreshScope与nacos2整合踩到的坑

前言

本文的素材来源于敌人整合 nacos2 作为配置核心进行动静刷新时，踩到的坑。他过后遇到的问题，如下截图

因为那段时间比较忙，于是我在没看敌人我的项目代码的根底上，就找个了看似解决方案的答案，扔了过来

前面敌人加了这个配置，问题果然没有解决。前面就抽了一点工夫，要了他的我的项目代码来看下。

代码示例

因为他这个我的项目次要是他自学 nacos 的我的项目，也没波及啥敏感信息。本文就间接拿他的我的项目示例演示

1、我的项目 pom 依赖

<properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
        <java.version>1.8</java.version>
        <spring-boot.version>2.3.12.RELEASE</spring-boot.version>
        <spring-cloud.version>Hoxton.SR12</spring-cloud.version>
        <spring-cloud-alibaba.version>2.2.8.RELEASE</spring-cloud-alibaba.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>
    </dependencies>
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-alibaba-dependencies</artifactId>
                <version>${spring-cloud-alibaba.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>
            <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>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
        </dependency>

    </dependencies>

注： nacos 服务端版本为 2.1.1

2、nacos 配置核心地址，配置在 bootstrap.yml 外面

spring:
  cloud:
    nacos:
      server-addr: localhost:8848

3、我的项目的根本信息配置在 application.yml 外面

#
spring:
  application:
    name: nacos-config



server:
  port: 8030

4、编写一个须要动静刷新获取值的 controller

@RestController
@RequestMapping("/config")
@RefreshScope
public class ConfigController {@Value("${user.userName:123}")
    private String userName;


    @RequestMapping("/get")
    private String get(){return userName;}




}

5、业务我的项目在 nacos 服务端上配置如下

以上就是敌人残缺的代码例子。咱们运行一下代码，会发现 controller 的 userName 取不到值。感兴趣的敌人，能够走查一下上述的代码，查找一下起因

取不到值的起因

理论知识铺垫 ：

当咱们应用 cglib 动静代理调用指标办法时，当办法被 private 润饰时，this 为动静代理对象。当办法被 public 或者 protected 润饰时，this 为指标对象。此外属性刷新刷的是指标对象的属性，controller 的 get 办法能够看成是

   @RequestMapping("/get")
    private String get(){return this.userName;}

当咱们在 controller 加上 @RefreshScope 注解时，如果不扭转变 proxyMode 这个属性值时，他默认就会生成一个 cglib 动静代理。当咱们调用 get 办法，因为 get 为公有办法，咱们能够看成

   @RequestMapping("/get")
    private String get(){return cglibProxy.userName;}

此时的 this 是代理对象，而此时 userName 是代理对象的 userName，代理对象的 userName 是空值。

解决办法

办法一、批改 @RefreshScope 的 proxyMode 属性

将 proxyMode 改为 ScopedProxyMode.DEFAULT 或者 ScopedProxyMode.NO

此时 this 为指标对象，因而能取到值

办法二：将指标办法的修饰符改为 public 或者 protected

示例 ：

此时 this 为指标对象，因而能取到值

3、办法三：应用属性配置类

@Configuration
@ConfigurationProperties(prefix = "user")
public class UserProperties {

    private String userName;

    public String getUserName() {return userName;}

    public void setUserName(String userName) {this.userName = userName;}
}

controller 调整成

@RestController
@RequestMapping("/config")
public class ConfigController {

    @Autowired
    private UserProperties userProperties;


    @RequestMapping("/get")
    public String get(){return userProperties.getUserName();
    }
    
}

此时 controller 不必加 @RefreshScope 也能实现动静刷新。因为属性类上的 @ConfigurationProperties 自身就具备动静刷新的个性

总结

本文不算是 @RefreshScope 与 nacos2 整合踩到的坑，次要还是动静代理方面的常识，题目有点题目党了。

有些视频讲 nacos 动静刷新时，基本上都是举 controller 上 @RerfreshScope +@value 来解说。其实利用 @ConfigurationProperties 也是能够达到相似的成果。如果没和 springcloud 整合，引入 nacos 配置核心的 starter，应用 @NacosPropertySource + @NacosValue 或者 @NacosRefresh 也是能够实现动静刷新，感兴趣的敌人能够试一下

最初，敌人之前在 nacos2 搭建过程中，也踩到了一些坑。感兴趣的敌人能够查看如下文章

记一次应用 nacos2 踩到的坑