SpringBoot（二）application.properties配置文件详解

最新推荐文章于 2023-06-04 19:14:41 发布
最新推荐文章于 2023-06-04 19:14:41 发布
阅读量2w 收藏 20
点赞数 7
分类专栏： SpringBoot 文章标签： application.properties配置文件详解
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/yhahaha_/article/details/88568121
版权

目录

新建子工程

.properties配置文件

@Value方式

@ConfigurationProperties方式

配置文件的位置

使用 spring.profiles.active来分区配置

SpringBoot版本：2.1.1

前言

在上篇入门教程中，一点配置文件的影子都没见到，因为Spring Boot使用了特定的方式来进行配置，从而使开发人员不再需要定义样板化的配置。

新建子工程

进入正题，在上次的父工程下新建子工程SpringBoot_PropertiesFile，只记录配置文件的使用，所以这里建的是jar包，在pom文件中就加入spring-boot-starter依赖，官网描述是：核心启动器，包括自动配置支持，日志记录和YAML。

下面是pom文件：

<project xmlns="http://maven.apache.org/POM/4.0.0"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<parent>
		<groupId>com.eastcom</groupId>
		<artifactId>SpringBoot_Demo</artifactId>
		<version>0.0.1-SNAPSHOT</version>
	</parent>
	<artifactId>SpringBoot_PropertiesFile</artifactId>
	
	<dependencies>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter</artifactId>
		</dependency>
	</dependencies>
</project>

.properties配置文件

项目建完了再创建配置文件，在resources下新建application.properties配置文件，在配置文件中你可以用spring.然后快捷键稍微过一眼配置项，这是官网列出来的常用应用属性配置：官网常用应用属性配置。

Spring Boot支持.properties和.yml形式的配置文件，.properties形式配置文件优先级高于.yml形式的配置文件，默认的配置文件是application.properties。

当然你也可以自定义配置项，比如下面这样在配置文件中加三条配置：

那么如何读取配置呢？两种方式分别用到@Value和@ConfigurationProperties这两个注解。

@Value方式

新建java类MyConfiguration_Value，代码如下：

@Component
public class MyConfiguration_Value {
	
	//@Value默认要有配置项，配置项可以为空，若没有配置项要指定默认值，:后的boot为默认值
	@Value("${com.eastcom.name:boot}")
	private String name;
	
	@Value("${com.eastcom.version}")
	private String version;
	
	@Value("${com.eastcom.listName}")
	private List<String> listName;

	public String getName() {
		return name;
	}
	public void setName(String name) {
		this.name = name;
	}
	public String getVersion() {
		return version;
	}
	public void setVersion(String version) {
		this.version = version;
	}
	public List<String> getListName() {
		return listName;
	}
	public void setListName(List<String> listName) {
		this.listName = listName;
	}
	@Override
	public String toString() {
		return "MyConfiguration_Value [name=" + name + ", version=" + version + ", listName=" + listName + "]";
	}
}

注解中放的就是配置项，@Value默认要有配置项，配置项可以为空，若没有配置项要指定默认值，:（冒号）后的boot为默认值。

新建Application主类,代码如下：

@SpringBootApplication
public class Application {
	public static void main(String[] args) {
		ConfigurableApplicationContext context = SpringApplication.run(Application.class, args);
		MyConfiguration_Value myConfiguration_Value = context.getBean(MyConfiguration_Value.class);
		System.out.println(myConfiguration_Value.toString());
		context.close();
	}
}

运行看一下结果，可以看到配置已经读到了。

再试一下@Value的默认值，把name在配置文件中去掉，在运行，可以看到name变成了boot。

@ConfigurationProperties方式

把name重新加上，新建MyConfiguration_Properties类，代码如下：

@Component
@ConfigurationProperties(prefix="com.eastcom")
public class MyConfiguration_Properties {
	
	private String name;
	
	private String version;
	
	private List<String> listName;

	public String getName() {
		return name;
	}
	public void setName(String name) {
		this.name = name;
	}
	public String getVersion() {
		return version;
	}
	public void setVersion(String version) {
		this.version = version;
	}
	public List<String> getListName() {
		return listName;
	}
	public void setListName(List<String> listName) {
		this.listName = listName;
	}
	@Override
	public String toString() {
		return "MyConfiguration_Properties [name=" + name + ", version=" + version + ", listName=" + listName + "]";
	}
	
}

@ConfigurationProperties的prefix属性值是配置项前缀，然后类中的属性名就是配置项的名字，在Application类中添加代码，代码如下：

@SpringBootApplication
public class Application {
	public static void main(String[] args) {
		ConfigurableApplicationContext context = SpringApplication.run(Application.class, args);
		MyConfiguration_Value myConfiguration_Value = context.getBean(MyConfiguration_Value.class);
		System.out.println(myConfiguration_Value.toString());
		
		MyConfiguration_Properties myConfiguration_Properties = context.getBean(MyConfiguration_Properties.class);
		System.out.println(myConfiguration_Properties.toString());

		context.close();
	}
}

再启动项目，输入如下，可以看到两种方式都成功了。

@Value适合配置少单个注入，@ConfigurationProperties适合全量或批量注入。

