关于日志（slf4j的使用心得）

2024-06-23 16:32
文章标签 使用 日志 心得 slf4j

本文主要是介绍关于日志（slf4j的使用心得），希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

没有调试过线上bug的人学不会打log

1. Object… arguments

从slf4j-1.6.0开始，public void error(String format, Object... arguments);中arguments的最后一个参数如果是throwable对象，将会被作为异常信息进行打印。
slf4j-1.6.0以前，只能通过public void error(String msg, Throwable t);打印异常信息，缺点是必须通过拼接字符串的形式把arguments组装为msg。

2. MDC的使用

本节内容摘取自：Slf4j MDC 使用和 基于 Logback 的实现分析(感谢原作者)
有了日志之后，我们就可以追踪各种线上问题。但是，在分布式系统中，各种无关日志穿行其中，导致我们可能无法直接定位整个操作流程。因此，我们可能需要对一个用户的操作流程进行归类标记，比如使用线程+时间戳，或者用户身份标识等；如此，我们可以从大量日志信息中grep出某个用户的操作流程，或者某个时间的流转记录。
MDC ( Mapped Diagnostic Contexts )，顾名思义，其目的是为了便于我们诊断线上问题而出现的方法工具类。虽然，Slf4j 是用来适配其他的日志具体实现包的，但是针对 MDC功能，目前只有logback 以及 log4j 支持。
在日志模板中，使用 %X{ }来占位，替换到对应的 MDC 中 key 的值。

看一个MDC使用的简单示例：

public class LogTest {private static final Logger logger = LoggerFactory.getLogger(LogTest.class);public static void main(String[] args) {MDC.put("THREAD_ID", String.valueOf(Thread.currentThread().getId()));logger.info("纯字符串信息的info级别日志");}
}

logback的输出模板配置：

<?xml version="1.0" encoding="UTF-8"?>
<configuration><property name="log.base" value="${catalina.base}/logs" /><contextListener class="ch.qos.logback.classic.jul.LevelChangePropagator"><resetJUL>true</resetJUL></contextListener><appender name="console" class="ch.qos.logback.core.ConsoleAppender"><encoder charset="UTF-8"><pattern>[%d{yyyy-MM-dd HH:mm:ss} %highlight(%-5p) %logger.%M\(%F:%L\)] %X{THREAD_ID} %msg%n</pattern></encoder></appender><root level="INFO"><appender-ref ref="console" /></root>
</configuration>

于是，就有了输出：

[2015-04-30 15:34:35 INFO  io.github.ketao1989.log4j.LogTest.main(LogTest.java:29)] 1 纯字符串信息的info级别日志

3. 日志文件的分类

STDOUT：控制台输出日志
RollingFile：完整的日志文件
ErrorFile：保存系统报错
MainFile：保存系统一些关键日志，便于搜索

4. 常用配置

工具类：

package com.example;import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.slf4j.MDC;/*** 日志工具类* * @author frcoder*/
public class LogUtil {/*** 记录用户行为*/public static Logger userLog = LoggerFactory.getLogger("@USER");public static void newUserLog(String somethings) {MDC.put("USER", "");MDC.put("DO", somethings);userLog.debug("...");}public static void newUserLog(Object userId, String somethings) {MDC.put("USER", userId.toString());MDC.put("DO", somethings);userLog.debug("...");}public static void newUserLog(Object userId, Object role, String somethings) {MDC.put("USER", UserRole.toRoleString((Integer) role) + ":" + userId.toString());MDC.put("DO", somethings);userLog.debug("...");}public static void userQuit() {MDC.clear();}
}

配置：

