关于springboot配置详解

spring boot有默认配置，但是一般情况下满足不了我们项目的需要，所以后续需要我们自定义配置

一、配置文件

配置文件，主要用于配置全局配置，包括server端口，数据库连接(可配多个)，日志，spring的配置等

1、配置文件类型

配置文件严格区分大小写

1.1：application.properties

spring boot默认的配置文件类型，语法为一组键值对，这种类型的配置文件在需要修改大量spring boot默认配置时，不推荐(可以理解为配置越多，后续如果需要修改添加时，存在⼀定的冗余数据)

server.port=8080 
server.tomcat.url-encoding=UTF-8

1.2：application.yml

spring boot配置文件的另一种类型，类似 json 格式的 树形配置⽅式进⾏配置的，yml 层级之间使⽤换⾏缩进的⽅式配置，key 和 value 之间使⽤“: ”英⽂ 冒号加空格的⽅式设置，并且空格不可省略。yml 通⽤性更好，⽀持更多语⾔，

server:
  port: 8080
  tomcat:
    uri-encoding: UTF-8

对象，Map，键值对的写法(k: v)

1.2.1：默认

server:
  port: 8080
  tomcat:
    uri-encoding: UTF-8

1.2.2：行内写法

server: {port: 8080,tomcat: {uri-encoding: UTF-8}}

数组（List、Set）的写法

1.3.1：默认

age:
    - 18
    - 19
    - 20

1.3.2：行内写法

age:[18,19,20]

值(value)的写法说明

1.4.1：默认

        默认value可以不加""或''

1.4.2：使用'value'

        单引号不处理转义字符，转义字符最终只是一个普通的字符串数据

1.4.3：使用"value"

        双引号处理转义字符

总结

理论上允许两个文件都存在，但是不建议

如果两个文件都存在，如果properties文件不存在某个配置，而yml中存在，则会引用yml中的文件，如果两个都存在，默认使用properties中的配置

2、读取配置文件

server:
  port: 8080
  tomcat:
    uri-encoding: UTF-8

2.1：使用 @Value 读取配置文件

@Data
@Component
public class Test{
    @Value(value = "${server.port}")
    public String port;
}

@RestController
@RequestMapping
public class TestController{
    @Autowired
    Test test;
    @GetMapping("/port")
    public String ports() {
        return test.getPort();
    }
}

2.2：使用 @ConfigurationProperties 读取配置文件

@Data
@Component
@ConfigurationProperties(prefix = "server")
public class Test{
    public String port;
}

@RestController
@RequestMapping
public class TestController{
    @Autowired
    Test test;
    @GetMapping("/port")
    public String ports() {
        return test.getPort();
    }
}

2.3：使用 Environment 读取配置文件

@RestController
@RequestMapping
public class TestController{
    @Resource
    private Environment enviroment;
    @GetMapping("/port")
    public String ports() {
        return enviroment.getProperty("server.port");
    }
}

2.4：使用 @PropertySource 读取配置文件

@Data
@Component
@PropertySource("classpath:application.yml")
public class Test{
    @Value(value = "${server.port}")
    public String port;
}

@RestController
@RequestMapping
public class TestController{
    @Autowired
    Test test;
    @GetMapping("/port")
    public String ports() {
        return test.getPort();
    }
}

2.5：使用原生方式读取配置文件

@Controller
@ResponseBody
public class TestController{

    @RequestMapping("/port")
    public void port() {
        Properties properties = new Properties();
        InputStreamReader inputStreamReader = new InputStreamReader(
            this.getClass().getClassLoader().getResourceAsStream("application.properties"),
                StandardCharsets.UTF_8
        );
        try {
            properties.load(inputStreamReader);
        } catch (IOException e) {
            e.printStackTrace();
        }
        System.out.println(properties.getProperty("server.port"));
    }
}

3、常用配置详细说明

3.1：server(嵌入式服务器配置（服务器属性）)

server:
  port: 8081#自定义端口号
  servlet:
      context-path: /项目名#配置项目的访问路径

参考：SpringBoot 配置文件详解      SpringBoot配置文件讲解