Spring Boot 初级入门教程(六) —— 添加配置文件 *.properties 及常用配置的使用(附源码)
2018年07月24日 21:17:20 SpringBoot ⁄ 共 6124字 暂无评论 ⁄ 被围观 984次

Spring Boot 使用了一个全局的配置文件 application.properties,放在 src/main/resources 目录下或者类路径的 /config 下。Sping Boot的全局配置文件的作用是对一些默认配置的配置值进行修改。

一、添加 application.properties 文件。

添加后目录结构如下图:

注意:开发过程中,尽量把配置文件的编码设置为 UTF-8,这样中文不会出现乱码,便于添加注释。

二、常用常量配置

application.properties 提供自定义属性的支持,这样可以把一些应用中用到的常量配置在该文件中,内容如下:

#################################
## 常量值配置
#################################
com.mll.constant.val.name=zhangsan
com.mll.constant.val.age=20
# 参数间直接引用
com.mll.constant.val.str=${com.mll.constant.val.name}'s age is ${com.mll.constant.val.age}.

新建一个常量值测试类 ConstantController.java,代码如下:

  1. package com.menglanglang.test.springboot.controller;  
  2.   
  3. import org.springframework.beans.factory.annotation.Value;  
  4. import org.springframework.web.bind.annotation.RequestMapping;  
  5. import org.springframework.web.bind.annotation.RestController;  
  6.   
  7. /** 
  8.  * @desc Controller常量类 
  9.  * 
  10.  * @author 孟郎郎 
  11.  * @blog http://blog.csdn.net/tzhuwb 
  12.  * @version 1.0 
  13.  * @date 2018年7月24日下午7:15:42 
  14.  */  
  15. @RestController  
  16. @RequestMapping("/cfg")  
  17. public class ConstantController {  
  18.   
  19.     // 常量值配置name  
  20.     @Value(value = "${com.mll.constant.val.name}")  
  21.     public String name;  
  22.   
  23.     // 常量值配置age  
  24.     @Value("${com.mll.constant.val.age}")  
  25.     private String age;  
  26.       
  27.     // 常量值互相应用  
  28.     @Value("${com.mll.constant.val.str}")  
  29.     private String str;  
  30.   
  31.     @RequestMapping("/outStr1")  
  32.     public String printOutStr1() {  
  33.         String outStr1 = "name = " + name + ", age = " + age;  
  34.         return outStr1;  
  35.     }  
  36.       
  37.     @RequestMapping("/outStr2")  
  38.     public String printOutStr2() {  
  39.         return str;  
  40.     }  
  41.   
  42. }  

启动程序,浏览器访问 http://localhost:8080/cfg/outStr1,则返回如下结果:

访问 http://localhost:8080/cfg/outStr2,则返回如下:

如果属性过多,也可以使用实体封装这些属性值。但需要在 pom.xml 文件中新加一个依赖包,代码如下:

		<!-- 添加 Spring Boot 配置文件依赖包 -->
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-configuration-processor</artifactId>
			<version>2.0.2.RELEASE</version>
			<optional>true</optional>
		</dependency>

新建源码包 entity,在其中新建实体类 PeopleInfo,内容如下:

  1. package com.menglanglang.test.springboot.entity;  
  2.   
  3. import org.springframework.boot.context.properties.ConfigurationProperties;  
  4. import org.springframework.stereotype.Component;  
  5.   
  6. /** 
  7.  * @desc 人实体信息 
  8.  * 
  9.  * @author 孟郎郎 
  10.  * @blog http://blog.csdn.net/tzhuwb 
  11.  * @version 1.0 
  12.  * @date 2018年7月24日下午8:05:11 
  13.  */  
  14. @ConfigurationProperties(prefix = "com.mll.constant.val")  
  15. @Component  
  16. public class PeopleInfo {  
  17.   
  18.     /** 
  19.      * 姓名 
  20.      */  
  21.     private String name;  
  22.   
  23.     /** 
  24.      * 年龄 
  25.      */  
  26.     private String age;  
  27.   
  28.     public String getName() {  
  29.         return name;  
  30.     }  
  31.   
  32.     public void setName(String name) {  
  33.         this.name = name;  
  34.     }  
  35.   
  36.     public String getAge() {  
  37.         return age;  
  38.     }  
  39.   
  40.     public void setAge(String age) {  
  41.         this.age = age;  
  42.     }  
  43.   
  44. }  

在需要使用时,直接注入实体类即可。

	@Autowired
	private PeopleInfo peopleInfo;
	
	@RequestMapping("/outStr3")
	public String printOutStr3() {
		String outStr3 = "Name = " + peopleInfo.getName() + ", Age = " + peopleInfo.getAge();
		return outStr3;
	}

访问 http://localhost:8080/cfg/outStr3,则返回如下:

