Spring boot 整合 log4j2日志、程序异常，发送邮件通知

官方文档：https://logging.apache.org/log4j/2.x/

1.Maven修改如下

<!-- 引入 log4j2 -->
<dependency>
  <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>

<!-- 需要注意的是：spring-boot 和 mybatis 默认有自己的日志依赖，需要排除。其他maven若有依赖也要排除 -->
<!-- 排除spring-boot-starter日志 -->
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter</artifactId>
  <exclusions>
      <exclusion>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-logging</artifactId>
      </exclusion>
  </exclusions>
</dependency>
<!-- 排除spring-boot-starter-web日志 -->
<dependency>
  	<groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <exclusions>
        <exclusion>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-logging</artifactId>
        </exclusion>
    </exclusions>
</dependency>
<!-- 排除mybatis日志 -->
<dependency>
  <groupId>org.mybatis.spring.boot</groupId>
  <artifactId>mybatis-spring-boot-starter</artifactId>
  <version>xxx</version>
  <exclusions>
      <exclusion>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-logging</artifactId>
      </exclusion>
  </exclusions>
</dependency>

2.加入配置文件

在配置文件application.properties指定log4j2.xml文件的位置

logging.config=classpath:log4j2.xml

log4j2.xml 文件内容，配置内容说明可参看注释内容：

<?xml version="1.0" encoding="UTF-8"?>
<!--设置log4j2的自身log级别为warn-->
<!--日志级别以及优先级排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
<!--Configuration后面的status，这个用于设置log4j2自身内部的信息输出，可以不设置，
    当设置成trace时，你会看到log4j2内部各种详细输出-->
<!--monitorInterval：Log4j能够自动检测修改配置 文件和重新配置本身，设置间隔秒数-->
<configuration status="warn" monitorInterval="30">
    <properties>
        <!-- 发送邮件的日志等级可选值：OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL，当为OFF时不发送 -->
        <property name="MAIL_LEVEL">ERROR</property>
		<!-- 项目名称（自行更改） -->
        <property name="PROJECT_NAME">prod-project</property>
        <!-- 日志文件输出位置，输出到当前目录（自行更改） -->
        <property name="LOG_BACK_HOME">./${PROJECT_NAME}-log</property>
    </properties>
    <!--先定义所有的appender-->
    <appenders>
        <!--控制台输出配置-->
        <console name="Console" target="SYSTEM_OUT">
            <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
            <!--开发环境要打印更多,注释点该语句-->
            <ThresholdFilter level="DEBUG" onMatch="ACCEPT" onMismatch="DENY"/>
            <!--输出日志的格式、颜色-->
            <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} %highlight{%-5level} [%t] %highlight{%l}: %msg%n"/>
        </console>
        <!-- 这个会打印出所有的info及以下级别的信息，每次大小超过size，
        则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->
        <RollingFile name="RollingFileInfo" fileName="${LOG_BACK_HOME}/info.log"
                     filePattern="${LOG_BACK_HOME}/$${date:yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log">
            <Filters>
                <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
                <ThresholdFilter level="WARN" onMatch="NEUTRAL" onMismatch="DENY"/>
                <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
            </Filters>
            <PatternLayout pattern="[%d{yyyy/MM/dd HH:mm:ss,SSS}] [%p] - %l - %m%n"/>
            <Policies>
                <TimeBasedTriggeringPolicy/>
                <SizeBasedTriggeringPolicy size="10 MB"/>
            </Policies>
        </RollingFile>

        <RollingFile name="RollingFileWarn" fileName="${LOG_BACK_HOME}/warn.log"
                     filePattern="${LOG_BACK_HOME}/$${date:yyyy-MM}/warn-%d{yyyy-MM-dd}-%i.log">
            <Filters>
                <ThresholdFilter level="WARN" onMatch="ACCEPT" onMismatch="DENY"/>
                <ThresholdFilter level="ERROR" onMatch="DENY" onMismatch="NEUTRAL"/>
            </Filters>
            <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
            <Policies>
                <TimeBasedTriggeringPolicy/>
                <SizeBasedTriggeringPolicy size="100 MB"/>
            </Policies>
            <!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件，这里设置了20 -->
            <DefaultRolloverStrategy max="20"/>
        </RollingFile>

        <RollingFile name="RollingFileError" fileName="${LOG_BACK_HOME}/error.log"
                     filePattern="${LOG_BACK_HOME}/$${date:yyyy-MM}/error-%d{yyyy-MM-dd}-%i.log">
            <ThresholdFilter level="ERROR"/>
            <PatternLayout pattern="[%d{yyyy/MM/dd HH:mm:ss,SSS}] [%t] - %l - %m%n"/>
            <Policies>
                <TimeBasedTriggeringPolicy/>
                <SizeBasedTriggeringPolicy size="100 MB"/>
            </Policies>
            <!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件，这里设置了20 -->
            <DefaultRolloverStrategy max="20"/>
        </RollingFile>
        <!-- 发送邮件配置（自行更改） -->
        <SMTP name="Mail" subject="${PROJECT_NAME} Error Log" to="chao_c_c@163.com, 11278900096@qq.com, " from="发送方如：chao_c_c@163.com"
              smtpHost="邮件服务器如：smtp.163.com" smtpPort="25" bufferSize="1024" smtpProtocol="smtp" smtpDebug="false"
              smtpPassword="密码" smtpUsername="用户名如：chao_c_c@163.com">
        </SMTP>
        <!-- appender to send mails asynchronously -->
        <Async name="AsyncMail" >
            <appender-ref ref="Mail"/>
        </Async>
    </appenders>
    <!--然后定义logger，只有定义了logger并引入的appender，appender才会生效-->
    <loggers>
        <!--过滤掉spring和mybatis的一些无用的DEBUG信息 -->
        <logger name="org.springframework" level="INFO"></logger>
        <logger name="org.mybatis" level="INFO"></logger>
        <!-- 第三方日志系统 -->
        <logger name="org.springframework.core" level="info" />
        <logger name="org.springframework.beans" level="info" />
        <logger name="org.springframework.context" level="info" />
        <logger name="org.springframework.web" level="info" />
        <logger name="org.jboss.netty" level="warn" />
        <logger name="org.apache.http" level="warn" />
        <logger name="org.hibernate" level="info" />
        <logger name="com.alibaba.druid" level="info" />
        <logger name="org.thymeleaf" level="info" />

        <!--<logger name="org.mybatis" level="debug"/>-->
        <root level="all">
            <appender-ref ref="Console"/>
            <appender-ref ref="RollingFileInfo"/>
            <appender-ref ref="RollingFileWarn"/>
            <appender-ref ref="RollingFileError"/>
            <appender-ref ref="AsyncMail" level="${MAIL_LEVEL}"/>
        </root>
    </loggers>
