SpringBoot配置文件和日志

喜欢ヅ旅行 2024-03-22 15:21 46阅读 0赞

**目录**

SpringBoot配置文件

SpringBoot配置文件的作用

项目中的重要数据写在配置文件当中

降低代码耦合

SpringBoot配置文件的格式

properties配置文件

读取配置文件中的内容（@Value注解使用$\{\}格式读取）

properties优缺点

yml配置文件

yml特点：

yml语法

yml对于单双引号的问题

yml配置对象多行写法

yml 配置文件单行写法

获取对象：

①在yml配置文件中存放一个对象

②新建一个实体类（与该对象保存一致）并注入到Spring容器

③从配置文件中获取该对象

④通过属性注入获取对象

yml配置集合

①在yml中存放一个集合

②注入集合

③获取bean对象

properties和yml有什么区别(重要)

SpringBoot日志

日志的作用：

如何使用日志：

日志的级别 （由低到高）：

日志的级别设置：

日志的持久化：

①配置日志的保存路径

②配置日志的文件名字

③更加简易的添加日志的方式：添加lombok

lombok常用注解：

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

## SpringBoot配置文件 ##

### SpringBoot配置文件的作用 ###

#### 项目中的重要数据写在配置文件当中 ####

如：数据库的连接信息，项目的启动端口，第三方系统的日志信息等等，如果没有我们的配置文件，数据库就不能连接。

#### 降低代码耦合 ####

在使用servlet的时候，包括使用JDBC编程的时候，数据库的连接信息都是写在java代码中的，在SpringBoot框架中则要写到配置文件中。

写到配置文件中就可以降低代码的耦合程度。

配置文件中的内容便于开发者进行修改，如果写在java文件中，那么编译后的.class文件就是只可以读的，不能进行修改。而且写到配置文件中也便于开发者可以在配置文件中看到项目部署的端口号，数据库连接情况等等。

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

一般是两种格式;

**properties（默认）**

**yml（yaml）**

![03d60f3ed1b74e4bb5ee9743ec8f056f.png][]

如果这两个格式的配置文件都有的时候（不建议出现两种），**优先以properties格式**的为主，这也是SpringBoot约定大于配置的一个体现。

注意：两种格式，都得**以application.properties和application.yml命名**，因为SpringBoot启动的时候只读取application命名的配置文件。

### properties配置文件 ###

**键值对Key=Value的方式**

可以使用系统的配置，也可以自定义

![5e85069b22d24ffda50ea499ca12e14c.png][]

![38ab170cd1df4c6b86c157c1f9a36e4b.png][]

#### 读取配置文件中的内容（@Value注解使用$\{\}格式读取） ####

使用@Value注解来读取配置文件的内容，使用$\{\}获取到配置文件中内容的赋值。

package com.example.demo.Controller;
    
    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
    @RequestMapping("/user")
    public class UserController {
        @Value("username")
        private String name;
        @RequestMapping("/sayHi")
        public String sayHi(){
            return "Hi "+ name;
        }
    }

![97cccd15b4f345f0a0a71a95aa6327e3.png][]

如果不加$\{\}相当于@Value中的字符串赋值给了name。

如果要获得赋值的配置文件则需要使用**$\{\}**来获取。

package com.example.demo.Controller;
    
    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
    @RequestMapping("/user")
    public class UserController {
        @Value("${studentname}")
        private String name;
        @RequestMapping("/sayHi")
        public String sayHi(){
            return "Hi "+ name;
        }
    }

![bbc30c2a91344b6f9cc08761d80e471b.png][]![ae90749c55ce415a8cfa7fd53cd5186d.png][]

#### properties优缺点 ####

优点:

1.是系统默认的配置文件

2.优先级比yml高

3.格式简单

缺点:写法比较冗余(包名必须全都写上,很多相同包名下的配置都要写上包名)

![032ee4e800694d6eb0ad5a9f63316041.png][]

### yml配置文件 ###

yml是yaml的缩写，在使用配置文件时使用yml和yaml都可以，推荐使用yml。

yml可读性高,写法简单,易于理解,语法和JSON相似

#### **yml特点：** ####

> 1、写法简单、可读性高；
> 
> 2、支持更多的数据类型
> 
> 3、**支持跨语言的使用（最大优势）**

#### yml语法 ####

yml也是按照key：value的方式存储的，但是它的写法比properties更简洁。

