前言
上一篇介绍了Spring Boot的入门,知道了Spring Boot使用“习惯优于配置”(项目中存在大量的配置,此外还内置了一个习惯性的配置,让你无需手动进行配置)的理念让你的项目快速运行起来。所以,我们要想把Spring Boot玩的溜,就要懂得如何开启各个功能模块的默认配置,这就需要了解Spring Boot的配置文件application.properties。
正文
Spring Boot使用了一个全局的配置文件application.properties,放在src/main/resources目录下或者类路径的/config下。Sping Boot的全局配置文件的作用是对一些默认配置的配置值进行修改。
接下来,让我们一起来解开配置文件的面纱。
注:如果你工程没有这个application.properties,那就在src/main/java/resources目录下新建一个。
自定义属性
application.properties提供自定义属性的支持,这样我们就可以把一些常量配置在这里:
1 2 |
com.dudu.name="嘟嘟MD" com.dudu.want="祝大家鸡年大吉吧" |
然后直接在要使用的地方通过注解@Value(value=”${config.name}”)就可以绑定到你想要的属性上面
1 2 3 4 5 6 7 8 9 10 11 12 13 |
@RestController public class UserController { "${com.dudu.name}") ( private String name; "${com.dudu.want}") ( private String want; "/") ( public String hexo(){ return name+","+want; } } |
我们启动工程输入http://localhost:8080 就可以看到打印了”嘟嘟MD祝大家鸡年大吉吧”。
有时候属性太多了,一个个绑定到属性字段上太累,官方提倡绑定一个对象的bean,这里我们建一个ConfigBean.java类,顶部需要使用注解@ConfigurationProperties(prefix = “com.dudu”)来指明使用哪个
1 2 3 4 5 6 7 |
"com.dudu") (prefix = public class ConfigBean { private String name; private String want; // 省略getter和setter } |
这里配置完还需要在spring Boot入口类加上@EnableConfigurationProperties并指明要加载哪个bean,如果不写ConfigBean.class,在bean类那边添加
1 2 3 4 5 6 7 8 |
@SpringBootApplication ({ConfigBean.class})public class Chapter2Application { public static void main(String[] args) { SpringApplication.run(Chapter2Application.class, args); } } |
最后在Controller中引入ConfigBean使用即可,如下:
1 2 3 4 5 6 7 8 9 10 |
@RestController public class UserController { ConfigBean configBean; "/") ( public String hexo(){ return configBean.getName()+configBean.getWant(); } } |
参数间引用
在application.properties中的各个参数之间也可以直接引用来使用,就像下面的设置:
1 2 3 |
com.dudu.name="嘟嘟MD" com.dudu.want="祝大家鸡年大吉吧" com.dudu.yearhope=${com.dudu.name}在此${com.dudu.want} |
这样我们就可以只是用yearhope这个属性就好
使用自定义配置文件
有时候我们不希望把所有配置都放在application.properties里面,这时候我们可以另外定义一个,这里我明取名为test.properties,路径跟也放在src/main/resources下面。
1 2 |
com.md.name="哟西~" com.md.want="祝大家鸡年,大吉吧" |
我们新建一个bean类,如下:
1 2 3 4 5 6 7 8 |
@Configuration "com.md") (prefix = "classpath:test.properties") (public class ConfigTestBean { private String name; private String want; // 省略getter和setter } |
这里要注意哦,有一个问题,如果你使用的是1.5以前的版本,那么可以通过locations指定properties文件的位置,这样:
1
|
@ConfigurationProperties(prefix = "config2",locations="classpath:test.properties")
|
但是1.5版本后就没有这个属性了,找了半天发现添加@Configuration和@PropertySource(“classpath:test.properties”)后才可以读取。
随机值配置
配置文件中${random} 可以用来生成各种不同类型的随机值,从而简化了代码生成的麻烦,例如 生成 int 值、long 值或者 string 字符串。
1 2 3 4 5 6 |
dudu.secret=${random.value} dudu.number=${random.int} dudu.bignumber=${random.long} dudu.uuid=${random.uuid} dudu.number.less.than.ten=${random.int(10)} dudu.number.in.range=${random.int[1024,65536]} |
外部配置-命令行参数配置
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文件可以放在以下四个位置:
- 外置,在相对于应用程序运行目录的/congfig子目录里。
- 外置,在应用程序运行的目录里
- 内置,在config包内
- 内置,在Classpath根目录
同样,这个列表按照优先级排序,也就是说,src/main/resources/config下application.properties覆盖src/main/resources下application.properties中相同的属性,如图:
此外,如果你在相同优先级位置同时有application.properties和application.yml,那么application.properties里的属性里面的属性就会覆盖application.yml。
Profile-多环境配置
当应用程序需要部署到不同运行环境时,一些配置细节通常会有所不同,最简单的比如日志,生产日志会将日志级别设置为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 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 |
/** * 测试数据库 */ @Component "testdb") (public class TestDBConnector implements DBConnector { public void configure() { System.out.println("testdb"); } } /** * 生产数据库 */ @Component "devdb") (public class DevDBConnector implements DBConnector { public void configure() { System.out.println("devdb"); } } |
通过在配置文件激活具体使用哪个实现类
1
|
spring.profiles.active=testdb
|
然后就可以这么用了
1 2 3 4 5 6 7 8 9 10 11 12 13 |
@RestController "/task") (public class TaskController { DBConnector connector ; "/",""}) (value = { public String hellTask(){ connector.configure(); //最终打印testdb return "hello task !! myage is " + myage; } } |
除了spring.profiles.active来激活一个或者多个profile之外,还可以用spring.profiles.include来叠加profile
1 2 |
spring.profiles.active: testdb spring.profiles.include: proddb,prodmq |
总结
这次对Spring Boot中application.properties配置文件做的整理总结希望对大家有所帮助,最后贴上Spring Boot中常用的配置属性,需要的时候可打开查找。
( ̄︶ ̄)↗Spring Boot干货系列:常用属性汇总
想要查看更多Spring Boot干货教程,可前往:Spring Boot干货系列总纲
参考
Spring Boot属性配置文件详解
spring boot 使用profile来分区配置
Spring Boot实战
JavaEE开发的颠覆者Spring Boot实战
相关推荐
spring boot环境下的 logback 三种环境即:开发环境、测试环境、生产环境的应用日志的详细配置.
spring boot 配置 maven 配置 项目打包 基本应用 环境的准备
在开发过程中,Spring Boot提供了许多实用的工具和插件,如Maven和Gradle等构建工具,以及IntelliJ IDEA和Eclipse等集成开发环境(IDE)。这些工具可以帮助开发者快速构建、调试和部署应用。同时,Spring
config|[Spring Cloud Alibaba(二)配置中心多项目、多配置文件、分目录实现](https://github.com/smltq/spring-boot-demo/blob/master/cloud-alibaba/README2.md) Sentinel|[Spring Cloud Alibaba(三)Sentinel...
①部署Spring Boot开发环境 ②熟悉Idea工具的使用 ③创建Spring Boot程序 ④单元测试 ⑤配置热部署
Spring Boot 2.x基础教程:2.4版本前后的多环境配置变化 Spring Boot 2.x基础教程:2.4版本前后的分组配置变化 Spring Boot 2.x基础教程:配置元数据的应用 Spring Boot 2.x基础教程:加密配置中的敏感信息 API开发 ...
上面的 N 步和下面的2步形成巨大的反差,这仅仅只是在开发环境搭建的这个方面。 Spring Boot 使测试变得更简单 Spring Boot 对测试的支持不可谓不强大,Spring Boot 内置了7种强大的测试框架: JUnit: 一个 Java ...
Spring Boot 2.0版本以上的...上面的 N 步和下面的2步形成巨大的反差,这仅仅只是在开发环境搭建的这个方面。 Spring Boot 使测试变得更简单 Spring Boot 对测试的支持不可谓不强大,Spring Boot 内置了7种强大的测
- chapter2-1-1:[配置文件详解:自定义属性、随机数、多环境配置等](http://blog.didispace.com/springbootproperties/) ### Web开发 - chapter3-1-1:[构建一个较为复杂的RESTful API以及单元测试]...
基于Spring Boot开发的汽车租赁管理系统,java项目。 eclipse和idea都能打开运行。 推荐环境配置:eclipse/idea jdk1.8 maven mysql 前端技术:vue,Ajax,Json 后端技术:SpringBoot,MyBatis 本系统共分为两个角色...
Spring Boot文件 1.关于文档 2.获得帮助 3.第一步 4.使用Spring Boot 5.了解Spring Boot功能 6.转向生产 7.高级主题 II。入门 8.介绍Spring Boot 9.系统要求 9.1.Servlet容器 10....
《IntelliJ IDEA搭建Spring Boot项目教程.docx》是一份详尽而实用的指南,旨在为开发者提供逐步的步骤,帮助他们在IntelliJ IDEA集成开发环境中高效地创建和搭建Spring Boot项目。这份教程将IntelliJ IDEA和Spring ...
本源码为基于Spring Boot的gomyck-fastdfs-spring-boot-starter设计,共包含56个文件,其中java文件32个,css...该组件可以快速集成fastDFS文件服务,免去繁琐的配置,适用于springboot开发环境,便于开发者快速上手。
主要介绍了Spring Boot 开发环境热部署,本文给大家介绍了Spring Boot 开发环境热部署的原理及快速配置方法,通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
运行环境 jdk8+mysql5.6+IntelliJ IDEA+maven 项目技术(必填) springboot+shiro+mybatis+bootstrap+jquery http://localhost/login admin 123456 注意事项 1.修改application-druid.yml中的db配置 2.修改application...
通过特定的配置方式,Spring Boot使得开发人员不再需要定义样板化的配置,从而提高了开发效率。同时,Spring Boot继承了Spring框架原有的优秀特性,如控制反转(IOC)、面向切面编程(AOP)等,为系统提供了强大的...
适用人群:该教程适合已具备基础Java和Spring Boot开发经验的开发者,尤其是需要快速构建轻量级应用原型,或是希望在单元测试中模拟数据库行为的开发人员。 场景目标:通过集成Spring Boot+Mybatis+H2,可以简化...
Spring Boot整合邮件发送并保存历史发送邮箱 项目描述 项目主要是使用 Spring Boot 发送邮件,主要的技术点有: 1、Spring Boot +mybatis的整合 2、Spring Boot项目中jsp的使用 3、Spring Boot 发送邮件...
所以博主自己开发了一个elastic job 的spring boot starter自动装载模块;目前 该starter已经在公司多个项目生产环境运行。研发只需关注实现job和在application.yml增 加相应配置即可。 模块运行环境: 1.JDK...
通过特定的配置方式,Spring Boot使开发人员能够避免样板化的配置任务,从而更加专注于业务逻辑的实现。这使得理财管理系统能够快速响应市场变化,为用户提供实时的财务信息和投资建议。 而Thymeleaf则是一个适用于...