JeeSite | 保存信息修改記錄

需求點

        在很多場景中信息是不能輕易被修改的，修改時要么需要具備權限，要么需要審批，但是無論是哪種方式，修改前后的數據都是需要留有“案底”的，也就是說關鍵的信息被修改后是有修改記錄的，一般修改記錄會記錄修改人、修改日期和修改的數據字段。

        比如，修改一個人的姓名從“張三”變為了“李四”，那么在進行記錄的時候，記錄的信息可能如下：

        姓名：（張三）=>（李四）；性別：（女）=>（男）；

        這樣就很好的體現出了修改了哪個字段，修改前后的數據分別是什么。關鍵的信息無論怎么修改都會有據可查，時間、人物、修改數據前后信息等。

 

判斷被修改的數據

        在頁面中將數據修改並提交頁面后，數據會從 JSP 傳遞到 Controller 中，這時數據還沒有被更新到數據庫中，從提交到 Controller 的對象中用數據的 id 從數據庫中查出它現有的數據，然后使用現有的數據和提交的數據進行對比，就可以得到被修改過的數據字段有哪些了。

        這里比較繁瑣的是如何進行比對，逐個字段的使用 if 進行判斷肯定不是好方法，畢竟字段太多的時候是要寫死人的。那么如何進行，直接比較兩個對象就行，源碼我是從網上找的，好用，符合需求，源碼如下：

/** 
 * 獲取兩個對象同名屬性內容不相同的列表 
 * @param class1 對象1 
 * @param class2 對象2 
 * @return 
 * @throws ClassNotFoundException 
 * @throws IllegalAccessException 
 */  
public static List<Map<String ,Object>> compareTwoClass(Object class1, Object class2) {  
    List<Map<String,Object>> list=new ArrayList<Map<String, Object>>();  
    // 獲取對象的class  
    Class<?> clazz1 = class1.getClass();  
    Class<?> clazz2 = class2.getClass();  
    // 獲取對象的屬性列表  
    Field[] field1 = clazz1.getDeclaredFields();  
    Field[] field2 = clazz2.getDeclaredFields();  
    // 遍歷屬性列表field1  
    for(int i=0;i<field1.length;i++){  
        // 遍歷屬性列表field2  
        for(int j=0;j<field2.length;j++){  
            // 如果field1[i]屬性名與field2[j]屬性名內容相同  
            if(field1[i].getName().equals(field2[j].getName())){  
                if(field1[i].getName().equals(field2[j].getName())){  
                    field1[i].setAccessible(true);  
                    field2[j].setAccessible(true);  
                    // 如果field1[i]屬性值與field2[j]屬性值內容不相同  
                    try {
                        if (!compareTwo(field1[i].get(class1), field2[j].get(class2))){  
                            Map<String,Object> map2=new HashMap<String, Object>();  
                            map2.put("name",field1[i].getName());  
                            map2.put("old",field1[i].get(class1));  
                            map2.put("new",field2[j].get(class2));  
                            list.add(map2);  
                        }
                    } catch (IllegalArgumentException e) {
                        // TODO Auto-generated catch block
                        e.printStackTrace();
                    } catch (IllegalAccessException e) {
                        // TODO Auto-generated catch block
                        e.printStackTrace();
                    }  
                    break;  
                }  
            }
        }
    }
    return list;
}

/**  
 * 對比兩個數據是否內容相同  
 *  
 * @param  object1,object2  
 * @return boolean類型  
 */  
public static boolean compareTwo(Object object1,Object object2){  
    if ( object1 == null && object2 == null ) {  
        return true;  
    }  
    if ( object1 == null && object2 != null ) {  
        return false;  
    }  
    if ( object1.equals(object2) ) {  
        return true;  
    }  
    return false;  
}

        源碼是從哪里找到的忘記了，在這里感謝願意分享的網友，是你的源碼讓我快速解決了項目中的問題。（當時雖然不懂 Java，但是對於類似的處理我認為一定有相應的方法，而不是傻傻的去逐個比較，后來了解到這是 Java 中的反射，發現反射與注解真是好東西，用在項目當中會省很多事，現在我寫 PHP 時，雖然 PHP 不支持注解，但是我也會通過反射去解析注釋的方式，實現類似 Java 中注解的功能，真的很省事。）

 

