YAML 语法规范、Spring Boot 自动配置原理、多环境配置 Profiles
发布日期:2021-06-23 19:02:45 浏览次数:11 分类:技术文章

本文共 5224 字,大约阅读时间需要 17 分钟。

目录


YAML 语法规范

1、Spring Boot 使用一个全局配置文件来对一些默认配置值进行修改,比如 Tomcat 端口等

2、配置文件名字约定为 “application.properties” 或者 “application.yml”

3、配置文件放必须放在 src/main/resources 目录或者类路径 /config 下

4、yml 全称 YAML(YAML Ain't Markup Language),以数据为中心,比 json、xml 等更适合做配置文件

5、语法规范参考网址:

YAML 语法

1、k:(空格)v:表示一对键值对,注意必须有空格,如 info: good

2、使用缩进表示层级关系,缩进时不允许使用Tab键,只允许使用空格,具体个数没有强制限制,只要相同层级的元素左侧对齐即可(通常约定使用两个2个空格)

3、大小写敏感,如:

server:
  port: 8082
YAML 支持以下数据结构
数据类型 描述 举例
对象 键值对的集合,常用写法

k: v:在下一行来写对象的属性和值的关系;注意缩进.冒号后面跟空格来分开键值;如下 frined 表示对象,latName  与 age 表示属性:

friend:

  lastName: zhangsan
  age: 20

{k: v}:行内写法,如下 frined 表示对象,latName 与 age表示属性

friend: {lastName: zhangsan,age: 18}

数组 一组按次序排列的值

“- 值”表示数组中的一个元素,注意缩进 和空格,如:

Animal:

 ‐ cat
 ‐ dog

行内写法:Animal: [cat,dog,pig]

字面量 单个的、不可再分的值

k: v:字面量直接写,值(v)可以是“数字”、“字符串”、“布尔”、“日期”

字符串默认不使用单引号或者双引号

双引号不会转义字符串里面的特殊字符,特殊字符会作为本身想表示的意思,,如:name: "zhangsan \n lisi":输出的结果是:zhangsan 换行 lisi

单引号会转义字符串中的特殊字符,特殊字符最终只是一个普通的字符串数据,如:name: ‘zhangsan \n lisi’:输出结果为:zhangsan \n lisi

复合结构 以上三种写法的任意组合都可以  

Spring Boot 多环境配置

1、Profile 是 Spring 对不同环境提供不同配置功能的支持,可以通过激活、指定参数等方式快速切换环境

2、项目开发时有开发环境、测试环境、部署环境等,可以通过 profile 配置切换

3、spring.profiles.active 的值为多个时,用逗号隔开,。

多 profile 文件形式

1、格式:application-{profile}.properties/yml,如:application-dev.properties、application-prod.properties 等

2、Spring Boot 默认从全局配置文件 application.properties 和 application.yml 进入开始读取

3、然后在全局配置文件 application.properties 和 application.yml 激活使用 “spring.profiles.active=profile”  激活指定文件.

yml 文档块形式

1、yml 文件支持多文档块方式,同一个 yml 文件中,可以使用"---"来区分不同的文档,相当于不同的配置文件

2、这也是 Spring Boot 官方推荐的方式

spring: profiles:  active: devel #指定激活哪个环境配置,激活后,第一个文档内容失效;不指定时,以第一个文档为准server: port: 8083--- #"---"用于分隔不同的profiles()文档块spring: profiles: devel #指定环境标识为"devel",相当于"application-{profile}.properties/yml"中的profileserver: port: 8081---spring: profiles: deploy #指定环境标识为"deploy",相当于"application-{profile}.properties/yml"中的profileserver: port: 8082

Spring Boot 自动配置原理

1、Spring Boot 启动的时候加载主配置类(@SpringBootApplication),开启了自动配置功能 @EnableAutoConfiguration

@Target({ElementType.TYPE})@Retention(RetentionPolicy.RUNTIME)@Documented@Inherited@AutoConfigurationPackage@Import({AutoConfigurationImportSelector.class})public @interface EnableAutoConfiguration {    String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration";

2、将 类路径下 META-INF/spring.factories 里面配置的所有 XxxAutoConfiguration 的值加入到了容器中;

...# Auto Configureorg.springframework.boot.autoconfigure.EnableAutoConfiguration=\org.springframework.boot.autoconfigure.admin.SpringApplicationAdminJmxAutoConfiguration,\org.springframework.boot.autoconfigure.aop.AopAutoConfiguration,\org.springframework.boot.autoconfigure.amqp.RabbitAutoConfiguration,\org.springframework.boot.autoconfigure.batch.BatchAutoConfiguration,\org.springframework.boot.autoconfigure.cache.CacheAutoConfiguration,\org.springframework.boot.autoconfigure.cassandra.CassandraAutoConfiguration,\org.springframework.boot.autoconfigure.cloud.CloudAutoConfiguration,\org.springframework.boot.autoconfigure.context.ConfigurationPropertiesAutoConfiguration,\org.springframework.boot.autoconfigure.context.MessageSourceAutoConfiguration,\org.springframework.boot.autoconfigure.context.PropertyPlaceholderAutoConfiguration,\org.springframework.boot.autoconfigure.couchbase.CouchbaseAutoConfiguration,\...

3、每一个这样的 xxxAutoConfiguration 类都是容器中的一个组件,都加入到容器中,用他们来做自动配置。

4、每一个自动配置类进行自动配置功能,以 HttpEncodingAutoConfiguration(Http 编码自动配置)为例解释自动配置原理。

@Configuration //表示这是一个配置类,与以前编写的配置文件一样,也可以给容器中添加组件@EnableConfigurationProperties({HttpEncodingProperties.class}) //启动指定类的    //ConfigurationProperties功能;将配置文件中对应的值和HttpEncodingProperties绑定起来;并把    //HttpEncodingProperties加入到ioc容器中 @ConditionalOnWebApplication(    type = Type.SERVLET) //判断当前应用是否是web应用,如果是,当前配置类生效 @ConditionalOnClass({CharacterEncodingFilter.class}) //判断当前项目有没有这个类    //CharacterEncodingFilter;SpringMVC中进行乱码解决的过滤器;@ConditionalOnProperty(    prefix = "spring.http.encoding",    value = {"enabled"},    matchIfMissing = true)    //判断配置文件中是否存在某个配置 spring.http.encoding.enabled; matchIfMissing = true:如果不存在,判断也是成立的 public class HttpEncodingAutoConfiguration {//他已经和SpringBoot的配置文件映射了private final HttpEncodingProperties properties;//只有一个有参构造器的情况下,参数的值就会从容器中拿public HttpEncodingAutoConfiguration(HttpEncodingProperties properties) {this.properties = properties;}@Bean //给容器中添加一个组件,这个组件的某些值需要从properties中获取@ConditionalOnMissingBean(CharacterEncodingFilter.class) //判断容器没有这个组件?public CharacterEncodingFilter characterEncodingFilter() {CharacterEncodingFilter filter = new OrderedCharacterEncodingFilter();filter.setEncoding(this.properties.getCharset().name());filter.setForceRequestEncoding(this.properties.shouldForce(Type.REQUEST));filter.setForceResponseEncoding(this.properties.shouldForce(Type.RESPONSE));return filter;}

5、根据当前不同的条件判断,决定这个配置类是否生效?一但这个配置类生效,这个配置类就会给容器中添加各种组件,这些组件的属性是从对应的 Xxxproperties 类中获取的,这些类里面的每一个属性又是和配置文件绑定的;所有在配置文件中能配置的属性都是在XxxProperties 类中封装的;配置文件能配置什么就可以参照某个功能对应的这个属性类。

@ConfigurationProperties(    prefix = "spring.http.encoding") //从配置文件中获取指定的值和bean的属性进行绑定public class HttpEncodingProperties {    public static final Charset DEFAULT_CHARSET;    private Charset charset;    private Boolean force;    private Boolean forceRequest;    private Boolean forceResponse;    private Map
mapping;

 

转载地址:https://wangmaoxiong.blog.csdn.net/article/details/81028526 如侵犯您的版权,请留言回复原文章的地址,我们会给您删除此文章,给您带来不便请您谅解!

上一篇:Android 键盘弹起和回落事件监听
下一篇:微信小程序-上海站

发表评论

最新留言

初次前来,多多关照!
[***.217.46.12]2024年04月17日 11时22分22秒

关于作者

    喝酒易醉,品茶养心,人生如梦,品茶悟道,何以解忧?唯有杜康!
-- 愿君每日到此一游!

推荐文章