SpringBoot详解如果通过@Value注解给静态变量注入值

2022-11-13 10:11:18 变量 注解 静态

最近做项目的时候,给static变量赋值, 使用 @value注解 ,结果 获取一直为null ,

1、spring不允许/不支持把值注入到静态变量中
 
2、Spring的@Value依赖注入是依赖set方法
 
3、set方法是普通的对象方法
 
4、static变量是类的属性,static没有set方法

前序

SpringBoot中使用@Value()只能给普通变量注入值,不能直接给静态变量赋值

例如,application-dev.properties配置文件有如下配置:

给普通变量赋值时,直接在变量声明之上添加@Value()注解即可,如下所示:

当要给静态变量注入值的时候,若是在静态变量声明之上直接添加@Value()注解是无效的,例如:

虽然没有编译和运行上的报错,经调试可知这种注解方式mailUsername、mailPassWord、mailHost的值都是null,也就是说直接给静态变量读取配置文件是无效的,如下所示:

方案一

若要给静态变量赋值,可以使用set()方法,其中需要在类上加入@Component注解,方法名(例如setMailUsername)和参数名(例如username)可以任意命名,如下所示:

调试结果如下:

@Component
public class JDConfig {
    
    public static String url;
    
    public static String sysId;
    
    public static Boolean isAuth;
    
    public static String sysKey;
    @Autowired(required = false)
    @Value(value="${jd.serverHost:}")
    public void setUrl( String url) {
        JDConfig.url = url;
    }
    @Autowired(required = false)
    @Value(value="${contract.jd.appKey:}")
    public void setSysId( String sysId) {
        JDConfig.sysId = sysId;
    }
    @Autowired(required = false)
    @Value(value="${jd.isAuth:true}")
    public void setAuth(Boolean isAuth) {
        JDConfig.isAuth = isAuth;
    }
    @Autowired(required = false)
    @Value(value="${contract.jd.appSecurity:}")
    public void setSysKey(String sysKey) {
        JDConfig.sysKey = sysKey;
    }
    public  String getUrl() {
        return url;
    }
    public  String getSysId() {
        return sysId;
    }
    public  Boolean getIsAuth() {
        return isAuth;
    }
    public  String getSysKey() {
        return sysKey;
    }
}

方案二

如果你觉得@value注解麻烦。可以使用@ConfigurationProperties注解代替,这样比较简洁

  • 前缀要写合适
  • 方法名(例如setOssUrl)必须和属性保持一致,例如写为setUrl()会注入失败
  • 类上加入@Component注解

最近的项目还有有这样一个需求,就是类中有几个静态变量,初始化的时候,他们的值需要读取一个配置文件,获取一个code,然后用这个code拼接而成。 这个code不是静态的变量,怎么实现的呢,代码如下:

    @Value("${projectCode}")
    private String projectCode;
    public static String COOPERATIVE_GoV_TEMPLATE_KEY ;
    // 消息短信配置
    public static String DEPOLY_KEY;
    // 消息短信详情配置
    public static String MSG_DEPOLY_KEY;
    // 过滤配置
    public static String MSG_FILTER_KEY;
    @PostConstruct
    public void init() {
        COOPERATIVE_GOV_TEMPLATE_KEY = projectCode + ":template";
        DEPOLY_KEY = projectCode + ":depoly";
        MSG_DEPOLY_KEY = projectCode + ":msgDepoly";
        MSG_FILTER_KEY = projectCode + ":msgFilter";
    }

这样当项目启动的时候,这几个静态变量就有有值了。 一定要注意这个类要被spring管理,也就是要用@Controller,@Service,@Component等注解注释。

方案三

  • 类上加入@Component注解
  • @PostConstruct注解修饰的方法中进行赋值操作

使用场景

那么问题来啦!我们什么场景下需要把值注入到静态变量?

场景一

场景二

工具类中将值注入静态变量,就可以直接在静态方法之中使用,我本文中遇到的正是这个场景

总结

本文中,我们从一个实际问题出发,探寻了三种在springboot中静态变量注入方案,希望对大家有所帮助。

到此这篇关于SpringBoot详解如果通过@Value注解给静态变量注入值的文章就介绍到这了,更多相关SpringBoot @Value内容请搜索以前的文章或继续浏览下面的相关文章希望大家以后多多支持!

相关文章