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指定的默认属性

命令行参数

 与类C语言一样,main函数都可以传入参数,这被称为命令行参数。
 比如配置文件配置服务端口好是:
server.port=8081
那么对应的命令行就是:
mvn spring-boot:run -Drun.arguments="--server.port=8081"

系统参数

系统参数也分为很多种的,首先如果是使用main方法的话。点击run as选择run config然后配置系统参数

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

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

  1. # LOGGING
  2. logging.path=/var/logs
  3. logging.file=myapp.log
  4. logging.config= # location of config file (default classpath:logback.xml for logback)
  5. logging.level.*= # levels for loggers, e.g. "logging.level.org.springframework=DEBUG" (TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF)
  6. # EMBEDDED SERVER CONFIGURATION (ServerProperties)
  7. server.port= 8080
  8. server.address= # bind to a specific NIC
  9. server.session-timeout= # session timeout in seconds
  10. server.context-parameters.*= # Servlet context init parameters, e.g. server.context-parameters.a=alpha
  11. server.context-path= # the context path, defaults to '/'
  12. server.servlet-path= # the servlet path, defaults to '/'
如果我们是用mvn打包的话, 系统参数就配置在我们的mvaen里面。如果是用tomcat打包的话, 系统参数就配置在我们
的tomcat里面。

操作系统环境变量

配置过JAVA_HOME的应该都了解这一个。

这里需要注意的地方,有些OS可以不支持使用.这种名字,如server.port,这种情况可以使用SERVER_PORT来配置。

具体名字如何匹配,看本文后面。

RandomValuePropertySource

系统中用到随机数的地方,例如:

  1. 操作系统环境变量
  2. 配置过JAVA_HOME的应该都了解这一个。
  3. 这里需要注意的地方,有些OS可以不支持使用.这种名字,如server.port,这种情况可以使用SERVER_PORT来配置。
  4. 具体名字如何匹配,看本文后面。
  5. RandomValuePropertySource
  6. 系统中用到随机数的地方,例如:
  7. my.secret=${random.value}
  8. my.number=${random. int}
  9. my.bignumber=${random. long}
  10. my.number.less.than.ten=${random. int( 10)}
  11. my.number.in.range=${random. int[ 1024, 65536]}
  12. random. int*支持value参数和,max参数,当提供max参数的时候,value就是最小值。

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

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

当我们创建一个springboot项目的时候,系统默认会为我们在src/main/ Java /resources目录下创建一个application.properties。
或者application.yml。yml的语法比properties简单,而且优先级要比proper高。建议使用yml;
先创建一个配置文件。
  1. name: java core
  2. price: 35.4

如果你需要读取配置文件的值只需要加@Value(“${属性名}”)
  1. @RestController
  2. public class BookController {
  3. @Value( "${name}")
  4. private String name;
  5. @Value( "${price}")
  6. private Double price;
  7. @RequestMapping(value = "/book")
  8. public String bookToString(){
  9. return "图书名称:"+name+ ",图书价格:"+ ":"+price;
  10. }
  11. }
这里直接访问会出现

将配置文件的属性赋给实体类

当我们有很多配置属性的时候,这时我们会把这些属性作为字段来创建一个javabean,并将属性值赋予给他们。
  1. book.name: javacore
  2. book.price: '35.4'
  1. @ConfigurationProperties(prefix = "book")
  2. @Component
  3. public class Book {
  4. private String name;
  5. private Double price;
  6. public String getName() {
  7. return name;
  8. }
  9. public void setName(String name) {
  10. this.name = name;
  11. }
  12. public Double getPrice() {
  13. return price;
  14. }
  15. public void setPrice(Double price) {
  16. this.price = price;
  17. }
  18. @Override
  19. public String toString() {
  20. return "Book [name=" + name + ", price=" + price + "]";
  21. }
  22. }

  1. @Controller
  2. @EnableConfigurationProperties({Book.class})
  3. public class BookController {
  4. @Autowired
  5. private Book book;
  6. @RequestMapping( "book")
  7. public String framework(ModelMap map) {
  8. map.addAttribute( "book",book);
  9. return "freeMarker/book";
  10. }
  11. }
  1. <!DOCTYPE html>
  2. <html>
  3. <head lang="en">
  4. <meta charset="UTF-8" />
  5. <title> </title>
  6. </head>
  7. <body>
  8. <h1>图书名称:${book.name} </h1>
  9. <h1>图书价格:${book.price} </h1>
  10. </body>
  11. </html>
