Spring Boot 日志配置

梦里梦外; 2022-02-27 19:22 283阅读 0赞

看这里，**[Spring Boot-日志配置(超详细)][Spring Boot-]**，足够详细清楚。

本文只是在看完后的简单汇总梳理，请查看[原文][Spring Boot-]。

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

### 文章目录 ###

*   *   *  一、默认Logback
         *  二、配置\`application.properties\`以应对简单场景
         *  三、配置\`logback-spring.xml\`以应对复杂场景
         *  四、打印日志logger.info()
         *  五、Spring Boot + AOP 统一处理日志
         *  六、保存日志到数据库（留坑）

### 一、默认Logback ###

1.  默认情况：Spring Boot使用Logback，INFO级别输出到控制台；
2.  按说需要添加`spring-boot-starter-logging`依赖，实际无需添加，因为`spring-boot-starter`中已包含；
3.  日志级别：`TRACE < DEBUG < INFO < WARN < ERROR < FATAL`；

### 二、配置`application.properties`以应对简单场景 ###

# 日志路径
    logging.path=log/
    # 日志文件（注意和logging.path同时配置的话，只有logging.file起作用）
    logging.file=log/boot.log
    logging.file.max-history=30（单位是天，默认7天）
    logging.file.max-size=100MB（单位是KB、MB等，默认10MB）
    # 日志级别（可具体到包）
    logging.level.root=info
    logging.level.com.fukaiit=DEBUG
    # 日志格式
    logging.pattern.console=%d{yyyy/MM/dd-HH:mm:ss} [%thread] %-5level %logger- %msg%n 
    logging.pattern.file=%d{yyyy/MM/dd-HH:mm} [%thread] %-5level %logger- %msg%n

注意:  
logging.path和logging.file已过时，新版使用logging.file.name和logging.file.path（不能同时生效）：

logging.file.name=log/myapp.log   # 指定路径和文件名（用这个就够了）
    logging.file.path=log/  # 只能指定路径，文件名默认spring.log

日志格式说明

> %d\{HH: mm:ss.SSS\}——日志输出时间  
> %thread——输出日志的进程名字，这在Web应用以及异步任务处理中很有用  
> %-5level——日志级别，并且使用5个字符靠左对齐  
> %logger\{36\}——日志输出者的名字  
> %msg——日志消息  
> %n——平台的换行符

### 三、配置`logback-spring.xml`以应对复杂场景 ###

在resources目录下配置logback-spring.xml即可被正确识别；指定自定义文件的方法：

logging.config=classpath:logging-config.xml

在涉及多环境配置的情况下不能使用logback.xml，因为logback.xml加载早于application.yml，需使用logback-spring.xml或自定义文件名实现日志配置。  
![在这里插入图片描述][20190328152351731.png]

**一个较完整的例子**，具体节点说明请参考[这里][Spring Boot-]：

<?xml version="1.0" encoding="UTF-8"?>
    <configuration>
        
        <property name="PATTERN" value="%-12(%d{yyyy-MM-dd HH:mm:ss.SSS}) |-%-5level [%thread] %c [%L] -| %msg%n" />
    	
    	<springProperty scope="context" name="LOG_PATH" source="log.path" />
    
    	
    	<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
    		<encoder>
    			<pattern>${PATTERN}</pattern>
    		</encoder>
    	</appender>
    
    	
    	<springProfile name="dev">
    		<logger name="com.light.springboot" level="debug" />
    		<root level="info">
    			<appender-ref ref="CONSOLE" />
    		</root>
    	</springProfile>
    
    	
    	<springProfile name="test,prod">
    		
    		<appender name="FILE-OUT" class="ch.qos.logback.core.rolling.RollingFileAppender">
    			<file>${LOG_PATH}/test123.log</file>
    			<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
    				
    				<fileNamePattern>${LOG_PATH}/log/test123.%d{yyyy-MM-dd}.log</fileNamePattern>
    				
    				<MaxHistory>30</MaxHistory>
    			</rollingPolicy>
    			<layout class="ch.qos.logback.classic.PatternLayout">
    				<pattern>${PATTERN}</pattern>
    			</layout>
    		</appender>
    		<root level="info">
    			<appender-ref ref="CONSOLE" />
    			<appender-ref ref="FILE-OUT" />
    		</root>
    	</springProfile>
    
    	<logger name="org.springframework.jdbc.core.JdbcTemplate" level="debug" />
    	<logger name="org.apache.ibatis" level="debug"></logger>
    </configuration>

### 四、打印日志logger.info() ###

import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    
    @Controller
    public class DispatchController { 
    	private final Logger logger = LoggerFactory.getLogger(this.getClass());
    	
    	@RequestMapping("/{template}.html")
    	public String template(@PathVariable String template) { 
    		logger.info("fdsafsadfasdfas");
    		return template;
    	}
    }

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

> references：  
> [Spring Boot-日志配置(超详细)][Spring Boot-]  
> [Spring Boot系列——日志配置][Spring Boot]

### 五、Spring Boot + AOP 统一处理日志 ###

1.  添加依赖

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-aop</artifactId>
    </dependency>

1.  创建`WebLogAspect`类

package com.fukaiit.aspect;
    
    import java.util.Enumeration;
    import javax.servlet.http.HttpServletRequest;
    import org.aspectj.lang.JoinPoint;
    import org.aspectj.lang.annotation.AfterReturning;
    import org.aspectj.lang.annotation.Aspect;
    import org.aspectj.lang.annotation.Before;
    import org.aspectj.lang.annotation.Pointcut;
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.stereotype.Component;
    import org.springframework.web.context.request.RequestContextHolder;
    import org.springframework.web.context.request.ServletRequestAttributes;
    
    @Aspect
    @Component
    public class WebLogAspect { 
    	private Logger logger = LoggerFactory.getLogger(getClass());
    
    	// 记录请求处理时间
    	ThreadLocal<Long> startTime = new ThreadLocal<Long>();
    
    	@Pointcut("execution(public * com.fukaiit.controller..*.*(..))")
    	public void webLog() { 
    
    	}
    
    	@Before("webLog()")
    	public void doBefore(JoinPoint joinPoint) { 
    		startTime.set(System.currentTimeMillis());
    
    		ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
    		HttpServletRequest request = attributes.getRequest();
    		logger.info("===============请求内容===============");
    		logger.info("地址:" + request.getRequestURL().toString());
    		logger.info("方式:" + request.getMethod());
    		logger.info("方法:" + joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName());
    		logger.info("参数:");
    		Enumeration<String> enu = request.getParameterNames();
    		while (enu.hasMoreElements()) { 
    			String name = (String) enu.nextElement();
    			logger.info(" {}:{}", name, request.getParameter(name));
    		}
    		logger.info("===============请求内容===============");
    	}
    
    	@AfterReturning(returning = "ret", pointcut = "webLog()")
    	public void doAfterReturning(Object ret) throws Throwable { 
    		logger.info("---------------返回内容---------------");
    		logger.info("RESPONSE:" + ret);
    		logger.info("请求处理时长（毫秒）:" + (System.currentTimeMillis() - startTime.get()));
    		logger.info("---------------返回内容---------------");
    	}
    }

### 六、保存日志到数据库（留坑） ###

方案： 使用spring的aop技术切到自定义注解上，针对不同注解标志进行参数解析，记录日志。  
[springboot—spring aop 实现系统操作日志记录存储到数据库][springboot_spring aop]

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

> references：  
> [springboot集成AOP管理日志][springboot_AOP]  
> [spring-boot使用AOP统一处理日志][spring-boot_AOP]

[Spring Boot-]: https://blog.csdn.net/zombres/article/details/79260518
[20190328152351731.png]: /images/20220227/60006b5c591b4de78d299943669332e3.png
[Spring Boot]: https://www.cnblogs.com/bigdataZJ/p/springboot-log.html
[springboot_spring aop]: https://www.jianshu.com/p/d0bbdf1974bd
[springboot_AOP]: https://www.cnblogs.com/30go/p/8443522.html
[spring-boot_AOP]: https://blog.csdn.net/w05980598/article/details/79053209