《springboot实战》第三章 springboot 统一日志

深藏阁楼爱情的钟 2023-09-25 21:41 22阅读 0赞

## 系列文章目录 ##

[第一章 SpringBoot起步][SpringBoot]  
[第二章 springboot 配置文件、多环境配置、运行优先级][springboot]  
[第三章 springboot 统一日志][springboot 1]  
[第四章 SpringBoot加载静态文件资源][SpringBoot 1]  
[第五章 springboot 拦截器][springboot 2]  
[第六章 实现自定义全局异常处理][Link 1]  
[第七章 springboot 数据库应用][springboot 3]  
[第八章 springboot 整合Druid][springboot _Druid]  
[第九章 springboot 整合MyBatis - xml、注解篇][springboot _MyBatis - xml]  
[第十一章 整合Mybatis plus][_Mybatis plus]  
[第十二章 SpringBoot整合swagger-bootstrap-ui][SpringBoot_swagger-bootstrap-ui]

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

#### 文章目录 ####

*  系列文章目录
 *  1、日志配置
 *   *  1.1、日志级别
     *  1.2、日志格式化
     *  1.3、Spring Boot 日志默认级别
     *  1.4、application.properties配置
     *  1.5、日志文件大小
     *  1.6、在日志中添加IP
     *   *  1.6.1、增加java文件，获取IP
 *  2、Java代码中打印日志

![在这里插入图片描述][56508647f5b047dc96f20479a517b648.png]

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

## 1、日志配置 ##

Spring Boot 默认使用 SLF4J+Logback 记录日志

### 1.1、日志级别 ###

trace<debug<info<warn<error<fatal

<table> 
 <thead> 
  <tr> 
   <th>序号</th> 
   <th>日志级别</th> 
   <th align="left">说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>trace</td> 
   <td align="left">追踪，指明程序运行轨迹</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>debug</td> 
   <td align="left">调试，实际应用中一般将其作为最低级别，而 trace 则很少使用</td> 
  </tr> 
  <tr> 
   <td>3</td> 
   <td>info</td> 
   <td align="left">输出重要的信息，使用较多</td> 
  </tr> 
  <tr> 
   <td>4</td> 
   <td>warn</td> 
   <td align="left">警告，使用较多</td> 
  </tr> 
  <tr> 
   <td>5</td> 
   <td>error</td> 
   <td align="left">错误信息，使用较多</td> 
  </tr> 
 </tbody> 
</table>

### 1.2、日志格式化 ###

<table> 
 <thead> 
  <tr> 
   <th>序号</th> 
   <th align="left">输出格式</th> 
   <th align="left">说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td align="left">%d{yyyy-MM-dd HH:mm:ss, SSS}</td> 
   <td align="left">日志生产时间,输出到毫秒的时间</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td align="left">%-5level</td> 
   <td align="left">输出日志级别，-5 表示左对齐并且固定输出 5 个字符，如果不足在右边补 0</td> 
  </tr> 
  <tr> 
   <td>3</td> 
   <td align="left">%logger 或 %c</td> 
   <td align="left">logger 的名称</td> 
  </tr> 
  <tr> 
   <td>4</td> 
   <td align="left">%thread 或 %t</td> 
   <td align="left">输出当前线程名称</td> 
  </tr> 
  <tr> 
   <td>5</td> 
   <td align="left">%p</td> 
   <td align="left">日志输出格式(日志等级)</td> 
  </tr> 
  <tr> 
   <td>6</td> 
   <td align="left">%message 或 %msg 或 %m</td> 
   <td align="left">日志内容，即 logger.info(“message”)</td> 
  </tr> 
  <tr> 
   <td>7</td> 
   <td align="left">%n</td> 
   <td align="left">换行符</td> 
  </tr> 
  <tr> 
   <td>8</td> 
   <td align="left">%class 或 %C</td> 
   <td align="left">输出 Java 类名</td> 
  </tr> 
  <tr> 
   <td>9</td> 
   <td align="left">%file 或 %F</td> 
   <td align="left">输出文件名</td> 
  </tr> 
  <tr> 
   <td>10</td> 
   <td align="left">%L</td> 
   <td align="left">输出错误行号</td> 
  </tr> 
  <tr> 
   <td>11</td> 
   <td align="left"></td> 
   <td align="left">%method 或 %M</td> 
  </tr> 
  <tr> 
   <td>12</td> 
   <td align="left">%l</td> 
   <td align="left">输出语句所在的行数, 包括类名、方法名、文件名、行数</td> 
  </tr> 
  <tr> 
   <td>13</td> 
   <td align="left">hostName</td> 
   <td align="left">本地机器名</td> 
  </tr> 
  <tr> 
   <td>14</td> 
   <td align="left">hostAddress</td> 
   <td align="left">本地 ip 地址</td> 
  </tr> 
 </tbody> 