![cab4438d9dff427bae1f2d0766402d21.png][]

tab和空格不能少，否则容器无法识别

package com.example.demo.Controller;
    import org.springframework.beans.factory.annotation.Value;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    @RestController//==@Controller+@ResponseBody
    public class StudentController {
        @Value("${server.bbbb}")
        private String name;
        @RequestMapping("/sayhi")
        public String sayHi(){
            return "Hi "+name;
        }
    
    }

![d1ca1305d04e4d5783e86fa5eebada17.png][]

![652665596aec40009184444d04c8426a.png][]

#### yml对于单双引号的问题 ####

![64e2bf0a671548178cb6ccee19d25318.png][]

前两种：

![e8d6f5f7492c46e79bdb4aea6f659c56.png][]

加双引号;

![8c66004200f44930bb9cdd9b3775aa81.png][]

在网页中\\n转义字符不好看出来。

![d0273134d21443a5ae721d5ec391f288.png][]

#### yml配置对象多行写法 ####

#对象多行写法
    student :
      id : 1
      name : 张三
      age : 18

#### yml 配置文件单行写法 ####

#对象单行写法
    student2 : {id : 2, name : 李四, age : 19}

#### 获取对象： ####

#### ①在yml配置文件中存放一个对象 ####

![4e991d5f02da44e8bc7d34457c208233.png][]

#### ②新建一个实体类（与该对象保存一致）并注入到Spring容器 ####

package com.example.demo;
    
    import lombok.Data;
    import org.springframework.stereotype.Component;
    
    @Data
    @Component
    public class Student {
        private int id;
        private String name;
        private int age;
    }

#### ③从配置文件中获取该对象 ####

![29ad3e6c4b794ee2a36d7a125965958b.png][]

#### ④通过属性注入获取对象 ####

package com.example.demo.controller;
    
    import com.example.demo.Student;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.stereotype.Controller;
    
    @Controller
    public class StudentController {
        @Autowired
        private Student student;
        
        public Student getStudent(){
            return student;
        }
    }

#### yml配置集合 ####

#集合
    #myName对应于实体类
    #name是集合
    myName : { name : [ 张三, 李四, 王五 ] }

#### ①在yml中存放一个集合 ####

![42b9ba2d57d0429cb745439fdcd21bf1.png][]

#### ②注入集合 ####

![37f8a7780e144a41a8f208d2575a1b92.png][]

#### ③获取bean对象 ####

package com.example.demo.controller;
    
    import com.example.demo.MyNameController;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.stereotype.Controller;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.ResponseBody;
    
    @Controller
    @RequestMapping("/hello")
    public class ListController {
        @Autowired
        private MyNameController myNameController;
    
    
    @RequestMapping("/hi")
    @ResponseBody
        public String getNames(){
            return myNameController.getName()+"";
        }
    }

### properties和yml有什么区别(重要) ###

> 区别1：properties仅仅支持Java项目，但是yml支持包括Java在内的多种语言（例如python）；
> 
> 区别2：properties的key写起来比较冗余，不像yml那样简易。(yml支持层级，层级之间采用缩进的方式）
> 
> 区别3：yml支持更多的数据类型（string,object,list)

## SpringBoot日志 ##

### 日志的作用： ###

1、发现和定位问题，报错了不查看日志，难以发现和定位问题

2、记录用户的登录日志，方便分析用户的登录状态，是恶意还是正常

3、记录系统的操作情况，定位操作人，操作时间和操作行为等等

4、记录程序的执行时间，方便后续的优化等等....

### 如何使用日志： ###

SpringBoot内置了日志框架，所以会有默认的日志。

![6be63f5103db4e298a841b5870f20fff.png][]

使用日志，首先我们要找到日志的门面**SLF4J ，然后根据SLF4J获取到日志对象，再进行使用。**

![24aacd298b954fc396e7d46dd1726416.png][]

package com.example.demo.controller;
    
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    @RestController
    @RequestMapping("/hello")
    public class UserController {
        //通过slf4j获取日志对象
        private static Logger logger= LoggerFactory.getLogger(UserController.class);
        //输出日志
        @RequestMapping("/hi")
        public void sayhi(){
            logger.info("hi i'm info");
            logger.debug("hi i'm debug");
            logger.error("hi i'm error");
            logger.warn("hi i'm warn");
        }
    }

