/
RequestAndResponseLogger.java
222 lines (195 loc) · 9.09 KB
/
RequestAndResponseLogger.java
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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
package ksbysample.webapp.lending.aspect.logging;
import com.google.common.collect.Iterators;
import org.apache.commons.lang3.StringUtils;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.After;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.Arrays;
import java.util.Map;
import java.util.Optional;
import java.util.stream.StreamSupport;
/**
* ???
*/
@Aspect
@Component
public class RequestAndResponseLogger {
private final Logger logger = LoggerFactory.getLogger(RequestAndResponseLogger.class);
private static final String POINTCUT_ALL_CLASS_AND_METHOD_UNDER_APPLICATION_PACKAGE
= "execution(* ksbysample.webapp.lending..*.*(..))";
private static final String LOG_REQUEST_INFO = "[req][info ] ";
private static final String LOG_REQUEST_HEADER = "[req][header] ";
private static final String LOG_REQUEST_COOKIE = "[req][cookie] ";
private static final String LOG_REQUEST_PARAMETER = "[req][param ] ";
private static final String LOG_RESPONSE_INFO = "[res][info ] ";
private static final String LOG_RESPONSE_HEADER = "[res][header] ";
/**
* Web アプリケーションの package 配下の全てのクラスのメソッドを Join Point にする Pointcut
*/
@Pointcut(POINTCUT_ALL_CLASS_AND_METHOD_UNDER_APPLICATION_PACKAGE)
public void allClassAndMethodUnderApplicationPackage() {
}
/**
* {@link RequestMapping} アノテーションが付加されたメソッドを Join Point にする Pointcut
*/
@Pointcut("@annotation(org.springframework.web.bind.annotation.RequestMapping)")
public void requestMappingAnnotation() {
}
/**
* {@link GetMapping}, {@link PostMapping} 等 {@link RequestMapping} アノテーションを使用した
* composed annotation が付加されたメソッドを Join Point にする Pointcut
*/
@Pointcut("execution(@(@org.springframework.web.bind.annotation.RequestMapping *) * *(..))")
public void requestMappingComposedAnnotations() {
}
/**
* ???
*
* @param pjp ???
* @return ???
* @throws Throwable ???
*/
@SuppressWarnings("ReturnValueIgnored")
@Around(value = "allClassAndMethodUnderApplicationPackage()"
+ " && (requestMappingAnnotation() || requestMappingComposedAnnotations())")
public Object logginRequestAndResponse(ProceedingJoinPoint pjp)
throws Throwable {
HttpServletRequest request
= ((ServletRequestAttributes) RequestContextHolder.currentRequestAttributes()).getRequest();
loggingRequest(request);
Object ret = pjp.proceed();
Optional.ofNullable((ServletRequestAttributes) RequestContextHolder.getRequestAttributes())
.flatMap(requestAttributes -> Optional.ofNullable(requestAttributes.getResponse()))
.flatMap(response -> {
loggingResponse(response);
return Optional.empty();
});
return ret;
}
/**
* ???
*/
@SuppressWarnings("ReturnValueIgnored")
@After(value = "allClassAndMethodUnderApplicationPackage()"
+ " && @annotation(org.springframework.web.bind.annotation.ExceptionHandler)")
public void logginResponseAfterExceptionHandler() {
Optional.ofNullable((ServletRequestAttributes) RequestContextHolder.getRequestAttributes())
.flatMap(requestAttributes -> Optional.ofNullable(requestAttributes.getResponse()))
.flatMap(response -> {
loggingResponse(response);
return Optional.empty();
});
}
private void loggingRequest(HttpServletRequest request) {
loggingRequestInfo(request);
loggingRequestHeaders(request);
loggingRequestCookies(request);
loggingRequestParameters(request);
}
private void loggingResponse(HttpServletResponse response) {
loggingResponseInfo(response);
loggingResponseHeaders(response);
}
private void loggingRequestInfo(HttpServletRequest request) {
StringBuilder sb = new StringBuilder();
append(sb, "REQUEST_URI", request.getRequestURI());
append(sb, ", SERVLET_PATH", request.getServletPath());
logging(LOG_REQUEST_INFO, null, sb.toString());
sb = new StringBuilder();
append(sb, "CHARACTER_ENCODING", request.getCharacterEncoding());
append(sb, ", CONTENT_LENGTH", String.valueOf(request.getContentLength()));
append(sb, ", CONTENT_TYPE", request.getContentType());
append(sb, ", LOCALE", String.valueOf(request.getLocale()));
append(sb, ", SCHEME", request.getScheme());
logging(LOG_REQUEST_INFO, null, sb.toString());
sb = new StringBuilder();
append(sb, "REMOTE_ADDR", request.getRemoteAddr());
append(sb, ", REMOTE_HOST", request.getRemoteHost());
append(sb, ", SERVER_NAME", request.getServerName());
append(sb, ", SERVER_PORT", String.valueOf(request.getServerPort()));
logging(LOG_REQUEST_INFO, null, sb.toString());
sb = new StringBuilder();
append(sb, "CONTEXT_PATH", request.getContextPath());
append(sb, ", REQUEST_METHOD", request.getMethod());
append(sb, ", QUERY_STRING", request.getQueryString());
append(sb, ", PATH_INFO", request.getPathInfo());
append(sb, ", REMOTE_USER", request.getRemoteUser());
logging(LOG_REQUEST_INFO, null, sb.toString());
}
private void loggingRequestHeaders(HttpServletRequest request) {
Iterable<String> headerNameList = () -> Iterators.forEnumeration(request.getHeaderNames());
StreamSupport.stream(headerNameList.spliterator(), false)
.filter(headerName -> !StringUtils.equals(headerName, "cookie"))
.forEach(headerName -> {
Iterable<String> headerList = () -> Iterators.forEnumeration(request.getHeaders(headerName));
headerList.forEach(header -> logging(LOG_REQUEST_HEADER, headerName, header));
});
}
private void loggingRequestCookies(HttpServletRequest request) {
if (request.getCookies() != null) {
Arrays.asList(request.getCookies()).forEach(cookie -> {
StringBuilder sb = new StringBuilder();
sb.append("name = ")
.append(cookie.getName())
.append(", value = ")
.append(cookie.getValue())
.append(", domain = ")
.append(cookie.getDomain())
.append(", path = ")
.append(cookie.getPath())
.append(", maxage = ")
.append(cookie.getMaxAge())
.append(", secure = ")
.append(cookie.getSecure())
.append(", httponly = ")
.append(cookie.isHttpOnly());
logging(LOG_REQUEST_COOKIE, null, sb.toString());
});
}
}
private void loggingRequestParameters(HttpServletRequest request) {
Map<String, String[]> parameterMap = request.getParameterMap();
parameterMap.forEach((key, values) -> {
Arrays.asList(values).forEach(value -> logging(LOG_REQUEST_PARAMETER, key, value));
});
}
private void loggingResponseInfo(HttpServletResponse response) {
StringBuilder sb = new StringBuilder();
append(sb, "RESPONSE_STATUS", String.valueOf(response.getStatus()));
append(sb, ", CHARACTER_ENCODING", response.getCharacterEncoding());
append(sb, ", CONTENT_TYPE", response.getContentType());
append(sb, ", LOCALE", String.valueOf(response.getLocale()));
logging(LOG_RESPONSE_INFO, null, sb.toString());
}
private void loggingResponseHeaders(HttpServletResponse response) {
response.getHeaderNames().forEach(headerName -> {
response.getHeaders(headerName).forEach(header -> logging(LOG_RESPONSE_HEADER, headerName, header));
});
}
private void logging(String title, String name, String value) {
StringBuilder sb = new StringBuilder(title);
if (name != null) {
sb.append(name)
.append(" = ");
}
sb.append(value);
logger.info(sb.toString().replaceAll("[\r\n]", ""));
}
private void append(StringBuilder sb, String name, String value) {
sb.append(name)
.append(" = ")
.append(value);
}
}