Struts2攔截器記錄系統操作日志

• 前言

　　最近開發了一個項目，由於項目在整個開發過程中處於趕時間狀態（每個項目都差不多如此）所以項目在收尾階段發現缺少記錄系統日志功能，以前系統都是直接寫在每個模塊的代碼中，然后存入表單，在頁面可以查看部分日志。這個系統並沒有此要求，因此便想到了做一個系統通用的日志記錄，主要記錄數據有：操作時間、操作對象、操作方法、操作的一些參數以及操作結果。剛開始直接想到的是利用aspect實現aop記錄日志，但實際應用中發現aspect並不能友好的攔截action,而是主要用作攔截service層業務。由於系統框架是基於ssh框架的，所以最終考慮使用struts2的自帶攔截器Interceptor。

• 什么攔截器？

　　攔截器是動態攔截Action調用的對象。它提供了一種機制可以使開發者可以定義在一個action執行的前后執行的代碼，也可以在一個action執行前阻止其執行。同時也是提供了一種可以提取action中可重用的部分的方式。談到攔截器，還有一個詞大家應該知道——攔截器鏈（Interceptor Chain，在Struts 2中稱為攔截器棧Interceptor Stack）。攔截器鏈就是將攔截器按一定的順序聯結成一條鏈。在訪問被攔截的方法或字段時，攔截器鏈中的攔截器就會按其之前定義的順序被調用。

•  攔截器的原理和大致流程

 

 　　1.ActionInvocation初始化時，根據配置，加載Action相關的所有Interc eptor。

 

　　 2. 通過ActionInvocation.invoke方法調用Action實現時，執行Interceptor。

 

    Interceptor將很多功能從我們的Action中獨立出來，大量減少了我們Action的代碼，獨立出來的行為具有很好的重用性。XWork、WebWork的許多功能都是有Interceptor實現，可以在配置文件中組裝Action用到的Interceptor，它會按照你指定的順序，在Action執行前后運行。

• 項目實現攔截器代碼

package com.mnsn.utils;

import java.io.BufferedWriter;
import java.io.File;
import java.io.FileWriter;
import java.util.Calendar;
import java.util.Map;
import java.util.Set;

import org.apache.struts2.ServletActionContext;

import com.mnsn.project.user.User;
import com.opensymphony.xwork2.ActionInvocation;
import com.opensymphony.xwork2.interceptor.Interceptor;
import com.opensymphony.xwork2.interceptor.PreResultListener;

/**
 * 系統日志攔截器
 * @AUTHER LiuLonglong
 * @Motto Goals determine what you are going to be.
 * @URL http://www.cnblogs.com/mvilplss/
 * @Time 下午04:09:37
 * @Version
 */
public class Dolog implements Interceptor {

    private static final long serialVersionUID = 1L;

    public String intercept(ActionInvocation ai) throws Exception {

        ai.addPreResultListener(new PreResultListener() {

            public void beforeResult(ActionInvocation ai, String arg1) {
                try {
                    StringBuffer sb = new StringBuffer();
                    sb.append(MyUtils.getDataYmdhms2() + ":");
                    Map<String, Object> session = ai.getInvocationContext().getSession();
                    User user = (User) session.get("loginUser");
                    if (user != null) {
                        sb.append("操作人：" + user.getName());
                    } else {
                        sb.append("操作人：系統未獲取");
                    }
                    sb.append("類名：" + ai.getAction() + " ");
                    sb.append("方法名：" + ai.getInvocationContext().getName()+ " ");
                    Map<String, Object> map = ai.getInvocationContext().getParameters();
                    Set<String> keys = map.keySet();
                    sb.append("參數：");
                    for (String key : keys) {
                        sb.append(key + "=" + ((Object[]) map.get(key))[0]+ "#");
                    }
                    sb.append(" ");
                    sb.append("執行結果：" + ai.getResultCode() + " ");
                    String appPath = ServletActionContext.getServletContext().getRealPath("/");
                    saveLog(appPath + "operLog", sb.toString());
                } catch (Exception e) {
                    e.printStackTrace();
                }

            }
        });

        return ai.invoke();
    }