![7e0387b65341414f91febbe39afabba9.png][]

### 日志的级别 （由低到高）： ###

> **trace**  
> 少许的日志，这一个是最低的级别。
> 
> **debug**  
> 这个级别用于"调试"的级别
> 
> **info**  
> 这个级别是普通的日志信息。（如果不指定日志的级别，那么默认就是这个）
> 
> **warn**  
> 警告日志：有一些地方存在警告的风险的，就需要使用到这个warn级别的日志
> 
> **error**  
> 错误级别的日志，如果发生了一些错误，那么就需要使用这个级别来记录。
> 
> **fatal**  
> 发生了比较致命的情况，需要由系统来进行输出，不可以由用户手动进行debug输出。  
>

默认的级别是info，所以一般情况下只会出现info及其以上的日志，较为低级的日志一般不会出现。

### 日志的级别设置： ###

日志的默认级别是info，所以info以上的日志一般不会出现，但是这个默认的级别是可以通过配置文件进行修改的。（注意：fatal是由系统输出的，不能我们手动进行debug输出）

![688a4a395b9d4ee1806f64ca4f324d55.png][]

当我们修改默认级别为error的时候，控制台就基本没有日志

![f3865f76486647adbcfc6f0656ee3179.png][]上述是全局日志的设定，当然也有局部日志的设定，但是局部日志的设定要服从全局

![5f037bef805d47cea28d75746a824238.png][]

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

日志的持久化，说白了就是把日志存在本地的磁盘

#### ①配置日志的保存路径 ####

这里的路径中要用**“/”** ，因为**“/”**会被认为是特殊符号

![8398191356d745268cee153a6a51b488.png][] 目标目录下就会有个日志文件：

![81a618354a9c4873874aa756cb389e83.png][]

#### ②配置日志的文件名字 ####

![4276165e6c88446cbb0f5475a998cf92.png][]

![7868409509184e3496332dfa575fc29d.png][]

#### ③更加简易的添加日志的方式：添加lombok ####

1、安装一个EditStarters插件：

![ae9f09f2b65e49f6aff5c9242731e66f.png][]

2、添加@Slf4j注解

![73626370361346e99da891daf711602f.png][]

![ddf6af7f9f104fd5a4b80e9292562a88.png][]

那么为什么@Slf4j就可以生成一个log对象呢？这个主要是因为在编译时期@Slf4j会为当前类当中设置一个**静态从常量属性**，这一个属性就是**log。**

我们可以看看UserController的字节码文件：

![1d653a24c0d5492da36d435d11c9b8c7.png][]

#### lombok常用注解： ####

⽇志注解 ：

基本注解 ：

<table> 
 <tbody> 
  <tr> 
   <td colspan="2">注解</td> 
   <td colspan="5">作用</td> 
  </tr> 
  <tr> 
   <td colspan="2">@Getter</td> 
   <td colspan="5">⾃动添加 getter ⽅法</td> 
  </tr> 
  <tr> 
   <td colspan="2">@Setter</td> 
   <td colspan="5">⾃动添加 setter ⽅法</td> 
  </tr> 
  <tr> 
   <td colspan="2">@ToString</td> 
   <td colspan="5">⾃动添加 toString ⽅法</td> 
  </tr> 
  <tr> 
   <td colspan="2">@EqualsAndHashCode</td> 
   <td colspan="5">⾃动添加 equals 和 hashCode ⽅法</td> 
  </tr> 
  <tr> 
   <td colspan="2">@NoArgsConstructor</td> 
   <td colspan="5">⾃动添加⽆参构造⽅法</td> 
  </tr> 
  <tr> 
   <td colspan="2">@AllArgsConstructor</td> 
   <td colspan="5">⾃动添加全属性构造⽅法，顺序按照属性的定义顺序</td> 
  </tr> 
  <tr> 
   <td colspan="2">@NonNull</td> 
   <td colspan="5">属性不能为 null</td> 
  </tr> 
  <tr> 
   <td colspan="2">@RequiredArgsConstructor</td> 
   <td colspan="5">⾃动添加必需属性的构造⽅法，final + @NonNull 的<br> 属性为必需</td> 
  </tr> 
 </tbody> 
</table>

组合注解：

