Spring Boot 属性配置和使用
spring Boot 允许通过外部配置让你在不同的环境使用同一应用程序的代码,简单说就是可以通过配置文件来注入属性或者修改默认的配置。
Spring Boot 系列
Spring Boot 入门
Spring Boot 属性配置和使用
Spring Boot 集成MyBatis
Spring Boot 静态资源处理
Spring Boot - 配置排序依赖技巧
Spring Boot - DevTools 介绍
Spring Boot 支持多种外部配置方式
这些方式优先级如下:
- 命令行参数
- 来自
java:comp/env
的JNDI属性 - Java系统属性(
System.getProperties()
) - 操作系统环境变量
RandomValuePropertySource
配置的random.*
属性值jar
包外部的application-{profile}.properties
或application.yml
(带spring.profile
)配置文件jar
包内部的application-{profile}.properties
或application.yml
(带spring.profile
)配置文件jar
包外部的application.properties
或application.yml
(不带spring.profile
)配置文件jar
包内部的application.properties
或application.yml
(不带spring.profile
)配置文件@Configuration
注解类上的@PropertySource
- 通过
SpringApplication.setDefaultProperties
指定的默认属性
命令行参数
通过Java -jar app.jar --name="Spring" --server.port=9090
方式来传递参数。
参数用--xxx=xxx
的形式传递。
可以使用的参数可以是我们自己定义的,也可以是Spring Boot中默认的参数。
很多人可能会关心如web端口如何配置这样的问题,这些都是Spring Boot中提供的参数,部分可用参数如下:
# LOGGING
logging.path=/var/logs
logging.file=myapp.log
logging.config= # location of config file (default classpath:logback.xml for logback) logging.level.*= # levels for loggers, e.g. "logging.level.org.springframework=DEBUG" (TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF) # EMBEDDED SERVER CONFIGURATION (ServerProperties) server.port=8080 server.address= # bind to a specific NIC server.session-timeout= # session timeout in seconds server.context-parameters.*= # Servlet context init parameters, e.g. server.context-parameters.a=alpha server.context-path= # the context path, defaults to '/' server.servlet-path= # the servlet path, defaults to '/'
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
更多常见的应用属性请浏览这里
注意:命令行参数在app.jar
的后面!
可以通过SpringApplication.setAddCommandLineProperties(false)
禁用命令行配置。
Java系统属性
注意Java系统属性位置java -Dname="isea533" -jar app.jar
,可以配置的属性都是一样的,优先级不同。
例如java -Dname="isea533" -jar app.jar --name="Spring!"
中name
值为Spring!
操作系统环境变量
配置过JAVA_HOME的应该都了解这一个。
这里需要注意的地方,有些OS可以不支持使用.
这种名字,如server.port
,这种情况可以使用SERVER_PORT
来配置。
具体名字如何匹配,看本文后面。
RandomValuePropertySource
系统中用到随机数的地方,例如:
my.secret=${random.value}
my.number=${random.int}
my.bignumber=${random.long} my.number.less.than.ten=${random.int(10)} my.number.in.range=${random.int[1024,65536]}
- 1
- 2
- 3
- 4
- 5
- 1
- 2
- 3
- 4
- 5
random.int*
支持value
参数和,max
参数,当提供max
参数的时候,value
就是最小值。
应用配置文件(.properties或.yml)
在配置文件中直接写:
name=Isea533
server.port=8080
- 1
- 2
- 1
- 2
.yml
格式的配置文件如:
name: Isea533
server:port: 8080
- 1
- 2
- 3
- 1
- 2
- 3
当有前缀的情况下,使用.yml
格式的配置文件更简单。关于.yml
配置文件用法请看这里
注意:使用.yml
时,属性名的值和冒号中间必须有空格,如name: Isea533
正确,name:Isea533
就是错的。
属性配置文件的位置
spring会从classpath下的/config
目录或者classpath的根目录查找application.properties
或application.yml
。
/config
优先于classpath根目录
@PropertySource
这个注解可以指定具体的属性配置文件,优先级比较低。
SpringApplication.setDefaultProperties
例如:
SpringApplication application = new SpringApplication(Application.class);
Map<String, Object> defaultMap = new HashMap<String, Object>();
defaultMap.put("name", "Isea-Blog");
//还可以是Properties对象 application.setDefaultProperties(defaultMap); application.run(args);
- 1
- 2
- 3
- 4
- 5
- 6
- 1
- 2
- 3
- 4
- 5
- 6
应用(使用)属性
@Value(“${xxx}”)
这种方式是最简单的,通过@Value
注解可以将属性值注入进来。
@ConfigurationProperties
Spring Boot 可以方便的将属性注入到一个配置对象中。例如:
my.name=Isea533
my.port=8080
my.servers[0]=dev.bar.com my.servers[1]=foo.bar.com
- 1
- 2
- 3
- 4
- 1
- 2
- 3
- 4
对应对象:
@ConfigurationProperties(prefix="my")
public class Config { private String name; private Integer port; private List<String> servers = new ArrayList<String>(); public String geName(){ return this.name; } public Integer gePort(){ return this.port; } public List<String> getServers() { return this.servers; } }
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
Spring Boot 会自动将prefix="my"
前缀为my
的属性注入进来。
Spring Boot 会自动转换类型,当使用List
的时候需要注意在配置中对List
进行初始化!
Spring Boot 还支持嵌套属性注入,例如:
name=isea533
jdbc.username=root
jdbc.password=root
...
- 1
- 2
- 3
- 4
- 1
- 2
- 3
- 4
对应的配置类:
@ConfigurationProperties
public class Config { private String name; private Jdbc jdbc; class Jdbc { private String username; private String password; //getter... } public Integer gePort(){ return this.port; } public Jdbc getJdbc() { return this.jdbc; } }
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
jdbc
开头的属性都会注入到Jdbc
对象中。
在@Bean方法上使用@ConfigurationProperties
例如:
@ConfigurationProperties(prefix = "foo")
@Bean
public FooComponent fooComponent() { ... }
- 1
- 2
- 3
- 4
- 5
- 1
- 2
- 3
- 4
- 5
Spring Boot 会将foo
开头的属性按照名字匹配注入到FooComponent
对象中。
属性占位符
例如:
app.name=MyApp
app.description=${app.name} is a Spring Boot application
- 1
- 2
- 1
- 2
可以在配置文件中引用前面配置过的属性(优先级前面配置过的这里都能用)。
通过如${app.name:默认名称}
方法还可以设置默认值,当找不到引用的属性时,会使用默认的属性。
由于${}
方式会被Maven处理。如果你pom继承的spring-boot-starter-parent
,Spring Boot 已经将maven-resources-plugins
默认的${}
方式改为了@ @
方式,例如@name@
。
如果你是引入的Spring Boot,你可以修改使用其他的分隔符
通过属性占位符还能缩短命令参数
例如修改web默认端口需要使用--server.port=9090
方式,如果在配置中写上:
server.port=${port:8080}
- 1
- 1
那么就可以使用更短的--port=9090
,当不提供该参数的时候使用默认值8080
。
属性名匹配规则
例如有如下配置对象:
@Component
@ConfigurationProperties(prefix="person")
public class ConnectionSettings { private String firstName; }
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 1
- 2
- 3
- 4
- 5
- 6
- 7
firstName
可以使用的属性名如下:
person.firstName
,标准的驼峰式命名person.first-name
,虚线(-
)分割方式,推荐在.properties
和.yml
配置文件中使用PERSON_FIRST_NAME
,大写下划线形式,建议在系统环境变量中使用
属性验证
可以使用JSR-303
注解进行验证,例如:
@Component
@ConfigurationProperties(prefix="connection")
public class ConnectionSettings { @NotNull private InetAddress remoteAddress; // ... getters and setters }
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
最后
以上是Spring Boot 属性配置和使用的内容,有些不全面的地方或者读者有更多疑问,可以查看Spring Boot完整文档 或 Externalized Configuration。
Spring Boot 属性配置和使用相关推荐
- Spring Boot 属性配置你所不知道的细节
今天我们要聊的这个问题,可能工作5年的资深程序员也不一定搞得很清楚,但是我敢保证在开发 Web 应用过程中大家都遇到过. 这个问题就是: Spring Boot 应用程序读取配置属性时,不同配置源的优 ...
- 8.1、Spring Boot 属性配置
1.属性生效的优先级 默认属性(硬编码) @PropertySource 绑定的属性 JAR 包内的 application.properies JAR 包外的 application.properi ...
- JSP如何获取Spring Boot的配置属性
在Spring Boot + JSP的应用中,一般使用Session作为用户身份的认证, 有时候在JSP页面中需要读取配置在Spring Boot 的配置文件(比如application.proper ...
- spring boot自动配置
首先,一般的java Web项目需要很多配置,web配置(web.xml).spring配置(默认叫applicationContext.xml),非常繁琐 而spring-boot-starter是 ...
- Spring Boot自动配置原理
要了解Spring Boot的自动配置首先我需要先了解Spring Boot的两个机制,一个是配置文件如何进入到系统变成属性,二是如何将这些属性加入到容器中. 首先我们需要有一个组件,这个组件中的属性 ...
- Spring Boot - 自动配置实例解读
文章目录 Pre 启用 debug=true输出自动配置 HttpEncodingAutoConfiguration 什么情况下,Spring Boot 会自动装配 HttpEncodingAutoC ...
- Spring Boot自动配置原理分析
一.写在前面 随着时间的迁移Spring Boot 越来越多的出现在Java 后端程序员的视野中,Spring Boot 之所以会那么流行,很大的一个原因是自身集成了很多的Bean,简化了传统Srin ...
- 芋道 Spring Boot 自动配置原理
转载自 芋道 Spring Boot 自动配置原理 1. 概述 友情提示:因为本文是分享 Spring Boot 自动配置的原理,所以需要胖友有使用过 Spring Boot 的经验.如果还没使用过 ...
- Spring Boot 自动配置的 “魔法” 是如何实现的?
转载自 Spring Boot 自动配置的 "魔法" 是如何实现的? Spring Boot是Spring旗下众多的子项目之一,其理念是约定优于配置,它通过实现了自动配置(大多数 ...
最新文章
- 读后感与机翻《从视频中推断力量和学习人类效用》
- logicaldoc 6.5 结合postgresql 9.x安装部署—基于windows平台
- Numpy生成二项分布随机数
- PMCAFF | App竞品分析报告:美丽说VS蘑菇街
- 学习 Android O HIDL
- Composite(组合)--对象结构型模式
- python 从地址获取数据失败怎么解决_python面试题大全
- 计算机水平拼音怎么写,电脑上的拼音到底是怎么敲出来的
- 计算机cpu结构实物图片,cpu内部结构显微图/cpu内部结构放大图
- 学计算机要选什么科,新高考省份想学计算机专业怎么选科
- idea 中 maven 项目依赖关系 查看 箭头的含义
- 普罗米修斯监控mysql与邮件告警
- 虚拟机创建centons
- MySQL 5.5.62 一键安装包
- win11 安卓子系统(WSA)安装教程
- 海量大数据地图可视化
- 原生M1/M2 Photoshop 2022 for Mac(PS2022)v23.4.2 中英文正式发布详情介绍安装教程
- CSS filter 有哪些神奇用途
- python单用户登录_Python 实现用户登录的简单方法
- [J2EE][shiro][授权和认证框架]