第二章、日志管理

<parent>
    <groupId>cn.chenzecheng</groupId>
    <artifactId>sld-common</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <relativePath>../pom.xml</relativePath>
</parent>

<artifactId>sld-common-log</artifactId>

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <property name="LOG_DIR" value="./logs"/>
    <property name="LOG_MAX_FILE_SIZE" value="100MB"/>

    <!--application.yml 传递参数，不使用logback 自带的<property>标签 -->
    <springProperty scope="context" name="APP_ID" source="spring.application.name" default="default-application-name"/>
    <springProperty scope="context" name="LOG_MAX_HISTORY" source="logback.MaxHistory" default="15"/>

    <appender name="Console" class="ch.qos.logback.core.ConsoleAppender">
        <layout class="ch.qos.logback.classic.PatternLayout">
            <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符-->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} | %X{uri} | %X{requestId} | %-5level | ${PID} | ${APP_ID} | ${HOSTNAME}
                | [%thread] | %logger{36}.%M\(%F:%L\) | %msg%n
            </pattern>
            <charset>UTF-8</charset>
        </layout>
    </appender>

    <appender name="RollingFile" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${LOG_DIR}/app.log</file>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符-->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} | %X{uri} | %X{requestId} | %-5level | ${PID} | ${APP_ID} | ${HOSTNAME}
                | [%thread] | %logger{36}.%M\(%F:%L\) | %msg%n
            </pattern>
        </encoder>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${LOG_DIR}/archived/app.%d{yyyy-MM-dd}.log</fileNamePattern>
            <maxHistory>${LOG_MAX_HISTORY}</maxHistory>
            <totalSizeCap>${LOG_MAX_FILE_SIZE}</totalSizeCap>
        </rollingPolicy>
    </appender>

    <root level="INFO">
        <appender-ref ref="Console"/>
        <appender-ref ref="RollingFile"/>
    </root>
</configuration>

server.port=8001
spring.application.name=sld-common-test
# logging.level.xxx（包名）设置对应的包的日志等级,root是所有
logging.level.root=info
logging.level.cn.chenzecheng.sld.common.test.controller.log=trace

    @GetMapping("/log")
    public String testLog(){
        log.error("test error");
        log.warn("test warn");
        log.info("test info");
        log.debug("test debug");
        log.trace("test trace");
        return"test log";
    }

@Slf4j
public class MdcFilter implements Filter {

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        HttpServletRequest httpServletRequest = (HttpServletRequest) request;
        HttpServletResponse response1 = (HttpServletResponse) response;
        try {
            mdcRequestInfo(httpServletRequest, response1);
        } catch (Exception e) {
            log.error("doFilter error: ", e);
        }
        try {
            chain.doFilter(request, response);
        } finally {
            MdcUtils.clear();
        }
    }

    /**
     * mdc记录请求跟踪信息
     */
    private void mdcRequestInfo(HttpServletRequest httpServletRequest, HttpServletResponse response) {
        MdcUtils.put(MdcConstants.LOCAL_IP_MDC_KEY, localIp);
        String requestId = httpServletRequest.getHeader(MdcConstants.REQUEST_ID_HEADER);
        if (Objects.isNull(requestId) || requestId.length() == 0) {
            requestId = UUID.randomUUID().toString().replace("-", "");
        }
        //将requestId放入mdc
        MdcUtils.put(MdcConstants.REQUEST_ID_MDC_KEY, requestId);
        //将时间戳和uri放入mdc
        MdcUtils.put(MdcConstants.TIMESTAMP, String.valueOf(System.currentTimeMillis()));
        String pathUri = httpServletRequest.getRequestURI();
        if (Objects.nonNull(pathUri) && requestId.length() > 0 && !pathUri.contains("jsessionid") && !pathUri.contains(";")) {
            MdcUtils.put(MdcConstants.URI_MDC_KEY, pathUri);
        }
    }
}

@Configuration
public class MdcFilterConfig {
    @Bean
    @Order(0)
    public FilterRegistrationBean<MdcFilter> getMdcFilter() {
        FilterRegistrationBean<MdcFilter> registration = new FilterRegistrationBean<>();
        registration.setFilter(new MdcFilter());
        registration.addInitParameter(MdcConstants.MAPPED_HEADERS_KEY, Boolean.FALSE.toString());
        registration.addInitParameter(MdcConstants.MAPPED_PARAMETERS, Boolean.FALSE.toString());
        registration.addUrlPatterns("/*");
        registration.setName("MdcFilter");
        return registration;
    }
}

cn.chenzecheng.sld.common.log.mdc.MdcFilterConfig

    @NotNull
    @Override
    public Future<?> submit(@NotNull Runnable task){
        return super.submit(MdcThreadUtil.wrap(task,MDC.getCopyOfContextMap()));
    }

    // MdcThreadUtil.wrap方法
    public static Runnable wrap(final Runnable runnable,final Map<String, String> context){
        return()->{
            if(context==null){
                MdcUtil.clear();
            }else{
                MdcUtil.setContextMap(context);
            }
            //设置requestId
            setRequestIdIfAbsent();
            try{
                runnable.run();
            }finally{
                MdcUtil.clear();
            }
        };
    }