配置文件的位置

配置文件的位置也可以放到不同的位置，当然，不同的位置配置文件读取的优先级肯定也不同，下面是配置文件可以放置的四个位置，优先级依次从高到低：

  1. file：./config/                项目当前路径下的config子目录
  2. file：./                           项目当前目录
  3. classpath：/config/       类路径下的config目录
  4. classpath：/                  类路径下

在这四个位置新建四个配置文件，然后在项目中看一下这四个位置，图中数字跟上面数字对应。

然后在每一个配置文件中添加一个配置com.eastcom.index,值跟图中的数字对应，分别是1，2，3，4。另外我把每个配置文件中都加上了上面的三个自定义配置，并把版本号稍微改成跟顺序对应。如下：

在Application类添加代码，如下：

@SpringBootApplication
public class Application {
	public static void main(String[] args) {
		ConfigurableApplicationContext context = SpringApplication.run(Application.class, args);
		MyConfiguration_Value myConfiguration_Value = context.getBean(MyConfiguration_Value.class);
		System.out.println(myConfiguration_Value.toString());
		
		MyConfiguration_Properties myConfiguration_Properties = context.getBean(MyConfiguration_Properties.class);
		System.out.println(myConfiguration_Properties.toString());
		
		System.out.println(context.getEnvironment().getProperty("com.eastcom.index"));
		context.close();
	}
}

控制台输出信息：

很明显，读取的是项目当前路径下的config子目录中的配置，其余的就不一一试了。

使用 spring.profiles.active来分区配置

上一篇博客中有讲到spring-boot-starter-parent提供的特性，其中就包括能够识别application.properties和application.yml类型的文件，同时也能支持profile-specific类型的文件（例如： application-dev.properties 和 application-dev.yml，这个功能可以更好的配置不同生产环境下的配置文件)。
新建三个配置文件，分别为application-dev.properties（开发）、application-test.properties（测试）、application-prod.properties（生产）。

可以使用spring.profile.active配置项在application.properties配置文件中指定哪些配置文件处于活动状态，可以指定多个。

新建一个配置类MyActiveProfileConfig等会要用，代码如下：

@Configuration
public class MyActiveProfileConfig {
	
	@Bean
	public Runnable create() {
		System.out.println("default");
		return ()->{};
	}	
	@Bean
	@Profile("dev")
	public Runnable createDev() {
		System.out.println("dev");
		return ()->{};
	}
	@Bean
	@Profile("prod")
	public Runnable createProd() {
		System.out.println("prod");
		return ()->{};
	}
	@Bean
	@Profile("test")
	public Runnable createTest() {
		System.out.println("test");
		return ()->{};
	}
}

@Profile("dev")表示只有当启动的配置是开发环境的配置是才创建这个bean，@Profile也可以放在类上，意思是一样的，只有当启用某个配置文件是才去创建这个配置类中的bean。

为了跟上面说的分开，再重新创个主类AppActiveProfile吧，强迫症，全混一起感觉太乱了。代码如下：

@SpringBootApplication
public class AppActiveProfile {
	public static void main(String[] args) {
		SpringApplication application = new SpringApplication(AppActiveProfile.class);
//		application.setAdditionalProfiles("dev","prod");
		ConfigurableApplicationContext context = application.run(args);
		context.close();
	}
}

运行看打印信息。上面我设置启用的是dev和test，可以看到已经启用了，@Profile注解是生效了的。

当然你还可以通过代码设置启用哪些配置文件，把AppActiveProfile类中注释的代码取消注释，setAdditionalProfiles(String... profiles)方法同样可以设置多个值，参数是String，...表示可以有多个,自行去尝试。

至此，Sping Boot 配置文件就讲完了，有不足或者错误的地方欢迎指正。

项目源码：https://github.com/AiHePing/SpringBoot_Demo

 

