@ConfigurationProperties(prefix=““)不生效原因及解决方案

@ConfigurationProperties(prefix="")不起作用的原因与解决方法

今天在调试 Spring Boot 项目时，发现 @ConfigurationProperties 注解始终没有生效。查了不少资料，也尝试了几种网上常见的处理办法，最后终于把问题排查出来。虽然其中有些方案并不完全符合我的实际情况，但整体梳理下来，还是很适合用来定位 @ConfigurationProperties 绑定失败的问题，希望能帮你少踩一些坑。

先看第一种常见情况：注解没有写完整

有些人只写了 @ConfigurationProperties，却忘了加 @Component。要注意，这两个注解在很多场景下通常需要配合使用，少了其中一个，配置属性绑定就可能失效：

@Component
@ConfigurationProperties(prefix = "")

如果没有 @Component，Spring 就不会把这个类注册并托管为 Bean，配置文件中的属性自然也无法正确绑定到类字段上。

再来看第二个容易忽略的问题：实体类字段被写成了静态

如果类中的字段以及对应的 getter/setter 都使用了 static 修饰，那么即使 @Component 和 @ConfigurationProperties 都已经正确添加，依然不会生效。例如下面这种写法：

@Component
@ConfigurationProperties(prefix = "userinfo")
public class User
{
    private static String name;
    public static String getName()
    {
        return name;
    }
    public static void setName(String name)
    {
        this.name = name;
    }
}

Spring Boot 的配置绑定机制并不支持将属性注入到静态成员中，这也是 @ConfigurationProperties 不起作用时比较常见、但又很容易被忽略的原因之一。

最后，再说说我自己踩过的一个坑——估计很多人平时不太会注意到：

//使用实体类的时候没有使用注解自动注入
User user = new User();
name = user.getName();//这样当然NullPointExecption

如果是自己手动 new 出来的对象，Spring 容器并不会帮你完成配置属性注入。想要拿到真正经过 @ConfigurationProperties 处理后的对象，必须使用 @Autowired、构造器注入等方式，从 Spring 容器中获取 Bean。否则，拿到的只是一个普通对象，字段值自然是 null，出现 NullPointerException 也就不奇怪了。

总体来看，@ConfigurationProperties 不生效的常见原因，基本可以归纳为这三类：缺少 @Component、字段被定义为静态、以及直接手动 new 对象而没有交给 Spring 管理。排查 Spring Boot 配置绑定问题时，可以按照这个顺序逐一检查，通常都能更快定位并解决问题。