Springboot 日志处理

发布于：2024-11-02 ⋅ 阅读:(47) ⋅ 点赞:(0)
微信交流群：https://732903.hlcode.cn/?id=NK1fWUR

一、日志存入数据库（AOP）

1.引入aop依赖

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

2.创建aop包，自定义注解（用于在Controller层使用注解标注哪个方法需要增加日志） 

在log包下创建Log.java文件
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Log {
String value() default "";
}
@interface 注解类，自定义注解
@Target 用来说明该注解可以被声明在那些元素之前
ElementType.METHOD说明该注解只能被声明在一个类的方法前
@Retention 用来说明该注解类的生命周期。
RetentionPolicy.RUNTIME注解保留在程序运行期间，此时可以通过反射获得定义在某个类上的所有注解

3.编写LogAspect增强类与增强方法（我们使用环绕增强around）

 

@Aspect
@Component
public class LogAspect {
    //切入点，指定当使用Log注解时进入环绕增强 
    @Pointcut("@annotation(com.hz.aop.BootLog)")//路径自己记得改改
    public void pointcut() {}
    @Around("pointcut()")
    public Object around(ProceedingJoinPoint point) {
        try {
             System.out.println("执行环绕增强..............开始");
             Object result = point.proceed();//执行方法
             System.out.println("结束..........");
             return result;
        } catch (Throwable throwable) {
        throwable.printStackTrace();
    }
    return null;
    }
}

4.创建controller进行测试

@BootLog("获取所有用户集合")
@GetMapping("/getSfUserList")
public List<SfUser> getSfUserList() {
List<SfUser> sfUserList = sfUserService.getSfUserList(1);
System.out.println(sfUserList.size());
return sfUserList;
}

 有公共类可以

 我的公共类

package com.hz.pojo.dto;

import lombok.Getter;
import lombok.Setter;

import java.io.Serializable;

@Setter
@Getter
public class ResultJSON implements Serializable {
    private String code;
    private String msg;
    private Object data;
    public ResultJSON(){}

    public ResultJSON(String code, String msg, Object data) {
        this.code = code;
        this.msg = msg;
        this.data = data;
    }

    public ResultJSON(String msg) {
        this.msg = msg;
    }

    public ResultJSON(String code, String msg) {
        this.code = code;
        this.msg = msg;
    }
    public static ResultJSON ok(String msg){

        return new ResultJSON("200",msg);
    }
    public static ResultJSON ok(Object data){

        return new ResultJSON("200","请求成功",data);
    }
    public static ResultJSON ok(){

        return new ResultJSON("200","请求成功");
    }

    public static ResultJSON error(){
        return new ResultJSON("400","请求失败");
    }
    public static ResultJSON error(String msg){
        return new ResultJSON("400",msg);
    }
}

 

测试

 

二、开始写入数据库

1. 创建日志记录表 sys_log 
DROP TABLE IF EXISTS `sys_log`;
CREATE TABLE `sys_log` (
`ID` bigint(20) NOT NULL AUTO_INCREMENT,
`USERNAME` varchar(50) DEFAULT NULL COMMENT '用户名',
`OPERATION` varchar(50) DEFAULT NULL COMMENT '用户操作',
`TIME` int(11) DEFAULT NULL COMMENT '响应时间',
`METHOD` varchar(200) DEFAULT NULL COMMENT '请求方法',
`PARAMS` varchar(500) DEFAULT NULL COMMENT '请求参数',
`IP` varchar(64) DEFAULT NULL COMMENT 'IP地址',
`CREATE_TIME` timestamp NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
PRIMARY KEY (`ID`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

 数据库别错了

 2.创建实体类

/**
* 日志记录实体类
*/
@Data
@TableName("sys_log")
public class SysLog {
    @TableId("id")
    private Long id;
    private String username;
    private String operation;
    private Integer time;
    private String method;
    private String params;
    private String ip;
    private Date createTime;
}

 

 3.编写DAO层接口与实现，向表中插入数据

package com.hz.dao;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.hz.pojo.SysLog;

public interface SysLogDao extends BaseMapper<SysLog> {
    
}

 

4.修改LogAspect增强类与增强方法

package com.hz.utls;

import javax.servlet.http.HttpServletRequest;

public class IPUtils {

	/**
	 * 获取IP地址
	 * 
	 * 使用Nginx等反向代理软件， 则不能通过request.getRemoteAddr()获取IP地址
	 * 如果使用了多级反向代理的话，X-Forwarded-For的值并不止一个，而是一串IP地址，X-Forwarded-For中第一个非unknown的有效IP字符串，则为真实IP地址
	 */
	public static String getIpAddr(HttpServletRequest request) {

		String ip = request.getHeader("x-forwarded-for");
		if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
			ip = request.getHeader("Proxy-Client-IP");
		}
		if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
			ip = request.getHeader("WL-Proxy-Client-IP");
		}
		if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
			ip = request.getRemoteAddr();
		}
		return "0:0:0:0:0:0:0:1".equals(ip) ? "127.0.0.1" : ip;
	}

}