<table> 
 <tbody> 
  <tr> 
   <td colspan="2">注解</td> 
   <td colspan="5">作用</td> 
  </tr> 
  <tr> 
   <td colspan="2">@Data</td> 
   <td colspan="5">@Getter + @Setter + @ToString +<br> @EqualsAndHashCode +<br> @RequiredArgsConstructor +<br> @NoArgsConstructor</td> 
  </tr> 
 </tbody> 
</table>

注解的原理，就是在**编译时期**添加对应的方法

[03d60f3ed1b74e4bb5ee9743ec8f056f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/18/35e8169b9911467f9e9d213128d8852c.png
[5e85069b22d24ffda50ea499ca12e14c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/18/ae7260284b414eed9f981f065a933cfd.png
[38ab170cd1df4c6b86c157c1f9a36e4b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/18/e770f2f080824c7bb667cfafac5542c9.png
[97cccd15b4f345f0a0a71a95aa6327e3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/18/3608af374d5c4adb9d46f98562902716.png
[bbc30c2a91344b6f9cc08761d80e471b.png]: https://img-blog.csdnimg.cn/bbc30c2a91344b6f9cc08761d80e471b.png
[ae90749c55ce415a8cfa7fd53cd5186d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/18/c9e9b80a87e3407a980cd9563f86579b.png
[032ee4e800694d6eb0ad5a9f63316041.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/18/ddfffca9537c49cc875e5c6b1b3d1f60.png
[cab4438d9dff427bae1f2d0766402d21.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/18/7601c092a7da45cb91b10b3c8945ea0f.png
[d1ca1305d04e4d5783e86fa5eebada17.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/18/a8e49c4d08dc4302b585ef40faf43fc7.png
[652665596aec40009184444d04c8426a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/18/30bd0ac91e494153a60865e6abc84dbc.png
[64e2bf0a671548178cb6ccee19d25318.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/18/99283809d0604baab6d2bff5a191fc67.png
[e8d6f5f7492c46e79bdb4aea6f659c56.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/18/df9eecb90b714afda3150d437496e78a.png
[8c66004200f44930bb9cdd9b3775aa81.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/18/5219d27400c54f4cb7ba7e2bd09d65ad.png
[d0273134d21443a5ae721d5ec391f288.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/18/4d0129cdd69c4c969c10230af16b4fd2.png
[4e991d5f02da44e8bc7d34457c208233.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/18/cd6da50bce3a4bf78e0c8b6cec811a50.png
[29ad3e6c4b794ee2a36d7a125965958b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/18/2d234f7cb81140a9b7351f5601c46407.png
[42b9ba2d57d0429cb745439fdcd21bf1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/18/b0c3ba45b8ec4076aae85dc2cade65b3.png
[37f8a7780e144a41a8f208d2575a1b92.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/18/088f64a068f54f8e95306d25105331af.png
[6be63f5103db4e298a841b5870f20fff.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/18/d930040ea1a344a0822af7f636d870ad.png
[24aacd298b954fc396e7d46dd1726416.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/18/b6b756b3709048439962a3b7ffe21b3d.png
[7e0387b65341414f91febbe39afabba9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/18/912c8fa828254c9ca258573de13eb6c6.png
[688a4a395b9d4ee1806f64ca4f324d55.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/18/f9c925ee31c849c3a7a8373d41ce94a7.png
[f3865f76486647adbcfc6f0656ee3179.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/18/1fe2e02805584877b07e094f6efc8c3b.png
[5f037bef805d47cea28d75746a824238.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/18/ea97487686094dc09af5e71554a6357e.png
[8398191356d745268cee153a6a51b488.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/18/4b9894dc6a3942b0b43a890a42c13132.png
[81a618354a9c4873874aa756cb389e83.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/18/18e5fe01699e42328c781f2aec62f139.png
[4276165e6c88446cbb0f5475a998cf92.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/18/ca4217b92d5a4389818b1617d435281f.png
[7868409509184e3496332dfa575fc29d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/18/b76eae47dbc94fe9b714eea90a1db9d4.png
[ae9f09f2b65e49f6aff5c9242731e66f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/18/f3ea5cfbcbc446b0a17956a320bc3fd1.png
[73626370361346e99da891daf711602f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/18/7e39a244852a49bca66017aa11206116.png
[ddf6af7f9f104fd5a4b80e9292562a88.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/18/5511689823744fc9bbb5fd83c1982ea2.png
[1d653a24c0d5492da36d435d11c9b8c7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/18/9c1da3bf0781490d85a2d19cab397cff.png