java工程中封装静态的log4j日志工具类

最新推荐文章于 2023-03-28 14:47:50 发布
最新推荐文章于 2023-03-28 14:47:50 发布
阅读量2.6k 收藏 10
点赞数
分类专栏： 后端技术 文章标签： java log4j 日志 工具类
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/PiaoMiaoXiaodao/article/details/82054808
版权

一般在web工程或者普通java工程中都会用到日志记录工具,java一般使用的是log4j,用法大都是在每个需要记录日志的类上添加一个私有的日志记录器,记录本类中的异常:如下

    private final Logger logger = LoggerFactory.getLogger(Test.class);
	logger.error("报错！", e);
	logger.debug("到达方法");

log4j的配置文件中指定的日志输出格式一般如下 %d{yyyy-MM-dd HH:mm:ss} %-5p [%t] [%c@%L] %m%n
log4j的输出格式可以参考这里 log4j输出格式

输出日志如下
2018-08-25 19:49:05 DEBUG [main] [com.lsg.weblog.logutil.Log@86] 到达方法

可以看到输出的信息有 时间 线程 等级 位置 信息
而每个类自己定义单独一个日志记录器的目的只是为了获取位置而已 ([%c@%L]).为了获取一个位置信息我们必须在每个要记录日志的位置都添加一个记录器对象,这是相当麻烦的.一些时候我们需要在非常简单的java对象如mode vo dto等简单记录一些信息时候突然发现自己还必须在这对象内部添加一个日志记录器,也许会直接导致放弃日志记录的意图

其实位置信息完全可以我们自己来获取,因为原理无非都是去读取线程栈而已.
我们将配置文件中的日志输出格式去掉输出位置信息的那一截 添加自定义的位置变量 seat 变为 %d{yyyy-MM-dd HH:mm:ss} %-5p [%t] [%X{seat}] %m%n

然后创建个自己的日志记录类:



import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.slf4j.MDC;

/**
 * 日志记录
 * 
 * @author Norton Lai
 * @created 2018-8-25 下午4:41:56
 */
public class Log {
    // 源生日志记录对象
    private static final Logger log = LoggerFactory.getLogger("custom_log");
    // 本对象的路径
    private static String thisClassUrl = Log.class.getName();

    // 私有构造
    private Log() {
    }

    /**
     * 为日志自定义一个变量 seat 日志里可以添加这个位置信息[%X{seat}]
     * 
     * @param s
     * @return
     * @author Norton Lai
     * @created 2018-8-25 下午7:04:34
     */
    private static void setSeat() {
        MDC.put("seat", getInvokInfo());
    }

    /**
     * 返回此方法的调用者信息.<br>
     * 即谁调用此方法就返回调用位置的类名 方法名 行号 <br>
     * 例: >> net.evecom.cwyun.pdk.vmware.Main.main() 第 102 行 方法会从堆栈最上层往下找到第一个 非 Thread、CkUtil的调用者 ，如果没找到就取最底层的调用者信息
     * 
     * @author Norton Lai
     * @created 2017-10-16 下午2:42:43
     * @return
     */
    private static String getInvokInfo() {
        StackTraceElement[] ste = Thread.currentThread().getStackTrace();
        String className = null;
        String methodName = null;
        int lineNumber = 0;
        // 从栈的最上开始 往下找 找到第一个不为Log和线程的类
        for (int i = 0; i < ste.length; i++) {
            className = ste[i].getClassName();

            if ("java.lang.Thread".equals(className) || thisClassUrl.equals(className)) {
                if (i != (ste.length - 1)) {
                    continue;// 如果不是最后一个就跳过，如果是最后一个那就没办法了，返回这栈信息吧
                }
            }
            methodName = ste[i].getMethodName();
            lineNumber = ste[i].getLineNumber();
            break;
        }
        return className + "." + methodName + "()@" + lineNumber + "";
    }

    /**
     * 日志记录
     * 
     * @param arg0
     * @author Norton Lai
     * @created 2018-8-25 下午7:10:11
     */
    public static void debug(String arg0) {
        if (log.isDebugEnabled()) {
            setSeat();
            log.debug(arg0);
        }
    }

    /**
     * 日志记录
     * 
     * @param arg0
     * @author Norton Lai
     * @created 2018-8-25 下午7:10:11
     */
    public static void debug(String arg0, Object arg1) {
        if (log.isDebugEnabled()) {
            setSeat();
            log.debug(arg0, arg1);
        }
    }

    /**
     * 日志记录
     * 
     * @param arg0
     * @author Norton Lai
     * @created 2018-8-25 下午7:10:11
     */
    public static void debug(String arg0, Object[] arg1) {
        if (log.isDebugEnabled()) {
            setSeat();
            log.debug(arg0, arg1);
        }
    }