最终结果图:


这个只是最简单的注入
Spring Boot 会自动转换类型,当使用List的时候需要注意在配置中对List进行初始化!
Spring Boot 还支持嵌套属性注入
  1. book.name: javacore
  2. book.price: '35.4'
  3. book.address:
  4. - '上海图书馆'
  5. - '上海张江高科图书馆'
  6. book.manage.name: '张三'
  7. book.manage.age: 23
这里我们添加了一个地址集合,和一个嵌套类,管理员对象。
  1. @ConfigurationProperties(prefix = "book")
  2. public class Book {
  3. private String name;
  4. private Double price;
  5. private List<String> address= new ArrayList<>();
  6. public Manage manage= new Manage();
  7. class Manage{
  8. private String name;
  9. private Integer age;
  10. public String getName() {
  11. return name;
  12. }
  13. public void setName(String name) {
  14. this.name = name;
  15. }
  16. public Integer getAge() {
  17. return age;
  18. }
  19. public void setAge(Integer age) {
  20. this.age = age;
  21. }
  22. @Override
  23. public String toString() {
  24. return "Manage [name=" + name + ", age=" + age + "]";
  25. }
  26. }
  27. public String getName() {
  28. return name;
  29. }
  30. public void setName(String name) {
  31. this.name = name;
  32. }
  33. public Double getPrice() {
  34. return price;
  35. }
  36. public void setPrice(Double price) {
  37. this.price = price;
  38. }
  39. @Override
  40. public String toString() {
  41. return "Book [name=" + name + ", price=" + price + "]";
  42. }
  43. public List<String> getAddress() {
  44. return address;
  45. }
  46. public void setAddress(List<String> address) {
  47. this.address = address;
  48. }
  49. public Manage getManage() {
  50. return manage;
  51. }
  52. public void setManage(Manage manage) {
  53. this.manage = manage;
  54. }
  55. }
记住,集合和对象一定要初始化,不然会报错。Controller基本不变。
  1. <!DOCTYPE html>
  2. <html xmlns="http://www.w3.org/1999/xhtml" xmlns:th="http://www.thymeleaf.org"
  3. xmlns:sec= "http://www.thymeleaf.org/thymeleaf-extras-springsecurity3">
  4. <head lang="en">
  5. <meta charset="UTF-8" />
  6. <title> </title>
  7. </head>
  8. <body>
  9. <h1>图书名称:${book.name} </h1>
  10. <h1>图书价格:${book.price} </h1>
  11. <#list book.address as address>
  12. 图书所在地址 : ${address} <br/>
  13. </#list>
  14. <h2>管理员属性:${book.manage} <h2>
  15. </body>
  16. </html>


属性占位符

  1. app.name=MyApp
  2. app.description=${app.name} is a Spring Boot application

可以在配置文件中引用前面配置过的属性(优先级前面配置过的这里都能用)。

通过如${app.name:默认名称}方法还可以设置默认值,当找不到引用的属性时,会使用默认的属性。

由于{}方式改为了@ @方式,例如@name@。

如果你是引入的Spring Boot,你可以修改使用其他的分隔符

通过属性占位符还能缩短命令参数

server.port=${port:7001}

属性名匹配规则

例如有如下配置对象:

  1. @Component
  2. @ConfigurationProperties(prefix= "person")
  3. public class ConnectionSettings {
  4. private String firstName;
  5. }

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

person.firstName,标准的驼峰式命名

person.first-name,虚线(-)分割方式,推荐在.properties和.yml配置文件中使用

PERSON_FIRST_NAME,大写下划线形式,建议在系统环境变量中使用


猜你喜欢

转载自blog.csdn.net/weixin_39816740/article/details/80911135