</configuration>

基本配置完成。
收到的邮件效果如下：

拓展信息配置：显示请求路径、访问IP、请求参数等信息

线程上下文堆栈会唯一地标记每个请求，用户可以在请求刚进入时将上下文信息压入堆栈（通过ThreadContext.put()），当发送错误邮件时，log4j会获取压入的上下文数据进行发送

在请求刚进来时拦截，添加上下文信息：

import com.alibaba.fastjson.JSON;
import lombok.extern.slf4j.Slf4j;
import org.apache.logging.log4j.ThreadContext;
import org.springframework.util.CollectionUtils;

import javax.servlet.*;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.Map;
/**
 * 请求日志信息
 * @author Aesop
 * @date 2019/9/26 11:29
 */
@Slf4j
public class RequestLogFilter implements Filter {

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

    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        HttpServletRequest request =  (HttpServletRequest) servletRequest;
        ThreadContext.put("URL", request.getRequestURL().toString());
        ThreadContext.put("HttpMethod", request.getMethod());
        ThreadContext.put("IPAddr", request.getRemoteAddr());
        ThreadContext.put("ContentType", request.getContentType());

        // 获取所有参数名
        Map<String, String> paramNames = new HashMap<>();
        Enumeration<String> parameterNames = request.getParameterNames();
        while (parameterNames.hasMoreElements()) {
            String name = parameterNames.nextElement();
            paramNames.put(name, request.getParameter(name));
        }
        ThreadContext.put("ParamNames", CollectionUtils.isEmpty(paramNames) ? "{}" : JSON.toJSONString(paramNames));

        //TODO 需要时打开注释
        // log.info("URL: " + request.getRequestURL().toString());
        // log.info("Http Method: " + request.getMethod());
        // log.info("IP Addr: " + request.getRemoteAddr());
        // log.info("Content Type: " + request.getContentType());
        // log.info("ParamNames: " + (CollectionUtils.isEmpty(paramNames) ? "{}" : JSON.toJSONString(paramNames)));

        filterChain.doFilter(servletRequest,servletResponse);
    }

    @Override
    public void destroy() {
	    //请求结束后清除信息
        ThreadContext.clearAll();
    }
}

此时再看邮件效果如下，多出来一行MDC：