    /**
     * 日志记录
     * 
     * @param arg0
     * @author Norton Lai
     * @created 2018-8-25 下午7:10:11
     */
    public static void debug(String arg0, Throwable arg1) {
        if (log.isDebugEnabled()) {
            setSeat();
            log.debug(arg0, arg1);
        }
    }

    /**
     * 日志记录
     * 
     * @param arg0
     * @author Norton Lai
     * @created 2018-8-25 下午7:10:11
     */
    public static void error(String arg0) {
        if (log.isErrorEnabled()) {
            setSeat();
            log.error(arg0);
        }
    }

    /**
     * 日志记录
     * 
     * @param arg0
     * @author Norton Lai
     * @created 2018-8-25 下午7:10:11
     */
    public static void error(String arg0, Object arg1) {
        if (log.isErrorEnabled()) {
            setSeat();
            log.error(arg0, arg1);
        }
    }

    /**
     * 日志记录
     * 
     * @param arg0
     * @author Norton Lai
     * @created 2018-8-25 下午7:10:11
     */
    public static void error(String arg0, Object[] arg1) {
        if (log.isErrorEnabled()) {
            setSeat();
            log.error(arg0, arg1);
        }
    }

    /**
     * 日志记录
     * 
     * @param arg0
     * @author Norton Lai
     * @created 2018-8-25 下午7:10:11
     */
    public static void error(String arg0, Throwable arg1) {
        if (log.isErrorEnabled()) {
            setSeat();
            log.error(arg0, arg1);
        }
    }

    /**
     * 日志记录
     * 
     * @param arg0
     * @author Norton Lai
     * @created 2018-8-25 下午7:10:11
     */
    public static void info(String arg0) {
        if (log.isInfoEnabled()) {
            setSeat();
            log.info(arg0);
        }
    }

    /**
     * 日志记录
     * 
     * @param arg0
     * @author Norton Lai
     * @created 2018-8-25 下午7:10:11
     */
    public static void info(String arg0, Object arg1) {
        if (log.isInfoEnabled()) {
            setSeat();
            log.info(arg0, arg1);
        }
    }

    /**
     * 日志记录
     * 
     * @param arg0
     * @author Norton Lai
     * @created 2018-8-25 下午7:10:11
     */
    public static void info(String arg0, Object[] arg1) {
        if (log.isInfoEnabled()) {
            setSeat();
            log.info(arg0, arg1);
        }
    }

    /**
     * 日志记录
     * 
     * @param arg0
     * @author Norton Lai
     * @created 2018-8-25 下午7:10:11
     */
    public static void info(String arg0, Throwable arg1) {
        if (log.isInfoEnabled()) {
            setSeat();
            log.info(arg0, arg1);
        }
    }

    /**
     * 日志记录
     * 
     * @param arg0
     * @author Norton Lai
     * @created 2018-8-25 下午7:10:11
     */
    public static void trace(String arg0) {
        if (log.isTraceEnabled()) {
            setSeat();
            log.trace(arg0);
        }
    }

    /**
     * 日志记录
     * 
     * @param arg0
     * @author Norton Lai
     * @created 2018-8-25 下午7:10:11
     */
    public static void trace(String arg0, Object arg1) {
        if (log.isTraceEnabled()) {
            setSeat();
            log.trace(arg0, arg1);
        }
    }

    /**
     * 日志记录
     * 
     * @param arg0
     * @author Norton Lai
     * @created 2018-8-25 下午7:10:11
     */
    public static void trace(String arg0, Object[] arg1) {
        if (log.isTraceEnabled()) {
            setSeat();
            log.trace(arg0, arg1);
        }
    }

    /**
     * 日志记录
     * 
     * @param arg0
     * @author Norton Lai
     * @created 2018-8-25 下午7:10:11
     */
    public static void trace(String arg0, Throwable arg1) {
        if (log.isTraceEnabled()) {
            setSeat();
            log.trace(arg0, arg1);
        }
    }

    /**
     * 日志记录
     * 
     * @param arg0
     * @author Norton Lai
     * @created 2018-8-25 下午7:10:11
     */
    public static void warn(String arg0) {
        if (log.isWarnEnabled()) {
            setSeat();
            log.warn(arg0);
        }
    }

    /**
     * 日志记录
     * 
     * @param arg0
     * @author Norton Lai
     * @created 2018-8-25 下午7:10:11
     */
    public static void warn(String arg0, Object arg1) {
        if (log.isWarnEnabled()) {
            setSeat();
            log.warn(arg0, arg1);
        }
    }

    /**
     * 日志记录
     * 
     * @param arg0
     * @author Norton Lai
     * @created 2018-8-25 下午7:10:11
     */
    public static void warn(String arg0, Object[] arg1) {
        if (log.isWarnEnabled()) {
            setSeat();
            log.warn(arg0, arg1);
        }
    }

