Spring Boot使用“习惯优于配置”（项目中存在大量的配置，此外还内置了一个习惯性的配置，让你无需手动进行配置）的理念让你的项目快速运行起来。所以，我们要想把Spring Boot搞清楚，就要懂得如何开启各个功能模块的默认配置，这就需要了解Spring Boot的配置文件application.properties。

Spring Boot使用了一个全局的配置文件application.properties，放在src/main/resources目录下或者config目录下。Sping Boot的全局配置文件的作用是对一些默认配置的配置值进行修改。接下来，让我们一起来解开配置文件的面纱。

注:如果你工程没有这个application.properties，那就在src/main/resources目录下新建一个。

自定义属性

application.properties提供自定义属性的支持，这样我们就可以把一些常量配置在这里：

  1. com.xci.name="王卫国"
  2. com.xci.want="祝大家过年好"

然后直接在要使用的地方通过注解@Value(value=”${config.name}”)就可以绑定到你想要的属性上面
还可以指定默认值，当读取的配置不存在时使用标记：@Value(“${配置名称:默认值}”) ，例如：@Value(“${xci.max-page-size:500}”)

  1. @RestController
  2. public class UserController {
  4.     @Value("${com.xci.name}")
  5.     private  String name;
  6.     @Value("${com.xci.want}")
  7.     private  String want;
  9.     @RequestMapping("/")
  10.     public String hexo(){
  11.         return name+","+want;
  12.     }
  13. }

我们启动项目就可以看到打印了”王卫国,祝大家过年好”。
有时候属性太多了，一个个绑定到属性字段上太累，官方提倡绑定一个对象的bean，这里我们建一个ConfigBean.java类，顶部需要使用注解@ConfigurationProperties(prefix = “com.xci”)来指明使用哪个

  1. @Component //@Component或者@Configuration
  2. @ConfigurationProperties(prefix = "com.xci")
  3. public class ConfigBean {
  4.     private String name;
  5.     private String want;
  7.     // 省略getter和setter
  8. }

最后在Controller中引入ConfigBean使用即可，如下：

  1. @RestController
  2. public class UserController {
  3.     @Resource
  4.     private ConfigBean configBean;
  6.     @RequestMapping("/")
  7.     public String hexo(){
  8.         return configBean.getName()+configBean.getWant();
  9.     }
  10. }

参数间引用

在application.properties中的各个参数之间也可以直接引用来使用，就像下面的设置：

  1. com.dudu.name="嘟嘟MD"
  2. com.dudu.want="祝大家鸡年大吉吧"
  3. com.dudu.yearhope=${com.dudu.name}在此${com.dudu.want}

这样我们就可以只是用yearhope这个属性就好

使用自定义配置文件

有时候我们不希望把所有配置都放在application.properties里面，这时候我们可以另外定义一个，这里我明取名为test.properties,路径跟也放在src/main/resources下面。

  1. com.md.name="哟西~"
  2. com.md.want="祝大家鸡年,大吉吧"

我们新建一个bean类,如下：

  1. @Configuration 
  2. @ConfigurationProperties(prefix = "com.md") 
  3. @PropertySource("classpath:test.properties")
  4. public class ConfigTestBean {
  5.     private String name;
  6.     private String want;
  7.     // 省略getter和setter
  8. }

这里要注意哦，有一个问题，如果你使用的是1.5以前的版本，那么可以通过locations指定properties文件的位置，这样：

  1. @ConfigurationProperties(prefix = "config2",locations="classpath:test.properties")

随机值配置

配置文件中${random} 可以用来生成各种不同类型的随机值，从而简化了代码生成的麻烦，例如 生成 int 值、long 值或者 string 字符串。

  1. dudu.secret=${random.value}
  2. dudu.number=${random.int}
  3. dudu.bignumber=${random.long}
  4. dudu.uuid=${random.uuid}
  5. dudu.number.less.than.ten=${random.int(10)}
  6. dudu.number.in.range=${random.int[1024,65536]}

配置文件语法

配置文件支持application.properties和application.yml两张语法。

值的写法

  1. #properties配置文件
  2. name=zhangsan
  4. #yml配置文件
  5. name: zhangsan