天黑黑～
关注
专栏目录
深入解析Spring Boot的application.yml配置文件
fudaihb的博客
07-09 1825
Spring Boot应用程序的配置文件用于定义应用程序的各种属性，是其中一种常见的格式。文件采用YAML（Yet Another Markup Language）格式，具有简洁、易读的特点。开发者可以在文件中定义自定义的配置属性，并在代码中使用@Value注解或配置类来读取这些属性。myapp:feature:本文深入探讨了Spring Boot中配置文件的使用，包括基本结构、常见配置、环境配置、高级技巧等内容。
05全局配置文件application.properties详解
m0_54861649的博客
07-29 3205
SpringBoot提供了大量的自动配置，极大地简化了spring应用的开发过程，当用户创建了一个SpringBoot项目后，即使不进行任何配置，该项目也能顺利的运行起来。当然，用户也可以根据自身的需要使用配置文件修改SpringBoot的默认设置。SpringBoot默认使用以下2种全局的配置文件，其文件名是固定的。......
Spring-Boot (二) application.properties配置文件内容
热门推荐
t0m的专栏
11-10 7万+
Spring-Boot官方开发指导文档 默认创建spring-boot项目后，会在resources目录下生成一个空的application.properties配置文件，springboot启动时加载该配置文件。 application.properties(或者application.yml)中包含系统属性、环境变量、命令参数这类信息。 下面简要说一部分spring-boot项目中a
application.properties 之配置大全
10-04
application.properties 之配置大全---- application.properties 之配置大全
springboot项目application.properties配置文件摘抄
jlc1330JLC的博客
10-10 807
＃SPRING CONFIG（ConfigFileApplicationListener） spring.config.name =＃配置文件名（默认 为 'application' ） spring.config.location =＃配置文件的位置 ＃ 多环境配置文件激活属性 spring.profiles.active=dev ＃加载application-dev.properties配置文件内容 application-dev.properties： ＃开发环境.
application.properties配置文件
世间本无路，恒走坦途出
10-19 4051
首先，得保证你读取配置的类是spring组件，不行你加个 @Component 注解将其变成组件yml里的配置test:读取类其中，@Value("${test.key1:fileName}")代表默认值为fileName，有个兜底值。如果是静态变量，那么就麻烦些，使用set方法赋值}}
Spring Boot （六）——详解配置文件 application.properties
云中、漫步的博客
01-01 1322
详解配置文件 application.properties 在 Spring Boot 中，配置文件有两种不同的格式，一个是 properties ，另一个是 yaml 。 虽然 properties 文件比较常见，但是相对于 properties 而言，yaml 更加简洁明了，而且使用的场景也更多，很多开源项目都是使用 yaml 进行配置（例如 Hexo）。除了简洁，yaml 还有另外一个特点，...
Spring Boot Application.properties和yaml配置文件
梁辰兴的博客
06-04 5637
全局配置文件能够对一些默认配置值进行修改。Spring Boot使用一个application.properties或者application.yaml的文件作为全局配置文件，该文件存放在src/main/resource目录或者类路径的/config，一般会选择resource目录。
最全的springboot之application.properties配置文件详解
Demon丶冷漠
01-04 2518
为方便自己使用，在全网找的最全的application.properties配置文件详解，需要的时候可以来这里找一下配置！ 目录 1.网友的配置 2.王军伟老师的总结 1.网友的配置 # REDIS (Redis 配置) # 连接工厂使用的数据库索引 spring.redis.database= 0 # Redis服务器主机 spring.redis.host= # redis服务器端口 spring.redis.port= 6379 # 登录redis服务器的密码 spring.redis..
application.properties
07-24
springboot该项目配置文件，application.properties，需要的可以参考一下，需要springboot前后端分离，增删改查项目的可以私聊我
SpringBoot中 application.yml /application.properties常用配置介绍
zhukaixin_的博客
08-21 1969
SpringBoot中 application.yml /application.properties常用配置介绍 项目中常见配置： 服务端口 服务名称 容器： 类型 如tomcat、undertow 程池大小 请求日志和目录 连接池配置： sql连接配置 info配置： 模板配置 资源配置 # Tomcat server: tomcat: uri-encoding...
application.properties 的配置信息
qq_39879632的博客
08-17 720
# =================================================================== # COMMON SPRING BOOT PROPERTIES # # This sample file is provided as a guideline. Do NOT copy it in its # entirety to your own ap...
application.properties文件配置
lb812383331的专栏
08-11 160
除了做一些基础的配置外，还可以配置绑定类的属性值 application.properties server.port=8888 # 配置person的值 person.age=20 person.birthday=2020/2/3 person.boss=true person.name=张三 person.dog.name=gougou person.dog.age=19 person.lists=1,2,3 person.maps.k1=v1 person.maps.zhang=12 基本
SpringBoot2.2.x（四）配置文件
lizc_lizc的博客
04-11 294
本系列文章都是基于SpringBoot2.2.5.RELEASE application.properties SpringBoot启动时，默认会加载application.properties作为默认的配置文件。默认从下面四个路径去加载，优先级从高到底，优先级高的会覆盖优先级低的。maven会将resources目录下的文件打包到classpath目录下。 工程目录/config/applic...
【Spring Boot】application.properties参数配置
韩旭051的博客
03-11 2287
springboot 约定大于配置 官方文档 https://docs.spring.io/spring-boot/docs/current/reference/html/appendix-application-properties.html application.properties参数详解 参考这两篇博客 用的时候直接在 这篇文章 里 Ctrl+F 搜索就行了 不用去官方文档查了 https://www.cnblogs.com/javaGoGo/p/10125359.html https://blo
application.properties配置双
最新发布
08-18
application.properties配置文件可以同时被application.yaml配置文件覆盖。在使用application.yaml配置文件进行测试时，需要将application.properties配置文件中的配置注释掉，以确保application.properties不会覆盖application.yaml的配置。<span class="em">1</span><span class="em">2</span><span class="em">3</span> #### 引用[.reference_title] - *1* *3* [SpringBoot（二）application.properties配置文件详解](https://blog.csdn.net/yhahaha_/article/details/88568121)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_2"}}] [.reference_item style="max-width: 50%"] - *2* [application.properties配置文件](https://blog.csdn.net/weixin_39654465/article/details/114203790)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_2"}}] [.reference_item style="max-width: 50%"] [ .reference_list ]
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值