package com.hz.utls;

import javax.servlet.http.HttpServletRequest;

import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

public class HttpContextUtils {
	public static HttpServletRequest getHttpServletRequest() {
		return ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
	}
}

@Aspect
@Component
public class LogAspect {
@Autowired
private SysLogDao sysLogDao;
@Pointcut("@annotation(com.hz.log.Log)")
public void pointcut() {}
@Around("pointcut()")
public Object around(ProceedingJoinPoint point) {
try {
long beginTime = System.currentTimeMillis();//开始执行时间
Object result = point.proceed();//执行方法
// 执行时长(毫秒)
long time = System.currentTimeMillis() - beginTime;
//实例化日志类
SysLog sysLog = new SysLog();
sysLog.setUsername("wzy");//模拟一个用户名 实际可以从session中获取
sysLog.setTime((int) time);//执行时长(毫秒)
// 获取request
HttpServletRequest request =
HttpContextUtils.getHttpServletRequest();
// 设置IP地址
sysLog.setIp(IPUtils.getIpAddr(request));
MethodSignature signature = (MethodSignature) point.getSignature();
Method method = signature.getMethod();
Log logAnnotation = method.getAnnotation(Log.class);
if (logAnnotation != null) {
// 注解上的描述
sysLog.setOperation(logAnnotation.value());
}
// 请求的方法名
String className = point.getTarget().getClass().getName();
String methodName = signature.getName();
sysLog.setMethod(className + "." + methodName + "()");
// 请求的方法参数值
Object[] args = point.getArgs();
// 请求的方法参数名称
LocalVariableTableParameterNameDiscoverer u = new
LocalVariableTableParameterNameDiscoverer();
String[] paramNames = u.getParameterNames(method);
if (args != null && paramNames != null) {
String params = "";
for (int i = 0; i < args.length; i++) {
params += " " + paramNames[i] + ": " + args[i];
}
sysLog.setParams(params);
}
// 保存系统日志
sysLogDao.saveSysLog(sysLog);
return result;
} catch (Throwable throwable) {
throwable.printStackTrace();
}
return null;
}
}
注意：
IP的获取需要工具类，网上可以自行查找
获取参数与获取方法名的方式都可以从网站查询

5.运行测试@Log