对象、Map（属性和值）（键值对）

例如配置类中的字段为：Map<String,String> maps;

  1. #yml配置文件中，行内写法
  2. person.maps: {key1: value1,key2: value2}
  4. #需要注意:号后的空格，或者
  5. person:
  6.   maps:
  7.    key: value
  10. #在properties配置文件中
  11. person.maps.key1=value1
  12. person.maps.key2=value2

数组（List、Set）

  1. #在yml配置文件中
  2. person:
  3.   list:
  4.    - 1
  5.    - 2
  6.    - 3
  8. #行内写法
  9. person:
  10.   list: [1,2,3]
  12. #在properties配置文件中
  13. person.list[0]=1
  14. person.list[1]=2
  15. person.list[2]=3

属性名匹配规则

例如有如下配置对象：

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

firstName可以使用的属性名如下：
person.firstName，标准的驼峰式命名
person.first-name，虚线（-）分割方式，推荐在.properties和.yml配置文件中使用
PERSON_FIRST_NAME，大写下划线形式，建议在系统环境变量中使用

属性验证

**可以使用JSR-303注解进行验证，例如：

  1. @Component
  2. @ConfigurationProperties(prefix="connection")
  3. public class ConnectionSettings {
  5.     @NotNull
  6.     private InetAddress remoteAddress;
  8.     // ... getters and setters
  10. }

命令行参数

Spring Boot是基于jar包运行的，打成jar包的程序可以直接通过下面命令运行：

  1. java -jar xx.jar

可以以下命令修改tomcat端口号：

  1. java -jar xx.jar --server.port=9090

可以看出，命令行中连续的两个减号--就是对application.properties中的属性值进行赋值的标识。所以java -jar xx.jar --server.port=9090等价于在application.properties中添加属性server.port=9090。

如果你怕命令行有风险，可以使用SpringApplication.setAddCommandLineProperties(false)禁用它。

实际上，Spring Boot应用程序有多种设置途径，Spring Boot能从多重属性源获得属性，包括如下几种：

  • 根目录下的开发工具全局设置属性(当开发工具激活时为~/.spring-boot-devtools.properties)。
  • 测试中的@TestPropertySource注解。
  • 测试中的@SpringBootTest#properties注解特性。
  • 命令行参数
  • SPRING_APPLICATION_JSON中的属性(环境变量或系统属性中的内联JSON嵌入)。
  • ServletConfig初始化参数。
  • ServletContext初始化参数。
  • java:comp/env里的JNDI属性
  • JVM系统属性
  • 操作系统环境变量
  • 随机生成的带random.* 前缀的属性（在设置其他属性时，可以应用他们，比如${random.long}）
  • 应用程序以外的application.properties或者appliaction.yml文件
  • 打包在应用程序内的application.properties或者appliaction.yml文件
  • 通过@PropertySource标注的属性源
  • 默认属性(通过SpringApplication.setDefaultProperties指定).

这里列表按组优先级排序，也就是说，任何在高优先级属性源里设置的属性都会覆盖低优先级的相同属性，列如我们上面提到的命令行属性就覆盖了application.properties的属性。

配置文件的优先级

application.properties和application.yml文件可以放在一下四个位置：

  • 外置，在相对于应用程序运行目录的/config子目录里。
  • 外置，在应用程序运行的目录里
  • 内置，在config包内
  • 内置，classpath根目录

同样，这个列表按照优先级排序，也就是说，src/main/resources/config下application.properties覆盖src/main/resources下application.properties中相同的属性，如图：
image.png
此外，如果你在相同优先级位置同时有application.properties和application.yml，那么application.yml里面的属性就会覆盖application.properties里的属性。

多环境配置

当应用程序需要部署到不同运行环境时，一些配置细节通常会有所不同，最简单的比如日志，生产日志会将日志级别设置为WARN或更高级别，并将日志写入日志文件，而开发的时候需要日志级别为DEBUG，日志输出到控制台即可。
如果按照以前的做法，就是每次发布的时候替换掉配置文件，这样太麻烦了，Spring Boot的Profile就给我们提供了解决方案，命令带上参数就搞定。
这里我们来模拟一下，只是简单的修改端口来测试
在Spring Boot中多环境配置文件名需要满足application-{profile}.properties的格式，其中{profile}对应你的环境标识，比如：

  • application-dev.properties：开发环境
  • application-prod.properties：生产环境

