logback+MDC日志

1 简介

今天整理了一下项目的日志，觉得有必要记录下来，方便以后随时copy。话不多说，下面进入正题。

2 目标

我们希望的打印格式如下：

2019-05-23 20:23:27.663 || 123 || scene-v1 || INFO - =====================================================================

初级目标：
时间 || 请求id || 服务名 || 日志级别 - 日志内容
高级目标：
时间 || 请求id || 服务名 || 接口URI || 远端IP || 服务器IP || 请求参数 || 日志级别 - 日志内容

3 实现步骤

3.1 创建一个springboot项目

3.2 pom.xml文件中加入依赖

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>2.1.5.RELEASE</version>
		<relativePath/> <!-- lookup parent from repository -->
	</parent>
	<groupId>com.czh</groupId>
	<artifactId>log</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<name>log</name>
	<description>Demo project for Spring Boot</description>

	<properties>
		<java.version>1.8</java.version>
	</properties>

	<dependencies>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>

		<dependency>
			<groupId>org.projectlombok</groupId>
			<artifactId>lombok</artifactId>
			<version>1.16.18</version>
		</dependency>
		<dependency>
			<groupId>com.alibaba</groupId>
			<artifactId>fastjson</artifactId>
			<version>1.2.7</version>
		</dependency>

	</dependencies>

	<build>
		<plugins>
			<plugin>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-maven-plugin</artifactId>
			</plugin>
		</plugins>
	</build>

</project>

3.3 在resource下创建logback.xml文件

logback.xml

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <!--给appName赋值-->
    <property name="appName" value="boss-v1"/>
    <!--日志输出到控制台-->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <!--%d{yyyy-MM-dd HH:mm:ss.SSS} 为时间格式-->
            <!--%X{rid} 为系统内MDC中rid的值-->
            <!--${appName} 为上面变量appName的值-->
            <!--%-5level 为日志级别-->
            <!--%msg%n 为系统内log打印的日志内容-->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} || %X{rid} || ${appName} || %-5level - %msg%n</pattern>
        </encoder>
    </appender>

    <root level="info">
        <appender-ref ref="STDOUT"/>
    </root>
</configuration>

3.4 创建filter，为logback.xml中的%X{rid}赋值。记得给启动类加@ServletComponentScan注解

package com.czh.log.filter;

import lombok.extern.slf4j.Slf4j;
import org.slf4j.MDC;
import org.springframework.util.StringUtils;

import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;


@Slf4j
@WebFilter(filterName = "apiFilter",
        urlPatterns = "/*"
)
public class ApiFilter implements Filter {

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain)
            throws IOException, ServletException {
        log.info("=============ApiFilter============");
        HttpServletRequest request = (HttpServletRequest) servletRequest;
        //日志
        this.insertIntoMDC(request);

        filterChain.doFilter(request, servletResponse);
    }

    private void insertIntoMDC(HttpServletRequest request) {
        String rid = request.getHeader("rid");
        if(StringUtils.isEmpty(rid)){
            rid = (int)(Math.random() * 10000) + "";
        }
        MDC.put("rid", rid);
    }

    @Override
    public void destroy() {
    	MDC.clear();
    }
}

4 创建testController验证

package com.czh.log.controller;

import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@RestController
@Slf4j
public class TestController {

    @GetMapping("/test")
    public String test(@RequestParam String params){
        log.info("params : {}", params);
        return params;
    }
}

打印的日志

2019-05-30 20:29:45.516 || || boss-v1 || INFO - =ApiFilter
2019-05-30 20:29:45.541 || 5789 || boss-v1 || INFO - params : 12345

最终的的目录

5 结尾

感兴趣的小伙伴们可以尝试上面的高级目标，日志格式化处理方便对项目的各个方面做数据统计。为日后做日志统计分析，大数据分析打下基础。