    /**
     * 日志记录
     * 
     * @param arg0
     * @author Norton Lai
     * @created 2018-8-25 下午7:10:11
     */
    public static void warn(String arg0, Throwable arg1) {
        if (log.isWarnEnabled()) {
            setSeat();
            log.warn(arg0, arg1);
        }
    }

}

其中

private static String getInvokInfo() {
        StackTraceElement[] ste = Thread.currentThread().getStackTrace();
        String className = null;
        String methodName = null;
        int lineNumber = 0;
        // 从栈的最上开始 往下找 找到第一个不为Log和线程的类
        for (int i = 0; i < ste.length; i++) {
            className = ste[i].getClassName();

            if ("java.lang.Thread".equals(className) || thisClassUrl.equals(className)) {
                if (i != (ste.length - 1)) {
                    continue;// 如果不是最后一个就跳过，如果是最后一个那就没办法了，返回这栈信息吧
                }
            }
            methodName = ste[i].getMethodName();
            lineNumber = ste[i].getLineNumber();
            break;
        }
        return  className + "." + methodName + "()@" + lineNumber ;
    }

代替了[%c@%L] 的功能,可以获取到相同的位置信息
这样再也不需要在其他类定义日志记录器了,直接Log.debug(“xxx”)即可,
可以比对下输出的日志格式:
原本
2018-08-25 19:49:05 DEBUG [main] [com.lsg.weblog.logutil.Log@86] 到达方法
现在
2018-08-25 19:49:05 DEBUG [main] [com.lsg.weblog.test.Test.a()@63] aaaa

几乎没有什么差别,而且完全不用担心性能问题,因为他原本也一样是通过读取栈去获取位置信息的.
这样我们就可以在工程的任何位置随心所欲的添加日志记录了
**如发现所使用的log4j版本中logger的父类 Category的callAppenders 方法中存在同步锁如下

 public void callAppenders(LoggingEvent event) {
    int writes = 0;

    for(Category c = this; c != null; c=c.parent) {
      // Protected against simultaneous call to addAppender, removeAppender,...
      synchronized(c) {
    	if(c.aai != null) {
    	  writes += c.aai.appendLoopOnAppenders(event);
    	}
    	if(!c.additive) {
    	  break;
    	}
      }
    }

    if(writes == 0) {
      repository.emitNoAppenderWarning(this);
    }
  }

则必须自己改源码去掉此同步锁,或者继承于logger自己写个子类 去掉同步锁,此锁作用只是为了防止在调用方法同时调用了添加删除append的方法.一般人压根不会去这么操作,这个锁作用不大,但及易引起死锁,减慢速度,
如果使用的log4j版本存在此锁,但没有人为去去除,那么使用此工具类可能会减慢系统运行速度!

后面考虑到全部只用一个logger去记录可能有一定的影响,又对这部分进行了修改,可以参考

java工程中封装静态的log4j日志工具类2

