Springcloud中Controller和Feign的日志切面实现

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
import com.alibaba.fastjson.JSON;
import java.util.Arrays;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.List;
import java.util.UUID;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.ArrayUtils;
import org.apache.commons.lang3.StringUtils;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.Signature;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.web.context.request.RequestAttributes;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import org.springframework.web.multipart.MultipartFile;

@Aspect
@Slf4j
public class LogAspect {

    private final String PARENT_HTTP_REQUEST_TRACKING_ID = "B2cParentHttpRequestTrackingId";
    //private final String CURRENT_REQUEST_TRACKING_ID = "B2cCurrentRequestTrackingId";
    private final Integer MAX_LENGTH = 1500;

    @Pointcut("execution(* com.sf.pharma..start..*Controller.*(..))")
    public void controllerPointCut() {
    }

    @Around("controllerPointCut()")
    public Object controllerAround(ProceedingJoinPoint pjp) throws Throwable {
        long startTimeMillis = System.currentTimeMillis();
        //返回切入点的签名
        Signature sig = pjp.getSignature();
        if (!(sig instanceof MethodSignature)) {
            log.error("该日志切面只能用于方法！");
            return pjp.proceed();
        }
        //获取全类名和方法名
        String className = pjp.getSignature().getDeclaringTypeName();
        String methodName = pjp.getSignature().getName();
        //
        RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();
        ServletRequestAttributes servletRequestAttributes = (ServletRequestAttributes) requestAttributes;
        HttpServletRequest httpRequest = servletRequestAttributes.getRequest();
        if (this.isBlackListUrl(httpRequest.getRequestURI())) {
            return pjp.proceed();
        }

        //Controller类的方法请求参数全部打印，不截取。
        Object resultObj = null;
        String errorMsg = null;
        String parentRequestId = UUID.randomUUID().toString();
        String currentRequestId = UUID.randomUUID().toString();
        try {
            //简单请求链路跟踪
            httpRequest.setAttribute(PARENT_HTTP_REQUEST_TRACKING_ID, parentRequestId);

            StringBuilder reqContentSb = new StringBuilder();
            reqContentSb.append("RequestId:").append(currentRequestId)
                .append(", ").append("ParentRequestId:").append(parentRequestId)
                .append(", Request-").append(httpRequest.getMethod()).append("-Url:").append(httpRequest.getRequestURI())
                .append(", ").append("RequestClass:").append(className)
                .append(", ").append("RequestMethod:").append(methodName)
                .append(", ").append("RequestHeadParams:").append(StringUtil.subStr(buildReqHeaderLog(httpRequest), MAX_LENGTH))
                .append(", ").append("RequestParams:").append(buildReqParamsLog(pjp));
            log.info(reqContentSb.toString());
            resultObj = pjp.proceed();
        } catch (Throwable t) {
            errorMsg = t.toString();
            throw t;
        } finally {
            StringBuilder respContentSb = new StringBuilder();
            respContentSb.append("ResponseId:").append(currentRequestId)
                .append(", ").append("ParentResponseId:").append(parentRequestId)
                .append(", ").append("ResponseTime:").append(System.currentTimeMillis() - startTimeMillis).append("ms")
                .append(", ").append("ResponseResult:").append(StringUtil.subStr(JSON.toJSONString(resultObj), MAX_LENGTH));
            if (StringUtils.isNotBlank(errorMsg)) {
                respContentSb.append(", ").append("ResponseErrorMsg:").append(errorMsg);
            }
            log.info(respContentSb.toString());
        }
        return resultObj;
    }

    /**
     * 这个切面粒度太粗，会把调用下游接口的日志也打印出来。
     */
    @Pointcut("execution(* com.sf.pharma..api.facade..*Facade.*(..))")
    public void feignPointCut() {
    }

