操作日志的使用

妖狐艹你老母 2022-11-20 08:15 148阅读 0赞

系统框架zw-edu-framework-base增加了日志明细记录的支持
    具体使用如下
    业务系统添加maven依赖,一般都添加了的

<dependency>
        <groupId>com.weiyan.zw</groupId>
        <artifactId>zw-edu-framework-base</artifactId>
    </dependency>

#  系统使用 #

任何需要进行日志记录的类中引入`LogClient`。例如：

@Autowired
    private LogClient logClient;

## 简单使用 ##

直接将对象的零个、一个、多个属性变化放入baseActionItemModelList中发出即可。baseActionItemModelList置为`null`则表示此次对象无需要记录的属性变动。例如，业务应用中调用：

List<BaseAttributeModel> baseActionItemModelList = new ArrayList<>();
            BaseAttributeModel baseActionItemModel = new BaseAttributeModel();
            baseActionItemModel.setAttributeType("NORMAL");
            baseActionItemModel.setAttributeName("status");
            baseActionItemModel.setAttributeAlias("部门");
            baseActionItemModel.setOldValue("办公室,语文组");
            baseActionItemModel.setNewValue("语文组");
            baseActionItemModel.setDiffValue(null);
            baseActionItemModelList.add(baseActionItemModel);
    		logClient.logAttributes(tenantId, String.valueOf(AppConstant.USERMANAGERNAIRE),
    						"教职工", teacher.getCode(),
    						teacher.getName(),
    						"update", "设置部门",
    						null, "设置部门为 "+selectOrg.getName(),
    						baseActionItemModelList);

## 对象变动自动记录 ##

该功能可以自动完成新老对象的对比，并根据对比结果，将多个属性变动一起写入日志系统中。使用时，要确保传入的新老对象属于同一个类。

例如，业务系统这样调用：

logClient.logObject(tenantId,
    					String.valueOf(AppConstant.USERMANAGERNAIRE),
    					"教职工",
    					old.getCode(),
    					sysUserTeacherDTO.getOperatiorName(),
    					"update", "更新教职工",
    					null, null,
    					oldSysUserTeacher, sysUserTeacher);

对象属性的自动对比需要`@logTag `注解的支持。对于对象中未加注解的属性会自动跳过对比。

例如，本次示例中的注解配置如下

public class SysUserTeacher implements Serializable {
    
        private String code;
    
        private String loginName;
    
        private String password;
    
        @LogTag
        private String name;
    
        @LogTag
        private String email;
    }