记录系统操作日志以及脱敏插件，即引即用
在项目开发过程中，记录系统用户操作日志必不可少，不免存在每个项目都要去写一遍有关系统日志记录的方法。为了节省开发过程中这一块的时间，于是造出了log-tracing-spring-boot-starter 插件，用于记录系统日志，同时加入了脱敏注解，依赖jackson或者fastjson2实现对敏感数据进行脱敏处理。
SET NAMES utf8mb4;
SET FOREIGN_KEY_CHECKS = 0;
-- ----------------------------
-- Table structure for t_log
-- ----------------------------
DROP TABLE IF EXISTS `t_log`;
CREATE TABLE `t_log` (
`id` bigint(20) NOT NULL COMMENT '日志主键',
`operate_module` varchar(50) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT '' COMMENT '操作模块',
`business_type` int(2) NULL DEFAULT NULL COMMENT '业务类型,根据自己的业务自定义类型，例如:0=其它,1=新增,2=修改,3=删除......',
`request_url` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT '' COMMENT '请求url',
`method` varchar(10) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT '' COMMENT '方法名称',
`request_method` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT '' COMMENT '请求方式',
`request_param` varchar(2000) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT '' COMMENT '请求参数',
`operator_type` int(2) NULL DEFAULT NULL COMMENT '操作者类别',
`operate_user_id` bigint(20) NULL DEFAULT NULL COMMENT '操作者id',
`operate_user_name` varchar(50) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT '' COMMENT '操作者用户名',
`operate_dept_name` varchar(50) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT '' COMMENT '操作者部门名',
`operate_ip` varchar(128) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT '' COMMENT '操作者ip地址',
`operate_description` varchar(2000) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT '' COMMENT '操作描述',
`error_msg` varchar(2000) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT '' COMMENT '错误信息',
`json_result` varchar(2000) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT '' COMMENT '返回参数',
`operate_time` datetime NULL DEFAULT NULL COMMENT '操作时间',
`cost_time` bigint(20) NULL DEFAULT 0 COMMENT '消耗时间',
PRIMARY KEY (`id`) USING BTREE
) ENGINE = InnoDB CHARACTER SET = utf8mb4 COLLATE = utf8mb4_general_ci ROW_FORMAT = Dynamic;
-- ----------------------------
-- Records of t_log
-- ----------------------------
SET FOREIGN_KEY_CHECKS = 1;<!--引入依赖-->
<dependency>
<groupId>xyz.lijunyi</groupId>
<artifactId>log-tracing-spring-boot-starter</artifactId>
<version>1.0.3.RELEASE</version>
</dependency>log:
tracing:
json-parser-name: fastjson2
# 支持 fastjson2、jackson/**
* @version 1.0.0
* @className: LogInfoWriteServiceImpl
* @description: 此处一定要将IOperationLogService交给spring进行管理
* @author: LiJunYi
* @create: 2023/3/10 16:09
*/
@Service
@Slf4j
public class TestImpl implements IOperationLogService {
/**
* 获取系统用户信息
*
* @return {@link BaseUserEntity}
*/
@Override
public BaseUserEntity getSysUserInfo() {
return new BaseUserEntity(100, 200L, "测试", "研发部", "");
}
/**
* 记录操作日志
*
* @param baseLogEntity 基地日志实体
*/
@Override
@Async
public void recordOperateLog(BaseLogEntity baseLogEntity) {
log.info("线程：{}，获取到一条操作日志:{}",Thread.currentThread().getName(),baseLogEntity);
}
}/**
* @version 1.0.0
* @className: TestController
* @description:
* @author: LiJunYi
* @create: 2023/3/10 16:09
*/
@RestController
@RequestMapping("log")
public class TestController {
/**
* 查询用户接口参数测试
*
* @param userName 用户名
* @return {@link Person}
*/
@GetMapping("user")
@SysLog(operateModule = "用户模块",businessType = 1,operateDescription = "查询用户操作")
public Person queryUser(String userName,String password)
{
Person user = new Person();
user.setUserName(userName);
user.setPassword(password);
return user;
}
/**
* 保存用户接口Body参数测试
*
* @param user user
* @return {@link Person}
*/
@PostMapping("save")
@SysLog(operateModule = "用户模块",businessType = 2,operateDescription = "保存用户信息")
public Person saveUser(@RequestBody Person user)
{
return user;
}
}2023-04-03 09:29:26.021 INFO 2076 --- [ task-1] com.example.test.impl.TestImpl : 线程：task-1，获取到一条操作日志:BaseLogEntity{id=null, operateModule='用户模块', businessType=1, requestUrl='/log/user', method='com.example.test.controller.TestController.queryUser()', requestMethod='GET', requestParam='{"password":"123456","userName":"zhangsan"}', operatorType=100, operateUserId=200, operateUserName='测试', operateDeptName='研发部', operateIp='127.0.0.1', operateDescription='查询用户操作', errorMsg='', jsonResult='{"userName":"z*angsan","password":"******","email":null,"phone":null,"idCard":null,"bankCard":null,"address":null}', operateTime=Mon Apr 03 09:29:25 CST 2023, costTime=51}
2023-04-03 09:29:27.471 INFO 2076 --- [ task-2] com.example.test.impl.TestImpl : 线程：task-2，获取到一条操作日志:BaseLogEntity{id=null, operateModule='用户模块', businessType=2, requestUrl='/log/save', method='com.example.test.controller.TestController.saveUser()', requestMethod='POST', requestParam='{"userName":"王*虎","password":"********","email":"2****@qq.com","phone":null,"idCard":null,"bankCard":null,"address":null}', operatorType=100, operateUserId=200, operateUserName='测试', operateDeptName='研发部', operateIp='127.0.0.1', operateDescription='保存用户信息', errorMsg='', jsonResult='{"userName":"王*虎","password":"********","email":"2****@qq.com","phone":null,"idCard":null,"bankCard":null,"address":null}', operateTime=Mon Apr 03 09:29:27 CST 2023, costTime=0}
2023-04-03 09:31:24.406 INFO 3440 --- [ task-1] com.example.test.impl.TestImpl : 线程：task-1，获取到一条操作日志:BaseLogEntity{id=null, operateModule='用户模块', businessType=1, requestUrl='/log/user', method='com.example.test.controller.TestController.queryUser()', requestMethod='GET', requestParam='{"userName":"zhangsan"}', operatorType=100, operateUserId=200, operateUserName='测试', operateDeptName='研发部', operateIp='127.0.0.1', operateDescription='查询用户操作', errorMsg='', jsonResult='{"userName":"zhangsan"}', operateTime=Mon Apr 03 09:31:24 CST 2023, costTime=104}
2023-04-03 09:31:25.633 INFO 3440 --- [nio-8080-exec-2] c.l.l.service.impl.FastJson2Parser : use FastJson2Parser Serialize Java Object to JSON
2023-04-03 09:31:25.633 INFO 3440 --- [nio-8080-exec-2] c.l.l.service.impl.FastJson2Parser : use FastJson2Parser Serialize Java Object to JSON
2023-04-03 09:31:25.633 INFO 3440 --- [ task-2] com.example.test.impl.TestImpl : 线程：task-2，获取到一条操作日志:BaseLogEntity{id=null, operateModule='用户模块', businessType=2, requestUrl='/log/save', method='com.example.test.controller.TestController.saveUser()', requestMethod='POST', requestParam='{"email":"[email protected]","userName":"王小虎"}', operatorType=100, operateUserId=200, operateUserName='测试', operateDeptName='研发部', operateIp='127.0.0.1', operateDescription='保存用户信息', errorMsg='', jsonResult='{"email":"[email protected]","userName":"王小虎"}', operateTime=Mon Apr 03 09:31:25 CST 2023, costTime=1}
/**
* @version 1.0.0
* @className: Person
* @description: 用户类
* @author: LiJunYi
* @create: 2023/3/13 10:13
*/
@Data
public class Person {
/**
* 姓名脱敏
*/
@Sensitive(strategy = SensitiveStrategy.USERNAME)
private String userName;
/**
* 密码
*/
@Sensitive(strategy = SensitiveStrategy.PASSWORD)
private String password;
/**
* 电子邮件
*/
@Sensitive(strategy = SensitiveStrategy.EMAIL)
private String email;
/**
* 手机号脱敏
*/
@Sensitive(strategy = SensitiveStrategy.PHONE)
private String phone;
/**
* 身份证号码脱敏
*/
@Sensitive(strategy = SensitiveStrategy.ID_CARD)
private String idCard;
/**
* 银行卡
*/
@Sensitive(strategy = SensitiveStrategy.BANK_CARD)
private String bankCard;
/**
* 地址信息脱敏
*/
@Sensitive(strategy = SensitiveStrategy.ADDRESS)
private String address;
}{
"userName": "不*人",
"password": "************",
"email": "2****@163.com",
"phone": "187****1111",
"idCard": "2314****3623",
"bankCard": "622202****6744",
"address": "浙江省****市余****"
}