架構師必看！操作日志系統搭建秘技
在Java開發中，我們經常會遇到一個棘手的問題：記錄用戶的操作行為。
某些操作是相對簡單的，我們可以逐條記錄。但是某些操作行為卻很難記錄，例如編輯操作。在某一次操作中，用戶可能編輯了對象A的幾個屬性，而下一次操作中用戶可能編輯了對象B的幾個屬性。如果我們針對對象A、對象B的屬性變化分別進行記錄，則整個操作十分復雜。而且，會與業務操作高度耦合。
而今天我們介紹的是一個叫ObjectLogger的系統，它是一個強大且易用的Java對象日志記錄系統，能夠分析任何對象的屬性變化，實現對象變化的記錄與查詢。
因此，它可以應用在用戶操作日志記錄、對象屬性變更記錄等諸多場景中。簡單易用，實為利器。
基于它，我們可以很方便地實現下面的效果。
該系統為github開源項目，地址為：https://github.com/yeecode/ObjectLogger
下面我們簡單介紹下該系統?；谒?，我們可以非常方便地搭建一套日志記錄系統。
1 系統特點
該系統具有以下特點：
- 一站整合：系統支持日志的記錄與查詢，開發者只需再開發前端界面即可使用。
- 完全獨立：與業務系統無耦合，可插拔使用，不影響主業務流程。
- 應用共享：系統可以同時供多個業務系統使用，互不影響。
- 簡單易用：服務端直接jar包啟動;業務系統有官方Maven插件支持。
- 自動解析：能自動解析對象的屬性變化，并支持富文本的前后對比。
- 便于擴展：支持自定義對象變動說明、屬性變動說明。支持更多對象屬性類型的擴展。
2 快速上手
2.1 創建數據庫
使用該項目的/server/database/init_data_table.sql文件初始化兩個數據表。
2.2 啟動Server
下載該項目下***的Server服務jar包，地址為/server/target/ObjectLogger-*.jar。
啟動下載的jar包。
java -jar ObjectLogger-*.jar --spring.datasource.driver-class-name={db_driver} --spring.datasource.url=jdbc:{db}://{db_address}/{db_name} --spring.datasource.username={db_username} --spring.datasource.password={db_password}
上述命令中的用戶配置項說明如下：
- db_driver:數據庫驅動。如果使用MySql數據庫則為com.mysql.jdbc.Driver;如果使用SqlServer數據庫則為com.microsoft.sqlserver.jdbc.SQLServerDriver。
- db:數據庫類型。如果使用MySql數據庫則為mysql;如果使用SqlServer數據庫則為sqlserver。
- db_address:數據庫連接地址。如果數據庫在本機則為127.0.0.1。
- db_name:數據庫名，該數據庫中需包含上一步初始化的兩個數據表。
- db_username:數據庫登錄用戶名。
- db_password:數據庫登錄密碼。
啟動jar包后，系統默認的服務地址為：
http://127.0.0.1:8080/ObjectLogger/
訪問上述地址可以看到下面的歡迎界面：
至此，ObjectLogger系統已經搭建結束，可以接受業務系統的日志寫入和查詢操作。
3 業務系統接入
該部分講解如何配置業務系統來將業務系統中的對象變化記錄到ObjectLogger中。
3.1 引入依賴包
在pom中增加下面的依賴：
- <dependency>
- <groupId>com.github.yeecode.objectLogger</groupId>
- <artifactId>ObjectLoggerClient</artifactId>
- <version>{***版本}</version>
- </dependency>
3.2 添加對ObjectLoggerClient中bean的自動注入
3.2.1 對于SpringBoot應用
在SpringBoot的啟動類前添加@ComponentScan注解，并在basePackages中增加ObjectLoggerClient的包地址：com.github.yeecode.objectLoggerClient，如：
- @SpringBootApplication
- @ComponentScan(basePackages={"{your_beans_root}","com.github.yeecode.objectLogger"})
- public class MyBootAppApplication {
- public static void main(String[] args) {
- // 省略其他代碼
- }
- }
3.2.2 對于Spring應用
在applicationContext.xml增加對ObjectLoggerClient包地址的掃描：
- <context:component-scan base-package="com.github.yeecode.objectLoggerClient">
- </context:component-scan>
3.3 完成配置
在application.properties中增加:
- object.logger.add.log.api=http://{ObjectLogger_address}/ObjectLogger/log/add
- object.logger.appName={your_app_name}
- object.logger.autoLog=true
- ObjectLogger_address:屬性指向上一步的ObjectLogger的部署地址，例如：127.0.0.1:8080
- your_app_name:指當前業務系統的應用名。以便于區分日志來源，實現同時支持多個業務系統
- object.logger.autoLog:是否對對象的所有屬性進行變更日志記錄
至此，業務系統的配置完成。已經實現了和ObjectLogger的Server端的對接。
4 日志查詢
系統運行后，可以通過/ObjectLogger/log/query查詢系統中記錄的日志，并通過傳入參數對日志進行過濾。
通過這里，我們可以查詢下一步中寫入的日志。
5 日志寫入
業務系統在任何需要進行日志記錄的類中引入LogClient。例如：
- @Autowired
- private LogClient logClient;
5.1 簡單使用
直接將對象的零個、一個、多個屬性變化放入actionItemModelList中發出即可。actionItemModelList置為null則表示此次對象無需要記錄的屬性變動。例如，業務應用中調用：
- logClient.sendLogForItems("TaskModel",5,"actor name","addTask","add Task","via web page","some comments",null);
在ObjectLogger中使用如下查詢條件：
- http://{your_ObjectLogger_address}/ObjectLogger/log/query?appName=myBootApp&objectName=TaskModel&objectId=5
查詢到日志：
- {
- "respMsg": "成功",
- "respData": [
- {
- "id": 16,
- "appName": "myBootApp",
- "objectName": "TaskModel",
- "objectId": 5,
- "actor": "actor name",
- "action": "addTask",
- "actionName": "add Task",
- "extraWords": "via web page",
- "comment": "some comments",
- "actionTime": "2019-04-10T10:56:15.000+0000",
- "actionItemModelList": []
- }
- ],
- "respCode": "1000"
- }
5.2 對象變動自動記錄
該功能可以自動完成新老對象的對比，并根據對比結果，將多個屬性變動一起寫入日志系統中。使用時，要確保傳入的新老對象屬于同一個類。
例如，業務系統這樣調用：
- TaskModel oldTaskModel = new TaskModel();
- oldTaskModel.setId(9);
- oldTaskModel.setTaskName("oldName");
- oldTaskModel.setUserId(3);
- oldTaskModel.setDescription(" <p>the first line</p>
- " +
- " <p>the second line</p>
- " +
- " <p>the 3th line</p>");
- TaskModel newTaskModel = new TaskModel();
- newTaskModel.setId(9);
- newTaskModel.setTaskName("newName");
- newTaskModel.setUserId(5);
- newTaskModel.setDescription(" <p>the first line</p>
- " +
- " <p>the second line</p>
- " +
- " <p>the last line</p>");
- logClient.sendLogForObject(9,"actor name","editTask","edit Task","via app",
- "some comments",oldTaskModel,newTaskModel);
則我們可以使用下面查詢條件：
- http://{your_ObjectLogger_address}/ObjectLogger/log/query?appName=myBootApp&objectName=TaskModel&objectId=9
查詢到如下結果：
- {
- "respMsg": "成功",
- "respData": [
- {
- "id": 15,
- "appName": "myBootApp",
- "objectName": "TaskModel",
- "objectId": 9,
- "actor": "actor name",
- "action": "editTask",
- "actionName": "edit Task",
- "extraWords": "via app",
- "comment": "some comments",
- "actionTime": "2019-04-10T10:56:17.000+0000",
- "actionItemModelList": [
- {
- "id": 18,
- "actionId": 15,
- "attributeType": "NORMAL",
- "attribute": "taskName",
- "attributeName": "TASK",
- "oldValue": "oldName",
- "newValue": "newName",
- "diffValue": null
- },
- {
- "id": 19,
- "actionId": 15,
- "attributeType": "USERID",
- "attribute": "userId",
- "attributeName": "USER",
- "oldValue": "USER:3",
- "newValue": "USER:5",
- "diffValue": "diffValue"
- },
- {
- "id": 20,
- "actionId": 15,
- "attributeType": "TEXT",
- "attribute": "description",
- "attributeName": "DESCRIPTION",
- "oldValue": ""\t<p>the first line</p>\n\t<p>the second line</p>\n\t<p>the 3th line</p>"",
- "newValue": ""\t<p>the first line</p>\n\t<p>the second line</p>\n\t<p>the last line</p>"",
- "diffValue": "第6行變化:<br/> -：<del> the 3th line </del> <br/> +：<u> the last line </u> <br/>"
- }
- ]
- }
- ],
- "respCode": "1000"
- }
6 對象屬性過濾
有些對象的屬性的變動不需要進行日志記錄，例如updateTime、hashCode等。ObjectLogger支持對對象的屬性進行過濾，只追蹤我們感興趣的屬性。
并且，對于每個屬性我們可以更改其記錄到ObjectLogger系統中的具體方式，例如修改命名等。
要想啟用這個功能，首先將配置中的object.logger.autoLog改為false。
- object.logger.autoLog=false
然后在需要進行變化日志記錄的屬性上增加@LogTag注解。凡是沒有增加該注解的屬性在日志記錄時會被自動跳過。
例如，注解配置如下則id字段的變動將被忽略。
- private Integer id;
- @LogTag(name = "TaskName")
- private String taskName;
- @LogTag(name = "UserId", extendedType = "userIdType")
- private int userId;
- @LogTag(name = "Description", builtinType = BuiltinTypeHandler.TEXT)
- private String description;
該注解屬性介紹如下：
- name:必填，對應寫入日志后的attributeName值。
- builtinType：ObjectLogger的內置類型，為BuiltinTypeHandler的值。默認為BuiltinTypeHandler.NORMAL。
- BuiltinTypeHandler.NORMAL：記錄屬性的新值和舊值，對比值為null
- BuiltinTypeHandler.TEXT: 用戶富文本對比。記錄屬性值的新值和舊值，并將新舊值轉化為純文本后逐行對比差異，對比值中記錄差異
- extendedType：擴展屬性類型。使用ObjcetLogger時，用戶可以擴展某些字段的處理方式。
7 屬性處理擴展
很多情況下，用戶希望能夠自主決定某些對象屬性的處理方式。例如，對于例子中Task對象的userId屬性，用戶可能想將其轉化為姓名后存入日志系統，從而使得日志系統與userId完全解耦。
ObjectLogger完全支持這種情況，可以讓用戶自主決定某些屬性的日志記錄方式。要想實現這種功能，首先在需要進行擴展處理的屬性上為@LogTag的extendedType屬性賦予一個字符串值。例如：
- @LogTag(name = "UserId", extendedType = "userIdType")
- private int userId;
然后在業務系統中聲明一個Bean繼承BaseExtendedTypeHandler，作為自由擴展的鉤子。代碼如下:
- @Service
- public class ExtendedTypeHandler implements BaseExtendedTypeHandler {
- @Override
- public BaseActionItemModel handleAttributeChange(String attributeName, String logTagName, Object oldValue, Object newValue) {
- return null;
- }
- }
接下來，當ObjectLogger處理到該屬性時，會將該屬性的相關信息傳入到擴展Bean的handleAttributeChange方法中，然后用戶可以自行處理。傳入的四個參數解釋如下：
- extendedType：擴展類型值，即@LogTag注解的extendedType值。本示例中為userIdType。
- attributeName：屬性名。本示例中為userId。
- logTagName：@LogTag注解的name值，可能為null。本示例中為UserId。
- oldValue：該屬性的舊值。
- newValue：該屬性的新值。
例如我們可以采用如下的方式處理userIdType屬性：
- public BaseActionItemModel handleAttributeChange(String extendedType, String attributeName, String logTagName, Object oldValue, Object newValue) {
- BaseActionItemModel baseActionItemModel = new BaseActionItemModel();
- if (extendedType.equals("userIdType")) {
- baseActionItemModel.setOldValue("USER_" + oldValue);
- baseActionItemModel.setNewValue("USER_" + newValue);
- baseActionItemModel.setDiffValue(oldValue + "->" + newValue);
- }
- return baseActionItemModel;
- }
8 總結
怎么樣，是不是ObjectLogger https://github.com/yeecode/ObjectLogger 的存在極大地方便了我們的日志記錄操作。
