优化日志输出

pom.xml

@@ -36,6 +36,12 @@
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-test</artifactId>
             <scope>test</scope>
+            <exclusions>
+                <exclusion>
+                    <groupId>com.vaadin.external.google</groupId>
+                    <artifactId>android-json</artifactId>
+                </exclusion>
+            </exclusions>
         </dependency>
         <dependency>
             <groupId>junit</groupId>

src/main/java/com/esv/freight/file/common/constants/CommonConstants.java

+package com.esv.freight.file.common.constants;
+
+/**
+ * @description: 全局常量
+ * @project: freight-file-service
+ * @name: com.esv.freight.file.common.constants.CommonConstants
+ * @author: 黄朝斌
+ * @email: huangchaobin@esvtek.com
+ * @createTime: 2020/05/26 15:21
+ * @version:1.0
+ */
+public class CommonConstants {
+
+    /**
+     * 访问端来源：1-浏览器端、2-Android端、3-iOS端、4-后台服务端
+     **/
+    public static final String REQ_SOURCE_TYPE_KEY = "Source-Type";
+    public static final String REQ_SOURCE_TYPE_WEB = "1";
+    public static final String REQ_SOURCE_TYPE_ANDROID = "2";
+    public static final String REQ_SOURCE_TYPE_IOS = "3";
+    public static final String REQ_SOURCE_TYPE_SERVICE = "4";
+
+    /**
+     * Feign调用返回参数
+     **/
+    public static final String FEIGN_RESULT_CODE = "code";
+    public static final String FEIGN_RESULT_MESSAGE = "message";
+    public static final String FEIGN_RESULT_DATA = "data";
+    public static final int FEIGN_RESULT_SUCCESS = 200;
+
+    /**
+     * 字符串"null"
+     **/
+    public static final String NULL_STRING = "null";
+
+    /**
+     * 字符串"unknown"
+     **/
+    public static final String UNKNOWN_STRING = "unknown";
+
+    /**
+     * log日志输出的最大长度及截取输出的长度
+     **/
+    public static final int LOG_MAX_LENGTH = 5000;
+    public static final int LOG_CUT_LENGTH = 1000;
+
+    /**
+     * Spring Boot Admin监控url前缀
+     **/
+    public static final String SPRING_BOOT_ADMIN_PREFIX_URL = "/actuator";
+
+    /**
+     * 默认字符编码
+     **/
+    public static final String DEFAULT_CHARACTER_ENCODING = "utf-8";
+
+    /**
+     * Http请求方式
+     **/
+    public static final String HTTP_REQUEST_METHOD_GET = "GET";
+    public static final String HTTP_REQUEST_METHOD_POST = "POST";
+
+    /**
+     * Http请求头
+     **/
+    public static final String HTTP_HEADER_X_FORWARDED_FOR = "x-forwarded-for";
+    public static final String HTTP_HEADER_PROXY_CLIENT_IP = "Proxy-Client-IP";
+    public static final String HTTP_HEADER_WL_PROXY_CLIENT_IP = "WL-Proxy-Client-IP";
+}

src/main/java/com/esv/freight/file/common/filter/RestLogFilter.java

 package com.esv.freight.file.common.filter;
 
+import com.alibaba.fastjson.JSONObject;
+import com.esv.freight.file.common.constants.CommonConstants;
+import com.esv.freight.file.common.util.ReqUtils;
 import com.esv.freight.file.common.wrapper.RestRequestWrapper;
 import com.esv.freight.file.common.wrapper.RestResponseWrapper;
 import lombok.extern.slf4j.Slf4j;
-import org.apache.commons.lang3.StringUtils;
 
 import javax.servlet.*;
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
-import java.io.BufferedReader;
-import java.io.IOException;
-import java.io.InputStream;
-import java.io.InputStreamReader;
+import java.io.*;
 import java.nio.charset.Charset;
 import java.util.Enumeration;
 import java.util.HashMap;
@@ -34,40 +33,31 @@ public class RestLogFilter implements Filter {
 
     }
 
+    @Override
+    public void destroy() {
+
+    }
+
     @Override
     public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
         RestRequestWrapper requestWrapper = new RestRequestWrapper((HttpServletRequest)servletRequest);
         RestResponseWrapper responseWrapper = new RestResponseWrapper((HttpServletResponse) servletResponse);
 
-        String reqContentType = StringUtils.trimToEmpty(requestWrapper.getContentType()).toLowerCase();
-        if (reqContentType.contains("multipart/form-data")) {
-            log.info("multipart/form-data request");
-        } else {
-            // 日志输出请求
-            logReq(requestWrapper);
-        }
-
-        filterChain.doFilter(requestWrapper, responseWrapper);
+        // 日志输出请求体
+        this.logReq(requestWrapper);
 
