SpringBoot使用注解对静态变量赋值方式

先说结论：在SpringBoot项目里用注解快速开发确实很方便，比如在application.yml里配置自定义参数，然后在业务代码中随手一写@Value就能拿到配置值。但如果你恰好需要把它赋给一个static变量，那就踩坑了——直接写在字段上，返回的永远是null。

为什么会这样？又该怎么正确操作？下面说清楚。

原因

问题的根子在于Spring的依赖注入原理与Ja va静态变量的加载时序之间存在一个时间差。静态变量属于类级别，在类加载的字节码阶段就已经完成了内存分配和初始化，而这个时间点远远早于Spring容器启动后执行属性注入的时机。简单说就是：Spring还没管你，静态变量就已经“生米煮成熟饭”了，所以注入操作被Spring直接跳过。

因此，直接在静态字段上加@Value是无效的——注入根本不生效，运行时必然是空指针。

解决方案

方法很简单：把@Value放在set方法上，并且这个set方法不能是static的。另外，set方法的参数名需要避开属性名，否则会引发混淆甚至报错。

举例说明

曾在一个项目里配置Redis哨兵集群，配置项必须读入静态变量。配置文件application.yml中redis部分的配置如下：

  redis:
    password: root
    timeout: 5000
    jedis:
      pool:
        max-active: 100
        max-wait: 10000
        max-idle: 20
        min-idle: 8
    sentinel:
      master: mymaster
      nodes:127.0.0.1:26379;127.0.0.1:26380;127.0.0.1:26381

对应的静态配置类如下——注意set方法参数名与属性名故意不同，这是避免冲突的细节：

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@Component
public class RedisConnectConfig {

    public static String MAX_ACTIVE;
    public static String MAX_IDLE;
    public static String MAX_WAIT;
    public static String MASTER;
    public static String NODES;
    public static String TIMEOUT;
    public static String PASSWORD;

    @Value("${spring.redis.jedis.pool.max-active}")
    private void setMaxActive(String maxActive){
        MAX_ACTIVE = maxActive;
    }

    @Value("${spring.redis.jedis.pool.max-idle}")
    private void setMaxIdle(String maxIdle){
        MAX_IDLE = maxIdle;
    }

    @Value("${spring.redis.jedis.pool.max-wait}")
    private void setMaxWait(String maxWait){
        MAX_WAIT = maxWait;
    }

    @Value("${spring.redis.sentinel.master}")
    private void setMaster(String master){
        MASTER = master;
    }

    @Value("${spring.redis.sentinel.nodes}")
    private void setNODES(String nodes){
        NODES = nodes;
    }

    @Value("${spring.redis.timeout}")
    private void setTIMEOUT(String timeout){
        TIMEOUT = timeout;
    }

    @Value("${spring.redis.password}")
    private void setPASSWORD(String password){
        PASSWORD = password;
    }
}

使用这些静态变量的代码段：

static {
    try {
        if (shardedJedisSentinelPool == null) {
            GenericObjectPoolConfig config = new GenericObjectPoolConfig();
            config.setMaxTotal(Integer.parseInt(RedisConnectConfig.MAX_ACTIVE));
            config.setMaxIdle(Integer.parseInt(RedisConnectConfig.MAX_IDLE));
            config.setMaxWaitMillis(Integer.parseInt(RedisConnectConfig.MAX_WAIT));

            String masterName = RedisConnectConfig.MASTER;
            List masters = new ArrayList<>();
            for (String strMaster : masterName.split(";")) {
                masters.add(strMaster.trim());
            }

            String hostAndPort = RedisConnectConfig.NODES;
            Set sentinels = new HashSet<>();
            for (String str : hostAndPort.split(";")) {
                sentinels.add(str.trim());
            }

            int timeout = Integer.parseInt(RedisConnectConfig.TIMEOUT);
            String password = RedisConnectConfig.PASSWORD;
            shardedJedisSentinelPool = new ShardedJedisSentinelPool(
                masters, sentinels, config, timeout, password);
        }
    } catch (Exception e) {
        e.printStackTrace();
    }
}

当然，同一个类里可以同时存在普通变量和静态变量：

import lombok.Data;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Configuration;

@Configuration
@Data
public class AlipayScanConfig {

    // 普通变量，直接在字段上使用 @Value
    @Value("${alipay.scan.timeoutExpress}")
    private String timeoutExpress;

    @Value("${alipay.scan.charset}")
    private String charset;

    @Value("${alipay.scan.format}")
    private String format;

    @Value("${alipay.scan.notifyUrl}")
    private String notifyUrl;

    @Value("${alipay.scan.downloadPath}")
    private String downloadPath;

    // 静态变量，必须通过 set 方法赋值，且 set 方法不能是 static
    public static String ZFBINFO_PROPERTIES;

    @Value("${alipay.scan.zfbinfoProperties}")
    private void setZfbinfoProperties(String zfbinfoProperties){
        ZFBINFO_PROPERTIES = zfbinfoProperties;
    }
}

使用时的区别也很直观：

普通变量通过@Autowired注入对象后调用get方法：

@Autowired
private AlipayWithholdConfig alipayWithholdConfig;

alipayWithholdConfig.getNotifyUrl();

而静态变量直接通过类名访问：

@Autowired
private AlipayWithholdConfig alipayWithholdConfig;

AlipayWithholdConfig.appId;

总结

一句话：@Value 不能直接给静态字段赋值，但可以通过非静态的 set 方法间接注入。set 方法的参数名要与字段名不同，且方法本身不能是 static。这个技巧在需要配合静态工具类或静态配置的场景下非常实用。