Configuration:# Internal Log4j events levelstatus: warn# Automatic Reconfiguration, unit: secondmonitorInterval: 300dest: errname: YAMLConfigproperties:property:-name: projectNamevalue: me-name: logHomevalue: /tmp/logsthresholdFilter:level: debugappenders:## Console appenderConsole:name: STDOUTPatternLayout:Pattern: "%d %-5p %c [%L] [%t] [%X{USER}:%X{DO}] - %m%n"## RollingFile appenderRollingRandomAccessFile:-name: RollingFilefilename: "${logHome}/${projectName}.log"filePattern: "${logHome}/${projectName}.%d{yyyy-MM-dd}-%i.log.gz"PatternLayout:Pattern: "%d %-5p %c [%L] [%t] [%X{USER}:%X{DO}] - %m%n"Policies:SizeBasedTriggeringPolicy:size: 20MBDefaultRollOverStrategy:max: 5Delete:basePath: "/tmp/logs"maxDepth: 1IfFileName:glob: "epg*.log.*"IfLastModified:age: 5d-name: ErrorFilefilename: "${logHome}/${projectName}-error.log"filePattern: "${logHome}/${projectName}-error.%d{yyyy-MM-dd}-%i.log.gz"PatternLayout:Pattern: "%d %-5p %c [%L] [%t] [%X{USER}:%X{DO}] - %m%n"Policies:SizeBasedTriggeringPolicy:size: 20MBDefaultRollOverStrategy:max: 5-name: MainFilefilename: "${logHome}/${projectName}-main.log"filePattern: "${logHome}/${projectName}-main.%d{yyyy-MM-dd}-%i.log.gz"thresholdFilter:level: debugPatternLayout:Pattern: "%d %-5p %c [%L] [%t] [%X{USER}:%X{DO}] - %m%n"Policies:SizeBasedTriggeringPolicy:size: 20MBDefaultRollOverStrategy:max: 5Loggers:logger:-name: com.examplelevel: debugadditivity: falseAppenderRef:- ref: MainFile- ref: STDOUT-name: "@USER"level: debugadditivity: falseAppenderRef:- ref: MainFile- ref: STDOUT-name: org.hibernate.SQLlevel: warnRoot:level: infoAppenderRef:- ref: STDOUTlevel: error- ref: RollingFilelevel: info- ref: ErrorFilelevel: error

注意：上面代码中的additivity属性（false：只在本logger中输出，不要传递给上级logger；true：不仅在本logger中输出，也会传递给上级，如果本logger和上级logger都指向同一个日志文件，则日志可能会在该文件中打印2次。）

特别提示：各个level的优先级
thresholdFilter：总开关，低于这个级别的日志都不会显示
logger下：logger.level和logger.AppenderRef.level的级别取最低值

5. 日志与行为

一般在行为完成之后才打日志，看到日志就表示该行为已完成。

6. Response模板类

package com.example;import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonProperty;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;/*** Response模板类* * @author frcoder*/
@ApiModel(value = "Response", description = "接口响应对象")
public class Response<T> {@ApiModelProperty(value = "编码")@JsonProperty("code")private int code;@ApiModelProperty(value = "消息")@JsonProperty("message")private String message;@ApiModelProperty(value = "数据")@JsonProperty("data")private T data;@JsonIgnoreprivate Exception exception;public static <T> Response<T> ok() {return ok(null, "success");}public static <T> Response<T> ok(T data) {return ok(data, "success");}public static <T> Response<T> ok(T data, String message) {return ok(0, data, message);}public static <T> Response<T> ok(Integer code, T data, String message) {return new Response(code, message, data);}public static <T> Response<T> fail(String message) {return fail(99, message);}public static <T> Response<T> fail(Integer code, String message) {return new Response(code, message);}public static <T> Response<T> failParam(String message) {return fail(400, message);}public static <T> Response<T> error(String message, Exception e) {return error(99, message, e);}public static <T> Response<T> error(Integer code, String message, Exception e) {return new Response(code, message).exception(e);}public Response() {}public Response(int code) {this.code = code;}public Response(int code, String message) {this.code = code;this.message = message;}public Response(int code, String message, T data) {this.code = code;this.message = message;this.data = data;}public int getCode() {return code;}public void setCode(int code) {this.code = code;}public Response code(int code) {this.code = code;return this;}public String getMessage() {return message;}public void setMessage(String message) {this.message = message;}public Response message(String message) {this.message = message;return this;}public T getData() {return data;}public void setData(T data) {this.data = data;}public Response data(T data) {this.data = data;return this;}public Exception getException() {return exception;}public void setException(Exception exception) {this.exception = exception;}public Response exception(Exception exception) {this.exception = exception;return this;}
}

7. 注解与切面在日志中的应用

1. 在gradle中引入jar包