</table>

### 1.3、Spring Boot 日志默认级别 ###

Spring Boot启动时随机抓取一条日志：

2023-04-04 14:16:39.094  INFO 14464 --- [  restartedMain] c.hqyj.mqreceiver.MqReceiverApplication  : No active profile set, falling back to 1 default profile: "default"

通过控制台输出结果可知，Spring Boot 日志默认级别为 info，日志输出内容默认包含以下元素：

*  时间日期
 *  日志级别
 *  进程 ID
 *  分隔符：—
 *  线程名：方括号括起来（可能会截断控制台输出）
 *  Logger 名称
 *  日志内容

### 1.4、application.properties配置 ###

#日志级别
    logging.level.com.hqyj.springboot=trace
    #使用相对路径的方式设置日志输出的位置（项目根目录目录\my-log\mylog\spring.log）
    logging.file.name=F:/springboot/logging/springboot.log
    #绝对路径方式将日志文件输出到
    logging.file.path=F:/springboot/logging
    #控制台日志输出格式
    logging.pattern.console=%d{
        yyyy-MM-dd hh:mm:ss} [%thread] %-5level %logger{
        50} [%L] ${
        hostName}  - %msg%n
    #日志文件输出格式
    logging.pattern.file=%d{
        yyyy-MM-dd} === [%thread] === %-5level === %logger{
        50} === - %msg%n

*  logging.level.root=info指定整个系统的默认日志级别是info，日志级别统一化
 *  logging.level.com.zimug.boot.launch.controller=debug,指定某个特定的package的日志级别是debug，日志级别个性化。优先级角度，个性配置大于统一配置。
 *  logging.file.path将日志输出到指定目录，如果不指定logging.file.name，日志文件的默认名称是spring.log。配置了logging.file.name之后,logging.file.path配置失效。
 *  无论何种设置，Spring Boot都会自动按天分割日志文件，也就是说每天都会自动生成一个新的log文件，而之前的会自动打成GZ压缩包。

### 1.5、日志文件大小 ###

*  可以设置  
    logging.file.max-size=10MB分割的每个日志的文件最大容量，超过这个size之后日志继续分隔。
 *  可以设置保留的日志时间  
    logging.file.max-history=10，以天为单位
 *  logging.pattern.file输出到文件中的日志的格式
 *  logging.pattern.console控制台输出日志的格式，为了在控制台调试时候显示效果更清晰，为日志增加了颜色。red、green等等  
    yml与xml的结合

########## 日志 配置 - START ##########
    spring:
      profiles:
        active: dev
    my:
      info:
        appName: springboot
    logging:
      config: classpath:logback-spring.xml # logback日志配置
      yh:
        logFileHome: # 各个环境的配置文件目录
          dev: F:/springboot/logging
          test: /www/wwwroot/yhApps/logs/
          pro: /www/wwwroot/yhApps/logs/
        pattern: "%-12(%d{yyyy-MM-dd HH:mm:ss.SSS}) |-%-5level [%thread] %c [%L] -| %msg%n"
        maxHistory: 10 # 最大保存10个（天）的历史文件

