實(shí)現(xiàn)代碼
主要功能實(shí)現(xiàn)類
import com.alibaba.fastjson.JSON;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.FileWriter;
import java.io.IOException;
import java.io.OutputStream;
import java.io.PrintWriter;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.Enumeration;
/**
* Created by tt on 2017/6/16.
* 全局異常處理類
*/
@ControllerAdvice
public class ExceptionHandlerAdvice {
private Logger logger = LoggerFactory.getLogger(getClass());
@Value("${err.logging.file}")
private String errFile;
private final SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
/**
* 攔截所有的Exception
*/
@ExceptionHandler(value = {Exception.class})
public void exception(Exception exception, HttpServletResponse response, HttpServletRequest request) {
try {
FileWriter fileWriter = new FileWriter(errFile, true);
fileWriter.write("========================================================================================================================================\n");
//記錄錯誤時間
fileWriter.write(sdf.format(new Date()) + "\n");
//記錄用戶設(shè)備型號
fileWriter.write(request.getHeader("User-Agent") + "\n");
String ip = getRemoteAddress(request);
String requestURL = request.getRequestURL().toString();
String url = request.getQueryString() == null ? requestURL + "" : (requestURL + "?" + request.getQueryString());
//記錄請求地址
fileWriter.write(url + "\n");
//記錄請求ip地址
fileWriter.write(ip + "\n");
Enumeration paramNames = request.getParameterNames();
while (paramNames.hasMoreElements()) {
String paramName = (String) paramNames.nextElement();
String[] paramValues = request.getParameterValues(paramName);
if (paramValues.length == 1) {
String paramValue = paramValues[0];
if (paramValue.length() != 0) {
//記錄請求參數(shù)
fileWriter.write("param: " + paramName + " = " + paramValue + "\n");
}
}
}
PrintWriter printWriter = new PrintWriter(fileWriter);
//把異常信息記錄到日志文件中
exception.printStackTrace(printWriter);
//關(guān)閉writer流
fileWriter.write("\n");
fileWriter.close();
printWriter.close();
} catch (IOException e) {
logger.info("I can't open the file " + errFile);
}
//控制臺打印異常詳細(xì)信息
exception.printStackTrace();
//使用OutputStream流向客戶端輸出錯誤信息
try {
OutputStream os = response.getOutputStream();
//通過設(shè)置響應(yīng)頭控制瀏覽器以UTF-8的編碼顯示數(shù)據(jù)兔甘，如果不加這句話花吟，那么瀏覽器顯示的將是亂碼
response.setHeader("content-type", "text/html;charset=UTF-8");
ResultData<Object> resultData = new ResultData<>();
String e = exception.toString();
// 異常類型
resultData.setData("異常類型：" + (e.contains(":") ? e.substring(0, e.indexOf(":")) : e));
resultData.setCode(555);// 異常信息
resultData.setMsg("異常信息：" + exception.getMessage());
String data = JSON.toJSONString(resultData);
//將字符轉(zhuǎn)換成字節(jié)數(shù)組胞锰，指定以UTF-8編碼進(jìn)行轉(zhuǎn)換
byte[] dataByteArr = data.getBytes("UTF-8");
//使用OutputStream流向客戶端輸出字節(jié)數(shù)組
os.write(dataByteArr);
//關(guān)閉輸出流
os.close();
} catch (IOException e1) {
e1.printStackTrace();
}
}
private static String getRemoteAddress(HttpServletRequest request) {
String ip = request.getHeader("x-forwarded-for");
if (ip == null || ip.length() == 0 || ip.equalsIgnoreCase("unknown")) {
ip = request.getHeader("Proxy-Client-IP");
}
if (ip == null || ip.length() == 0 || ip.equalsIgnoreCase("unknown")) {
ip = request.getHeader("WL-Proxy-Client-IP");
}
if (ip == null || ip.length() == 0 || ip.equalsIgnoreCase("unknown")) {
ip = request.getRemoteAddr();
}
return ip;
}
}
以下為ResultData類，用于返回給客戶端的json格式數(shù)據(jù)
public class ResultData<T> {
private T data;
private Integer code = 200;
private String msg;
private Boolean success = true;
// 此處省略getter setter
}
代碼說明
@ControllerAdvice
通過@ControllerAdvice注解到類上葬凳，我們可以將對于控制器的全局配置放在同一個位置绰垂，通過@ExceptionHandler，@InitBinder火焰，@ModelAttribute(本文只提到@ExceptionHandler劲装，另外兩個注解讀者有興趣可自行嘗試)注解在該類的方法上，這對所有注解了@Controller的類內(nèi)的注解了@RequestMapping的方法都有效昌简。
我們現(xiàn)在要用到的是@ExceptionHandler占业，用于全局處理控制器里的異常。
@ExceptionHandler(value = {Exception.class})
這邊可以看到@ExceptionHandler注解內(nèi)我們使用到了value屬性纯赎，它可以過濾攔截的條件谦疾。此處我們攔截所有的Exception。除此之外我們還可以根據(jù)自己的需要犬金，定制細(xì)化的異常處理念恍，把各種不同的異常類型分開處理。
@Value
@Value("${err.logging.file}")
@Value 用于獲取 application.properties 文件的外部配置屬性晚顷，此示例在外部配置文件內(nèi)的配置如下樊诺，主要用于配置異常處理的日志錯誤信息保存的路徑，方便項(xiàng)目運(yùn)行動態(tài)設(shè)置音同。
err.logging.file = err.log
其他細(xì)節(jié)
OutputStream os = response.getOutputStream();
//通過設(shè)置響應(yīng)頭控制瀏覽器以UTF-8的編碼顯示數(shù)據(jù)，如果不加這句話秃嗜，那么瀏覽器顯示的將是亂碼
response.setHeader("content-type", "text/html;charset=UTF-8");
ResultData<Object> resultData = new ResultData<>();
String e = exception.toString();
// 異常類型
resultData.setData("異常類型：" + (e.contains(":") ? e.substring(0, e.indexOf(":")) : e));
resultData.setCode(555);// 異常信息
resultData.setMsg("異常信息：" + exception.getMessage());
String data = JSON.toJSONString(resultData);
//將字符轉(zhuǎn)換成字節(jié)數(shù)組权均，指定以UTF-8編碼進(jìn)行轉(zhuǎn)換
byte[] dataByteArr = data.getBytes("UTF-8");
//使用OutputStream流向客戶端輸出字節(jié)數(shù)組
os.write(dataByteArr);
//關(guān)閉輸出流
os.close();
這里用于異常捕獲處理日志后，向客戶端輸出的異常信息锅锨，處理后的json輸出示例：
{
code: 555,
data: "異常類型：org.springframework.web.bind.MissingServletRequestParameterException",
msg: "異常信息：Required List parameter 'ids' is not present",
success: false
}
這樣可以保持客戶端請求服務(wù)端接口的返回數(shù)據(jù)格式一致叽赊。
最后附上日志記錄信息的結(jié)果（具體的記錄信息科自行定制，本文僅提供方案）
屏幕快照 2017-08-16 13.33.29.png