compile "org.springframework.boot:spring-boot-starter-aop:${springBootVersion}"

2. 编写注解类

package com.example;import java.lang.annotation.*;/*** @Log注解类* * @author frcoder*/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Log {String value() default "";
}

package com.example;import com.example.Response;
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 static com.example.LogUtil.userLog;/*** LogAop日志切面类* * @author frcoder*/
@Aspect
@Component
public class LogAop {private static Logger logger = LoggerFactory.getLogger(LogAop.class);/*** api.impl包下的函数，如果参数列表是以userId, role开头的会被记录用户日志*/@Pointcut("execution(public * com..api.impl..*.*(..)) || @annotation(Log))")public void log() {}@Before(value = "log()")public void doBeforeLog(JoinPoint joinPoint) {try {String methodName = joinPoint.getSignature().getName();Map args = AOPUtil.getArgs(joinPoint);if (args.containsKey("userId")) {if (args.containsKey("role")) {LogUtil.newUserLog(args.get("userId"), args.get("role"), methodName);} else {LogUtil.newUserLog(args.get("userId"), methodName);}} else {LogUtil.newUserLog(methodName);}} catch (Exception e) {logger.debug("LogAop doBefore new Log is wrong", e);}}@AfterReturning(value = "log()", returning = "ret")public void doAfterReturningLog(Object ret) {try {Response response = (Response) ret;userLog.info("[{}]: {}", response.getCode(), response.getMessage());if (response.getData() != null) {userLog.debug(StringUtil.Obj2JsonStr(response.getData()));}if (response.getException() != null) {userLog.error(response.getException().toString(), response.getException());}} catch (Exception e) {logger.debug("LogAop doAfterReturning is wrong", e);} finally {LogUtil.userQuit();}}}
package com.example;import org.aspectj.lang.JoinPoint;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.core.DefaultParameterNameDiscoverer;
import org.springframework.core.ParameterNameDiscoverer;import java.lang.reflect.Method;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;/*** AOP工具类* * @author frcoder*/
public class AOPUtil {private static Logger logger = LoggerFactory.getLogger(AOPUtil.class);/*** 用于提取切入点参数*/public static Map getArgs(JoinPoint joinPoint) {try {String classType = joinPoint.getTarget().getClass().getName();String methodName = joinPoint.getSignature().getName();// 获取参数值Object[] args = joinPoint.getArgs();Class<?>[] classes = new Class[args.length];for (int k = 0; k < args.length; k++) {if (!args[k].getClass().isPrimitive()) {// 获取的是封装类型而不是基础类型String result = args[k].getClass().getName();Class s = map.get(result);classes[k] = s == null ? args[k].getClass() : s;}}// 获取方法（第二个参数可以不传，但是为了防止有重载的现象，还是需要传入参数的类型）Method method = Class.forName(classType).getMethod(methodName, classes);// 获取参数名ParameterNameDiscoverer pnd = new DefaultParameterNameDiscoverer();String[] parameterNames = pnd.getParameterNames(method);// 通过map封装参数名和参数值HashMap<String, Object> paramMap = new HashMap();for (int i = 0; i < parameterNames.length; i++) {paramMap.put(parameterNames[i], args[i]);}return paramMap;} catch (Exception e) {logger.error("提取切入点参数出错", e);}return Collections.EMPTY_MAP;}private static HashMap<String, Class> map = new HashMap<String, Class>() {{put("java.lang.Integer", Integer.class);put("java.lang.Double", Double.class);put("java.lang.Float", Float.class);put("java.lang.Long", Long.class);put("java.lang.Short", Short.class);put("java.lang.Boolean", Boolean.class);put("java.lang.Char", Character.class);}};}

这篇关于关于日志（slf4j的使用心得）的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1087684。

相关文章

SpringBoot使用ffmpeg实现视频压缩

SpringBoot使用ffmpeg实现视频压缩

《SpringBoot使用ffmpeg实现视频压缩》FFmpeg是一个开源的跨平台多媒体处理工具集,用于录制,转换,编辑和流式传输音频和视频,本文将使用ffmpeg实现视频压缩功能,有需要的可以参考... 目录核心功能1.格式转换2.编解码3.音视频处理4.流媒体支持5.滤镜（Filter）安装配置linu
阅读更多...
Redis中的Lettuce使用详解

Redis中的Lettuce使用详解

《Redis中的Lettuce使用详解》Lettuce是一个高级的、线程安全的Redis客户端,用于与Redis数据库交互,Lettuce是一个功能强大、使用方便的Redis客户端,适用于各种规模的J... 目录简介特点连接池连接池特点连接池管理连接池优势连接池配置参数监控常用监控工具通过JMX监控通过Pr
阅读更多...
Apache 高级配置实战之从连接保持到日志分析的完整指南

Apache 高级配置实战之从连接保持到日志分析的完整指南

《Apache高级配置实战之从连接保持到日志分析的完整指南》本文带你从连接保持优化开始,一路走到访问控制和日志管理,最后用AWStats来分析网站数据,对Apache配置日志分析相关知识感兴趣的朋友... 目录Apache 高级配置实战：从连接保持到日志分析的完整指南前言 一、Apache 连接保持 - 性
阅读更多...
apache的commons-pool2原理与使用实践记录

apache的commons-pool2原理与使用实践记录

《apache的commons-pool2原理与使用实践记录》ApacheCommonsPool2是一个高效的对象池化框架,通过复用昂贵资源（如数据库连接、线程、网络连接）优化系统性能,这篇文章主... 目录一、核心原理与组件二、使用步骤详解（以数据库连接池为例）三、高级配置与优化四、典型应用场景五、注意事
阅读更多...
使用Python实现Windows系统垃圾清理

使用Python实现Windows系统垃圾清理

《使用Python实现Windows系统垃圾清理》Windows自带的磁盘清理工具功能有限,无法深度清理各类垃圾文件,所以本文为大家介绍了如何使用Python+PyQt5开发一个Windows系统垃圾... 目录一、开发背景与工具概述1.1 为什么需要专业清理工具1.2 工具设计理念二、工具核心功能解析2.
阅读更多...
Linux系统之stress-ng测压工具的使用

Linux系统之stress-ng测压工具的使用

《Linux系统之stress-ng测压工具的使用》：本文主要介绍Linux系统之stress-ng测压工具的使用,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录一、理论1.stress工具简介与安装2.语法及参数3.具体安装二、实验1.运行8 cpu, 4 fo
阅读更多...
Java使用MethodHandle来替代反射,提高性能问题

Java使用MethodHandle来替代反射,提高性能问题

《Java使用MethodHandle来替代反射,提高性能问题》：本文主要介绍Java使用MethodHandle来替代反射,提高性能问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑... 目录一、认识MethodHandle1、简介2、使用方式3、与反射的区别二、示例1、基本使用2、（重要）
阅读更多...
使用C#删除Excel表格中的重复行数据的代码详解

使用C#删除Excel表格中的重复行数据的代码详解

《使用C#删除Excel表格中的重复行数据的代码详解》重复行是指在Excel表格中完全相同的多行数据,删除这些重复行至关重要,因为它们不仅会干扰数据分析,还可能导致错误的决策和结论,所以本文给大家介绍... 目录简介使用工具C# 删除Excel工作表中的重复行语法工作原理实现代码C# 删除指定Excel单元
阅读更多...
MySQL 事务的概念及ACID属性和使用详解

MySQL 事务的概念及ACID属性和使用详解

《MySQL事务的概念及ACID属性和使用详解》MySQL通过多线程实现存储工作,因此在并发访问场景中,事务确保了数据操作的一致性和可靠性,下面通过本文给大家介绍MySQL事务的概念及ACID属性和... 目录一、什么是事务二、事务的属性及使用2.1 事务的 ACID 属性2.2 为什么存在事务2.3 事务
阅读更多...
Nacos日志与Raft的数据清理指南

Nacos日志与Raft的数据清理指南

《Nacos日志与Raft的数据清理指南》随着运行时间的增长,Nacos的日志文件（logs/）和Raft持久化数据（data/protocol/raft/）可能会占用大量磁盘空间,影响系统稳定性,本... 目录引言1. Nacos 日志文件（logs/ 目录）清理1.1 日志文件的作用1.2 是否可以删除
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2