<?xml version="1.0" encoding="UTF-8"?>
    
    <configuration scan="true" scanPeriod="60 seconds" debug="false">
        <contextName>springboot</contextName>
        
        
        <springProperty scope="context" name="pattern" source="logging.yh.pattern"/>
        
        <springProperty scope="context" name="maxHistory" source="logging.yh.maxHistory"/>
        
        <springProperty scope="context" name="appName" source="my.info.appName"/>
    
        
        <springProperty scope="context" name="devLogHome" source="logging.yh.logFileHome.dev"/>
        
        <springProperty scope="context" name="testLogHome" source="logging.yh.logFileHome.test"/>
        
        <springProperty scope="context" name="proLogHome" source="logging.yh.logFileHome.pro"/>
    
        
        <springProfile name="dev">
            <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
                <encoder>
                    <pattern>${pattern}</pattern>
                </encoder>
            </appender>
    
            
            <appender name="CONSOLE-FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
                
                <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                    
                    <fileNamePattern>${devLogHome}/${appName}_log/debug.%d{yyyy-MM-dd}.log</fileNamePattern>
                    
                    <MaxHistory>${maxHistory}</MaxHistory>
                </rollingPolicy>
                <layout class="ch.qos.logback.classic.PatternLayout">
                    <pattern>${pattern}</pattern>
                </layout>
            </appender>
    
            <logger name="com.hqyj" level="info"/>
            <root level="info">
                <appender-ref ref="CONSOLE"/>
                <appender-ref ref="CONSOLE-FILE"/>
            </root>
        </springProfile>
    
        
        <springProfile name="test">
            
            <appender name="TEST-FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
                
                <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                    
                    <fileNamePattern>${testLogHome}/${appName}_log/info.%d{yyyy-MM-dd}.log</fileNamePattern>
                    
                    <MaxHistory>100</MaxHistory>
                </rollingPolicy>
                <layout class="ch.qos.logback.classic.PatternLayout">
                    <pattern>${pattern}</pattern>
                </layout>
            </appender>
            <root level="info">
                <appender-ref ref="TEST-FILE"/>
            </root>
        </springProfile>
    
        
        <springProfile name="pro">
            <appender name="PROD_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
                <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                    <fileNamePattern>${proLogHome}/${appName}_log/warn.%d{yyyy-MM-dd}.log</fileNamePattern>
                    <MaxHistory>100</MaxHistory>
                </rollingPolicy>
                <layout class="ch.qos.logback.classic.PatternLayout">
                    <pattern>${pattern}</pattern>
                </layout>
            </appender>
            <root level="warn">
                <appender-ref ref="PROD_FILE"/>
            </root>
        </springProfile>
    </configuration>

### 1.6、在日志中添加IP ###

#### 1.6.1、增加java文件，获取IP ####

/**
     * 日志中获取IP
     */
    public class LogIpConfig extends ClassicConverter {
        
        private static String hostAddress;
        static{
        
            try {
        
    
                hostAddress = InetAddress.getLocalHost().getHostAddress();
            } catch (UnknownHostException e) {
        
                e.printStackTrace();
            }
        }
        @Override
        public String convert(ILoggingEvent iLoggingEvent) {
        
            return hostAddress;
        }
    }

xml添加以下的代码：

将日志格式修改成以下的格式

pattern: "%-12(%d{yyyy-MM-dd HH:mm:ss.SSS}) |-%-5level [%thread] %c [%L] [%hostAddress] -| %msg%n"

## 2、Java代码中打印日志 ##

使用@Slf4j注解引入日志

import lombok.extern.slf4j.Slf4j;
    import org.junit.jupiter.api.Test;
    import org.springframework.boot.test.context.SpringBootTest;
    
    @Slf4j
    @SpringBootTest
    class MqReceiverApplicationTests {
        
        @Test
        void contextLoads() {
        
            String user = "zhangsan";
            log.info("Hello {}" , user);
        }
    }

**效果：**

> 2023-04-04 14:29:33.891 INFO 8224 — \[ main\] c.h.m.MqReceiverApplicationTests : Hello zhangsan

[SpringBoot]: https://blog.csdn.net/s445320/article/details/129921683
[springboot]: https://blog.csdn.net/s445320/article/details/129933138
[springboot 1]: https://blog.csdn.net/s445320/article/details/129949778
[SpringBoot 1]: https://blog.csdn.net/s445320/article/details/129952680
[springboot 2]: https://blog.csdn.net/s445320/article/details/129953402
[Link 1]: https://blog.csdn.net/s445320/article/details/130248527
[springboot 3]: https://blog.csdn.net/s445320/article/details/129958603
[springboot _Druid]: https://blog.csdn.net/s445320/article/details/129989045
[springboot _MyBatis - xml]: https://blog.csdn.net/s445320/article/details/130012383
[_Mybatis plus]: https://blog.csdn.net/s445320/article/details/130130130
[SpringBoot_swagger-bootstrap-ui]: https://blog.csdn.net/s445320/article/details/130419460
[56508647f5b047dc96f20479a517b648.png]: https://img-blog.csdnimg.cn/56508647f5b047dc96f20479a517b648.png