一、需求描述：

每次系統出現異常（有系統異常，也有業務功能的異常）都需要讓運維拉生產上的日誌檔案，檢視哪個地方出問題了，根據列印的log日誌定位問題點以及原因，比較浪費時間。為了解決這個問題，就想到：當系統出現異常時，將異常資訊記錄到資料庫中，然後以簡訊或郵件的形式通知管理員登入到管理系統後臺頁面進行檢視具體異常資訊，從而快速定位和判斷出現異常的位置和原因，直到修復。

二、實現思路：

1、建立一張資料表，專門用於存放異常資訊，例如：遠端訪問IP、異常所在類、異常出現的方法名稱、異常型別、異常發生時間以及異常的詳細內容。

2、自定義一個異常處理器，當系統出現異常時就攔截該異常，並且獲取必要資訊，記錄到資料庫儲存。

3、將異常資訊記錄到資料庫之後，再發送郵件/簡訊通知系統管理員，提醒其登入後臺系統進行檢視。（後臺系統做一個異常資訊的檢視頁面，進行異常日誌的檢視和管理）

三、實現步驟：

1、建立資料表

CREATE TABLE t_exception_log (
  id int(11) NOT NULL AUTO_INCREMENT COMMENT '主鍵id',
  ip varchar(20) DEFAULT NULL COMMENT '遠端訪問主機IP',
  class_name varchar(255) DEFAULT NULL COMMENT '類名',
  method_name varchar(120) DEFAULT NULL COMMENT '方法名',
  exception_type varchar(255) DEFAULT NULL COMMENT '異常型別',
  exception_msg text COMMENT '異常資訊',
  addtime datetime NOT NULL COMMENT '異常發生時間',
  is_view tinyint(2) DEFAULT '1' COMMENT '是否檢視，1：未檢視、2：已檢視',
  PRIMARY KEY (id)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='異常資訊日誌表';
 

2、自定義全域性異常處理器，攔截並處理異常資訊，傳送通知郵件

package com.its.handler;

import java.io.PrintWriter;
import java.io.StringWriter;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;

import javax.mail.MessagingException;
import javax.mail.internet.AddressException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.apache.shiro.authz.UnauthorizedException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.HandlerExceptionResolver;
import org.springframework.web.servlet.ModelAndView;

import com.its.common.utils.IPUtils;
import com.its.common.utils.mail.MailSenderFactory;
import com.its.entity.ExceptionLog;
import com.its.service.system.ExceptionLogService;

/**
 * 全域性異常處理器
 * 
 * @author HY
 * @date 建立時間：2017年2月24日
 * @version
 */
public class GlobalExceptionHandler implements HandlerExceptionResolver {

	private static final Logger LOGGER = LoggerFactory.getLogger(GlobalExceptionHandler.class);

	@Autowired
	private ExceptionLogService exceptionLogService;

	@Override
	public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
		Map<String, Object> model = new HashMap<String, Object>();
		model.put("ex", ex);

		if (handler instanceof HandlerMethod) {
			LOGGER.info(">>>>>>系統異常，記錄異常資訊到資料庫------start------");
			// 遠端訪問IP
			String ip = IPUtils.getRemortIP(request);
			HandlerMethod handlerMethod = (HandlerMethod) handler;
			String className = handlerMethod.getBeanType().getName();
			String methodName = handlerMethod.getMethod().getName();
			StringWriter sw = new StringWriter();
			ex.printStackTrace(new PrintWriter(sw, true));

			// 插入異常日誌到資料庫
			ExceptionLog log = new ExceptionLog();
			log.setIp(ip);
			log.setClassName(className);
			log.setMethodName(methodName);
			log.setExceptionType(ex.getClass().getSimpleName());
			log.setExceptionMsg(sw.toString()); // 異常詳細資訊
			log.setIsView((byte) 1); // 預設未讀,1:為檢視、2：已檢視
			log.setAddtime(new Date());
			this.exceptionLogService.insertExceptionLogSelective(log);
			LOGGER.info(">>>>>>系統異常，記錄異常資訊到資料庫------end------");

			// TODO 此處先寫死。後期完善，接收人從資料庫配置中獲取
			try {
				String recipient = "
 
[email protected]";
				String subject = "【XXXX系統異常通知】";
				Object content = "管理員，您好：<br/>   XXXX系統出現異常，請立即登入後臺系統：“系統管理”--“異常日誌管理”進行檢視。<br/>   "
						+ new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date());
				MailSenderFactory.getSender().send(recipient, subject, content);
			} catch (AddressException e) {
				e.printStackTrace();
			} catch (MessagingException e) {
				e.printStackTrace();
			}
		}
                
		String viewName = "error/500";
		if (ex instanceof UnauthorizedException) {  // 後臺系統用的shiro做許可權控制，該異常也是shiro的異常
			viewName = "error/403";
		}
		return new ModelAndView(viewName, model);
	}

}

