資訊專欄INFORMATION COLUMN
摘要：如果處理除了問題，也要返回顯示錯誤的。用上就方便多了，加一個攔截類，加一點配置，就可以搞定所有。其他配置根據情況添加。采用這種方法，實現了對所有方法進行統一的日志記錄。
在項目中一直使用SpringMVC做Java后臺服務，返回的基本都是JSON。
要求請求參數、返回結果都要打印到log里，方便追蹤。
如果處理除了問題，也要返回顯示錯誤的JSON。
如果不用AOP攔截，每個Controller方法都要寫成類似如下的樣子：
@RequestMapping(value = "/someUrl", produces = { "application/json;charset=UTF-8" })
@ResponseBody
public String someUrl(@ModelAttribute ReqForm reqParams) {
Logger.info(..., "someUrl request: "+JsonUtil.toJson(reqParams));
// form validation ...
try {
ResultObject result = someService.serviceMethod(reqParams);
Logger.info(..., "someUrl response: "+JsonUtil.toJson(result));
return JsonResult.success(result);
} catch (Exception e) {
Logger.error(..., "someUrl: "
+ JsonUtil.toJson(reqParams) + " || " + ExceptionUtil.printStackTraceToString(e));
return JsonResult.fail();
}
}
很煩，都是重復的東西。用上AOP就方便多了，加一個攔截類，加一點配置，就可以搞定所有。
首先，添加Maven依賴：
org.aspectj aspectjweaver 1.8.0
然后，實現一個請求攔截處理類(Logger的方法被簡化了)
import java.io.PrintWriter;
import java.io.StringWriter;
import java.lang.reflect.Method;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.Map;
import javax.servlet.http.HttpServletRequest;
import org.aopalliance.intercept.MethodInterceptor;
import org.aopalliance.intercept.MethodInvocation;
import org.springframework.ui.Model;
import org.springframework.ui.ModelMap;
import org.springframework.validation.BindingResult;
/**
* 請求攔截處理類
*
*
*/
public class ControllerInterceptor implements MethodInterceptor {
@Override
public String invoke(MethodInvocation invocation) {
String result = "";
String paramsStr = "";
Object value = null;
Method md = invocation.getMethod();
try {
Object[] args = invocation.getArguments();
paramsStr = this.logRequest(args);
value = invocation.proceed();
} catch (Throwable e) {
if (e instanceof ServiceException) {
Logger.error(..., ((ServiceException) e).getAlarmId(), md
.getDeclaringClass().getSimpleName()
+ "."
+ md.getName()
+ " || "
+ paramsStr
+ " || "
+ printStackTraceToString(e));
} else {
Logger.error(..., "some_alarm_id", md
.getDeclaringClass().getSimpleName()
+ "."
+ md.getName()
+ " || "
+ paramsStr
+ " || "
+ printStackTraceToString(e));
}
}
if (value != null) {
result = value.toString();
} else {
result = JsonResult.SYSERROR;
}
this.logRequestResponse(md, paramsStr, result);
return result;
}
private String logRequest(Object[] args) {
if (args == null) {
return "";
}
// 請求參數日志信息
Map params = new HashMap();
int i = 1;
for (Object arg : args) {
if (!(arg instanceof BindingResult) && !(arg instanceof ModelMap) && !(arg instanceof Model)) {
if (arg instanceof HttpServletRequest) {
HttpServletRequest httpRequest = (HttpServletRequest) arg;
Enumeration enume = httpRequest.getParameterNames();
if (null != enume) {
Map hpMap = new HashMap();
while (enume.hasMoreElements()) {
Object element = enume.nextElement();
if (null != element) {
String paramName = (String) element;
String paramValue = httpRequest.getParameter(paramName);
hpMap.put(paramName, paramValue);
}
}
params.put("HttpServletRequest", hpMap);
}
} else {
try {
params.put("arg" + i, JsonUtil.toJson(arg));
i++;
} catch (Throwable e) {
Logger.warn(..., "CANNOT trasform to json string:"
+ arg.getClass().getName());
}
}
}
}
String paramsStr = JsonUtil.toJson(params);
return paramsStr;
}
private void logRequestResponse(Method md, String paramsStr, String re) {
Map logMap = new HashMap();
logMap.put("controller.method", md.getDeclaringClass().getSimpleName() + "." + md.getName());
logMap.put("logReq", paramsStr);
logMap.put("logRes", re);
Logger.info(..., logMap);
}
private String printStackTraceToString(Throwable e) {
StringWriter sw = new StringWriter();
PrintWriter pw = new PrintWriter(sw);
e.printStackTrace(pw);
return sw.toString().replace("
", " ").replace("
", " ").replace(" ", " ");
}
}
這里用一個類實現了org.aopalliance.intercept.MethodInterceptor接口，實現invoke方法，達到對Controller方法的進入和返回攔截的效果。
注意要在適當的時機執行invocation.proceed()方法，并返回它的返回值。否則所有Controller方法都沒返回了。
還有一點，由于我用的SpringMVC，controller方法的一些參數并不需要打印出來，比如BingdingResult ModelMap Model等等。
如果有HttpServletRequest傳進來，也不能直接被JSON序列化，需要特殊處理一下。還有其他不能序列化的東西，直接略掉(代碼中的try…catch)。
然后，配置下spring。
在spring-mvc.xml文件的