PiaoMiaoXiaodao
关注
  • 0
    点赞
  • 踩
  • 10
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
日志工具类-java实现
12-16
在Java中，常见的日志框架有Log4j、SLF4J（Simple Logging Facade for Java）、Java Util Logging（JUL）等。这些框架提供了丰富的功能，如日志级别控制、多目标输出（如文件、控制台、网络）和日志格式定制等。 ...
Log4j笔记 第九章 封装Log4j
03-21
- **提高效率**：封装后的Log4j类可以优化日志输出的性能，比如在DEBUG级别下，只有DEBUG级别的日志会被处理，其他级别的日志则被忽略。 3. **封装Log4j的基本步骤** - 创建一个公共的Logger工厂类，如`LogUtil`...
SpringBoot对异常的统一处理
S mile0804的博客
01-23 1410
Spring Boot默认提供了一种映射到错误页面/error的机制来处理所有的错误，可以映射到名为404或500等的错误页面，但此种机制存在局限性。为此，SpringBoot提供了注解的方式自定义统一处理服务器500错误机制。 @ControllerAdvice注解表示我们定义的是一个控制器增强类，当其他任何控制器发生异常且异常类型符合@ExceptionHandler注解中指定的异常类时，原请求将会被拦截到这个我们自定义的控制器方法中。 其annotations参数表示我们要拦截的带有指定注解的类
java：反射封装Slf4j日志工具类
a232884c的博客
12-25 1363
使用Slf4j时，针对日志打印进行工具类封装使用（java反射封装日志工具类）。
封装Logger日志工具类
最新发布
qq_34589867的博客
03-28 363
但是我们实际写代码的过程中,很可能会忘记加上Sentry上报的逻辑,所以我们需要自己封装一个Logger工具类, 在工具类中增加上报Sentry逻辑, 对比了很多工具类, 大部分工具类是无法打印通过反射调用的方法的实际调用路径, 具体可以在以下代码中的堆栈信息中判断。原文链接: https://blog.csdn.net/qq_40663357/article/details/103498837。
Java日志框架（第五章）
至尊充电宝的博客
11-10 282
个人学习Java日志框架备忘笔记
40、Java 日志输出的简单封装
众神之翼
08-13 872
package com.lill.test.utils; import com.alibaba.fastjson.JSON; import org.slf4j.Logger; public class LogUtils { private static int originStackIndex = 2; /** * 获取当前文件名称 * @retu...
c# log4net封装类及配置文件
01-04
在`LogUtil.cs`中，通常会看到一个封装的静态类，这个类负责初始化`log4net`并提供一些通用的日志记录方法。例如： ```csharp public static class LogUtil { private static readonly ILog log = LogManager....
log4cplus日志封装log
06-16
首先，`log4cplus`模仿了Java中的`log4j`框架，提供了一个强大的日志处理机制。这个库的核心设计理念是模块化、可配置性和可扩展性。它允许开发者根据需要调整日志级别（如DEBUG、INFO、WARN、ERROR等），并且可以将...
基于Android系统Api封装常用工具类.zip
03-09
9. **Log工具类**：提供日志打印功能，可以设置不同的日志级别，便于调试和追踪代码执行过程。 10. **Intent工具类**：简化启动Activity、Service或BroadcastReceiver的Intent创建过程，可能还包含额外的数据传递...
【常用工具类】Java控制台打印工具类LogUtil
知不足而奋进，望远山而前行
05-26 2万+
代码】【常用工具类】Java控制台打印工具类LogUtil。
8.05 Day36----Spring两大核心模块
qq_63771774的博客
08-05 140
IOC&DI Inversion Of Control 控制反转（在运行时基于反射发现组件类和注册对象的过程） Dependency Injection 依赖注入（赋值的工程） 具有IoC功能的注解： 什么控制权？ 为什么要反转？ Component组件（组成工程的原件，指的是类） Bean/JavaBean 咖啡豆/组成（指的对象/被IoC容器发现后创建的对象） IoC&DI的实现方式有3种： 日志管理： 打印日志的规则： 日志级别： 设置日志规则： AOP： 建aop的依..
主流代码扫描静态分析工具
baidu_39574145的博客
02-11 9840
市场上静态代码扫描工具百花齐放，种类繁多，本文通过相关云厂商咨询、互联网峰会资料查阅和主流技术网站检索得出初步结论，和大家分享讨论。
java日志LoggerFactory.getLogger最全讲解使用方法
热门推荐
weixin_43085797的博客
04-26 6万+
LoggerFactory.getLogger可以在IDE控制台打印日志，便于开发，一般加在最上面： 使用： //调试日志 private final static Logger logger = LoggerFactory.getLogger(xxxController.class); 优点：使用指定类初始化日志对象，在日志输出的时候，可以打印出日志信息所在类 logger日志的几个方...
SpringBoot快速入门（笔记四-实用运维篇）
南郊靳东的个人博客
03-21 2335
本章节将讲一下我们在实际部署springBoot 项目中需要注意的问题 一：打包与运行 二：配置高级 三：多环境开发 四：日志
LoggerFactory.getLogger的用法
leewe7的博客
05-21 1056
Logger类下有多个不同的error方法，根据传入参数的个数及类型的不同，自动选择不同的重载方法。 使用+，只打印异常，不打印堆栈信息 private static final Logger logger = LoggerFactory.getLogger(LoggerTest.class); @Test public void logEorrorTest(){ try { int a=0; int c = 5/a;
LoggerFactory.getLogger用法
LeslieTsai2019的博客
07-18 1175
我在使用全局异常处理器时用到这个Logger对象， 作用是：使用指定类初始化日志对象 @ControllerAdvice //与@Exceptionhandler配合使用实现全局异常处理 public class GlobalExceptionHandler { private static final Logger LOGGER = LoggerFactory.getLogger(GlobalExceptionHandler.class); //捕获Exception异常
slf4j
底层码农
04-18 343
slf4j
java 日志系统学习
belusoi的博客
04-21 423
java 日志系统学习 一、 日志系统 1.JUL（java util logging）日志封装 JUL、logback、log4j、log4j2 2.JCL (jakarta Commons Logging) 日志接口 slf4j、JCL 二、JUL 学习 JUL 全称 java util Logging 是java 原生的日志框架，使用时不需要引入第三方类库。 2.1 框架介绍 Logger : 记录器，应用程序通过获取Logger对象，调用其API 来发布日志信息。Logger
Java微服务实践：Spring Boot日志与Log4j解析
8. **日志事件**（org.apache.log4j.LoggingEvent）：封装了日志信息，包括级别、时间戳、日志源等。 9. **日志配置器**（org.apache.log4j.spi.Configurator）：处理日志配置，如XMLConfigurator用于解析XML配置...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值