参考文章： http://www.51gjie.com/javaweb/1121.html 、 https://www.jianshu.com/p/dd9458592633
1.配置logback-spring.xml
<?xml version="1.0" encoding="UTF-8" ?>
<!-- 级别从高到低 OFF 、 FATAL 、 ERROR 、 WARN 、 INFO 、 DEBUG 、 TRACE 、 ALL -->
<!-- 日志输出规则 根据当前ROOT 级别，日志输出时，级别高于root默认的级别时 会输出 -->
<!-- 以下 每个配置的 filter 是过滤掉输出文件里面，会出现高级别文件，依然出现低级别的日志信息，通过filter 过滤只记录本级别的日志 -->
<!-- scan 当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。 -->
<!-- scanPeriod 设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟。 -->
<!-- debug 当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。 -->
<configuration scan="true" scanPeriod="60 seconds" debug="false">
<!-- 动态日志级别 -->
<jmxConfigurator/>
<!-- 定义日志文件 输出位置 -->
<property name="log.home_dir" value="./logs"/>
<property name="log.app_name" value="http-demo"/>
<!-- 日志最大的历史 30天 -->
<property name="log.maxHistory" value="30"/>
<property name="log.level" value="info"/>
<property name="log.maxSize" value="5MB" />
<!-- ConsoleAppender 控制台输出日志 -->
<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>
<!-- 设置日志输出格式 -->
%d{yyyy-MM-dd HH:mm:ss.SSS} [%-5level] [%thread] %logger - %msg%n
</pattern>
</encoder>
</appender>
<!-- ERROR级别日志 -->
<!-- 滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件 RollingFileAppender -->
<appender name="ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 过滤器，只记录WARN级别的日志 -->
<!-- 果日志级别等于配置级别，过滤器会根据onMath 和 onMismatch接收或拒绝日志。 -->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<!-- 设置过滤级别 -->
<level>ERROR</level>
<!-- 用于配置符合过滤条件的操作 -->
<onMatch>ACCEPT</onMatch>
<!-- 用于配置不符合过滤条件的操作 -->
<onMismatch>DENY</onMismatch>
</filter>
<!-- 最常用的滚动策略，它根据时间来制定滚动策略.既负责滚动也负责触发滚动 -->
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<!--日志输出位置 可相对、和绝对路径 -->
<fileNamePattern>
${log.home_dir}/error/%d{yyyy-MM-dd}/${log.app_name}-%i.log
</fileNamePattern>
<!-- 可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件,假设设置每个月滚动，且<maxHistory>是6，
则只保存最近6个月的文件，删除之前的旧文件。注意，删除旧文件是，那些为了归档而创建的目录也会被删除 -->
<maxHistory>${log.maxHistory}</maxHistory>
<!--日志文件最大的大小-->
<MaxFileSize>${log.maxSize}</MaxFileSize>
</rollingPolicy>
<encoder>
<pattern>
<!-- 设置日志输出格式 -->
%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
</pattern>
</encoder>
</appender>
<!-- INFO级别日志 appender -->
<appender name="INFO" class="ch.qos.logback.core.rolling.RollingFileAppender">
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>INFO</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<fileNamePattern>${log.home_dir}/info/%d{yyyy-MM-dd}/${log.app_name}-%i.log</fileNamePattern>
<maxHistory>${log.maxHistory}</maxHistory>
<MaxFileSize>${log.maxSize}</MaxFileSize>
</rollingPolicy>
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%-5level] %logger - %msg%n</pattern>
</encoder>
</appender>
<!-- DEBUG级别日志 appender -->
<appender name="DEBUG" class="ch.qos.logback.core.rolling.RollingFileAppender">
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>DEBUG</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<fileNamePattern>${log.home_dir}/debug/%d{yyyy-MM-dd}/${log.app_name}-%i.log</fileNamePattern>
<maxHistory>${log.maxHistory}</maxHistory>
<MaxFileSize>${log.maxSize}</MaxFileSize>
</rollingPolicy>
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%-5level] %logger - %msg%n</pattern>
</encoder>
</appender>
<!--设置一个向上传递的appender,所有级别的日志都会输出-->
<appender name="app" class="ch.qos.logback.core.rolling.RollingFileAppender">
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<fileNamePattern>${log.home_dir}/app/%d{yyyy-MM-dd}/${log.app_name}-%i.log</fileNamePattern>
<maxHistory>${log.maxHistory}</maxHistory>
<MaxFileSize>${log.maxSize}</MaxFileSize>
</rollingPolicy>
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%-5level] %logger - %msg%n</pattern>
</encoder>
</appender>
<!-- <appender name="ACCESS" class="com.kdyzm.validation.spring.bootdemo.AccessLogInterceptor">
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<fileNamePattern>${log.home_dir}/access/%d{yyyy-MM-dd}/${log.app_name}-%i.log</fileNamePattern>
<maxHistory>${log.maxHistory}</maxHistory>
<MaxFileSize>${log.maxSize}</MaxFileSize>
</rollingPolicy>
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%-5level] %logger - %msg%n</pattern>
</encoder>
</appender>-->
<!--org.springframework.web包下的类的日志输出-->
<logger name="org.springframework.web" additivity="false" level="INFO">
<appender-ref ref="INFO"/>
</logger>
<!--com.zgd包下的类的日志输出-->
<logger name="com.kdyzm" additivity="false" level="DEBUG" >
<appender-ref ref="app" />
<appender-ref ref="ERROR" />
<!--打印控制台-->
<appender-ref ref="CONSOLE" />
</logger>
<!-- root级别 DEBUG -->
<root>
<!-- 打印debug级别日志及以上级别日志 -->
<level value="${log.level}"/>
<!-- 控制台输出 -->
<appender-ref ref="CONSOLE"/>
<!-- 不管什么包下的日志都输出文件 -->
<appender-ref ref="ERROR"/>
</root>
</configuration>
2.配置access log
第一步，配置springmvc拦截器AccessLogInterceptor
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.slf4j.MDC;
import org.springframework.stereotype.Component;
import org.springframework.util.StringUtils;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.Map;
import java.util.UUID;
import java.util.regex.Pattern;
/**
* @author kdyzm
*/
@Component
public class AccessLogInterceptor implements HandlerInterceptor {
private static final Logger ACCESS_LOG = LoggerFactory.getLogger("ACCESS");
private static final String SEPARATOR = " ";
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response,
Object handler) {
return true;
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) {
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response,
Object handler, Exception ex) {
//domain & uri & refer
String domain = request.getServerName();
String uri = request.getRequestURI();
String refer = request.getHeader("Referer");
final String token = request.getHeader("x-auth-token");
final String installation_ID = request.getHeader("Installation-ID");
//traceId
String traceId = request.getHeader("X-B3-TraceId");
if (StringUtils.isEmpty(traceId)) {
traceId = UUID.randomUUID().toString();
}
MDC.put("X-B3-TraceId", traceId);
String remoteIp = getRemoteAddr(request);
String userAgent = request.getHeader("User-Agent");
Map<String, String> paramPair = getRequestParamValueMap(request);
printAccesslog(traceId, remoteIp, "", "", domain, uri, refer, userAgent, paramPair);
}
//打印access log
private void printAccesslog(String traceId, String remoteIp, String userId, String userName,
String domain, String uri, String refer,
String userAgent, Map<String, String> paramPair) {
StringBuilder sb = new StringBuilder();
long timestamp = System.currentTimeMillis();
sb.append(SEPARATOR).append(timestamp);
sb.append(SEPARATOR).append(remoteIp);
// sb.append(SEPARATOR).append(userId);
// sb.append(SEPARATOR).append(userName);
//RequestId用于定位access log与业务log
sb.append(SEPARATOR).append(traceId);
sb.append(SEPARATOR).append(domain);
sb.append(SEPARATOR).append(uri);
sb.append(SEPARATOR).append(refer);
sb.append(SEPARATOR).append(userAgent);
//将参数map打印成json格式，利于统计分析
sb.append(SEPARATOR);
ACCESS_LOG.info(sb.toString());
}
private String getRemoteAddr(HttpServletRequest request) {
String ip;
@SuppressWarnings("unchecked")
Enumeration<String> xffs = request.getHeaders("X-Forwarded-For");
if (xffs.hasMoreElements()) {
String xff = xffs.nextElement();
ip = resolveClientIPFromXFF(xff);
if (isValidIP(ip)) {
return ip;
}
}
ip = request.getHeader("Proxy-Client-IP");
if (isValidIP(ip)) {
return ip;
}
ip = request.getHeader("WL-Proxy-Client-IP");
if (isValidIP(ip)) {
return ip;
}
return request.getRemoteAddr();
}
/**
* 从X-Forwarded-For头部中获取客户端的真实IP。 X-Forwarded-For并不是RFC定义的标准HTTP请求Header
* ，可以参考http://en.wikipedia.org/wiki/X-Forwarded-For
*
* @param xff X-Forwarded-For头部的值
* @return 如果能够解析到client IP，则返回表示该IP的字符串，否则返回null
*/
private String resolveClientIPFromXFF(String xff) {
if (xff == null || xff.isEmpty()) {
return null;
}
String[] ss = xff.split(",");
for (int i = ss.length - 1; i >= 0; i--) {// x-forward-for链反向遍历
String ip = ss[i].trim();
if (isValidIP(ip)) {
return ip;
}
}
return null;
}
private static final Pattern ipPattern = Pattern.compile("([0-9]{1,3}\\.){3}[0-9]{1,3}");
private boolean isValidIP(String ip) {
if (ip == null || ip.isEmpty() || "unknown".equalsIgnoreCase(ip)) {
return false;
}
return ipPattern.matcher(ip).matches();
}
private Map<String, String> getRequestParamValueMap(HttpServletRequest request) {
Map<String,String> param2value = new HashMap<>();
Enumeration e = request.getParameterNames();
String param;
while(e.hasMoreElements()) {
param = (String)e.nextElement();
if(param != null) {
String value = request.getParameter(param);
if(value != null) {
param2value.put(param, value);
}
}
}
return param2value;
}
}
第二步，注册到register
import com.kdyzm.validation.spring.bootdemo.AccessLogInterceptor;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
/**
* @author kdyzm
*/
@Configuration
public class ApiWebMvcConfig implements WebMvcConfigurer {
@Autowired
private AccessLogInterceptor accessLogInterceptor;
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(accessLogInterceptor).addPathPatterns("/**");
}
}
注意：本文归作者所有，未经作者允许，不得转载