-        String resContentType = StringUtils.trimToEmpty(responseWrapper.getContentType());
-        if (resContentType.contains("text") || resContentType.contains("xml")
-                || resContentType.contains("json")) {
-            // 日志输出返回
-            try {
-                logRes(requestWrapper, responseWrapper);
-            } catch (Exception e) {
-                log.error(e.getMessage(), e);
-            }
-        } else {
-            log.info("Response ContentType: {}", resContentType);
-        }
-    }
+        // 日志输出请求头
+        this.logReqHeader(requestWrapper);
 
-    @Override
-    public void destroy() {
+        filterChain.doFilter(requestWrapper, responseWrapper);
 
+        // 日志输出返回体
+        this.logRes(requestWrapper, responseWrapper);
     }
 
+    /**
+     * 获取请求返回体
+     **/
     private String getPostBodyStr(HttpServletRequest request) {
         String bodyStr = null;
         StringBuilder sb = new StringBuilder();
@@ -75,7 +65,7 @@ public class RestLogFilter implements Filter {
         BufferedReader reader = null;
         try {
             inputStream = request.getInputStream();
-            reader = new BufferedReader(new InputStreamReader(inputStream, Charset.forName("UTF-8")));
+            reader = new BufferedReader(new InputStreamReader(inputStream, Charset.forName(CommonConstants.DEFAULT_CHARACTER_ENCODING)));
             String line = "";
             while ((line = reader.readLine()) != null) {
                 sb.append(line);
@@ -114,52 +104,72 @@ public class RestLogFilter implements Filter {
         return bodyStr;
     }
 
+    /**
+     * 日志输出请求体
+     **/
     private void logReq(RestRequestWrapper requestWrapper) {
         String url = requestWrapper.getRequestURI();
         String method = requestWrapper.getMethod();
-        if ("GET".equalsIgnoreCase(method)) {
+        String reqBody = "";
+
+        // 获取get、post请求体
+        if (CommonConstants.HTTP_REQUEST_METHOD_GET.equalsIgnoreCase(method)) {
             Enumeration em = requestWrapper.getParameterNames();
-            String reqParams = "";
             while (em.hasMoreElements()) {
                 String k = em.nextElement().toString();
                 String v = requestWrapper.getParameter(k);
-                reqParams += "&" + k + "=" + v;
-            }
-            reqParams = reqParams.replaceFirst("&", "");
-            if (url.startsWith("/actuator")) {
-                log.debug("[IP={}]收到{}请求，url：{}，params：{}", getHttpClientIp(requestWrapper), method, url, reqParams);
-            } else {
-                log.info("[IP={}]收到{}请求，url：{}，params：{}", getHttpClientIp(requestWrapper), method, url, reqParams);
+                reqBody += "&" + k + "=" + v;
             }
-        } else if ("POST".equalsIgnoreCase(method)) {
-            log.info("[IP={}]收到{}请求，url：{}，body：{}", getHttpClientIp(requestWrapper), method, url, getPostBodyStr(requestWrapper));
-        } else {
+            reqBody = reqBody.replaceFirst("&", "");
+        } else if (CommonConstants.HTTP_REQUEST_METHOD_POST.equalsIgnoreCase(method)) {
+            reqBody = this.getPostBodyStr(requestWrapper);
+        }
 
+        // 请求体日志截取
+        if (CommonConstants.LOG_MAX_LENGTH < reqBody.length()) {
+            reqBody = reqBody.substring(0, CommonConstants.LOG_CUT_LENGTH) + "……";
         }
-    }
 
-    private void logRes(RestRequestWrapper requestWrapper, RestResponseWrapper responseWrapper) throws Exception {
-        byte[] bytes = responseWrapper.getBody();
-        String resStr = new String(bytes,"utf-8");
-        String url = requestWrapper.getRequestURI();
-        if (url.startsWith("/actuator")) {
-            log.debug("请求响应：{}", resStr);
+        // 日志输出请求体
+        if (url.startsWith(CommonConstants.SPRING_BOOT_ADMIN_PREFIX_URL)) {
+            log.debug("[IP={}]收到{}请求，url：{}，params：{}", ReqUtils.getHttpClientIp(requestWrapper), method, url, reqBody);
         } else {
-            log.info("请求响应：{}", resStr);
+            log.info("[IP={}]收到{}请求，url：{}，body：{}", ReqUtils.getHttpClientIp(requestWrapper), method, url, reqBody);
         }
     }
 
-    private String getHttpClientIp(HttpServletRequest req){
-        String ip = req.getHeader("x-forwarded-for");
-        if(ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
-            ip = req.getHeader("Proxy-Client-IP");
+    /**
+     * 日志输出请求头
+     **/
+    private void logReqHeader(RestRequestWrapper request) {
+        JSONObject headerJson = new JSONObject();
+        Enumeration headerNames = request.getHeaderNames();
+        while (headerNames.hasMoreElements()) {
+            String key = (String) headerNames.nextElement();
+            headerJson.put(key, request.getHeader(key));
         }
-        if(ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
-            ip = req.getHeader("WL-Proxy-Client-IP");
+        log.info("请求头：{}", headerJson.toJSONString());
+    }
+
+    /**
+     * 日志输出返回体
+     **/
+    private void logRes(RestRequestWrapper requestWrapper, RestResponseWrapper responseWrapper) {
+        byte[] bytes = responseWrapper.getBody();
+        String resBody = null;
+        try {
+            resBody = new String(bytes, CommonConstants.DEFAULT_CHARACTER_ENCODING);
+        } catch (UnsupportedEncodingException e) {
+            log.error(e.getMessage(), e);
         }
-        if(ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
-            ip = req.getRemoteAddr();
+        String url = requestWrapper.getRequestURI();
+        if (CommonConstants.LOG_MAX_LENGTH < resBody.length()) {
+            resBody = resBody.substring(0, CommonConstants.LOG_CUT_LENGTH) + "……";
+        }
+        if (url.startsWith(CommonConstants.SPRING_BOOT_ADMIN_PREFIX_URL)) {
+            log.debug("请求响应：{}", resBody);
+        } else {
+            log.info("请求响应：{}", resBody);
         }
-        return ip;
     }
 }
\ No newline at end of file

src/main/java/com/esv/freight/file/common/util/ReqUtils.java

 package com.esv.freight.file.common.util;
 
+import com.esv.freight.file.common.constants.CommonConstants;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.web.context.request.RequestContextHolder;
 import org.springframework.web.context.request.ServletRequestAttributes;
@@ -26,14 +27,14 @@ public class ReqUtils {
      * @return
      */
     public static String getHttpClientIp(HttpServletRequest req){
-        String ip = req.getHeader("x-forwarded-for");
-        if(ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
-            ip = req.getHeader("Proxy-Client-IP");
+        String ip = req.getHeader(CommonConstants.HTTP_HEADER_X_FORWARDED_FOR);
+        if(ip == null || ip.length() == 0 || CommonConstants.UNKNOWN_STRING.equalsIgnoreCase(ip)) {
+            ip = req.getHeader(CommonConstants.HTTP_HEADER_PROXY_CLIENT_IP);
         }
-        if(ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
-            ip = req.getHeader("WL-Proxy-Client-IP");
+        if(ip == null || ip.length() == 0 || CommonConstants.UNKNOWN_STRING.equalsIgnoreCase(ip)) {
+            ip = req.getHeader(CommonConstants.HTTP_HEADER_WL_PROXY_CLIENT_IP);
         }
-        if(ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
+        if(ip == null || ip.length() == 0 || CommonConstants.UNKNOWN_STRING.equalsIgnoreCase(ip)) {
             ip = req.getRemoteAddr();
         }
         return ip;

src/test/java/com/esv/freight/file/BaseTestController.java

@@ -27,14 +27,20 @@ public class BaseTestController {
 
     MockMvc mockMvc;
 
+    private static Long TEST_START_TIME;
+    private static Long TEST_END_TIME;
+
     @Before
     public void before() {
         log.info("=================================== Test Start ===================================");
         mockMvc = MockMvcBuilders.webAppContextSetup(webApplicationContext).build();
+        TEST_START_TIME = System.currentTimeMillis();
     }
 
     @After
     public void after() {
+        TEST_END_TIME = System.currentTimeMillis();
+        log.info("Test耗时：" + (TEST_END_TIME - TEST_START_TIME) + "毫秒");
         log.info("=================================== Test End ===================================");
     }
 

src/test/java/com/esv/freight/file/module/file/controller/UploadControllerTest.java

@@ -106,12 +106,12 @@ public class UploadControllerTest extends BaseTestController {
         JSONObject reqJson = new JSONObject();
 
         // 构造数据
-        String filepath = "D:\\test\\线上合同-货主.docx";
+        String filepath = "D:\\test\\线上合同-司机.docx";
         File file = new File(filepath);
         InputStream input = new FileInputStream(file);
         reqJson.put("fileType", "word");
         reqJson.put("fileData", Base64.getEncoder().encodeToString(IOUtils.toByteArray(input)));
-        reqJson.put("fileName", "线上合同-货主");
+        reqJson.put("fileName", "线上合同-司机");
 
         MvcResult mvcResult = this.getMockMvc().perform(MockMvcRequestBuilders.post(url)
                 .contentType(MediaType.APPLICATION_JSON_UTF8_VALUE)