SpringBoot的自定义配置
SpringBoot免除了项目中大部分的手动配置,对一些特定情况,我们可以通过修改全局配置文件以适应具体生产环境,可以说,几乎所有的配置都可以写在application.properties文件中,SpringBoot会自动加载全局配置文件,从而免除我们手动加载的烦恼。但是,如果我们自定配置文件,SpringBoot是无法识别这些配置文件的,此时就需要我们手动加载。接下来,将针对SpringBoot的自定义配置文件及其加载方式进行讲解。
对于这种加载自定义配置文件的需求,可以使用@PropertySource注解结合@Configuration注解配置类的方式来实现。@PropertySource注解用于指定自定义配置文件的具体位置和名称。同时,为了保证SpringBoot能够扫描该注解,还需要类添加@Configuartion注解将实体类作为自定义配置类。
当然,如果需要将自定义配置文件中的属性值注入到对应类的属性中,可以使用@ConfigurationProperties或者@Value注解进行属性值注入
打开SpringBoot项目的resources目录,在项目的类路径下新建一个test.properties自定义配置文件,在该配置文件中编写需要的配置属性
在com.david.pojo包下新创建一个配置类MyProperties,提供 test.properties 自定义配置文件中对应的属性,并根据@PropertySource注解的使用进行相关配置
主要是一个自定义配置类,通过相关注解引入了自定的配置文件,并完成了自定义属性值的注入。针对示例中的几个注解,具体说明如下:
1)@Confiruation注解表示当前类是一个自定义配置类,并添加为Spring容器的组件,这里也可以使用传统的@Component注解
2)@PropertySource("classpath:properties")注解指定了自定义配置文件的位置和名称,此示例表示自定义配置文件为classpath类路径下的 test.properties 文件
3)@ConfigurationProperties(prefix="test")注解将上述自定义配置文件 test.properties 中以test开头的属性值注入到该配置类属性中
4)如果配置类上使用的是@Componnet注解而非@Configuration注解,那么@EnableConfigurationProperties注解还可以省略
在SpringBoot框架中,推荐使用配置类的方式向容器中添加和配置组件
在SpringBoot框架中,通常使用@Configuration注解定义一个配置类,SpringBoot会自动扫描和识别配置类,从而替换传统Spring框架中的XML配置文件。
当定义一个配置类后,还需要在类中的方法上使用@Bean注解进行组件配置,将方法的返回对象注入到Spring容器中,并且组件名称默认使用的是方法名,当然也可以使用@Bean注解的name或value属性自定义组件的名称
在项目下新建一个
Spring Boot 外部化配置简介
Spring Boot提供properties文件、YAML文件、环境变量(environment variables)和命令行参数的方式进行外部化配置,可以在不同的环境,使用不同的配置信息。
应用可以通过@Value注入到bean,也可以通过@ConfigurationProperties进行对象的绑定配置。
Spring Boot提供的默认通配符路径(wildcard location)在jar包路径的config/*/目录下。
可以通过指定spring.config.additional-location和spring.config.location来修改
SpringBoot入门-自动配置详解
通过查看SpringBootApplication的源码,会发现这是一个组合注解,其中最重要的注解是@EnableAutoConfiguration
先看@AutoConfigurationPackage这个注解
里面导入了一个Registrar类,这个类实现了bean的扫描与注册,那它扫描的是哪个包呢?
只要看PackageImports这个类,会发现如果没有用@ComponentScan指定包名,他默认扫描的是启动类的包名,比如你的启动类是cn.hollycloud.App,它扫描的就是cn.hollycloud
再来看AutoConfigurationImportSelector这个类,这个类用来加载所有的自动配置项
通过上面的源码我们知道spring把所有配置项都导进来了,但我们并不需要所有的功能。比如说我开发的时候并不需要mongodb相关功能,但spring也会把相关配置项加载进来,怎么关闭该功能呢?看下mongodb的自动配置源码
重点是@ConditionalOnClass(MongoClient.class),这个的意思是只有类路径中存在MongoClient.class,也就是我们导入mongo相关依赖,这个配置项才会开启,否则不会注册这个bean。
同时我们看下面有个MongoClient的bean,spring很贴心地为我们初始化好了mongo的客户端,我们直接使用就行了,如果想自定义客户端怎么办呢?也很简单,直接自己初始化一个mongo客户端放入spring容器就行了,@ConditionalOnMissingBean的意思是如果你没有自定义客户端它才会自己生成一个,是不是很方便,这个叫条件化注解
现在我们来实现一个简单的自动配置类来巩固下。
可以想象一下我们是一家机器人公司,专门制造高端机器人,很受客户欢迎,但是配置机器人过于复杂,这点老是被客户诟病,你的领导想让你提供给客户开机即用的产品,该如何实现呢?
首先我们创建一个机器人控制终端,这是控制终端可以操控机器人说话
接下来是自动配置项,可以自动注册配置终端
我们想要给客户一点自由,可以让客户自由配置机器人的名字和颜色,而不用管机器内部复杂的操作
接下来最重要的一步是把自动配置项放到类路径的/META-INF/spring.factories里面
然后客户直接引用你提供的依赖就能直接控制机器人了,而不用管复杂的初始化操作
来控制机器人说话吧,直接注入robot就能使用了,不需要客户关心复杂的初始化操作了
如果客户想为机器人改个名字也很简单,直接在application.yml配置下就行了
这个例子虽然很简单,但是说明了自动配置的工作原理,spring内置的自动配置虽然复杂,但原理都一样的。
参考代码: 下的AutoConfigTest模块
springboot配置文件总结
springboot 本身支持多种灵活的配置方式,为开发 springboot 程序带来了很大的灵活性和扩展性,但是同时由于太灵活,经常会导致明明配置了相关属性,却没有生效。
本文总结了 springboot 配置文件的原理以及多个配置文件生效的顺序。
springboot 配置文件支持灵活的路径,以及灵活的文件名,用一个变量表达式总结如下:
部分源码如下:
当满足上述变量表达式的配置文件有多个时,会有一个配置的优先级。假设
上面每个条件组合起来,则最多有配置文件如下,且顺序从上到下:
获取属性时,按从上到下的顺序遍历由上述文件生成的属性资源对象 PropertySource ,如果遇到匹配的key直接返回。
总结一下:就是如果同一个key的属性只出现一次,则直接取该值即可。如果同一个key的属性出现多次,则取顺序靠前的属性资源对象。另外其中每个文件都是可选的。
需要注意的一点是:如果在同一个 location 下配置了多个文件名一样的文件,则只会取一个,比如在 classpath:/ ,有如下两个文件 application.yml :
则只会根据 classloader 的 classpath 列表,选取第一个出现的文件。因为 springboot 加载配置文件时最底层是使用的下面的方法:
这两个方法只会获取 classloader 类的 ucp 属性里面第一个匹配到的值。如果对 springboot 自身的机制不满意,想获取所有的classpath:/路径下面的 applicaiton.yml 文件,可以使用下面的方法:
本文总结了 springboot 配置文件的原理以及多个配置文件生效的顺序。如果存在增加了配置文件或者在配置文件里面增加了属性却没有生效,可以参考上面的 springboot 配置文件表达式和配置文件生效顺序进行排查。
后面还会有一篇文章讨论基于 springboot 配置原理如何实现自定义的配置读取方式。
springboot配置需要全记吗
SpringBoot不需要添加复杂的web.xml或者spring.xml等配置文件,spring只有一个配置文件,也非必须的。
默认的配置文件是application.properties。
#修改端口号
server.port=8888
#定义项目的访问目录
server.context-path=/springboot
我们使用IDEA需要注意,图就不截图太麻烦了:
如果properties文件中出现乱码,找到setting中,在file encoding中勾选Transparent native-to-asci conversion。
YAML文件
除了默认的properties文件,SpringBoot还提供另外一种配置文件yml,这种文件提供一种更加简洁的方式编写配置信息。
yml是YAML(YAML Ain‘t Markup Language)语言的文件,是一种标记语言,以数据为中心,比json、xml等更适合做配置文件,有想法的可以去网上搜搜资料学习下。
参考语法规范:
官方参考:
yml学习参考:
YAML基本语法:
以键值对的方式表示属性。(空格必须有)。
使用缩进表示层级关系
缩进时不允许使用Tab键,只允许使用空格。
缩进的空格数目不重要,只要相同层级的元素左侧对齐即可。
属性和值是大小写敏感的。
例子:
server:
port: 8081
servlet:
context-path: springboot
注意:【:后必须跟一个空格】,两种方式推荐使用yml方式配置项目。
YAML语法
YAML支持的三种数据结构。
字面量:普通的值。(数字,字符串,布尔)
对象:键值对的集合。(Map)
数组:一组按次序排列的值。(List,Set)
字面量
YAML中字面量属于普通的值。以key: value来表示,value前必须带一个空格。
字面量,字符串默认不需要单双引号。
双引号:会转义字符,特殊字符会被转义。(name: "SimpleWu lisi" //输出:SimpleWu换行 lisi)
单引号:不会转义字符,特殊字符不会被转义。(name: 'SimpleWu lisi' //输出:SimpleWu lisi)
server:
port: 8081
对象、Map
在YAML中,对象和Map都是以键值对的方式表示。在下一行来编写属性和值得关系,注意缩进。
users:
firstName: SimpleWu
email: lovelyWu98k@gmail.com
对象还有另一种写法,看到这种写法是不是想到了JSON?
users: {
firstName: zhangsan,
email: lovelyWu98k@gmail.com
}
数组
用-值得方式来表示数组中的一个元素。
users:
- SimpleWu
- lovelyWu98k@gmail.com
- addressisnot
另外一种写法,还是像JSON
users: [SimpleWu,lovelyWu98k@gmail.com,addressisnot]
SpringBoot 配置文件详解(告别XML)
快速学会和掌握 SpringBoot 的 核心配置文件的使用。
SpringBoot 提供了丰富的 外部配置 ,常见的有:
其中核心配置文件我们并不陌生,主要以Key-Value的形式进行配置,其中属性Key主要分为两种:
在 application.properties 添加配置如下:
① 添加数据源信息
在 application.propertis 添加配置如下:
① 添加认证信息,其中 socks.indentity.* 是自定义的属性前缀。
② 添加随机值,其中spring.test.* 是自定义的属性前缀。
使用方法: @ConfigurationProperties(prefix = "spring.datasource")
使用说明:提供 Setter方法 和 标记组件 Component
如何验证是否成功读取配置?答:这里可以简单做个验证,注入 MyDataSource ,使用 Debug 模式可以看到如下信息:
使用方法: @Value("spring.datasource.*")
使用说明:提供 Setter方法 和 标记组件 Component
注意事项:@Value不支持注入静态变量,可间接通过Setter注入来实现。
关于两者的简单功能对比:
显然,前者支持松绑定的特性更强大,所以在实际开发中建议使用@ConfigurationProperties来读取自定义属性。
SpringBoot 默认会加载这些路径加载核心配置文件,按优先级从高到低进行排列:具体规则详见 ConfigFileApplicationListener
如果存在多个配置文件,则严格按照优先级进行覆盖,最高者胜出:
举个简单的例子,例如再上述位置都有一个application.properties ,并且每个文件都写入了server.port=xx (xx分别是9001,9002,9003,9004),在启动成功之后,最终应用的端口为:9004。图例:
如果想修改默认的加载路径 或者 调改默认的配置文件名,我们可以借助命令行参数进行指定,例如:
YAML是JSON的一个超集,是一种可轻松定义层次结构的数据格式。
答: 因为配置文件这东西,结构化越早接触越规范越好。这里推荐阅读阮一峰老师写的 YAML语言教程 ,写的很简单明了。
引入依赖: 在POM文件引入 snakeyaml 的依赖。
使用说明: 直接在类路径添加 application.yml 即可。
例如下面这两段配置是完全等价的:
① 在 application.yml 配置数据源:
② 在 application.properties 配置数据源:
在项目的实际开发中,我们往往需要根据不同的环境来加载不同的配置文件。例如生产环境,测试环境和开发环境等。此时,我们可以借助 Profiles 来指定加载哪些配置文件。例如:
温馨提示:如果spring.profiles.active指定了多个配置文件,则按顺序加载,其中最后的优先级最高,也就是最后的会覆盖前者。
使用方法:
使用Maven插件打包好项目,然后在当前路径,执行DOS命令: java -jar demo.jar --server.port=8081 ,在控制台可看到应用端口变成了8081。
实现原理:
默认情况下,SpringBoot会将这些命令行参数转化成一个 Property ,并将其添加到 Environment 上下文。
温馨提示:
由于命令行参数优先级非常之高,基本高于所有常见的外部配置,所以使用的时候要谨慎。详见 PropertySource 执行顺序 。
关闭方法:
如果想禁用命令行属性,可以设置如下操作:springApplication.setAddCommandLineProperties(false)