3、在Spring配置檔案中加上如下內容：

<!-- 全域性異常處理器 -->
<bean id="exceptionResolver" class="com.xhh.ddhd.handler.GlobalExceptionHandler" />

其它程式碼：

ExceptionLog.java

package com.its.entity;

import java.util.Date;

/**
 * 異常資訊日誌表
 * 
 */
public class ExceptionLog {
	/**
	 * 主鍵id
	 */
	private Integer id;

	/**
	 * 遠端訪問主機IP
	 */
	private String ip;

	/**
	 * 類名
	 */
	private String className;

	/**
	 * 方法名
	 */
	private String methodName;

	/**
	 * 異常型別
	 */
	private String exceptionType;

	/**
	 * 異常發生時間
	 */
	private Date addtime;

	/**
	 * 是否檢視，1：未檢視、2：已檢視
	 */
	private Byte isView;

	/**
	 * 異常資訊
	 */
	private String exceptionMsg;

       
        // setter、getter方法略......

}

IPUtils.java

package com.its.common.utils;

import javax.servlet.http.HttpServletRequest;

/**
 * IP地址操作工具類
 * 
 * @author HY
 * @date 建立時間：2017年2月24日
 * @version
 */
public class IPUtils {

	/**
	 * 獲取遠端訪問主機ip地址
	 * 
	 * 建立時間：2017年2月24日
	 * 
	 * @author HY
	 * @param request
	 * @return
	 */
	public static String getRemortIP(HttpServletRequest request) {
		String ip = request.getHeader("x-forwarded-for");
		if ((ip == null) || (ip.length() == 0) || ("unknown".equalsIgnoreCase(ip))) {
			ip = request.getHeader("Proxy-Client-IP");
		}
		if ((ip == null) || (ip.length() == 0) || ("unknown".equalsIgnoreCase(ip))) {
			ip = request.getHeader("WL-Proxy-Client-IP");
		}
		if ((ip == null) || (ip.length() == 0) || ("unknown".equalsIgnoreCase(ip))) {
			ip = request.getRemoteAddr();
		}
		return ip;
	}

}

MailSenderFactory.java

package com.its.common.utils.mail;

/**
 * 郵件傳送工廠
 * 
 * @author HY
 * @date 建立時間：2017年2月28日
 * @version
 */
public class MailSenderFactory {

	private static SimpleMailSender getInstance = null;

	private MailSenderFactory() {

	}

	public static SimpleMailSender getSender() {
		if (getInstance == null) {
			getInstance = new SimpleMailSender();
		}
		return getInstance;
	}

}

SimpleMailSender.java

package com.its.common.utils.mail;

import java.util.List;
import java.util.Properties;

import javax.mail.Message;
import javax.mail.Message.RecipientType;
import javax.mail.MessagingException;
import javax.mail.Session;
import javax.mail.Transport;
import javax.mail.internet.AddressException;
import javax.mail.internet.InternetAddress;
import javax.mail.internet.MimeMessage;

import com.its.common.context.Global;

/**
 * 簡單郵件（不帶附件的郵件）傳送器
 * 
 * @author HY
 * @date 建立時間：2017年2月28日
 * @version
 */
public class SimpleMailSender {

	private final transient Properties props = System.getProperties();

	private transient MailAuthenticator authenticator;

	private transient Session session;
        // 從本地快取中獲取郵件相關配置資訊
	private static final String USERNAME = Global.getSysValue("mail_sender_username");
	private static final String PASSWORD = Global.getSysValue("mail_sender_password");
	private static final String MAIL_SMTP_HOST = Global.getSysValue("mail_smtp_host");
	private static final String MAIL_SMTP_PORT = Global.getSysValue("mail_smtp_port");
	private static final String MAIL_SMTP_AUTH = Global.getSysValue("mail_smtp_auth").equals("1") ? "true" : "false";

