日志框架使用

二十三、项目日志管理

日志框架的概念

在项⽬开发、运维过程中，为了能够清晰的知道项⽬在服务器中的运⾏过程、便于查找服务器

运⾏过程的异 常原因，我们需要对系统运⾏过程进⾏记录 — 运⾏⽇志

1. 我们可以使⽤ 控制台输出 的形式进⾏运⾏过程记录（不便于⽇志信息跟踪和维护、不能够持久化存 储）
2. 控制台输出⽇志的诸多弊端 催化了 ⽇志框架的诞⽣

⽇志框架 ⽤于帮助我们在应⽤开发中完成⽇志记录的帮助类

⽇志框架作⽤

1.有结构的记录⽇志信息（结构是为了提升⽇志信息的可读性）

2.定义⽇志的输出策略（每个⽇志⽂件最⼤5m、每天⼀个⽇志⽂件）

日志框架的规范

⽇志框架规范：⽇志记录实现的规则

⽇志框架：实现⽇志记录

• 日志接口（日志框架规范）
• JCL
• SJF4J
• JBoss Logging
• 日志实现（日志框架）
  • Log4j
  • Logback

SJF4J

• SJF4J 简单日志门面 定义了一套日志规范 ，并不是日志框架解决方法

• SLF4J的实现框架

  

slf4j—simple

• 创建SpringBoot 应用

• 移出springboot应⽤默认logback-classic的⽇志依赖

  <dependency>
  	 <groupId>org.springframework.boot</groupId>
   	<artifactId>spring-boot-starter-web</artifactId>
   	<exclusions>
   		<exclusion>
  			 <groupId>ch.qos.logback</groupId>
  			 <artifactId>logback-classic</artifactId>
  		 </exclusion>
  	 </exclusions>
  </dependency>
  

• 添加依赖

  <!-- https://mvnrepository.com/artifact/org.slf4j/slf4j-simple -->
  <dependency>
       <groupId>org.slf4j</groupId>
       <artifactId>slf4j-simple</artifactId>
       <version>1.7.25</version>
  </dependency>
  
  

• 在service层打印⽇志

  @Service
  public class TestServiceImpl implements TestService {
   private Logger logger = LoggerFactory.getLogger(TestServiceImpl.class);
       @Override
       public void testLog() {
       //⽇志记录
       //System.out.println("⽇志信息");
       logger.info("订单添加完成");
       }
  }
  

log4j 使用

log4j没有实现slf4j,如果基于slf4j规范使⽤log4j，则需要添加slf4j-log4j12依赖

• 添加依赖

  <dependency>
       <groupId>org.slf4j</groupId>
       <artifactId>slf4j-log4j12</artifactId>
       <version>1.7.25</version>
       <scope>test</scope>
  </dependency>
  

• 在resources⽬录下创建log4j.properties⽂件

log4j.rootLogger=DEBUG,stdout
# MyBatis logging configuration...
log4j.logger.org.mybatis.example.BlogMapper=TRACE
# Console output...
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=[%t] %5p - %n%m

基于SpringBoot应⽤的logback⽇志配置

SpringBoot默认整合了logback-classic⽇志框架，我们需要对logback⽇志框架进⾏配置以⾃定义⽇志输出格 式、⽇志⽂件配置、⽇志⽂件保存策略等信息

• ⼯程的resources⽬录添加⽇志配置⽂件

  logback-spring.xml

  <?xml version="1.0" encoding="UTF-8"?>
  <configuration>
  
      <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
          <encoder>
              <springProfile name="dev">
                  <pattern>%d{yyyy-MM-dd-HH:mm:ss.SSS} %level [%thread]-%class:%line~~%msg%n</pattern>
              </springProfile>
              <springProfile name="!dev">
                  <pattern>%d{yyyy-MM-dd-HH:mm:ss.SSS} %level [%thread]-%class:%line~~%msg%n</pattern>
              </springProfile>
              <!--日志的编码格式-->
              <charset>UTF-8</charset>
          </encoder>
      </appender>
  
      <!--这个就表示的是要把 日志输出到文件(FileAppender)-->
      <appender name="file" class="ch.qos.logback.core.FileAppender">
          <file>log/output.log</file>
          <!--设置日志是否追加-->
          <append>true</append>
          <encoder>
              <pattern>%d{yyyy-MM-dd-HH:mm:ss.SSS} %level	[%thread]-%class:%line>>%msg%n</pattern>
              <charset>UTF-8</charset>
          </encoder>
          <!--设置日志写入是否线程安全-->
          <prudent>false</prudent>
      </appender>
  
      <appender name="timeFile" class="ch.qos.logback.core.rolling.RollingFileAppender">
          <!--TimeBasedRollingPolicy  基于时间的滚动策略-->
          <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
              <fileNamePattern>log/log-%d{yyyy-MM-dd}.log</fileNamePattern>
          </rollingPolicy>
          <encoder>
              <pattern>%d{yyyy-MM-dd-HH:mm:ss.SSS} %level	[%thread]-%class:%line>>%msg%n</pattern>
              <charset>UTF-8</charset>
          </encoder>
      </appender>
  
      <appender name="fixedFile" class="ch.qos.logback.core.rolling.RollingFileAppender">
          <file>d:/log/fixedFile.log</file>
          <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
              <fileNamePattern>log/fixedFile%i.log</fileNamePattern>
              <minIndex>1</minIndex>
              <maxIndex>10</maxIndex>
          </rollingPolicy>
          <!--SizeBasedTriggeringPolicy-->
          <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
              <maxFileSize>5MB</maxFileSize>
          </triggeringPolicy>
          <encoder>
              <pattern>%d{yyyy-MM-dd-HH:mm:ss.SSS} %level	[%thread]-%class:%line>>%msg%n
              </pattern>
              <charset>UTF-8</charset>
          </encoder>
      </appender>
  
  <!--    <logger name="com.qf.springboot.controller" level="info" addtivity="false">-->
  <!--        <appender-ref ref="file" />-->
  <!--        <appender-ref ref="timeFile" />-->
  <!--        <appender-ref ref="fixedFile" />-->
  <!--    </logger>-->
  
      <root level="info">
          <appender-ref ref="stdout" />
          <appender-ref ref="timeFile"/>
      </root>
  
  </configuration>
  

  在sercie实现类创建Logger对象，输⼊⽇志