logback自定义json日志输出

前言碎语

先说下楼主的使用场景吧，将程序的某些方法调用以json格式的内容记录到文件中，提供给大数据做数据分析用。当然这个需求实现起来很简单，通过aop拦截切面统一输出内容到文件即可。下面要介绍的就是通过logback日志体系以及logstash提供的json log依赖将数据以json格式记录到日志文件的例子。

依赖的jar

logstash-logback-encoder ： https://github.com/logstash/logstash-logback-encoder

maven坐标

<dependency>
    <groupId>net.logstash.logback</groupId>
    <artifactId>logstash-logback-encoder</artifactId>
    <version>5.2</version>
</dependency>

    <appender name="jsonLog" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <File>${logging.path}/customerBuriedPoint.log</File>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${logging.path}/customerBuriedPoint.%d{yyyy-MM-dd}.log</fileNamePattern>
        </rollingPolicy>
        <encoder class="net.logstash.logback.encoder.LoggingEventCompositeJsonEncoder">
            <jsonFactoryDecorator class="net.logstash.logback.decorate.CharacterEscapesJsonFactoryDecorator">
                <escape>
                    <targetCharacterCode>10</targetCharacterCode>
                    <escapeSequence>\u2028</escapeSequence>
                </escape>
            </jsonFactoryDecorator>
            <providers>
                <pattern>
                    <pattern>
                        {
                        "timestamp":"%date{ISO8601}",
                        "userId":"%mdc{userId}",
                        "requestIp":"%mdc{requestIp}",
                        "event":"%mdc{event}"
                        }
                    </pattern>
                </pattern>
            </providers>
        </encoder>
    </appender>

encoder：其他的所有配置logback该怎么配置就怎么配置，重点是logstash提供的LoggingEventCompositeJsonEncoder，一个json格式的编码器。

jsonFactoryDecorator：解决中文转码的问题，不加这个的话中文会被编码成ASCII码输出

providers：json格式提供者，想要什么字段的json就定义什么，logevent中的类型都可以在这里直接定义输出，比如，timestamp，message，thread_name等，其他的自定义的字段的值可以通过MDC设置进来，格式就是%mdc{xx},其中xx就是你日志上下文MDC中设置的值，比如MDC.put("requestIp",requestIp);

配置logger节点

    <logger name="buriedPoint" level="info" additivity="false">
        <appender-ref ref="jsonLog"/>
    </logger>

这里定义了name为buriedPoint的logger节点，那么日志系统中，只会输出定义为buriedPoint的日志，比如：

Logger logger = LoggerFactory.getLogger("buriedPoint");

最终实现的效果如下图所示：