SpringBoot 配置文件和日志文件

妖狐艹你老母 2023-10-10 23:39 56阅读 0赞

**目录**

一、SpringBoot配置文件

配置文件的格式

.properties配置文件格式

.yml配置文件格式

.properties 与 .yml的区别

配置文件的读取

.properties 与 .yml的区别

设置不同环境的配置⽂件

二、SpringBoot日志文件

日志打印的步骤

得到日志对象

方法一：使用日志工厂 LoggerFactory来得到日志对象

方法二：使用lombok可以更加高效的打印日志（推荐使用lombok）

日志级别

⽇志级别设置

日志的持久化

lombok 更多注解说明

基本注解

组合注解

--------------------

## 一、SpringBoot配置文件 ##

在项目中重要的配置信息都是在配置文件配置的，如果没有配置文件的话，一个项目都不会运行起来。

配置文件里面都包含着连接数据库的用户名和密码、第三方系统的密钥、端口号的设置以及用于发现异常错误信息的普通日志和异常日志。因此配置文件是十分重要的。

### 配置文件的格式 ###

Spring Boot项目中配置文件的格式有两种:

>  *  **application.properties**
>  *  **application.yml**

appllication.properties配置文件格式比较早，可以理解为老款的配置文件，而application.yml是一种新的配置文件。

注意properties与yml的区别：

理论上properties与yml可以共存在一个项目中，如果当properties与 yml存在一个项目中，并且这两个都配置了相同的配置时，此时**项目配置文件以properties为主 ，因为properties的优先级比yml高，但加载完properties配置文件后也会加载.yml配置文件。**

#### .properties配置文件格式 ####

.properties 是以键值的形式配置的，**key 和 value 之间是以“=”连接的**，如

![6002e4b37e6e4ed4a2a3ed558c241668.png][]

![a9d1e02c47ca442f8db10a65f1adc754.png][]

注意：在.proerties配置文件中以\#来添加注释

#### .yml配置文件格式 ####

.yml基础语法是**key: value**

注意 ：key 和 value 之间使⽤ **英⽂冒汗加空格** 的方式组成的，其中的 **空格不可省略**

![2f2de1d6b5374b64975c776d1271583a.png][]

如果没有没有带空格的话，IDEA会自动显示字体颜色为灰色![fa25791d3642479bb94255f1348c0dd9.png][]

> **.yml配置信息注意：**
> 
>  *  字符串默认不⽤加上单引号或者双引号
>  *  单引号会转义特殊字符，特殊字符最终只是⼀个普通的字符串数据。 
>  *  双引号不会转义字符串⾥⾯的特殊字符；特殊字符会作为本身想表示的意思

####  ####

#### .properties 与 .yml的区别 ####

1、.properties的优先级比 .yml高。举例来说：当在这两个配置文件都配置了端口号，这两个端口号不相同时，会优先以.properties配置的为主

2、 .properties的配置文件比.yml冗余。

![89718c30bbf84be1bb1ed08cf67a2b1f.png][]

![fbcdb95975914c018bdbf9a96260c448.png][]

### 配置文件的读取 ###

这两个配置文件的数据读取方式都是一样的，使用**@Value**注解来读取

> **@Value 注解使⽤“$\{\}”的格式读取**

![c5da3d81455e41008531f8d26011f53d.png][]

读取代码如下

package com.example.demo;
    
    import org.springframework.beans.factory.annotation.Value;
    import org.springframework.stereotype.Component;
    
    import javax.annotation.PostConstruct;
    
    @Component
    public class TestYml {
        @Value("${string.hello}")
        private String hello;
        @PostConstruct
        public void func(){
            System.out.println("配置文件读取结果："+hello);
        }
    }

![eb26dc27afc74700a053afdded2057c9.png][]

@Component 在 Spring Boot 启动时候会注⼊到框架中，注⼊到框架中时会执⾏ @PostConstruct 初始化⽅法，这个时候就能读取到配置信息了。

##  ##

**在 yml 中配置对象**

使用该注解来读取：@ConfigurationProperties

![65afa24fe61e4b15accbb1e8dab05665.png][]

![1563d379cf5147f59127b73ae93946f9.png][]

### .properties 与 .yml的区别 ###

1、.properties的优先级比 .yml高。举例来说：当在这两个配置文件都配置了端口号，这两个端口号不相同时，会优先以.properties配置的为主

2、 .properties的配置文件比.yml冗余。

![89718c30bbf84be1bb1ed08cf67a2b1f.png][]

![fbcdb95975914c018bdbf9a96260c448.png][]