    public static void saveLog(String dir, String content) {
        try {
            File path = new File(dir);
            if (!path.exists()) {
                path.mkdir();
            }
            File LogDir = new File(path + "/"
                    + (Calendar.getInstance().get(Calendar.MONTH) + 1));
            if (!LogDir.exists()) {
                LogDir.mkdir();
            }
            File file = new File(LogDir + "/"
                    + Calendar.getInstance().get(Calendar.DAY_OF_MONTH)
                    + ".log");
            if (!file.exists()) {
                file.createNewFile();
            }
            BufferedWriter br = new BufferedWriter(new FileWriter(file, true));
            br.write(content);
            br.newLine();
            br.flush();
            br.close();

            File LogDirOld = new File(
                    path
                            + "/"
                            + (Calendar.getInstance().get(Calendar.MONTH) - 2 > 0 ? (Calendar
                                    .getInstance().get(Calendar.MONTH) - 2)
                                    : Calendar.getInstance()
                                            .get(Calendar.MONTH) + 10));
            if (LogDirOld.exists()) {
                File[] fileOlds = LogDirOld.listFiles();
                for (File f : fileOlds) {
                    f.delete();
                }
                LogDirOld.delete();
            }
        } catch (Exception e) {
            e.printStackTrace();
        }

    }

    public void destroy() {

    }

    public void init() {

    }
}

• 項目部分配置

 

<!-- 配置攔截器 -->
        <interceptors>
            <interceptor name="dolog" class="com.mnsn.utils.Dolog"></interceptor>
            <interceptor-stack name="defaultStack">
                <interceptor-ref name="dolog"></interceptor-ref>
                   <interceptor-ref name="defaultStack"></interceptor-ref>
               </interceptor-stack>
        </interceptors>

 

• 執行結果

取自於文件：C:\Program Files (x86)\tomcat-6.0.43-myeclipse\webapps\qzdl\operLog\3\10.log

20150310173309:操作人：系統未獲取類名：com.mnsn.project.user.UserAction@b2c940 方法名：login 參數：loginname=ss#password=ss#x=31#y=11# 執行結果：pass 
20150310173313:操作人：欽州老大類名：com.mnsn.project.user.UserAction@1a2157e 方法名：list 參數： 執行結果：list 
20150310173322:操作人：欽州老大類名：com.mnsn.project.user.UserAction@108a2d1 方法名：delete 參數：users[0].id=402881ec4b38cf8f014b38d4510f0001# 執行結果：toList 
20150310173323:操作人：欽州老大類名：com.mnsn.project.user.UserAction@13e3101 方法名：list 參數： 執行結果：list 
20150310173326:操作人：欽州老大類名：com.mnsn.project.user.UserAction@158a9b 方法名：toOper 參數：user.id=402881fd4becf4d5014becf8253c0000# 執行結果：oper 
20150310173328:操作人：欽州老大類名：com.mnsn.project.user.UserAction@174edfd 方法名：update 參數：toWhere=#user.createtime=2015-03-06 10:44:20.0#user.group.id=402881ef4a9f4536014a9f69be6c0005#user.id=402881fd4becf4d5014becf8253c0000#user.job=部門主管#user.loginname=wml#user.mobilephone=18758010019#user.name=王明路#user.office_telephone=0571-6856156#user.password=123456#user.remark=此人為部門管理員#user.unit.id=402881fd4becf4d5014bed053ce80001# 執行結果：toList 
20150310173328:操作人：欽州老大類名：com.mnsn.project.user.UserAction@11efcc2 方法名：list 參數： 執行結果：list 

• 總結

　　struts2的攔截器相對aspect來說還是比較容易上手和理解的，對於要求一般的系統操作日志可以采用攔截器，而aspect重要用於細粒度的控制方法的出口和入口，實現邏輯層的增強，例如聲明式事物。

 

• 備注

　　本文在工作繁忙中碼出來的，如有錯誤在所難免，望讀者指出，謝謝！