	public SimpleMailSender() {
		init();
	}

	/**
	 * 初始化
	 * 
	 * 建立時間：2017年2月28日
	 * 
	 * @author HY
	 * @param smtpHostName
	 *            SMTP伺服器地址
	 * @param username
	 *            傳送郵件的使用者名稱（郵箱地址）
	 * @param password
	 *            密碼
	 */
	private void init() {
		// 初始化Properties
		props.put("mail.smtp.host", MAIL_SMTP_HOST);
		props.put("mail.smtp.port", MAIL_SMTP_PORT);
		props.put("mail.smtp.auth", MAIL_SMTP_AUTH);
		// 驗證傳送者賬戶密碼
		authenticator = new MailAuthenticator(USERNAME, PASSWORD);
		// 建立Session
		session = Session.getInstance(props, authenticator);
	}

	/**
	 * 傳送郵件（單發）
	 * 
	 * 建立時間：2017年2月28日
	 * 
	 * @author HY
	 * @param recipient
	 *            收件人郵箱地址
	 * @param subject
	 *            郵件主題
	 * @param content
	 *            郵箱內容
	 * @throws AddressException
	 * @throws MessagingException
	 */
	public void send(String recipient, String subject, Object content) throws AddressException, MessagingException {
		// 1.建立mime型別郵件
		final Message message = new MimeMessage(session);
		// 2.設定發件人
		message.setFrom(new InternetAddress(authenticator.getUsername()));
		// 3.設定收件人
		message.setRecipient(RecipientType.TO, new InternetAddress(recipient));
		// 4.設定郵件主題
		message.setSubject(subject);
		// 5.設定郵件內容
		message.setContent(content.toString(), "text/html;charset=utf-8");
		// 6.傳送
		Transport.send(message);
	}

	/**
	 * 群發郵件
	 * 
	 * 建立時間：2017年2月28日
	 * 
	 * @author HY
	 * @param recipients
	 *            多個收件人（郵箱地址集合）
	 * @param subject
	 *            郵件主題
	 * @param content
	 *            郵件內容
	 * @throws AddressException
	 * @throws MessagingException
	 */
	public void send(List<String> recipients, String subject, Object content) throws AddressException, MessagingException {
		// 1.建立mime型別郵件
		final Message message = new MimeMessage(session);
		// 2.設定發件人
		message.setFrom(new InternetAddress(authenticator.getUsername()));
		// 3.設定收件人
		final int num = recipients.size();
		InternetAddress[] addresses = new InternetAddress[num];
		for (int i = 0; i < num; i++) {
			addresses[i] = new InternetAddress(recipients.get(i));
		}
		message.setRecipients(RecipientType.TO, addresses);
		// 4.設定郵件主題
		message.setSubject(subject);
		// 5.設定郵件內容
		message.setContent(content.toString(), "text/html;charset=utf-8");
		// 6.傳送
		Transport.send(message);
	}

}

MailAuthenticator.java

package com.its.common.utils.mail;

import javax.mail.Authenticator;
import javax.mail.PasswordAuthentication;

/**
 * 郵箱伺服器登入驗證器
 * 
 * @author HY
 * @date 建立時間：2017年2月28日
 * @version
 */
public class MailAuthenticator extends Authenticator {

	/**
	 * 使用者名稱（登入郵箱地址）
	 */
	private String username = null;

	/**
	 * 密碼
	 */
	private String password = null;

	public MailAuthenticator() {

	}

	public MailAuthenticator(String username, String password) {
		this.username = username;
		this.password = password;
	}

	/**
	 * 賬戶認證
	 */
	@Override
	protected PasswordAuthentication getPasswordAuthentication() {
		return new PasswordAuthentication(username, password);
	}

	public String getUsername() {
		return username;
	}

	public void setUsername(String username) {
		this.username = username;
	}

	public String getPassword() {
		return password;
	}

	public void setPassword(String password) {
		this.password = password;
	}

}

4、驗證

隨便在controller中製造一個異常，然後看能否成功即可。此處就略過了...

注意：

我們專案用的MVC框架是SpringMVC，如果在springmvc配置檔案中配置了SimpleMappingExceptionResolver的話，則會導致以上的自定義全域性異常處理器無法正常

工作，若配置了，則將springmvc配置檔案中的相關內容去掉即可。

5、實際效果：

頁面：

郵件：