spring boot外部配置与运行原理

我们经常用到常规属性配置,如下方式注入属性值:

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及其属性关联

  1. 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。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 211,194评论 6 490
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,058评论 2 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 156,780评论 0 346
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,388评论 1 283
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,430评论 5 384
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,764评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,907评论 3 406
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,679评论 0 266
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,122评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,459评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,605评论 1 340
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,270评论 4 329
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,867评论 3 312
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,734评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,961评论 1 265
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,297评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,472评论 2 348

推荐阅读更多精彩内容