• SpringBoot 配置文件

    ✏️作者：银河罐头
    📋系列专栏：JavaEE

    🌲“种一棵树最好的时间是十年前，其次是现在”

    目录

    配置文件的作用

    整个项目的重要数据都是在配置文件中配置的。

    1.数据库的连接信息。(包括用户名和密码的设置)

    2.项目的启动端口。

    3.第三方系统的调用密钥等信息。

    4.用于发现和定位问题的普通日志和异常日志。

    SpringBoot 内置 Tomcat 端口号默认是8080

    配置文件的格式

    .properties

    .yml

    properties类型的配置文件相对于 yml 来说相当于是老款的，properties 是 创建 Spring Boot 项目的默认文件格式。

    理论上说properties 和 yml 可以同时存在于一个 Spring Boot 项目中，但实际的业务中，我们通常会采取一种统一的配置文件格式，这样可以更好地维护(降低故障率)。

    • 那如果 properties 和 yml 中给同一个属性配置了不同的端口号，那么该听谁的？

    那么这个时候会以 properties 中的配置为主，也就是 .properties 配置⽂件的优先级最⾼.

    properties 配置⽂件说明

    properties 基本语法

    properties 是以键值对的形式配置的，key 和 value 之间用 " = " 连接。

    # 配置项⽬端⼝号 
server.port=8084
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/testdb?characterEncoding=
utf8
spring.datasource.username=root
spring.datasource.password=root

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 配置项分类：

    1.系统配置项

    比如：server.port/spring.datasource.url

    2.用户自定义配置项(非系统配置项)

    key - > 用户自定义.

    image-20230510164442419

    properties 这里的字符集显示"灰色"，此处不能修改。而 yml 字符集显示"白色"，此处可以修改。

    当前 .properties 不支持 中文， .yml 支持中文.

    image-20230510164816619

    在 settings 修改下字符集配置就可以了。

    注意要把当前和新项目的字符集配置都要修改。

    • 通过配置文件修改项目端口号

    1).properties 中修改端口号

    # 设置项目的端口号
server.port=9090

    • 1
    • 2

    在 .properties 配置文件里把端口号改了之后，再次启动 Spring Boot,

    image-20230510165849570

    image-20230510165909584

    2).yml 中修改端口号

    此时先把 .properties 中的端口号注释掉，然后在 .yml 中配置新的端口号。

    # 设置项目端口号
server:
  port: 9999

    • 1
    • 2
    • 3

    注意 .yml 配置项书写格式和 .properties 不同

    再次启动 Spring Boot

    image-20230510170456972

    此时如果把 .properties 中的端口号也设置上，再次启动 Spring Boot

    image-20230510190441744

    会以 .properties 中的端口号为准。

    注意每次修改了代码，要把 Spring Boot 重新启动

    读取配置文件

    在项目中，想要主动的读取配置文件的内容，可以用 @Value 来实现.(properties, yml)

    .properties:

    # 设置项目的端口号
server.port=9090
# 用户自定义配置项
name = zhangSan

    • 1
    • 2
    • 3
    • 4
    package com.example.demo;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

@Controller
@ResponseBody
public class TestController {
    @Value("name")
    private String myConfig;
    
    @RequestMapping("/sayHi")
    public String sayHi(){
        return "hello world -> " + myConfig;
    }
}

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17

    预期结果是 hello world -> zhangSan, 但实际结果：

    image-20230510192559773

    why???

    @Value("name")
private String myConfig;
//和 "属性注入" 有点类似
//意思是 把 "name" 这个字符串赋值给 myConfig;
//而我想要的效果是把 "name" 这个 key 对应的 value 赋值给 myConfig;

    • 1
    • 2
    • 3
    • 4
    • 5

    @Value 注解使用 “${}” 的格式读取。

    @Value("${name}")

    • 1

    再次启动 Spring Boot

    image-20230510193225192

    如果@Value 注解里写的是配置文件里 不存在的 key，结果会怎样？

    @Value("${lisi}")

    • 1

    image-20230510193434203

    properties 优缺点

    优点：

    1.系统默认的配置文件

    2.properties 配置项的优先级比 yml 优先级高

    3.格式简单，不容易出错

    缺点：

    写法比较冗余

    spring.datasource.url=jdbc:mysql://127.0.0.1:3306/testdb?characterEncoding=
utf8
spring.datasource.username=root
spring.datasource.password=root
//3个配置项里面都有重复的部分"spring.datasource"

    • 1
    • 2
    • 3
    • 4
    • 5

    yml 配置文件说明

    yml 是 YAML 是缩写，它的全称 Yet Another Markup Language 翻译成中⽂就是“另⼀种标记语言”。

    yml 优点分析：

    1.yml 支持更多的编程语言，它不⽌是 Java 中，可以使⽤在 Golang、PHP、Python、Ruby、 JavaScript、Perl 中。

    2.可读性高，写法简单, 相比较于 properties 来说写法更加简洁。

    3.支持更多的数据类型，它可以简单表达数组、散列表，标量等数据形态。

    yml 基本语法

    yml 是树形结构的配置⽂件，它的基础语法是“key: value”，注意 key 和 value 之间使⽤英文冒号加空格的⽅式组成的，其中的空格不可省略。

    image-20230510205013523

    spring:
  datasource:
 	url: jdbc:mysql://127.0.0.0:3306/dbname?characterEncoding=utf8
    username: root
    password: root

    • 1
    • 2
    • 3
    • 4
    • 5

    yml 支持不同数据类型

    # 字符串
