我们经常用到常规属性配置,如下方式注入属性值:
application.properties配置文件中
student.name = xaioming
student.age = 12
class文件中
@value("${student.name}")
private String name;
@value("${student.age}")
private String age;
类型安全的配置
如果通用的属性值,上述中使用@value注入每个配置在实际项目中会显得格外麻烦,要注入很多次,spring boot还提供了基于类型安全的配置方式
通过@ConfigurationProperties将properties属性和一个Bean及其属性关联
- student.properties配置文件中
student.name = xaioming
student.age = 12
2.类型安全的Bean
@Data //Lombock
@Component
@ConfigurationProperties(prefix = "student",locations = {"classpath:config/student.properties"})
public class StudentProperties{
private String name;
private Long age;
}
3.引用
@RestController
@SpringBootApplication
public class Test{
@Autowired
private StudentProperties stu;
@RequestMapping("/test")
public String index(){
return stu.getName;
}
public static void main(String[] args) {
SpringApplication.run(Test.class, args);
}
}
运行原理
1.了解spring boot内置自动配置
常规项目web.xml设置编码
<filter>
<filter-name>encodingEilter</filter-name>
<filter-class>org.springframework.web.filter.CharacterEncodingFilter
</filter-class>
<init-param>
<param-name>encoding</param-name
<param-value>UTF-8</param-value>
</init-param>
<init-param>
<param-name>forceEncoding</param-name>
<param-value>true</param-value>
</init-param>
</filter>
所以:
自动配置要满足两个条件:
(1)能配置这个CharacterEncodingFilter这个Bean
(2)能配置encoding和forceEncoding这两个参数。
2.配置参数
基于上述类型安全的配置,springBoot的自动配置也是基于这一点实现的
这里的配置类可以在中直接设置,源码如下:
@ConfigurationProperties(prefix="spring.http.encoding")//1
public class HttpEncodingProperties{
public static final Charset DEEAULT_CHARSET=Charset.forName("UTF-8")
private Charset charset-DEFAULT_CHARSET; //2
private boolean force=true; //3
public Charset getCharset((
return this.charset;
}
public void setcharset(Charset charset)(
this.charset=charset;
}
public boolean isForce(){
return this.force;
}
public void setForce(boolean force){
this.force-force;
}
代码解析:
①在application.properties配置的时候前缀是spring.http.encoding
②默认编码方式为UTF-8,若修改可使用spring.http.encoding.charset=编码;
③设置forceEncoding,默认为tue,若修改可使用 spring.http.encoding.force = false
即项目中平常修改编码:
spring.http.encoding.force=true
spring.http.encoding.charset=UTF-8
spring.http.encoding.enabled=true
3.配置Bean
通过调用上述配置,并根据条件配置CharacterEneodingFriter的Bean,我们来看看源码:
@Configuration
@EnableConfigurationProperties(HttpEncodingProperties.class)//1
@ConditionalonClass(CharacterEncodingFilter,class)//2
@ConditionalOnProperty(prefix="spring.http.encoding",value="enabled",
matchIfMissing=true)//3
public class HttpEncodingAutoConfiguration (
@Autowire
private HttpEncodingProperties httpEncodingProperties;//3
@Bean//4
@ConditionalOnMissingBean(CharacterEncodingFilter.class)//5
public CharacterEncodingFilter characterEncodingFilter(){
CharacterEncodingFilter filter = new OrderedcharacterEncodingFilter();
filter.setEncoding(this.httpEncodingProperties.getcharset().name());
filter.setForceEncoding(this.httpEncodingProperties.isForce());
return filter;
}
代码解析:
①开启属性注入,通过 @EnableConfigurationProperties 声明,使用 @Autowire 注入;
②当 CharacterEneodingFriter 在类路径的条件下;
③当设置 spring.http.encoding=enabled 的情况下,如果没有设置则默认为true,即条件符合;
④像使用Java配置的方式配置 CharacterEneodingFriter 这个Bean;
⑤当容器中没有这个Bean的时候新建Bean.
注意点:
@ConfigurationProperties注解的作用是把yml或者properties配置文件转化为bean。
@EnableConfigurationProperties注解的作用是使@ConfigurationProperties注解生效。如果只配置@ConfigurationProperties注解,在spring容器中是获取不到yml或者properties配置文件转化的bean的。
总结
1、@Configuration&与@Bean->基于java代码的bean配置
2、@EnableConfigurationProperties与@ConfigurationProperties->读取配置文件转换为bean。
3、@EnableAutoConfiguration->实现bean发现与加载。
补充:
类似@ConditionalOnMissingBean注解还有
常见的条件依赖注解有:
@ConditionalOnBean,仅在当前上下文中存在某个bean时,才会实例化这个Bean。
@ConditionalOnClass,某个class位于类路径上,才会实例化这个Bean。
@ConditionalOnExpression,当表达式为true的时候,才会实例化这个Bean。
@ConditionalOnMissingBean,仅在当前上下文中不存在某个bean时,才会实例化这个Bean。
@ConditionalOnMissingClass,某个class在类路径上不存在的时候,才会实例化这个Bean。
@ConditionalOnNotWebApplication,不是web应用时才会实例化这个Bean。
@AutoConfigureAfter,在某个bean完成自动配置后实例化这个bean。
@AutoConfigureBefore,在某个bean完成自动配置前实例化这个bean。