3、.properties配置文件形式是key=value,而.yml配置文件是key: value。(**冒号后面必须要带有一个空格**)

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

5、yml对中文的兼容性很好，读取中文不会乱码，而.properties对中文的兼容性不是很友好，读取的时候大概率是乱码的

### 设置不同环境的配置⽂件 ###

设置在不同的运行环境下的配置文件，主要是为了方便进行部署项目和修改配置文件。

设置不同的带有后缀名字来区分不同的配置文件

1、创建不同环境的配置⽂件：

*  application.yml 设置调用的配置文件
 *  application-prod.yml 生产环境下的配置文件
 *  application-dev.yml 测试环境下的配置文件

2、在application.yml里面修改要具体要调用哪一个配置文件

![b372f37b60c44c9899aa84828254a257.png][]

## 二、SpringBoot日志文件 ##

在项目中，日志文件是十分重要的，它有如下功能：

1、记录⽤户登录⽇志，⽅便分析⽤户是正常登录还是恶意破解用户

2、记录项目中的报错信息

3、记录程序的执行时间 ，方便程序员来进行查看程序执行时间

总之，掌握日志的打印是一项必要的技能

### 日志打印的步骤 ###

第一步：得到日志对象（Spring Boot 内置了⽇志框架，不然也输出不了⽇志）

第二步：使用日志对象来打印日志

####  ####

#### 得到日志对象 ####

#### **方法一：使用日志工厂 LoggerFactory来得到日志对象** ####

使用方法：将类的类型传入，方便知道日志的归属类，这样可以更好地去定位日志的问题所在。

private static Logger logger = LoggerFactory.getLogger(SpringBootTest.class);
                                                    //SpringBootTest为自己创建的类名

![ad70d9d998a540288a6ed4671170be89.png][]

@RequestMapping("/hello")
    @Controller
    @ResponseBody
    public class SpringBootTest {
        // 获取到日志对象
        private static Logger logger = LoggerFactory.getLogger(SpringBootTest.class);
        // 使用日志对象去打印日志对象
        @RequestMapping("/hi")
        public void saiHi(){
            logger.trace("trace");
            logger.debug("debug");
            logger.info("这是一个日志打印:inf0");
            logger.warn("warn");
            logger.error("error");
        }
    }

![62fc3bbb47ba474ba32637b9a9e22357.png][]

#### 方法二：使用lombok可以更加高效的打印日志（推荐使用lombok） ####

在使用日志工厂LoggerFactory来得到日志对象，需要将每个类都要添加到其中十分麻烦，此时就可以使用lombok来获取日志对象，**使用@Slf4j注解**

> 使⽤ @Slf4j 注解，lombok 会自动提供 **对象名log**,在程序中使⽤ log 对象即可输⼊⽇志，并且 **只能使⽤ log 对象才能输出**

1）添加 lombok依赖

<dependency>
    <groupId>org.projectlombok</groupId>
     <artifactId>lombok</artifactId>
     <version>1.18.20</version>
     <optional>true</optional>
    </dependency>

也可以在创建SpringBoot项目的时候添加lombok

![55b8e0fc2f7945eeb466e73e726303d7.png][]

2） 使用**@Slf4j**注解来打印日志对象

![5d488d15711347c197852d0a761269db.png][]

![283b3c74ab424620ba8814e49b7abc50.png][]

使用注解@Slf4j提供的日志对象log,这样就可以成功打印日志了

### 日志级别 ###

当设置了不同的日志级别，我们就可以只看到相对应的日志级别，平时我们比较关注warn 和error级别，因此设置日志级别时为error和warn，这样我们就可以只看到这两个报错信息了。

⽇志级别可以帮你筛选出重要的信息，⽐如设置⽇志级别为 error，那么就可以只看程序的报错⽇志了，对于普通的调试⽇志和业务⽇志就可以忽略了，从⽽节省开发者信息筛选的时间。

日志有如下几种：

*  trace：微量，少许的意思，级别最低；
 *  debug：需要调试时候的关键信息打印；
 *  info：普通的打印信息（默认⽇志级别
 *  warn：警告，不影响使⽤，但需要注意的问题；
 *  error：错误信息，级别较⾼的错误⽇志信息

fatal：致命的，因为代码异常导致程序退出执⾏的事件。

1、级别依次由低到高：trace ---> fatal

2、日志打印只会打印**级别高于自己和自己本身的级别，级别低于自己的日志则不会打印**

3、级别越高，收到的日志信息就会越来越少，比如设置了warn，则只会收到warn、error和fatal 的日志信息

#### ⽇志级别设置  ####