屬性解析

        上面的函數會返回兩個對象中屬性值不同的 List，獲得該列表后，再次遍歷解析屬性對應的字段含義，進而拼接成一個字符串就可以生成修改日志進行保存了。

        通常情況下只要把類中的屬性和屬性對應的中文進行關聯后就可以了，但是在 JeeSite 中存在字典類型，比如“男”和“女”，在頁面上會顯示“男”和“女”，而在數據庫中可能是以 “0” 和 “1” 進行存儲的，所以一般在選擇“男”或“女”后頁面提交的也是 “0” 或 “1”，以這種方式進行日志記錄顯然不直觀，因此在這種情況下就需要將字段的中文和字典名也進行關聯，這樣就可以將字段中文匹配到字典的值的描述。

具體代碼如下：

public String catModifyInfo(List<Map<String, Object>> list) {
    Map<String, String> mapField = new HashMap<String, String>() {{ 
        // 類中的屬性，屬性對應的中文
        put("sex","性別");
    }};
    Map<String, String> mapDict = new HashMap<String, String>() {{ 
        // 屬性對應的中文，在JeeSite中字典的描述
        put("性別", "SEX");
    }}; 
    
    // 構造的修改字符串
    String modInfo = "";
    
    for ( Map<String, Object> mp : list) {
        System.out.println(mp.get("name") + "---" + mp.get("old") + "---" + mp.get("new"));
        System.out.println(mapField.get(mp.get("name")));
                    
        // 判斷修改的值是否為字典
        if ( mapDict.containsKey(mapField.get(mp.get("name"))) ) {
            String oldValue = mp.get("old").toString();
            String newValue = mp.get("new").toString();
            String type     = mapDict.get(mapField.get(mp.get("name")));
            String oldStr = DictUtils.getDictLabel(oldValue, type, "");
            String newStr = DictUtils.getDictLabel(newValue, type, "");
            System.out.println(mapField.get(mp.get("name")) + ":(" + oldStr + ") => (" + newStr + ");");
            modInfo += mapField.get(mp.get("name")) + ":(" + oldStr + ") => (" + newStr + ");"; 
        } else {
            modInfo += mapField.get(mp.get("name")) + ":(" + mp.get("old") + ") => (" + mp.get("new") + ");"; 
        }
    }
    
    return modInfo;
}

        函數傳入的參數是兩個對象差異的屬性，在循環進行解析並進行字符串拼接后，就可以獲得對應的日志了。

 

調用方法

        在 JeeSite 中提交數據后，無論是修改還是新建，都會調用相關 Controller 中的 save 方法，因此上面的方法需要在 save 方法中進行調用。

        相同的方法如何判斷當前是新建，還是修改呢？判斷的方法就是判斷傳入的對象中是否有 id，如果有 id 則說明是修改，如果沒有 id 則說明是新建。

        具體代碼如下：

/*
 * 如果id不為空，則表示為修改
 */
if ( StringUtils.isNotBlank(newXxx.getId()) ) {
    Xxx oldXxx = new Xxx();
    // 獲取原來的信息
    oldXxx = xxxService.get(newXxx.getId());
    
    // 比較修改后的信息和未修改的信息
    List<Map<String, Object>> modList = compareTwoClass(oldXxx, newXxx);
    // 生成差異信息
    String strModifyInfo = catModifyInfo(modList);
    // 輸出差異字符串
    System.out.println(strModifyInfo);
    
    // 把修改記錄保存到日志表中
    // ...
}

有了以上的方式就可以實現修改信息前后的日志記錄了，修改后的情況如下：

        不過該方式並不完美，如果修改了表字段的名稱或數量，那么代碼也要相應的修改，如果新添加的字段有對應的字典，那么也要添加字典對應的關聯，這樣就需要每次修改代碼，十分的不方便了。

        解決的方式很簡單，使用 JeeSite 中代碼生成的功能，就可以解決該問題。

 

---

 

我的微信公眾號：“碼農UP2U”