Spring Boot 属性配置和使用 喜欢ヅ旅行 2022-08-18 10:58 130阅读 0赞 # **Spring Boot 属性配置和使用** # Spring Boot 允许通过外部配置让你在不同的环境使用同一应用程序的代码,简单说就是可以通过配置文件来注入属性或者修改默认的配置。 ## **Spring Boot 系列** ## 1. [Spring Boot 入门][Spring Boot] 2. [Spring Boot 属性配置和使用][Spring Boot 1] 3. [Spring Boot 集成MyBatis][Spring Boot _MyBatis] 4. [Spring Boot 静态资源处理][Spring Boot 2] 5. [Spring Boot - 配置排序依赖技巧][Spring Boot -] 6. [Spring Boot - DevTools 介绍][Spring Boot - DevTools] ## **Spring Boot 支持多种外部配置方式** ## 这些方式优先级如下: 1. 命令行参数 2. 来自`java:comp/env`的JNDI属性 3. Java系统属性(`System.getProperties()`) 4. 操作系统环境变量 5. `RandomValuePropertySource`配置的`random.*`属性值 6. `jar`包外部的`application-{profile}.properties`或`application.yml`(带`spring.profile`)配置文件 7. `jar`包内部的`application-{profile}.properties`或`application.yml`(带`spring.profile`)配置文件 8. `jar`包外部的`application.properties`或`application.yml`(不带`spring.profile`)配置文件 9. `jar`包内部的`application.properties`或`application.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中提供的参数,部分可用参数如下: # 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 '/' 更多常见的应用属性请浏览[这里][Link 1] **注意:**命令行参数在`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=Isea533 server.port=8080 `.yml`格式的配置文件如: name: Isea533 server: port: 8080 当有前缀的情况下,使用`.yml`格式的配置文件更简单。关于`.yml`配置文件用法请看[这里][Link 2] **注意:**使用`.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); ## **应用(使用)属性** ## ### **@Value(“$\{xxx\}”)** ### 这种方式是最简单的,通过`@Value`注解可以将属性值注入进来。 ### **@ConfigurationProperties** ### Spring Boot 可以方便的将属性注入到一个配置对象中。例如: my.name=Isea533 my.port=8080 my.servers[0]=dev.bar.com my.servers[1]=foo.bar.com 对应对象: @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; } } Spring Boot 会自动将`prefix="my"`前缀为`my`的属性注入进来。 Spring Boot 会自动转换类型,当使用`List`的时候需要注意在配置中对`List`进行初始化! Spring Boot 还支持嵌套属性注入,例如: name=isea533 jdbc.username=root jdbc.password=root ... 对应的配置类: @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; } } `jdbc`开头的属性都会注入到`Jdbc`对象中。 ### **在@Bean方法上使用@ConfigurationProperties** ### 例如: @ConfigurationProperties(prefix = "foo") @Bean public FooComponent fooComponent() { ... } Spring Boot 会将`foo`开头的属性按照名字匹配注入到`FooComponent`对象中。 ## **属性占位符** ## 例如: app.name=MyApp app.description=${app.name} is a Spring Boot application 可以在配置文件中引用**前面**配置过的属性(优先级前面配置过的这里都能用)。 通过如`${app.name:默认名称}`方法还可以设置默认值,当找不到引用的属性时,会使用默认的属性。 由于`${}`方式会被Maven处理。如果你pom继承的`spring-boot-starter-parent`,Spring Boot 已经将`maven-resources-plugins`默认的`${}`方式改为了`@ @`方式,例如`@name@`。 如果你是引入的Spring Boot,你可以修改使用[其他的分隔符][Link 3] ### **通过属性占位符还能缩短命令参数** ### 例如修改web默认端口需要使用`--server.port=9090`方式,如果在配置中写上: server.port=${port:8080} 那么就可以使用更短的`--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完整文档][Spring Boot 3] 或 [Externalized Configuration][]。 关于Spring Boot更多的内容可以继续关注本博客。 [Spring Boot]: http://blog.csdn.net/isea533/article/details/50278205 [Spring Boot 1]: http://blog.csdn.net/isea533/article/details/50281151 [Spring Boot _MyBatis]: http://blog.csdn.net/isea533/article/details/50359390 [Spring Boot 2]: http://blog.csdn.net/isea533/article/details/50412212 [Spring Boot -]: http://blog.csdn.net/isea533/article/details/53975720 [Spring Boot - DevTools]: http://blog.csdn.net/isea533/article/details/70495714 [Link 1]: http://docs.spring.io/spring-boot/docs/1.2.3.RELEASE/reference/html/common-application-properties.html [Link 2]: http://docs.spring.io/spring-boot/docs/1.2.3.RELEASE/reference/html/boot-features-external-config.html#boot-features-external-config-yaml [Link 3]: http://maven.apache.org/plugins/maven-resources-plugin/resources-mojo.html#delimiters [Spring Boot 3]: http://docs.spring.io/spring-boot/docs/1.2.3.RELEASE/reference/html/index.html [Externalized Configuration]: http://docs.spring.io/spring-boot/docs/1.2.3.RELEASE/reference/html/boot-features-external-config.html
还没有评论,来说两句吧...