日志组件统一整理

于 2021-12-20 14:31:52 发布
阅读量313 收藏
点赞数
文章标签： java 后端
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/qq_43215592/article/details/122040021
版权

背景

log4j 与 log4j2

log4j2是log4j的升级版，二者互不兼容，据说log4j2带来了十倍的性能提升，所以基本上不再使用log4j1
log4j 1代的依赖如下：

<artifactId>log4j</artifactId>
<groupId>log4j</groupId>

log4j2的依赖如下：

   <dependency>
        <groupId>org.apache.logging.log4j</groupId>
        <artifactId>log4j-api</artifactId>
        <version>2.11.0</version>
    </dependency>
    <dependency>
        <groupId>org.apache.logging.log4j</groupId>
        <artifactId>log4j-core</artifactId>
        <version>2.11.0</version>
    </dependency>

如果你的项目是web项目，最好加上

 <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-web</artifactId>
            <version>2.11.0</version>
 </dependency>

slf4j

slf4j全称为Simple Logging Facade for JAVA，java简单日志门面。类似于Apache Common-Logging，是对不同日志框架提供的一个门面封装，可以在部署的时候不修改任何配置即可接入一种日志实现方案。但是，他在编译时静态绑定真正的Log库。使用SLF4J时，如果你需要使用某一种日志实现，那么你必须选择正确的SLF4J的jar包的集合（各种桥接包）。

slf4j静态绑定原理：SLF4J 会在编译时会绑定import org.slf4j.impl.StaticLoggerBinder;
该类里面实现对具体日志方案的绑定接入。任何一种基于slf4j
的实现都要有一个这个类。如：org.slf4j.slf4j-log4j12-1.5.6: 提供对 log4j
的一种适配实现。注意：如果有任意两个实现slf4j 的包同时出现，那么就可能出现问题。

slf4j 的依赖我们后面再分析，不同的实现对应不同的依赖

<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>1.7.25</version>
</dependency>

common-logging

common-logging是apache提供的一个通用的日志接口。用户可以自由选择第三方的日志组件作为具体实现，像log4j，或者jdk自带的logging， common-logging会通过动态查找的机制，在程序运行时自动找出真正使用的日志库。当然，common-logging内部有一个Simple logger的简单实现，但是功能很弱。所以使用common-logging，通常都是配合着log4j来使用。使用它的好处就是，代码依赖是common-logging而非log4j， 避免了和具体的日志方案直接耦合，在有必要时，可以更改日志实现的第三方库。

common-logging的依赖

<artifactId>commons-logging</artifactId>
<groupId>commons-logging</groupId>

slf4j 与 common-logging 比较

common-logging通过动态查找的机制，在程序运行时自动找出真正使用的日志库。由于它使用了ClassLoader寻找和载入底层的日志库， 导致了象OSGI（是基于模块（Bundle）驱动的，每个模块都有属于自己的classpath和类加载器，模块之间通过包暴露和引入进行关联，每个模块有着自己独立的生命周期，我们可以动态地对模块进行加载、卸载、更新）这样的框架无法正常工作，因为OSGI的不同的插件使用自己的ClassLoader。 OSGI的这种机制保证了插件互相独立，然而却使Apache Common-Logging无法工作。

**slf4j在编译时静态绑定真正的Log库,因此可以再OSGI中使用。**另外，SLF4J 支持参数化的log字符串，避免了之前为了减少字符串拼接的性能损耗而不得不写的if(logger.isDebugEnable())，现在你可以直接写：logger.debug(“current user is: {}”, user)。拼装消息被推迟到了它能够确定是不是要显示这条消息的时候，但是获取参数的代价并没有幸免（可以通过lambda达到延迟生成参数的效果）。

public static void delayDebug(Supplier<String> message) {
    if (log.isDebugEnabled()) {
        log.debug(message.get());
    }
}

LogBack

Logback是由log4j创始人设计的又一个开源日记组件。logback当前分成三个模块：logback-core,logback- classic和logback-access。logback-core是其它两个模块的基础模块。logback-classic是log4j的一个 改良版本。此外logback-classic完整实现SLF4J API使你可以很方便地更换成其它日记系统如log4j或JDK14 Logging。logback-access访问模块与Servlet容器集成提供通过Http来访问日记的功能。

logback的依赖

<dependency>  
       <groupId>ch.qos.logback</groupId>  
       <artifactId>logback-classic</artifactId>    
</dependency>

(听上去logback比log4j2更好，日后可以考虑切换到logback)

Log4j 与 LogBack 比较