想要使用对应的环境，只需要在application.properties中使用spring.profiles.active属性来设置，值对应上面提到的{profile}，这里就是指dev、prod这2个。
当然你也可以用命令行启动的时候带上参数：

  1. java -jar xxx.jar --spring.profiles.active=dev

我给不同的环境添加不同的端口属性server.port，然后根据指定不同的spring.profiles.active来切换使用。
除了可以用profile的配置文件来分区配置我们的环境变量，在代码里，我们还可以直接用@Profile注解来进行配置，例如数据库配置，这里我们先定义一个接口

  1. public  interface DBConnector { public  void  configure(); }

分别定义俩个实现类来实现它

  1. /**
  2.   * 测试数据库
  3.   */
  4. @Component
  5. @Profile("testdb")
  6. public class TestDBConnector implements DBConnector {
  7.     @Override
  8.     public void configure() {
  9.         System.out.println("testdb");
  10.     }
  11. }
  12. /**
  13.  * 生产数据库
  14.  */
  15. @Component
  16. @Profile("devdb")
  17. public class DevDBConnector implements DBConnector {
  18.     @Override
  19.     public void configure() {
  20.         System.out.println("devdb");
  21.     }
  22. }

通过在配置文件激活具体使用哪个实现类

  1. spring.profiles.active=testdb

然后就可以这么用了

  1. @RestController
  2. @RequestMapping("/task")
  3. public class TaskController {
  5.     @Autowired DBConnector connector ;
  7.     @RequestMapping(value = {"/",""})
  8.     public String hellTask(){
  10.         connector.configure(); //最终打印testdb     
  11.         return "hello task !! myage is " + myage;
  12.     }
  13. }

除了spring.profiles.active来激活一个或者多个profile之外，还可以用spring.profiles.include来叠加profile

  1. spring.profiles.active: testdb  
  2. spring.profiles.include: proddb,prodmq

配置自动提示


在配置自定义属性时，如果想要获得和配置Spring Boot属性自动提示一样的功能，则需要加入下面的依赖：

  1. <!--导入配置文件处理器，配置文件进行绑定就会有提示-->
  2. <dependency>
  3.    <groupId>org.springframework.boot</groupId>
  4.    <artifactId>spring-boot-configuration-processor</artifactId>
  5.    <optional>true</optional>
  6. </dependency>

若是依旧无法自动提示，可以尝试开启IDE的Annonation Processing
image.png

@Conditional注解

@Conditional派生注解（Spring注解版原生的@Conditional作用）
作用：必须是@Conditional指定的条件成立，才给容器中添加组件，配置配里面的所有内容才生效。

@Conditional扩展注解 作用（判断是否满足当前指定条件）
@ConditionalOnJava 系统的java版本是否符合要求
@ConditionalOnBean 容器中存在指定Bean；
@ConditionalOnMissingBean 容器中不存在指定Bean；
@ConditionalOnExpression 满足SpEL表达式指定
@ConditionalOnClass 系统中有指定的类
@ConditionalOnMissingClass 系统中没有指定的类
@ConditionalOnSingleCandidate 容器中只有一个指定的Bean，或者这个Bean是首选Bean
@ConditionalOnProperty 系统中指定的属性是否有指定的值
@ConditionalOnResource 类路径下是否存在指定资源文件
@ConditionalOnWebApplication 当前是web环境
@ConditionalOnNotWebApplication 当前不是web环境
@ConditionalOnJndi JNDI存在指定项

自动配置类必须在一定的条件下才能生效。
我们怎么知道哪些自动配置类生效？
我们可以通过在properties（yml）启用 debug=true 属性来让控制台打印自动配置报告，这样我们就可以很方便的知道哪些自动配置类生效。

总结

这次对Spring Boot中application.properties配置文件做的整理总结希望对大家有所帮助，最后贴上Spring Boot中常用的配置属性，需要的时候可打开查找。

https://docs.spring.io/spring-boot/docs/current/reference/html/common-application-properties.html