三、日志控制台打印与写入文件（logback）

 1.创建logback-spring.xml文件放入resource下，并复制内容到该文件

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<property name="LOG_CONTEXT_NAME" value="log"/>
<!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径-->
<property name="LOG_HOME" value="D:/logs" />
<!-- 定义日志上下文的名称 -->
<contextName>${LOG_CONTEXT_NAME}</contextName>
<!-- 控制台输出 -->
<!--<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
&lt;!&ndash;格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个
字符宽度%msg：日志消息，%n是换行符&ndash;&gt;
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %highlight(%-5level)
%cyan(%logger{50}:%L) - %msg%n</pattern>
<charset>utf-8</charset>
</encoder>
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>INFO</level>
</filter>
</appender>-->
<!-- 彩色日志依赖的渲染类 -->
<conversionRule conversionWord="clr"
converterClass="org.springframework.boot.logging.logback.ColorConverter" />
<conversionRule conversionWord="wex"
converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProx
yConverter" />
<conversionRule conversionWord="wEx"
converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrow
ableProxyConverter" />
<!-- 彩色日志格式 -->
<property name="CONSOLE_LOG_PATTERN" value="${CONSOLE_LOG_PATTERN:-
%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p})
%clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint}
%clr(%-40.40logger{39}){cyan} %clr(:){faint}
%m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>
<!--1. 输出到控制台-->
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<!--此日志appender是为开发使用，只配置最底级别，控制台输出的日志级别是大于或等于此级
别的日志信息-->
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>INFO</level>
</filter>
<encoder>
<Pattern>${CONSOLE_LOG_PATTERN}</Pattern>
<!-- 设置字符集 -->
<charset>UTF-8</charset>
</encoder>
</appender>
<!--info日志统一输出到这里-->
<appender name="file.info"
class="ch.qos.logback.core.rolling.RollingFileAppender">
<Prudent>true</Prudent>
<rollingPolicy
class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!--日志文件输出的文件名，按小时生成-->
<FileNamePattern>${LOG_HOME}/%d{yyyy-MM-dd}/info/info.%d{yyyy-MM-ddHH}.%i.log</FileNamePattern>
<!--日志文件保留天数-->
<MaxHistory>30</MaxHistory>
<timeBasedFileNamingAndTriggeringPolicy
class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<!-- 除按日志记录之外，还配置了日志文件不能超过10M(默认)，若超过10M，日志
文件会以索引0开始， -->
<maxFileSize>10MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符
宽度 %method 方法名 %L 行数 %msg：日志消息，%n是换行符-->
<pattern> %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level
%logger{56}.%method:%L - %msg%n</pattern>
<charset>utf-8</charset>
</encoder>
<!-- 此日志文件只记录info级别的 -->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>INFO</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<!--错误日志统一输出到这里-->
<appender name="file.error"
class="ch.qos.logback.core.rolling.RollingFileAppender">
<Prudent>true</Prudent>
<rollingPolicy
class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!--日志文件输出的文件名，按天生成-->
<FileNamePattern>${LOG_HOME}/%d{yyyy-MM-dd}/error/error.%d{yyyy-MMdd}.%i.log</FileNamePattern>
<!--日志文件保留天数-->
<MaxHistory>30</MaxHistory>
<timeBasedFileNamingAndTriggeringPolicy
class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<!-- 除按日志记录之外，还配置了日志文件不能超过10M(默认)，若超过10M，日志
文件会以索引0开始， -->
<maxFileSize>10MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符
宽度 %method 方法名 %L 行数 %msg：日志消息，%n是换行符-->
<pattern> %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level
%logger{56}.%method:%L - %msg%n</pattern>
<charset>utf-8</charset>
</encoder>
<!-- 此日志文件只记录error级别的 -->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>ERROR</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<!--warn日志统一输出到这里-->
<appender name="file.warn"
class="ch.qos.logback.core.rolling.RollingFileAppender">
<Prudent>true</Prudent>
<rollingPolicy
class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<FileNamePattern>${LOG_HOME}/%d{yyyy-MM-dd}/warn/warn.%d{yyyy-MMdd}.%i.log</FileNamePattern>
<!--日志文件保留天数-->
<MaxHistory>30</MaxHistory>
<timeBasedFileNamingAndTriggeringPolicy
class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<!-- 除按日志记录之外，还配置了日志文件不能超过10M(默认)，若超过10M，日志
文件会以索引0开始， -->
<maxFileSize>10MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符
宽度 %method 方法名 %L 行数 %msg：日志消息，%n是换行符-->
<pattern> %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level
%logger{56}.%method:%L - %msg%n</pattern>
<charset>utf-8</charset>
</encoder>
<!-- 此日志文件只记录warn级别的 -->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>WARN</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<!-- 日志输出级别 -->
<root level="DEBUG">
<appender-ref ref="STDOUT" />
<appender-ref ref="file.error" />
<appender-ref ref="file.info" />
<appender-ref ref="file.warn" />
</root>
</configuration>

2.配置application.properties文件

#读取配置文件
logging.config=classpath:logback-spring.xml

3.编写controller测试

Logger log = Logger.getLogger(SfUserController.class);
log.info("要输出的内容"）；//输出信息
等级可分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL，如果配置OFF则不打出任何信息，如果配置
为INFO这样只显示INFO, WARN, ERROR的log信息，而DEBUG信息不会被显示

网站公告

今日签到

点亮在社区的每一天
去签到

热门文章

最新发布