LogBack作为一个通用可靠、快速灵活的日志框架，将作为Log4j的替代和SLF4J组成新的日志系统的完整实现。LOGBack声称具有极佳的性能，“ 某些关键操作，比如判定是否记录一条日志语句的操作，其性能得到了显著的提高。这个操作在LogBack中需要3纳秒，而在Log4J中则需要30纳秒。 LogBack创建记录器（logger）的速度也更快：13微秒，而在Log4J中需要23微秒。更重要的是，它获取已存在的记录器只需94纳秒，而 Log4J需要2234纳秒，时间减少到了1/23。跟JUL相比的性能提高也是显著的”。 另外，LOGBack的所有文档是全面免费提供的，不象Log4J那样只提供部分免费文档而需要用户去购买付费文档。

实战

我们在项目中使用的log4j2，引入了log4j2的依赖，并且强制干掉了其它日志组件的依赖，同时使用slf4j桥接其它日志组件到log4j2的实现

log4j2的依赖

<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-api</artifactId>
    <version>2.11.0</version>
</dependency>
<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-core</artifactId>
    <version>2.11.0</version>
</dependency>

如果你的项目是web项目，最好加上

 <dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-web</artifactId>
    <version>2.11.0</version>
</dependency>

slf4j桥接其它日志组件（我项目中没用到，留在这做个记录）

<!--commons logging到slf4j的实现-->
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>jcl-over-slf4j</artifactId>
    <version>1.7.25</version>
</dependency>
<!--log4j1到slf4j的实现-->
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>log4j-over-slf4j</artifactId>
    <version>1.7.25</version>
</dependency>
<!--java util logging-->
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>jul-to-slf4j</artifactId>
    <version>1.7.25</version>
</dependency>

slf4j到log4j2的实现

<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-slf4j-impl</artifactId>
    <version>2.11.0</version>
</dependency>

一组比较ok的log依赖，使用log4j2

<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-api</artifactId>
    <version>2.11.0</version>
</dependency>
<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-web</artifactId>
    <version>2.11.0</version>
</dependency>
<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-core</artifactId>
    <version>2.11.0</version>
</dependency>
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>1.7.25</version>
</dependency>
<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-slf4j-impl</artifactId>
    <version>2.11.0</version>
</dependency>
<!--commons logging到slf4j的实现-->
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>jcl-over-slf4j</artifactId>
    <version>1.7.25</version>
</dependency>
<!--log4j1到slf4j的实现-->
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>log4j-over-slf4j</artifactId>
    <version>1.7.25</version>
</dependency>
<!--java util logging-->
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>jul-to-slf4j</artifactId>
    <version>1.7.25</version>
</dependency>

