关于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踩到的坑