logback日志格式规范

原文链接：logback日志格式规范

 

日志格式规范设定如下：

参考文章【logback日志分类收集配置】

%d %-5level [%thread][%X{hostName}][%X{userId}][%X{sessionId}] %logger{68} %line - %msg%n

时间 日志级别 [线程号][客户端IP][客户编号][sessionId] 日志发生类 行号 - 日志详细信息

打印日志样例：

2016-08-08 11:07:42,142 INFO  [http-bio-8090-exec-2][61.175.197.205][2000000000008831][29B2291637E4EE27FB28B8EEE6171F00] c.i.s.product.SeriesServiceImpl 87 - 转让产品总数缓存清除：2000000000008831

 

其中配置中%X是日志框架从本地线程变量中获取的，需要在程序入口中将变量进行设置，具体实现可以参考如下（使用MDC作为本地线程变量框架）：

 

针对spring-mvc的web项目,在入口处定义拦截器，拦截器继承【org.springframework.web.servlet.handler.HandlerInterceptorAdapter】

在preHandle中，在MDC中加入需要日志打印的变量

public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {

// 添加MDC配置信息

MDC.put(ATTRIBUTE_KEY_HOST_NAME, getRemoteIp(request));

MDC.put(ATTRIBUTE_KEY_USER_ID, "");

MDC.put(ATTRIBUTE_KEY_SESSION_ID, request.getSession().getId());

return super.preHandle(request, response, handler);

}

此处ATTRIBUTE_KEY_USER_ID设置为空，在登录拦截器中，在put值进去。MDC中封装了ThreadLocal，线程结束后需要将ThreadLocal内容进行清空。

public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {

// 清空threadLocal

MDC.clear();

super.afterCompletion(request, response, handler, ex);

}

 

 

完整代码如下：

   

public class IfaexLogMdcIntercepter extends HandlerInterceptorAdapter {

 

private static final Logger LOGGER = LoggerFactory.getLogger(IfaexLogMdcIntercepter.class);

 

public static final String ATTRIBUTE_KEY_HOST_NAME = "hostName";

 

public static final String ATTRIBUTE_KEY_USER_ID = "userId";

 

public static final String ATTRIBUTE_KEY_SESSION_ID = "sessionId";

 

public static final String ATTRIBUTE_KEY_REQUEST_STARTTIME = "requestStartTime";

 

@Override

public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {

 

// 添加MDC配置信息

MDC.put(ATTRIBUTE_KEY_HOST_NAME, getRemoteIp(request));

MDC.put(ATTRIBUTE_KEY_USER_ID, "");

MDC.put(ATTRIBUTE_KEY_SESSION_ID, request.getSession().getId());

MDC.put(ATTRIBUTE_KEY_REQUEST_STARTTIME, String.valueOf(System.currentTimeMillis()));

return super.preHandle(request, response, handler);

}

 

@Override

public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {

// 记录日志

logRequest(request);

// 清空threadLocal

MDC.clear();

super.afterCompletion(request, response, handler, ex);

}

 

/**

 * 打印请求日志

 * @param request

 * @author Silver

 * @date 2016年2月1日 上午9:17:39

 */

 

private void logRequest(HttpServletRequest request) {

 

StringBuffer logBuffer = new StringBuffer(128);

 

// refer_url

logBuffer.append("referUrl:");

 

@SuppressWarnings("rawtypes")

Enumeration e = request.getHeaders("Referer");

String referUrl;

if (e.hasMoreElements()) {

referUrl = (String) e.nextElement();

} else {

referUrl = "直接访问";

}

logBuffer.append(referUrl);

// 获取url

logBuffer.append(";URL:");

StringBuffer url = request.getRequestURL();

if (url != null) {

StringUtils.replaceOnce(url.toString(), "http://", "https://");

}

logBuffer.append(url.toString());

// 判断用户请求方式是否为ajax

logBuffer.append(";ISAJAX:");

String requestType = request.getHeader("X-Requested-With");

if (StringUtils.isNotBlank(requestType) && requestType.equals("XMLHttpRequest")) {

logBuffer.append("true");

} else {

logBuffer.append("false");

}

//获取所有参数

StringBuffer paramBuffer = new StringBuffer(64);

Enumeration<?> enu = request.getParameterNames();

while (enu.hasMoreElements()) {

String paraName = (String) enu.nextElement();

paramBuffer.append(paraName);

paramBuffer.append(": ");

paramBuffer.append(request.getParameter(paraName));

paramBuffer.append(", ");

}

logBuffer.append(";Parameters:");

logBuffer.append(paramBuffer.toString());

 

// 记录本次请求耗时：

Long requestEndTime = System.currentTimeMillis();

Long requestStartTime = StringUtils.isEmpty(MDC.get(ATTRIBUTE_KEY_REQUEST_STARTTIME)) ? requestEndTime : Long.valueOf(MDC.get(ATTRIBUTE_KEY_REQUEST_STARTTIME));

 

logBuffer.append(";COST:");

logBuffer.append(requestEndTime - requestStartTime);

logBuffer.append(" ms");

if (!"HEAD".equals(request.getMethod())) {

LOGGER.info("requestLog:" + logBuffer.toString());

}

 

}

 

/**

 * 拦截器获取IP

 * @param request

 * @return

 */

protected String getRemoteIp(HttpServletRequest request) {

 

String remoteIp = null;

remoteIp = request.getHeader("x-forwarded-for");

if (remoteIp == null || remoteIp.isEmpty() || "unknown".equalsIgnoreCase(remoteIp)) {

remoteIp = request.getHeader("X-Real-IP");

}

if (remoteIp == null || remoteIp.isEmpty() || "unknown".equalsIgnoreCase(remoteIp)) {

remoteIp = request.getHeader("Proxy-Client-IP");

}

if (remoteIp == null || remoteIp.isEmpty() || "unknown".equalsIgnoreCase(remoteIp)) {

remoteIp = request.getHeader("WL-Proxy-Client-IP");

}

if (remoteIp == null || remoteIp.isEmpty() || "unknown".equalsIgnoreCase(remoteIp)) {

remoteIp = request.getHeader("HTTP_CLIENT_IP");

}

if (remoteIp == null || remoteIp.isEmpty() || "unknown".equalsIgnoreCase(remoteIp)) {

remoteIp = request.getHeader("HTTP_X_FORWARDED_FOR");

}

if (remoteIp == null || remoteIp.isEmpty() || "unknown".equalsIgnoreCase(remoteIp)) {

remoteIp = request.getRemoteAddr();

}

if (remoteIp == null || remoteIp.isEmpty() || "unknown".equalsIgnoreCase(remoteIp)) {

remoteIp = request.getRemoteHost();

}

if (remoteIp == null || remoteIp.isEmpty()) {

remoteIp = "unknown";

}

String[] ipArray = remoteIp.split(",");

if (ipArray != null && ipArray.length > 1) {

return ipArray[0];

}

return ("0:0:0:0:0:0:0:1").equals(remoteIp) ? "127.0.0.1" : remoteIp;

}

}