聊聊使用@RefreshScope与nacos2整合踩到的坑聊聊使用@RefreshScope与nacos2整合

前言本文的素材来源于朋友整合nacos2作为配置中心进行动态刷新时，踩到的坑。他当时遇到的问题，如下截图

文章图片

因为那段时间比较忙，于是我在没看朋友项目代码的基础上，就找个了看似解决方案的答案，扔了过去

文章图片

后面朋友加了这个配置，问题果然没有解决。后面就抽了一点时间，要了他的项目代码来看下。
代码示例因为他这个项目主要是他自学nacos的项目，也没涉及啥敏感信息。本文就直接拿他的项目示例演示

1、项目pom依赖

8 8 1.8 2.3.12.RELEASE Hoxton.SR12 2.2.8.RELEASE org.springframework.boot spring-boot-starter-web org.springframework.boot spring-boot-starter-test test com.alibaba.cloud spring-cloud-alibaba-dependencies ${spring-cloud-alibaba.version} pom import org.springframework.boot spring-boot-dependencies ${spring-boot.version} pom import org.springframework.cloud spring-cloud-dependencies ${spring-cloud.version} pom import org.springframework.boot spring-boot-starter-web com.alibaba.cloud spring-cloud-starter-alibaba-nacos-config

注： nacos服务端版本为2.1.1

2、nacos配置中心地址，配置在bootstrap.yml里面

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

3、项目的基本信息配置在application.yml里面

# spring: application: name: nacos-configserver: 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搭建过程中，也踩到了一些坑。感兴趣的朋友可以查看如下文章
【聊聊使用@RefreshScope与nacos2整合踩到的坑】记一次使用nacos2踩到的坑