    @Around("feignPointCut()")
    public Object feignAround(ProceedingJoinPoint pjp) throws Throwable {
        long startTimeMillis = System.currentTimeMillis();
        //返回切入点的签名
        Signature sig = pjp.getSignature();
        if (!(sig instanceof MethodSignature)) {
            log.error("该日志切面只能用于方法！");
            return pjp.proceed();
        }
        //获取全类名和方法名
        String className = pjp.getSignature().getDeclaringTypeName();
        String methodName = pjp.getSignature().getName();
        //
        RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();
        ServletRequestAttributes servletRequestAttributes = (ServletRequestAttributes) requestAttributes;
        HttpServletRequest httpRequest = servletRequestAttributes.getRequest();
        if (this.isBlackListUrl(httpRequest.getRequestURI())) {
            return pjp.proceed();
        }

        //Feign类的方法请求参数太长时截取。
        Object resultObj = null;
        String errorMsg = null;
        String parentRequestId = null;
        String currentRequestId = UUID.randomUUID().toString();
        try {
            //简单请求链路跟踪
            parentRequestId = (String) httpRequest.getAttribute(PARENT_HTTP_REQUEST_TRACKING_ID);
            if (StringUtil.isEmpty(parentRequestId)) {
                parentRequestId = UUID.randomUUID().toString();
                httpRequest.setAttribute(PARENT_HTTP_REQUEST_TRACKING_ID, parentRequestId);
            }

            StringBuilder reqContentSb = new StringBuilder();
            reqContentSb.append("RequestId:").append(currentRequestId)
                .append(", ").append("ParentRequestId:").append(parentRequestId)
                .append(", ").append("RequestClass:").append(className)
                .append(", ").append("RequestMethod:").append(methodName)
                .append(", ").append("RequestParams:").append(StringUtil.subStr(buildReqParamsLog(pjp), MAX_LENGTH));
            log.info(reqContentSb.toString());
            resultObj = pjp.proceed();
        } catch (Throwable t) {
            errorMsg = t.toString();
            throw t;
        } finally {
            StringBuilder respContentSb = new StringBuilder();
            respContentSb.append("ResponseId:").append(currentRequestId)
                .append(", ").append("ParentResponseId:").append(parentRequestId)
                .append(", ").append("ResponseTime:").append(System.currentTimeMillis() - startTimeMillis).append("ms")
                .append(", ").append("ResponseResult:").append(StringUtil.subStr(JSON.toJSONString(resultObj), MAX_LENGTH));
            if (StringUtils.isNotBlank(errorMsg)) {
                respContentSb.append(", ").append("ResponseErrorMsg:").append(errorMsg);
            }
            log.info(respContentSb.toString());
        }
        return resultObj;
    }

    private boolean isBlackListUrl(String requestURI) {
        //一些url无需打印日志，可以排除一部分。
        String[] blackAry = new String[]{"/glhealthcheck/status/1", "/glhealthcheck/status/0"};
        for (int i = 0; i < blackAry.length; i++) {
            if (requestURI.endsWith(blackAry[i])) {
                return true;
            }
        }
        return false;
    }

    private String buildReqParamsLog(ProceedingJoinPoint pjp) {
        //返回被通知方法参数列表
        Object[] args = pjp.getArgs();
        Stream<?> stream = ArrayUtils.isEmpty(args) ? Stream.empty() : Arrays.asList(args).stream();
        //序列化时过滤掉request和response
        List<Object> reqArgs = stream
            .filter(arg -> (!(arg instanceof HttpServletRequest)
                && !(arg instanceof HttpServletResponse)
                && !(arg instanceof MultipartFile)))
            .collect(Collectors.toList());
        return JSON.toJSONString(reqArgs);
    }

    private String buildReqHeaderLog(HttpServletRequest httpRequest) {
        HashMap headerMap = new HashMap(16);
        Enumeration<String> headerNames = httpRequest.getHeaderNames();
        while (headerNames.hasMoreElements()) {
            String headerKey = headerNames.nextElement();
            String headerValue = httpRequest.getHeader(headerKey);
            //一些head参数对我们无用，可以排除一部分。
            //保留"clientId"、"Content-Length"、"Content-Type"、"Cookie"、"User-Agent"、"Host", "origin", "referer"、
            //保留"x-real-ip"、"x-forwarded-for"、
            String[] blackAry = new String[]{"x-cat-trace", "x-rontgen", "x-service-chain", "postman-token",
                "sec-ch-ua", "sec-ch-ua-mobile", "sec-ch-ua-platform", "sec-fetch-dest", "sec-fetch-mode", "sec-fetch-site",
                "accept", "accept-encoding", "accept-language", "connection", "cache-control", "scope"};
            List<String> blackList = Arrays.asList(blackAry);
            if (blackList.contains(headerKey)) {
                continue;
            }
            headerMap.put(headerKey, headerValue);
        }
        return JSON.toJSONString(headerMap);
    }


}