Spring Boot中Neo4jConnectionFactory无法读取配置文件值的问题

我尝试在Neo4jConnectionFactory类中通过@Value读取application.properties里的Neo4j配置，但获取到的值都是null；但同样的配置在SetupBeans类中能正常读取。想知道如何让Neo4jConnectionFactory也能正常读取配置？

相关代码 #

application.properties

neo4j.url = bolt://localhost:7687
neo4j.user = neo4j
neo4j.password = neo4j

SetupBeans.java

@Component
public class SetupBeans {
    @Bean
    public Neo4jClient neo4jClient() {
        return new Neo4jConnectionFactory().build();
    }
}

Neo4jConnectionFactory.java

@Configuration("neo4j")
public class Neo4jConnectionFactory {

    @Value("${neo4j.url}")
    private String url;

    @Value("${neo4j.user}")
    private String user;

    @Value("${neo4j.password}")
    private String password;

    public Neo4jClient build() {
        return new Neo4jClient(getUrl(), getUser(), getPassword());
    }
}

MyApplication.java

@SpringBootApplication
public class MyApplication {

    public static void main(String[] args) {
        SpringApplication.run(MyApplication.class, args);
    }
}

问题原因 #

核心问题是你在SetupBeans中手动new了Neo4jConnectionFactory对象，这个对象不属于Spring容器管理范围，Spring不会对它执行依赖注入（包括@Value的属性注入），所以url、user、password字段都是null。

而SetupBeans本身是@Component标注的Spring Bean，Spring会自动处理它内部的@Value注入逻辑，因此能正常获取配置值。

解决方案 #

下面提供几种可行的修复方式：

方案1：让Spring管理Neo4jConnectionFactory并注入使用

修改SetupBeans，通过构造注入的方式获取Spring容器管理的Neo4jConnectionFactory实例，而非手动new：

@Component
public class SetupBeans {
    private final Neo4jConnectionFactory neo4jConnectionFactory;

    // 构造注入Spring容器中的Neo4jConnectionFactory实例
    public SetupBeans(Neo4jConnectionFactory neo4jConnectionFactory) {
        this.neo4jConnectionFactory = neo4jConnectionFactory;
    }

    @Bean
    public Neo4jClient neo4jClient() {
        return neo4jConnectionFactory.build();
    }
}

此时Neo4jConnectionFactory上的@Configuration注解会让Spring将它纳入容器管理，@Value属性会被正常注入。

方案2：在SetupBeans中读取配置，手动传入Neo4jConnectionFactory

如果不想让Neo4jConnectionFactory成为Spring Bean，可以在SetupBeans中读取配置后，通过构造方法传给它：

1. 修改SetupBeans：

@Component
public class SetupBeans {
    @Value("${neo4j.url}")
    private String url;
    @Value("${neo4j.user}")
    private String user;
    @Value("${neo4j.password}")
    private String password;

    @Bean
    public Neo4jClient neo4jClient() {
        return new Neo4jConnectionFactory(url, user, password).build();
    }
}

2. 修改Neo4jConnectionFactory，添加构造方法接收配置：

// 去掉@Configuration注解，无需Spring管理
public class Neo4jConnectionFactory {
    private final String url;
    private final String user;
    private final String password;

    public Neo4jConnectionFactory(String url, String user, String password) {
        this.url = url;
        this.user = user;
        this.password = password;
    }

    public Neo4jClient build() {
        return new Neo4jClient(url, user, password);
    }
}

方案3：使用@ConfigurationProperties绑定配置（更规范的多配置项处理方式）

对于多个相关配置项，推荐用@ConfigurationProperties统一绑定，比分散的@Value更易维护：

1. 创建配置类：

@ConfigurationProperties(prefix = "neo4j")
public class Neo4jProperties {
    private String url;
    private String user;
    private String password;

    // 生成getter和setter，或用Lombok的@Data简化
    public String getUrl() { return url; }
    public void setUrl(String url) { this.url = url; }
    public String getUser() { return user; }
    public void setUser(String user) { this.user = user; }
    public String getPassword() { return password; }
    public void setPassword(String password) { this.password = password; }
}

2. 在主启动类开启配置绑定：

@SpringBootApplication
@EnableConfigurationProperties(Neo4jProperties.class)
public class MyApplication {
    public static void main(String[] args) {
        SpringApplication.run(MyApplication.class, args);
    }
}

3. 修改Neo4jConnectionFactory注入配置类：

@Configuration
public class Neo4jConnectionFactory {
    private final Neo4jProperties properties;

    public Neo4jConnectionFactory(Neo4jProperties properties) {
        this.properties = properties;
    }

    public Neo4jClient build() {
        return new Neo4jClient(properties.getUrl(), properties.getUser(), properties.getPassword());
    }
}

4. SetupBeans依然用构造注入的方式使用Neo4jConnectionFactory（同方案1的SetupBeans代码）。

内容的提问来源于stack exchange，提问作者Reid2