目录
前言
一、.properties配置文件
1.配置文件目录
2.application.properties中设置应用端口号和上下文访问路径
二、.yml配置文件
1.resources目录下创建配置文件
2.application.yml文件中设置端口号和上下文访问路径
三、多环境配置文件
1.多环境配置文件命名
2.创建多环境配置文件
3.激活环境配置文件
四、SpringBoot自定义配置
1.配置文件中设置自定义配置项
2.@Value读取自定义配置数据
3.将配置文件映射成一个类读取数据
总结
前言
SpringBoot核心配置文件在resources资源目录下,有两种文件格式。第一种是扩展名为.properties,第二种是扩展名为.yml。
一、.properties配置文件
1.配置文件目录
2.application.properties中设置应用端口号和上下文访问路径
控制器以及方法:
1)默认情况下,应用端口是8080,访问路径为空,可在服务器启动日志中查看,如下:
浏览器访问效果
2)application.properties文件中设置端口号和上下文访问路径
#设置端口号 server.port=8082 #设置上下文访问路径 server.servlet.context-path=/myBoot
重新启动,服务器日志如下:
浏览器访问:
二、.yml配置文件
yml格式配置文件形式上类似于json,采用空格和换行的格式进行各种属性的设置。相比于.properties格式的配置文件,yml的数据序列化格式更容易被计算机识别,推荐使用这种方式进行SpringBoot核心配置。
1.resources目录下创建配置文件
2.application.yml文件中设置端口号和上下文访问路径
代码如下(示例):
server:
port: 8083
servlet:
context-path: /boot
重新启动,服务器日志如下:
浏览器访问:
注意:
resources资源目录下同时存在两种格式的配置文件时,优先使用.properties文件
三、多环境配置文件
实际开发中,一个项目往往经历多个阶段才可以完成,从开发到测试再到实施,每个阶段中因为对项目的要求不同,环境不同,项目的配置文件都不同,例如:开发人员和测试人员用的端口号可能就不一样。此时,只存在一个配置文件的话就不够用了,所以需要根据项目所处的开发阶段进行对应的文件配置,以此适应不同的环境。
1.多环境配置文件命名
命名规范:application-环境标识.properties / application-环境标识.yml
application-dev.properties(.yml) ---------------> 开发环境
application-test.properties (.yml) ---------------> 测试环境
application-prod.properties (.yml) ----------------> 生产环境
2.创建多环境配置文件
开发环境下配置文件:application-dev.yml
#设置开发环境端口和上下文server:
server:
port: 8084
servlet:
context-path: /devBoot
生产环境下配置文件:application-prod.yml
#设置生产环境端口和上下文
server:
port: 8085
servlet:
context-path: /prodBoot
测试环境下配置文件:application-test.yml
#设置测试环境端口和上下文server:
server:
port: 8086
servlet:
context-path: /testBoot
3.激活环境配置文件
在主配置文件中激活当前环境下需要使用的配置文件
启动应用,查看服务器日志,以测试环境为例:
浏览器访问:
四、SpringBoot自定义配置
上面的配置中,端口以及上下文路径都是服务器内置的一些配置项。此外,当需要为代码提供一些外部数据时,例如jdbc中关于数据库驱动的一些配置,就可以通过自定义配置在不改变代码的情况下去进行外部数据的实时读取。关于如何读取数据有两种方式,第一种是通过@Value注解直接在控制器里设置属性进行读取;第二种是将整个文件映射成一个类,该类中设置同名的属性进行读取。前者适合自定义配置项少的情况,后者适用于自定义配置项多的情况。
1.配置文件中设置自定义配置项
在application.properties中添加school.name和school.webSite两个自定义配置项
2.@Value读取自定义配置数据
1) 在控制器的属性上使用@Value注解获取自定义属性值
2) 控制器类HelloController中创建查询方法queryData() 输出上述自定义属性值到浏览器
控制器类HelloController:
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
@Controller
public class helloController {
@Value("${server.port}")
private Integer port;
@Value("${server.servlet.context-path}")
private String contextPath;
@Value("${school.name}")
private String name;
@Value("${school.webSite}")
private String webSite;
@RequestMapping("/data")
@ResponseBody
public String queryData(){
return name + ", webSite ="+webSite+", 访问地址是:"+contextPath+", 应用端口是:"+port;
}
}
服务器启动日志:
启动应用,浏览器访问queryData,:
浏览器显示的结果正是控制器中queryData()方法中返回的字符串:
3.将配置文件映射成一个类读取数据
1)创建一个SchoolInfo 类映射配置文件中信息
@ConfigurationProperties(prefix=" ")注解负责将配置项数据映射过来,prefix的字段是自定义项的前缀字段
@Component
@ConfigurationProperties(prefix = "school")
public class SchoolInfo {
private String name;
private String webSite;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getWebSite() {
return webSite;
}
public void setWebSite(String webSite) {
this.webSite = webSite;
}
@Override
public String toString() {
return "SchoolInfo{" +
"name='" + name + ''' +
", webSite='" + webSite + ''' +
'}';
}
}
2)控制器HelloController中创建SchoolInfo引用属性,获取数据
SchoolInfo info:自定义配置项对象引用
@Resource:自动注入引用对象的属性值,规则是先通过byName根据名字查找有没有info这个对象,如果没有就通过byType根据类型查找引用类型是SchoolInfo的对象
3)浏览器访问结果
总结
本文主要讲解SpringBoot的核心配置文件,首先,配置文件的格式分为两种,根据扩展名分为.properties和.yml,其次,根据项目开发的阶段不同,编写不同开发环境下的配置文件,使用时只需要在主配置文件中进行激活即可,最后,根据自定义配置项读取数据的方式不同分为值读取和引用读取,值读取适用配置项少的情况,只要在控制器中添加对应属性即可;引用读取适用配置项多的情况,先在控制器中添加引用对象,然后在引用对象的类中设置自定义配置项的属性即可。



