1、使用@Value注解
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
@Component
public class MyBean {
@Value("${myapp.name}")
private String appName;
public void printAppName() {
System.out.println(appName);
}
}
2、使用Environment对象
import org.springframework.core.env.Environment;
import org.springframework.stereotype.Component;
@Component
public class MyBean {
private final Environment environment;
public MyBean(Environment environment) {
this.environment = environment;
}
public void printConfigParam() {
String paramValue = environment.getProperty("myapp.param");
System.out.println(paramValue);
}
}
3、使用@ConfigurationProperties 注解
3.1 当有大量的配置参数时,可以将它们组合到一个POJO类中,使用@Component、@ConfigurationProperties注解进行自动装配。此场景下,当POJO类被实例化为Bean对象时,@ConfigurationProperties会将其前缀的后面的配置参数与POJO类的属性进行匹配,名称相同的进行赋值。
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
@Component
@ConfigurationProperties(prefix = "myapp") // myapp 为配置参数的前缀
public class ConfigEntity {
private String name;
private String param;
private int version;
// getters and setters...
public static class InnerClass {
private boolean enabled;
// getter and setter for inner class properties...
}
private InnerClass inner;
// getters and setters for inner class properties...
}
3.2 使用@Bean、@ConfigurationProperties注解在配置类(@Configuration注解的类)的Bean定义方法时,可使配置文件中相应的配置参数初始化该Bean的属性。以数据源配置为例,将前缀为“spring.datasource.primary”的配置参数,赋值给DataSource对应的属性。
@Configuration
public class DataSourceConfig {
@Primary
@Bean(name = "primaryDataSource")
@ConfigurationProperties(prefix="spring.datasource.primary")
public DataSource primaryDataSource() {
return DataSourceBuilder.create().build();
}
}
3.3 配置参数的List、Map形式
kafka:
consumers:
### 86
- topics: DCCP-1,DCCP-2
servers: kafka01:8423,kafka02:8423,kafka03:8423
groupId: consumer_group
username: consumer
password: ******
### 131
- topics: DCCP-3,DCCP-4
servers: kafka01:8423,kafka02:8423,kafka03:8423
groupId: consumer_group
username: consumer
password: ******
- ...
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
@Data
@Component
@ConfigurationProperties(prefix = "kafka")
public class KafkaConsumers {
private List<Map<String, Object>> consumers;
}
4、使用@EnableConfigurationProperties 注解
如果想要全局共享配置参数,则可以使用@EnableConfigurationProperties注解。首先创建一个与配置项对应的POJO类,并使用@ConfigurationProperties 注解指定前缀。然后,在主程序类上添加@EnableConfigurationProperties注解,并传入该POJO类作为参数。示例如下所示:
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
@SpringBootApplication
@EnableConfigurationProperties(ConfigEntity.class)
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}