注意:如果有以下错误,说明实体在程序启动时,没有注入。

  1. 2018-07-24 21:25:57,938 INFO (DirectJDKLog.java:180)- Stopping service [Tomcat]  
  2. 2018-07-24 21:25:57,951 INFO (ConditionEvaluationReportLoggingListener.java:101)-   
  3.   
  4. Error starting ApplicationContext. To display the conditions report re-run your application with 'debug' enabled.  
  5. 2018-07-24 21:25:58,108 ERROR (LoggingFailureAnalysisReporter.java:42)-   
  6.   
  7. ***************************  
  8. APPLICATION FAILED TO START  
  9. ***************************  
  10.   
  11. Description:  
  12.   
  13. Field peopleInfo in com.menglanglang.test.springboot.controller.ConstantController required a bean of type 'com.menglanglang.test.springboot.entity.PeopleInfo' that could not be found.  
  14.   
  15.   
  16. Action:  
  17.   
  18. Consider defining a bean of type 'com.menglanglang.test.springboot.entity.PeopleInfo' in your configuration.  

方法一:在项目入口类 App.java 中添加注解 @EnableConfigurationProperties({PeopleInfo.class}),如图:

方法二:在实体类上,添加注解 @Component,如图:

一般使用方法二注入实体,便于维护。方法一在实体信息很多的情况下,则多而乱,不便于维护。

三、使用自定义的配置文件。

Spring Boot 默认读取的配置文件名为 application.properties,所以新建后不用做任何其他文件名配置就可以获取文件中的配置内容,而很多情况下,如果需要自己定义一个配置文件,比如 test.properties,那么如何读取该文件中的配置。

比如 test.properties 的内容如下:

#################################
## 测试配置文件
#################################
# 测试字符串,自定义属性,可以在Controller中读取
com.mll.constant.val.test1=Hello Test String

在 entity 包中自定义测试实体类 TestInfo,代码如下:

  1. package com.menglanglang.test.springboot.entity;  
  2.   
  3. import org.springframework.boot.context.properties.ConfigurationProperties;  
  4. import org.springframework.context.annotation.Configuration;  
  5. import org.springframework.context.annotation.PropertySource;  
  6.   
  7. /** 
  8.  * @desc 测试实体类 
  9.  * 
  10.  * @author 孟郎郎 
  11.  * @blog http://blog.csdn.net/tzhuwb 
  12.  * @version 1.0 
  13.  * @date 2018年7月24日下午8:45:47 
  14.  */  
  15. @Configuration  
  16. @PropertySource("classpath:test.properties")  
  17. @ConfigurationProperties(prefix = "com.mll.constant.val")  
  18. public class TestInfo {  
  19.   
  20.     /** 
  21.      * 测试1 
  22.      */  
  23.     private String test1;  
  24.   
  25.     public String getTest1() {  
  26.         return test1;  
  27.     }  
  28.   
  29.     public void setTest1(String test1) {  
  30.         this.test1 = test1;  
  31.     }  
  32.   
  33. }  

在需要使用时,直接注入实体类即可。

	@Autowired
	private TestInfo testInfo;

	@RequestMapping("/outStr4")
	public String printOutStr4() {
		String outStr4 = "test1 = " + testInfo.getTest1();
		return outStr4;
	}

访问 http://localhost:8080/cfg/outStr4,则返回如下:

注意:使用新版本 springboot,使用上面的配置,如果是 1.5 之前的版本,则实体类中,注解方式如下:

  1. package com.menglanglang.test.springboot.entity;  
  2.   
  3. import org.springframework.boot.context.properties.ConfigurationProperties;  
  4. import org.springframework.context.annotation.Configuration;  
  5. import org.springframework.context.annotation.PropertySource;  
  6. import org.springframework.stereotype.Component;  
  7.   
  8. /** 
  9.  * @desc 测试实体类 
  10.  * 
  11.  * @author 孟郎郎 
  12.  * @blog http://blog.csdn.net/tzhuwb 
  13.  * @version 1.0 
  14.  * @date 2018年7月24日下午8:45:47 
  15.  */  
  16. @ConfigurationProperties(locations = "classpath:test.properties", prefix = "com.mll.constant.val")  
  17. @Component  
  18. public class TestInfo {  
  19.   
  20.     /** 
  21.      * 测试1 
  22.      */  
  23.     private String test1;  
  24.   
  25.     public String getTest1() {  
  26.         return test1;  
  27.     }  
  28.   
  29.     public void setTest1(String test1) {  
  30.         this.test1 = test1;  
  31.     }  
  32.   
  33. }  

最后附上当前源码,源码中有点小改动,就是把两个配置文件都放在了 /config 目录下,当前目录结构如下:

源码下载:https://pan.baidu.com/s/10Awe7p1Ss9uRCKJNr-f0vg

给我留言

留言无头像?