博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
Spring Boot 属性配置和使用
阅读量:5890 次
发布时间:2019-06-19

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

hot3.png

Spring Boot 允许通过外部配置让你在不同的环境使用同一应用程序的代码,简单说就是可以通过配置文件来注入属性或者修改默认的配置。

Spring Boot 系列

Spring Boot 支持多种外部配置方式

这些方式优先级如下:

  1. 命令行参数
  2. 来自java:comp/env的JNDI属性
  3. Java系统属性(System.getProperties()
  4. 操作系统环境变量
  5. RandomValuePropertySource配置的random.*属性值
  6. jar包外部的application-{profile}.propertiesapplication.yml(带spring.profile)配置文件
  7. jar包内部的application-{profile}.propertiesapplication.yml(带spring.profile)配置文件
  8. jar包外部的application.propertiesapplication.yml(不带spring.profile)配置文件
  9. jar包内部的application.propertiesapplication.yml(不带spring.profile)配置文件
  10. @Configuration注解类上的@PropertySource
  11. 通过SpringApplication.setDefaultProperties指定的默认属性

命令行参数

通过java -jar app.jar --name="Spring" --server.port=9090方式来传递参数。

参数用--xxx=xxx的形式传递。

可以使用的参数可以是我们自己定义的,也可以是Spring Boot中默认的参数。

很多人可能会关心如web端口如何配置这样的问题,这些都是Spring Boot中提供的参数,部分可用参数如下:

# LOGGINGlogging.path=/var/logslogging.file=myapp.loglogging.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=8080server.address= # bind to a specific NICserver.session-timeout= # session timeout in secondsserver.context-parameters.*= # Servlet context init parameters, e.g. server.context-parameters.a=alphaserver.context-path= # the context path, defaults to '/'server.servlet-path= # the servlet path, defaults to '/'

更多常见的应用属性请浏览

注意:命令行参数在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]}

random.int*支持value参数和,max参数,当提供max参数的时候,value就是最小值。

应用配置文件(.properties或.yml)

在配置文件中直接写:

name=Isea533server.port=8080

.yml格式的配置文件如:

name: Isea533server:    port: 8080

当有前缀的情况下,使用.yml格式的配置文件更简单。关于.yml配置文件用法请看

注意:使用.yml时,属性名的值和冒号中间必须有空格,如name: Isea533正确,name:Isea533就是错的。

属性配置文件的位置

spring会从classpath下的/config目录或者classpath的根目录查找application.propertiesapplication.yml

/config优先于classpath根目录

@PropertySource

这个注解可以指定具体的属性配置文件,优先级比较低。

SpringApplication.setDefaultProperties

例如:

SpringApplication application = new SpringApplication(Application.class);Map
defaultMap = new HashMap
();defaultMap.put("name", "Isea-Blog");//还可以是Properties对象application.setDefaultProperties(defaultMap);application.run(args);

应用(使用)属性

@Value(“${xxx}”)

这种方式是最简单的,通过注解可以将属性值注入进来。

@ConfigurationProperties

Spring Boot 可以方便的将属性注入到一个配置对象中。例如:

my.name=Isea533my.port=8080my.servers[0]=dev.bar.commy.servers[1]=foo.bar.com

对应对象:

@ConfigurationProperties(prefix="my")public class Config {    private String name;    private Integer port;    private List
servers = new ArrayList
(); public String geName(){ return this.name; } public Integer gePort(){ return this.port; } public List
getServers() { return this.servers; }}

Spring Boot 会自动将prefix="my"前缀为my的属性注入进来。

Spring Boot 会自动转换类型,当使用List的时候需要注意在配置中对List进行初始化!

Spring Boot 还支持嵌套属性注入,例如:

name=isea533jdbc.username=rootjdbc.password=root...

对应的配置类:

@ConfigurationPropertiespublic 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;    }}

jdbc开头的属性都会注入到Jdbc对象中。

在@Bean方法上使用@ConfigurationProperties

例如:

@ConfigurationProperties(prefix = "foo")@Beanpublic FooComponent fooComponent() {    ...}

Spring Boot 会将foo开头的属性按照名字匹配注入到FooComponent对象中。

属性占位符

例如:

app.name=MyAppapp.description=${app.name} is a Spring Boot application
  • 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

那么就可以使用更短的--port=9090,当不提供该参数的时候使用默认值8080

属性名匹配规则

例如有如下配置对象:

@Component@ConfigurationProperties(prefix="person")public class ConnectionSettings {    private String firstName;}

firstName可以使用的属性名如下:

  1. person.firstName,标准的驼峰式命名
  2. person.first-name,虚线(-)分割方式,推荐在.properties.yml配置文件中使用
  3. PERSON_FIRST_NAME,大写下划线形式,建议在系统环境变量中使用

属性验证

可以使用JSR-303注解进行验证,例如:

@Component@ConfigurationProperties(prefix="connection")public class ConnectionSettings {    @NotNull    private InetAddress remoteAddress;    // ... getters and setters}

最后

以上是Spring Boot 属性配置和使用的内容,有些不全面的地方或者读者有更多疑问,可以查看 或 。

关于Spring Boot更多的内容可以继续关注本博客。

转载于:https://my.oschina.net/xiaominmin/blog/1602763

你可能感兴趣的文章
软件工程第一次作业
查看>>
hadoop
查看>>
js函数
查看>>
实验3 编程、编译、连接、跟踪
查看>>
Codeforces Round #462 (Div. 2)
查看>>
(5)Flask项目会员登录页
查看>>
五子棋AI大战OC实现
查看>>
写在省选前
查看>>
js 单精度浮点数转10进制_js浮点数精度问题的前世今生?
查看>>
db2 修改表空间自增长_db2 使用重定向方式恢复数据 and 修改表空间大小
查看>>
docker webdav_跨主机容器共享数据卷(webdav 双向同步)
查看>>
python数据整理代码讲解_python处理写入数据代码讲解
查看>>
3w最简单led灯电路图_怎么选择自己合适的LED驱动IC?(十大LED驱动IC典型应用电路图)...
查看>>
ami主板uefi_手把手教你玩转UEFI BIOS,以及BIOS详细设置说明
查看>>
centos7磁盘逻辑分区命令_centos7.2下新挂磁盘并创建逻辑组、逻辑卷
查看>>
inodesusedpercent_Go 每日一库之 gopsutil
查看>>
asp功放怎么装_功放机维修常见方法,小编教您如何维修功放机
查看>>
手机真机访问开发_手机真机和开发者工具图片上传格式不一致
查看>>
直系同源基因ks_系统发育基因组学揭开跳蚤的身世之谜
查看>>
lodop直接打印怎么去除水印_怎么去除抖音短视频水印 去除抖音短视频水印教程...
查看>>