java springboot中如何读取配置文件的属性

Java Spring Boot是一个非常受欢迎的Web应用程序框架，其中有一个很重要的功能是读取配置文件的属性。在Spring Boot应用程序中，开发者可以通过@ConfigurationProperties注解，实现对配置文件中的属性进行读取。以下是详细讲解“Java Spring Boot中如何读取配置文件的属性”的完整攻略。

1. 创建配置文件

在Spring Boot应用中使用配置文件非常简单，只需要在classpath下创建properties/yml文件即可。下面是一个示例application.yml文件。

server:
  port: 8080
  context-path: /myapp
  tomcat:
    max-threads: 200
    max-connections: 10000

在该配置文件中，我们定义了几个属性，包括服务端口、应用上下文路径、Tomcat最大线程数、Tomcat最大连接数等。

2. 创建Java配置类

创建一个Java配置类，使用@Configuration和@EnableConfigurationProperties注解，这样Spring会自动将@ConfigurationProperties组件的实例注入到Java配置类中。

@Configuration
@EnableConfigurationProperties({ServerConfig.class})
public class AppConfig {

    @Autowired
    private ServerConfig serverConfig;

    @Bean
    public WebServerFactoryCustomizer<ConfigurableWebServerFactory> webServerFactoryCustomizer() {
        return factory -> {
            factory.setPort(serverConfig.getPort());
            factory.setContextPath(serverConfig.getContextPath());
        };
    }
}

在上面的代码中，我们使用了@Bean注解，创建了一个WebServerFactoryCustomizer实例，并将ServerConfig中的属性设置到该实例中。

3. 创建Java配置属性类

在Java配置类中注入的ServerConfig是一个属性类，该属性类需要使用@ConfigurationProperties注解来指示该类是一个配置属性类，并且@ConfigurationProperties注解中需要指定配置文件中的前缀。

@ConfigurationProperties(prefix = "server")
public class ServerConfig {

    private int port;

    private String contextPath;

    private TomcatConfig tomcat;

    // 省略getter、setter方法
}

在上面的代码中，我们定义了几个属性，包括服务端口、应用上下文路径、Tomcat最大线程数、Tomcat最大连接数等。

4. 读取配置文件中的属性

当Java配置类被Spring初始化时，会自动读取配置文件中的属性，并将值注入到ServerConfig实例中。

public class AppTest extends TestCase {

    @Autowired
    private ServerConfig serverConfig;

    public void testServerConfig() {
        assertEquals(8080, serverConfig.getPort());
        assertEquals("/myapp", serverConfig.getContextPath());
        assertEquals(200, serverConfig.getTomcat().getMaxThreads());
        assertEquals(10000, serverConfig.getTomcat().getMaxConnections());
    }
}

在上面的代码中，我们注入了ServerConfig实例，并进行一系列的测试，确保配置属性已经正确读取。

示例一：使用@Value注解读取属性

除使用@ConfigurationProperties注解外，还可以使用@Value注解来读取单一属性值，例如：

@Value("${spring.datasource.url}")
private String datasourceUrl;

在上面的代码中，我们从application.yml中读取了一个属性spring.datasource.url的值，并注入到datasourceUrl变量中。

示例二：使用Environment读取属性

除使用@ConfigurationProperties注解和@Value注解外，还可以使用Environment类来进行读取，例如：

@Autowired
private Environment env;

public void testEnv() {
    assertEquals("localhost:27017", env.getProperty("spring.data.mongodb.uri"));
    assertEquals("admin", env.getProperty("spring.data.mongodb.username"));
    assertEquals("password", env.getProperty("spring.data.mongodb.password"));
}

在上面的代码中，我们注入了Environment实例，并进行一系列的测试，确保配置属性已经正确读取。