在配置文件里面设置日志级别

![bc0bbc819d774b67bff565d4ebdcf900.png][]

@RequestMapping("/hello")
    @Controller
    @ResponseBody
    @Slf4j  //使用@Slf4j注解来获取日志对象
    public class SpringBootTest {
    
        @RequestMapping("/hi")
            public void func(){ //直接拿lombok提供的log对象来打印日志
            // 配置文件里面配置了日志的隔离级别为warn，因此打印日志只会打印warn、error
                log.trace("trace");
                log.debug("debug");
                log.info("info");
                log.warn("warn");
                log.error("error");
            }
    }

![ffe099613f654ab9a4c95a6bc9d3bec5.png][]

**对不同的目录设置不同的级别**![8895e13330324ec685a2c0bcbeff5074.png][]

### 日志的持久化 ###

我们在控制台看到的日志不能被永久的保留下来，当再次运行时就不能看到上一次的日志，因此需要我们希望能把日志能够永久的保留下来。

想要将⽇志进⾏持久化，只需要在配置⽂件中指定⽇志的存储⽬录或者是指定⽇志保存⽂件名之后， Spring Boot 就会将控制台的⽇志写到相应的⽬录或⽂件下了

![2964aa6300ce4c4586e55c792df825ff.png][]

此时会在该路径下保存日志文件

![ebf56ffff766483e97a53db907758576.png][]

![d6276c2f8dd44f68ad969bffaaf2694e.png][]

![c34a40c02f4b47eebc31e7083a2b59af.png][]

### lombok 更多注解说明 ###

#### 基本注解 ####

<table style="width:700px;"> 
 <tbody> 
  <tr> 
   <td> 
    <div> 
     <span style="color:#333333;">注解</span> 
    </div> </td> 
   <td> 
    <div> 
     <span style="color:#333333;">作⽤</span> 
    </div> </td> 
  </tr> 
  <tr> 
   <td> 
    <div> 
     <span style="color:#333333;">@Getter </span> 
    </div> </td> 
   <td> 
    <div> 
     <span style="color:#333333;">⾃动添加 getter ⽅法</span> 
    </div> </td> 
  </tr> 
  <tr> 
   <td> 
    <div> 
     <span style="color:#333333;">@Setter </span> 
    </div> </td> 
   <td> 
    <div> 
     <span style="color:#333333;">⾃动添加 setter ⽅法</span> 
    </div> </td> 
  </tr> 
  <tr> 
   <td> 
    <div> 
     <span style="color:#333333;">@ToString </span> 
    </div> </td> 
   <td>自动添加toString方法</td> 
  </tr> 
  <tr> 
   <td> 
    <div> 
     <span style="color:#333333;">@EqualsAndHashCode</span> 
    </div> </td> 
   <td> 
    <div> 
     <span style="color:#333333;">⾃动添加 equals 和 hashCode ⽅法</span> 
    </div> </td> 
  </tr> 
  <tr> 
   <td> 
    <div> 
     <span style="color:#333333;">@NoArgsConstructor</span> 
    </div> </td> 
   <td> 
    <div> 
     <span style="color:#333333;">⾃动添加⽆参构造⽅法</span> 
    </div> </td> 
  </tr> 
  <tr> 
   <td> 
    <div> 
     <span style="color:#333333;">@AllArgsConstructor</span> 
    </div> </td> 
   <td> 
    <div> 
     <span style="color:#333333;">⾃动添加全属性构造⽅法，顺序按照属性的定义顺序</span> 
    </div> </td> 
  </tr> 
  <tr> 
   <td> 
    <div> 
     <span style="color:#333333;">@NonNull</span> 
    </div> </td> 
   <td> 
    <div> 
     <span style="color:#333333;">属性不能为 null </span> 
    </div> </td> 
  </tr> 
  <tr> 
   <td> 
    <div> 
     <span style="color:#333333;">@RequiredArgsConstructor</span> 
    </div> </td> 
   <td> 
    <div> 
     <span style="color:#333333;">⾃动添加必需属性的构造⽅法，final + @NonNull 的 </span> 
    </div> 
    <div> 
     <span style="color:#333333;">属性为必需</span> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

#### 组合注解 ####