一组比较ok的log4j2的配置

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="info">
    <Properties>
        <Property name="PRO_NAME">review-api</Property>
        <Property name="LOG_HOME">/home/work/log/${PRO_NAME}</Property>
        <Property name="PID">????</Property>
        <Property name="LOG_PATTERN">
            %clr{%d{yyyy-MM-dd HH:mm:ss.SSS}}{faint} %clr{%5p} %clr{${sys:PID}}{magenta}
            %clr{---}{faint} %clr{[%t]}{faint} %clr{%c{1.}}{cyan} %clr{:}{faint} %m%n%xwEx
        </Property>
    </Properties>

    <Appenders>

        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout>
                <!--<Pattern>${LOG_PATTERN}</Pattern>-->
                <Pattern>%d %p %c{1.} [%t] - %m%n</Pattern>
            </PatternLayout>
        </Console>

        <RollingRandomAccessFile name="rootFile"
                                 fileName="${LOG_HOME}/${PRO_NAME}-rootFile.log"
                                 filePattern="${LOG_HOME}/${PRO_NAME}-rootFile-%d{yyyy-MM-dd}.log.gz"
                                 append="true">
            <PatternLayout>
                <Pattern>%d %p %c{1.} [%t] - %m%n</Pattern>
            </PatternLayout>

            <Policies>
                <!--在启动时-->
                <OnStartupTriggeringPolicy/>
                <!--或在最小时间单位变动时-->
                <TimeBasedTriggeringPolicy interval="1" modulate="true"/>
            </Policies>
            <!--启动以下策略-->
            <DefaultRolloverStrategy max="10">
                <!--maxDepth：文件夹深度限制为2-->
                <Delete basePath="${LOG_HOME}" maxDepth="2">
                    <IfFileName glob="**.log.gz"/>
                    <!--日志保存7天-->
                    <IfLastModified age="7d"/>
                </Delete>
            </DefaultRolloverStrategy>
        </RollingRandomAccessFile>

        <RollingRandomAccessFile name="file"
                                 fileName="${LOG_HOME}/${PRO_NAME}.log"
                                 filePattern="${LOG_HOME}/${PRO_NAME}-%d{yyyy-MM-dd}.log.gz"
                                 immediateFlush="true" append="true">
            <PatternLayout>
                <Pattern>%d %p %c{1.} [%t] - %m%n</Pattern>
            </PatternLayout>
            <Policies>
                <TimeBasedTriggeringPolicy interval="1" modulate="true"/>
            </Policies>
        </RollingRandomAccessFile>

        <RollingRandomAccessFile name="error"
                                 fileName="${LOG_HOME}/${PRO_NAME}-error.log"
                                 filePattern="${LOG_HOME}/${PRO_NAME}-error-%d{yyyy-MM-dd}.log.gz"
                                 immediateFlush="true" append="true">
            <PatternLayout>
                <Pattern>%d %p %c{1.} [%t] - %m%n</Pattern>
            </PatternLayout>
            <Policies>
                <TimeBasedTriggeringPolicy interval="1" modulate="true"/>
            </Policies>
        </RollingRandomAccessFile>

        <ReviewLogAppender name="SELF_ELK" project-name="${PRO_NAME}"/>

    </Appenders>

    <Loggers>

        <logger name="com.company" level="error" additivity="false">
            <AppenderRef ref="error" level="error"/>
        </logger>

        <logger name="com.company.middle" level="${log4j_level}" additivity="false">
            <AppenderRef ref="file"/>
            <AppenderRef ref="SELF_ELK"/>
            <AppenderRef ref="Console"/>
        </logger>

        <logger name="com.company.browser" level="${log4j_level}" additivity="false">
            <AppenderRef ref="file"/>
            <AppenderRef ref="SELF_ELK"/>
            <AppenderRef ref="Console"/>
        </logger>

        <Root level="info">
            <AppenderRef ref="rootFile"/>
        </Root>
    </Loggers>
</Configuration>

其中关于SELF_ELK的实现,我们将所有日志打到kibana上一份，方便我们查看

/**
 *
 * 收集所有log日志，打到elk上
 */
@Plugin(name = "ReviewLogAppender", category = "Core", elementType = "appender", printObject = true)
public class ReviewLogAppender extends AbstractAppender {

    private String project;

    public ReviewLogAppender(String name, Filter filter,
                             Layout<? extends Serializable> layout, String project) {
        super(name, filter, layout);
        this.project = project;
    }

    @PluginFactory
    public static ReviewLogAppender create(@PluginAttribute("name") String name,
                                           @PluginElement("Layout") Layout<? extends Serializable> layout,
                                           @PluginElement("Filter") final Filter filter,
                                           @PluginAttribute("project-name") String project) {

        if (name == null) {
            return null;
        }
        if (layout == null) {
            layout = PatternLayout.createDefaultLayout();
        }

        return new ReviewLogAppender(name, filter, layout, project);
    }

    @Override
    public void append(LogEvent logEvent) {
        if (!EnvVar.isProduction()) {
            return;
        }

        MiddleReviewDebugLog middleReviewDebugLog = new MiddleReviewDebugLog();

        String logBody = logEvent.getMessage().getFormattedMessage();
        middleReviewDebugLog.setFrom(project);
        middleReviewDebugLog.setLevel(logEvent.getLevel().toString());
        middleReviewDebugLog.setTimestamp(System.currentTimeMillis());
        middleReviewDebugLog.setLogbody(logBody);
        middleReviewDebugLog.setServerIp(IPUtils.getHostIp());

        if (logEvent.getLevel().equals(Level.ERROR)) {
            StringBuilder stringBuilder = new StringBuilder();
            final Throwable thrown = logEvent.getThrown();
            if (thrown != null) {
                stringBuilder.append("errorMsg:").append(thrown.getMessage()).append("\nstackTrace:").append(ExceptionUtil.stacktraceToString(thrown));
            }
            middleReviewDebugLog.setExt(stringBuilder.toString());
        }

        LCS_LOGGER.write(TOPIC_AND_TEAM, middleReviewDebugLog);
    }
}

slf4j与其它各种日志组件的桥接图（可以等到看完设计模式研究完源码后再看）

应用代码中使用slf4j接口，接入具体实现的方法
在这里插入图片描述
应用代码中使用别的日志接口，转成slf4j的方法
在这里插入图片描述

HyggeJDS
关注
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值