我们开发的业务系统通常会提供给很多人使用，那在使用的过程中，日志系统变得非常重要。
日志系统记录的用户行为有以下的作用：
例如，在git的project操作中，我们就可以看到这样的操作日志展示：
对于这样的日志记录，我们可以在相关记录点添加对应的日志写入代码或者通过切面实现。然而，这样的日志展示是相对简单的，只是记录了操作行为的种类。而有时我们需要记录每个操作行为对操作对象引发的具体变动，例如展示出这样的结果：
这给日志记录带来了不小的挑战：
而今天，我们要介绍的是一套强大且易用的JAVA对象日志记录系统，支持对象属性变动的记录与查询。借助于它，我们可以方便地实现对象属性变动的记录与查询。
ObjectLogger是一套强大且易用的对象日志记录系统。它能够将任意对象的变动日志记录下来，并支持查询。可以应用在用户操作日志记录、对象属性变更记录等诸多场景中。
该系统具有以下特点：
整个项目包含四个部分：
2.1 创建数据库
使用该项目的/server/database/init_data_table.sql文件初始化两个数据表。
2.2 启动Server
下载该项目下最新的Server服务jar包，地址为/server/target/ObjectLoggerServer-*.jar。
启动下载的jar包。
java -jar ObjectLoggerServer-*.jar --spring.datasource.url=jdbc:{db}://{db_address}/{db_name} --spring.datasource.username={db_username} --spring.datasource.password={db_password}
上述命令中的用户配置项说明如下：
启动jar成功后可以看到下面的界面：
使用浏览器访问下面的页面可以看到系统欢迎页面：
http://127.0.0.1:12301/ObjectLoggerServer/
访问上述地址可以看到下面的欢迎界面：
至此，ObjectLoggerServer系统已经搭建结束，可以接受业务系统的日志写入和查询操作。
该部分讲解如何配置业务系统来将业务系统中的对象变化通过ObjectLoggerClient分析，然后记录到ObjectLoggerServer中。
这一部分的使用可以参照ObjectLoggerDemo项目，该项目给出了业务系统集成ObjectLoggerClient的详细示例。ObjectLoggerDemo的制品包可以从/demo/target/ObjectLoggerDemo-*.jar获得，无需其他配置直接运行java -jar ObjectLoggerDemo-*.jar便可以直接启动该项目。
可以直接根据启动页面的提示访问相关地址来体验：
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.objectlogger，如：
@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.objectlogger"> </context:component-scan>
3.3 完成配置
在application.properties中增加:
yeecode.objectLogger.serverAddress=http://{ObjectLoggerServer_address}
yeecode.objectLogger.businessAppName={your_app_name}
yeecode.objectLogger.autoLogAttributes=true
至此，业务系统的配置完成。已经实现了和ObjectLoggerServer端的对接。
系统运行后，可以通过http://127.0.0.1:12301/ObjectLoggerServer/log/query查询系统中记录的日志，并通过传入参数对日志进行过滤。
通过这里，我们可以查询下一步中写入的日志。
ObjectLogger有前端React组件react-object-logger支持，用于进行日志信息的展示。体验页面：react-object-logger 示例页面
展示效果如图：
感兴趣的用户可以前往react-object-logger进行了解。
同时也欢迎各位开发者开发面向其它前端技术栈的组件。
业务系统在任何需要进行日志记录的类中引入LogClient。例如：
@Autowired private LogClient logClient;
6.1 简单使用
直接将对象的零个、一个、多个属性变化放入List<BaseAttributeModel>后调用logAttributes方法发出即可。List<BaseAttributeModel>置为null则表示此次对象无需要记录的属性变动。例如，业务应用中调用：
logClient.logAttributes( "CleanRoomTask", 5, "Tom", "add", "Add New Task", "Create a cleanRoomTask", "taskName is :Demo Task", null);
在ObjectLoggerServer中使用如下查询条件：
http://127.0.0.1:12301/ObjectLoggerServer/log/query?appName=ObjectLoggerDemo&objectName=CleanRoomTask&objectId=5
查询到日志：
{
"respMsg": "SUCCESS",
"respData": [
{
"id": 1,
"appName": "ObjectLoggerDemo",
"objectName": "CleanRoomTask",
"objectId": 5,
"operator": "Jone",
"operationName": "start",
"operationAlias": "Start a Task",
"extraWords": "Begin to clean room...",
"comment": "Come on and start cleaning up.",
"operationTime": "2019-07-04T06:53:40.000+0000",
"attributeModelList": [
{
"attributeType": "NORMAL",
"attributeName": "status",
"attributeAlias": "Status",
"oldValue": "TODO",
"newValue": "DOING",
"diffValue": null,
"id": 1,
"operationId": 1
}
]
}
],
"respCode": "1000"
}
6.2 对象变动自动记录
该功能可以自动完成新老对象的对比，并根据对比结果，将多个属性变动一起写入日志系统中。使用时，要确保传入的新老对象属于同一个类。
例如，业务系统这样调用：
CleanRoomTask oldTask = new CleanRoomTask();
oldTask.setId(5);
oldTask.setTaskName("Demo Task");
oldTask.setStatus("TODO");
oldTask.setDescription("Do something...");
CleanRoomTask newTask = new CleanRoomTask();
newTask.setId(5);
newTask.setTaskName("Demo Task");
newTask.setStatus("DOING");
newTask.setDescription("The main job is to clean the floor.");
newTask.setAddress("Sunny Street");
newTask.setRoomNumber(702);
logClient.logObject(
cleanRoomTask.getId().toString(),
"Tom",
"update",
"Update a Task",
null,
null,
oldTask,
newTask);
则我们可以使用下面查询条件：
http://127.0.0.1:12301/ObjectLoggerServer/log/query?appName=ObjectLoggerDemo&objectName=CleanRoomTask&objectId=5
查询到如下结果：
{
"respMsg": "SUCCESS",
"respData": [
{
"id": 4,
"appName": "ObjectLoggerDemo",
"objectName": "CleanRoomTask",
"objectId": 5,
"operator": "Tom",
"operationName": "update",
"operationAlias": "Update a Task",
"extraWords": null,
"comment": null,
"operationTime": "2019-07-04T07:22:59.000+0000",
"attributeModelList": [
{
"attributeType": "NORMAL",
"attributeName": "roomNumber",
"attributeAlias": "roomNumber",
"oldValue": "",
"newValue": "702",
"diffValue": null,
"id": 5,
"operationId": 4
},
{
"attributeType": "NORMAL",
"attributeName": "address",
"attributeAlias": "address",
"oldValue": "",
"newValue": "Sunny Street",
"diffValue": null,
"id": 6,
"operationId": 4
},
{
"attributeType": "NORMAL",
"attributeName": "status",
"attributeAlias": "Status",
"oldValue": "TODO",
"newValue": "DOING",
"diffValue": null,
"id": 7,
"operationId": 4
},
{
"attributeType": "TEXT",
"attributeName": "description",
"attributeAlias": "Description",
"oldValue": "Do something...",
"newValue": "The main job is to clean the floor.",
"diffValue": "Line 1<br/> -： <del> Do something... </del> <br/> +： <u> The main job is to clean the floor. </u> <br/>",
"id": 8,
"operationId": 4
}
]
}
],
"respCode": "1000"
}
有些对象的属性的变动不需要进行日志记录，例如updateTime、hashCode等。ObjectLoggerClient支持对对象的属性进行过滤，只追踪我们感兴趣的属性。
并且，对于每个属性我们可以更改其记录到ObjectLoggerClient系统中的具体方式，例如修改命名等。
要想启用这个功能，首先将配置中的yeecode.objectLogger.autoLogAttributes改为false。
yeecode.objectLogger.autoLogAttributes=true
然后在需要进行变化日志记录的属性上增加@LogTag注解。凡是没有增加该注解的属性在日志记录时会被自动跳过。
例如，注解配置如下则id字段的变动将被忽略。
private Integer id; @LogTag private String taskName; @LogTag(alias = "UserId", extendedType = "userIdType") private int userId; @LogTag(alias = "Status") private String status; @LogTag(alias = "Description", builtinType = BuiltinTypeHandler.TEXT) private String description;
该注解属性介绍如下：
很多情况下，用户希望能够自主决定某些对象属性的处理方式。例如，对于例子中Task对象的userId属性，用户可能想将其转化为姓名后存入日志系统，从而使得日志系统与userId完全解耦。
ObjectLoggerClient完全支持这种情况，可以让用户自主决定某些属性的日志记录方式。要想实现这种功能，首先在需要进行扩展处理的属性上为@LogTag的extendedType属性赋予一个字符串值。例如：
@LogTag(alias = "UserId", extendedType = "userIdType") private int userId;
然后在业务系统中声明一个Bean继承BaseExtendedTypeHandler，作为自由扩展的钩子。代码如下:
@Service
public class ExtendedTypeHandler implements BaseExtendedTypeHandler {
@Override
public BaseAttributeModel handleAttributeChange(String extendedType, String attributeName, String attributeAlias, Object oldValue, Object newValue) {
// TODO
}
}
接下来，当ObjectLoggerClient处理到该属性时，会将该属性的相关信息传入到扩展Bean的handleAttributeChange方法中，然后用户可以自行处理。传入的四个参数解释如下：
例如我们可以采用如下的方式处理userIdType属性：
@Service
public class ExtendedTypeHandler implements BaseExtendedTypeHandler {
@Override
public BaseAttributeModel handleAttributeChange(String extendedType, String attributeName, String attributeAlias, Object oldValue, Object newValue) {
BaseAttributeModel baseAttributeModel = new BaseAttributeModel();
if (extendedType.equals("userIdType")) {
baseAttributeModel.setOldValue("USER_" + oldValue);
baseAttributeModel.setNewValue("USER_" + newValue);
baseAttributeModel.setDiffValue(oldValue + "->" + newValue);
}
return baseAttributeModel;
}
}
9 总结
怎么样，是不是有了这一套系统之后，再负责的日志系统都变得简单起来。快收藏起来当作自己的秘技吧！
分享架构师知识！ 欢迎关注我们，不错过每期的原创干货！
京公网安备 11010802035086号