用 zuulFilter 列印請求日志

一. 為什麼要用到這個

     用了 spingcloud 之後，很多業務功能都可以做分離，在網關 zuul 層的過濾器除了做一些驗證之外，還可以用來列印請求日志。

二.具體做法

  話不多說，直接上代碼：

import java.io.IOException;
import java.io.InputStream;
import java.nio.charset.Charset;
import java.util.Map;

import javax.servlet.http.HttpServletRequest;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.cloud.netflix.zuul.filters.support.FilterConstants;
import org.springframework.util.StreamUtils;

import com.netflix.zuul.ZuulFilter;
import com.netflix.zuul.context.RequestContext;

import net.sf.json.JSONObject;

public class PrintRequestLogFilter extends ZuulFilter {
    private static final Logger LOGGER = LoggerFactory.getLogger(PrintRequestLogFilter.class);

    @Override
    public String filterType() {
        return FilterConstants.POST_TYPE;//要列印傳回資訊，必須得用"post"
    }

    @Override
    public int filterOrder() {
        return 0;
    }

    @Override
    public boolean shouldFilter() {
        return true;
    }

    @Override
    public Object run() {
        try {
            RequestContext ctx = RequestContext.getCurrentContext();
            HttpServletRequest request = ctx.getRequest();
            InputStream in = request.getInputStream();
            String reqBbody = StreamUtils.copyToString(in, Charset.forName("UTF-8"));
            // 列印userId，擷取其他使用者資訊
            if (reqBbody != null) {
                JSONObject json = JSONObject.fromObject(reqBbody);
                Object userId = json.get("userId");
                if (userId != null) {
                    PrintRequestLogFilter.LOGGER.info("request userId:\t" + userId);
                }
            }
            // 列印請求方法，路徑
            PrintRequestLogFilter.LOGGER
                    .info("request url:\t" + request.getMethod() + "\t" + request.getRequestURL().toString());
            Map<String, String[]> map = request.getParameterMap();
            // 列印請求url參數
            if (map != null) {
                StringBuilder sb = new StringBuilder();
                sb.append("request parameters:\t");
                for (Map.Entry<String, String[]> entry : map.entrySet()) {
                    sb.append("[" + entry.getKey() + "=" + printArray(entry.getValue()) + "]");
                }
                PrintRequestLogFilter.LOGGER.info(sb.toString());
            }
            // 列印請求json參數
            if (reqBbody != null) {
                PrintRequestLogFilter.LOGGER.info("request body:\t" + reqBbody);
            }

            // 列印response
            InputStream out = ctx.getResponseDataStream();
            String outBody = StreamUtils.copyToString(out, Charset.forName("UTF-8"));
            if (outBody != null) {
                PrintRequestLogFilter.LOGGER.info("response body:\t" + outBody);
            }

            ctx.setResponseBody(outBody);//重要！！！

        } catch (IOException e) {
            e.printStackTrace();
        }

        return null;
    }

    String printArray(String[] arr) {
        StringBuilder sb = new StringBuilder();
        for (int i = 0; i < arr.length; i++) {
            sb.append(arr[i]);
            if (i < arr.length - 1) {
                sb.append(",");
            }
        }
        return sb.toString();
    }
}
           

以上代碼可以列印出所有請求的相關重要資訊，包含傳回。但要注意一點，就是

ctx.setResponseBody(outBody);
           

在zuulFilter中，用 InputStream out = ctx.getResponseDataStream();  取出response 資訊後，如果不把資訊 set 回去，會導緻傳回資訊為空.

日志列印如下：

request userId:    1
request url:    POST    http://127.0.0.1:8000/web/pro/get
request parameters:    [uuid=001]
request body:    {"userId":1,"pageNum":0,"pageSize":10}
response body:    {"message":"msg-null","msgCode":"abcd","statusCode":200,"success":true,"data":[],"totalPage":1,"totalSize":2,"pageSize":10,"pageNum":0}