string.value: Hello
# 布尔值，true或false
boolean.value: true
boolean.value1: false
# 整数
int.value: 10
int.value1: 0b1010_0111_0100_1010_1110 # ⼆进制
# 浮点数
float.value: 3.14159
float.value1: 314159e-5 # 科学计数法
# Null，~代表null
null.value: ~

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13

    注意事项：value 值加单双引号

    字符串默认不⽤加上单引号或者双引号，如果加英⽂的单双引号可以表示特殊的含义。 尝试在 application.yml 中配置如下信息：

    myStr1: 你\n好
myStr2: '你\n好'
myStr3: "你\n好"

    • 1
    • 2
    • 3

    读取程序实现代码如下：

    package com.example.demo;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import javax.annotation.PostConstruct;

@Controller
@ResponseBody
public class TestController {
    
    @Value("${myStr1}")
    private String myStr1;

    @Value("${myStr2}")
    private String myStr2;

    @Value("${myStr3}")
    private String myStr3;

    @PostConstruct
    public void doPostConstruct(){
        System.out.println("-----------------------------");
        System.out.println(myStr1);
        System.out.println(myStr2);
        System.out.println(myStr3);
        System.out.println("-----------------------------");
    }
}

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    • 23
    • 24
    • 25
    • 26
    • 27
    • 28
    • 29

    image-20230510210800915

    从上述结果可以看出：

    字符串默认不加单引号或双引号。

    加单引号之后会转义字符串中的特殊字符，特殊字符最终只是一个普通的字符串数据。

    加双引号之后不会转义字符串中的特殊字符，特殊字符最终原意输出。

    配置对象

    student:
  id: 1
  name: 张三
  age: 18

    • 1
    • 2
    • 3
    • 4
    @Value("${student.name}")
private String name;

    • 1
    • 2

    这样只能读取一个类的一个属性，如果我这个类里面有100个甚至更多的属性呢，也要写这么多行代码吗？有没有办法能够读取到这个对象？

    这个时候就不能⽤ @Value 来读取配置中的对象了，此时要使⽤另⼀个注解 @ConfigurationProperties 来读取，具体实现如下：

    package com.example.demo.entity;

import lombok.Getter;
import lombok.Setter;
import lombok.ToString;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

@ConfigurationProperties("student")
@Component
@Setter
@Getter
@ToString
public class StudentComponent {
    private int id;
    private String name;
    private int age;
}

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    package com.example.demo.controller;
import com.example.demo.entity.StudentComponent;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.ResponseBody;

import javax.annotation.PostConstruct;

@Controller
@ResponseBody//可以修饰类也可以修饰方法，表示返回的是非静态页面的数据
public class TestController {
    @Autowired
    private StudentComponent studentComponent;
    
    @PostConstruct
    public void doPostConstruct(){
        System.out.println(studentComponent);
    }
}

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20

    image-20230510213946196

    配置集合

    dbtypes:
  name:
    - mysql
    - sqlserver
    - db2

    • 1
    • 2
    • 3
    • 4
    • 5

    行内写法：

    dbtypes: {name: [mysql, sqlserver, db2]}

    • 1
    @Component
@ConfigurationProperties("dbtypes")
@Setter
@Getter
@ToString
public class ListConfig {
    private List<String> name;
}

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    @Controller
public class TestController {

    @Autowired
    private ListConfig listConfig;

    @PostConstruct
    public void doPostConstruct(){
        System.out.println(listConfig);
    }
}

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11

    image-20230511091241838

    properties VS yml

    1.properties 是以 key=value 的形式配置的键值类型的配置⽂件，⽽ yml 使⽤的是类似 json 格式的 树形配置⽅式进⾏配置的，yml 层级之间使⽤换⾏缩进的⽅式配置，key 和 value 之间使⽤“: ”英⽂冒号加空格的⽅式设置，并且空格不可省略。

    2.properties 为早期并且默认的配置⽂件格式，但其配置存在⼀定的冗余数据，使⽤ yml 可以很好的 解决数据冗余的问题。

    3.yml 通⽤性更好，⽀持更多语⾔，如 Java、Go、Python 等，如果是云服务器开发，可以使⽤⼀份 配置⽂件作为 Java 和 Go 的共同配置⽂件。

    4.yml ⽀持更多的数据类型。

    设置不同环境的配置⽂件

    假设需求：

    开发环境端口号：6666

    测试环境端口号：7777

    生产环境端口号：8888

    Spring Boot 不同平台的配置规则：

    1.必须有主配置文件，主配置文件名必须是 application.yml(.properties)

    2.不同平台的配置文件，每个平台拥有一个配置文件，配置文件名称要求: application-xxx.yml(.properties)

    # 主配置文件(存放的是公共配置项)
spring:
  profiles:
    active: dev

    • 1
    • 2
    • 3
    • 4
    # 开发环境配置文件
server:
  port: 6666

    • 1
    • 2
    • 3
    # 测试环境配合文件
server:
  port: 7777

    • 1
    • 2
    • 3
    # 生产环境配置文件
server:
  port: 8888

    • 1
    • 2
    • 3

    image-20230511094935728

  • 相关阅读:
    使用Mongoose populate实现多表关联存储与查询，内附完整代码
    设计模式-装饰者模式在Java中的使用示例
    Sentinel
    如何通过pywinauto开始PC端自动化
    2022年秋招成功斩获offer秘籍：九大核心知识+1000道大厂面试真题
    Java —— 多态
    【C++】特殊类的设计
    免杀对抗-内存加载-shellcode转换-UUID+MAC+IPV4
    图文详解 VCF 生信格式 (变异信息)
    ESP32 vscode环境搭建
  • 原文地址：https://blog.csdn.net/qq_63983125/article/details/130854820