<table style="width:600px;"> 
 <tbody> 
  <tr> 
   <td style="width:292px;"> 
    <div> 
     <span style="color:#333333;">注解</span> 
    </div> </td> 
   <td style="width:306px;"> 
    <div> 
     <span style="color:#333333;">作⽤ </span> 
    </div> </td> 
  </tr> 
  <tr> 
   <td style="width:292px;"> 
    <div> 
     <span style="color:#333333;">@Data </span> 
    </div> </td> 
   <td style="width:306px;"> 
    <div> 
     <span style="color:#333333;">@Getter + @Setter + @ToString + </span> 
    </div> 
    <div> 
     <span style="color:#333333;">@EqualsAndHashCode + </span> 
    </div> 
    <div> 
     <span style="color:#333333;">@RequiredArgsConstructor + </span> 
    </div> 
    <div> 
     <span style="color:#333333;">@NoArgsConstructor</span> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

导入import lombok.Data包后，就可以使用@Data 注解来自动构建一个对象的set和get方法

![52461fb911fb482692fbe65517956e35.png][]

[6002e4b37e6e4ed4a2a3ed558c241668.png]: https://img-blog.csdnimg.cn/6002e4b37e6e4ed4a2a3ed558c241668.png
[a9d1e02c47ca442f8db10a65f1adc754.png]: https://img-blog.csdnimg.cn/a9d1e02c47ca442f8db10a65f1adc754.png
[2f2de1d6b5374b64975c776d1271583a.png]: https://img-blog.csdnimg.cn/2f2de1d6b5374b64975c776d1271583a.png
[fa25791d3642479bb94255f1348c0dd9.png]: https://img-blog.csdnimg.cn/fa25791d3642479bb94255f1348c0dd9.png
[89718c30bbf84be1bb1ed08cf67a2b1f.png]: https://img-blog.csdnimg.cn/89718c30bbf84be1bb1ed08cf67a2b1f.png
[fbcdb95975914c018bdbf9a96260c448.png]: https://img-blog.csdnimg.cn/fbcdb95975914c018bdbf9a96260c448.png
[c5da3d81455e41008531f8d26011f53d.png]: https://img-blog.csdnimg.cn/c5da3d81455e41008531f8d26011f53d.png
[eb26dc27afc74700a053afdded2057c9.png]: https://img-blog.csdnimg.cn/eb26dc27afc74700a053afdded2057c9.png
[65afa24fe61e4b15accbb1e8dab05665.png]: https://img-blog.csdnimg.cn/65afa24fe61e4b15accbb1e8dab05665.png
[1563d379cf5147f59127b73ae93946f9.png]: https://img-blog.csdnimg.cn/1563d379cf5147f59127b73ae93946f9.png
[b372f37b60c44c9899aa84828254a257.png]: https://img-blog.csdnimg.cn/b372f37b60c44c9899aa84828254a257.png
[ad70d9d998a540288a6ed4671170be89.png]: https://img-blog.csdnimg.cn/ad70d9d998a540288a6ed4671170be89.png
[62fc3bbb47ba474ba32637b9a9e22357.png]: https://img-blog.csdnimg.cn/62fc3bbb47ba474ba32637b9a9e22357.png
[55b8e0fc2f7945eeb466e73e726303d7.png]: https://img-blog.csdnimg.cn/55b8e0fc2f7945eeb466e73e726303d7.png
[5d488d15711347c197852d0a761269db.png]: https://img-blog.csdnimg.cn/5d488d15711347c197852d0a761269db.png
[283b3c74ab424620ba8814e49b7abc50.png]: https://img-blog.csdnimg.cn/283b3c74ab424620ba8814e49b7abc50.png
[bc0bbc819d774b67bff565d4ebdcf900.png]: https://img-blog.csdnimg.cn/bc0bbc819d774b67bff565d4ebdcf900.png
[ffe099613f654ab9a4c95a6bc9d3bec5.png]: https://img-blog.csdnimg.cn/ffe099613f654ab9a4c95a6bc9d3bec5.png
[8895e13330324ec685a2c0bcbeff5074.png]: https://img-blog.csdnimg.cn/8895e13330324ec685a2c0bcbeff5074.png
[2964aa6300ce4c4586e55c792df825ff.png]: https://img-blog.csdnimg.cn/2964aa6300ce4c4586e55c792df825ff.png
[ebf56ffff766483e97a53db907758576.png]: https://img-blog.csdnimg.cn/ebf56ffff766483e97a53db907758576.png
[d6276c2f8dd44f68ad969bffaaf2694e.png]: https://img-blog.csdnimg.cn/d6276c2f8dd44f68ad969bffaaf2694e.png
[c34a40c02f4b47eebc31e7083a2b59af.png]: https://img-blog.csdnimg.cn/c34a40c02f4b47eebc31e7083a2b59af.png
[52461fb911fb482692fbe65517956e35.png]: https://img-blog.csdnimg.cn/52461fb911fb482692fbe65517956e35.png