一.配置文件的作用
配置文件是非常重要的,整个项目中所有的重要数据都是在配置文件中进行配置的例如:
- 数据库的连接信息(用户名和密码的设置);
- 项目启动的端口;
- 第三方系统调用的秘钥信息;
- 可以发现和定位问题的普通日志和异常日志等(日志的级别和持久化);
如果没有配置文件的话,这些信息就无法进行配置了,数据库无法连接,日志无法查看等这些问题都是对于Spring Boot项目非常关键的,因此配置文件是特别重要的!
二.配置文件的格式
配置文件的分类一般是:
- 系统的配置文件(系统定义好的),如连接字符串,日志的相关设置;
- 用户自己定义的;
而Spring Boot的配置文件主要有两种格式:
- .properties
- .yml
就是这样的两种格式,而且这里也一定要这么写,不然也是会报错的(约定大于配置),在这两个里面都是可以进行相关配置文件的设置的,两种格式只是不同时间的产物罢了,另外两种格式的写法也是不同的,这个下面会有相关的介绍,而且这两种格式也是可以并存的,如果两个都配置了,这里的配置会采用properties里面的配置,而忽略yml里面的配置,因此不建议同时使用两种格式再同一个项目中!
三.properties配置文件的说明
properties配置文件是更早期的配置文件格式,也是Spring Boot项目默认的配置文件,下面就具体介绍一下properties配置文件:
1.properties基本语法
在properties里面是以键值对为主的(key=value),类似于
这样的格式(中间不要写空格,也不要写多余的空格)
如果是自定义的配置文件的话,也是key=value的形式,而这是需要自己写的,如果要读取这个文件也只能使用自己定义的key值来得到value值!
2.读取配置文件
同样也是使用注解就可以解决这个问题,这里使用@Value注解以及${}的格式就可以进行读取了:
@Controller
public class Test {
@Value("${server.port}") //读取配置项
private String port;
@ResponseBody //返回一个非静态页面的数据
@RequestMapping("/func") //设置路由地址
public String func(){
return "port: " + port;
}
}
然后通过页面搜索http://localhost:8080/func就看有观察到读取到的端口号了:
而使用@Value是只能读取一个配置文件的话,如果想读取多个的话,需要多写几个@Value标签就可以了
3.properties的缺点
在properties里面是采用key=value的形式,而如果是同一key下的value,就需要把此key值重复来写,这就显得非常冗余了
而想要解决这个问题就需要使用yml配置文件了
四.yml配置文件的说明
yml是另一种格式的配置文件,yml 是⼀个可读性⾼,易于理解,⽤来表达数据序列化的格式,yml的语法和高级语言非常类似,而yml最大的优势是可以跨语言,像python,golang都可以使用yml作为配置⽂件。下面具体介绍一下yml配置文件:
1.yml基本语法
在yml里面的基本语法是:key: value,注意key和value之间需要英文冒号加空格,其中的空格也是不可省略的,类似
这样的语法再写上面的连接数据库配置的话,就方便很多了:
补充:yml中关于单、双引号的问题:yml中如果使用了双引号就会按照(原)语义执行,如果不加,或者加了单引号,那么默认就会将字符串中的特殊字符进行转义,比如\n -> \n(转义)处理。
2.读取配置文件
yml配置文件的读取方式也是和properties一样的,都是使用@Value注解加${}的格式,这里就不演示了,下面来看一下yml不一样的地方!
3.配置对象
在yml里面还是可以配置对象的:
另外也可以使用行内写法:
而想要读取到这个对象的话就不能再使用@Value注解了,这里需要借助@ConfigurationProperties来读取:
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
@Data
@ConfigurationProperties(prefix = "student") //读取配置文件的对象
@Component
public class Student {
private int id;
private String name;
private int age;
}
然后读取对象,就可以直接进行注入了:
@Controller
public class Test {
@Autowired
private Student student;
@ResponseBody
@RequestMapping("/getstudent")
public String getStudent(){
return "student: " + student;
}
}
然后通过浏览器搜索http://localhost:8080/getstudent就可以得到对象内容了:
4.配置集合
在yml里面也是可以配置集合的:
同样行内写法也是可以的:
而要获取到集合的话,和获取对象是差不多的,也是通过@ConfigurationProperties来获取:
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
import java.util.List;
@Data
@ConfigurationProperties(prefix = "dbtypes")
@Component
public class ListConfig {
private List<String> name;
}
读取集合:
@Controller
public class Test {
@Autowired
private ListConfig listConfig;
@ResponseBody
@RequestMapping("/getlist")
public String getList(){
return "name:" + listConfig.getName();
}
}
然后通过浏览器搜索http://localhost:8080/getlist就可以得到对象内容了:
五.properties和yml的区别
- properties是以key=value的形式配置的键值对类型配置文件,而yml是以key: value的形式配置的键值对类型配置文件;
- properties是早期且系统默认的配置文件格式,但配置存在一定的冗余数据,而yml可以更好的解决数据冗余问题;
- yml通用性更好,支持多语言;
- yml支持更多的数据类型;
到此这篇关于Spring Boot详解配置文件有哪些作用与细则的文章就介绍到这了,更多相关Spring Boot配置文件内容请搜索编程网以前的文章或继续浏览下面的相关文章希望大家以后多多支持编程网!