实战项目中,很多业务表需要我们添加一些审计信息,这些审计信息包括创建人,创建时间,最后更新人,最后更新时间,在发现数据问题的时候,这些信息,在没有记录详细的日志情况下,可以帮助我们一定程度上的排除问题,查询源头。
1、添加属性
因为这些审计信息在很多业务表中都可能会用到,所以我们在BaseEntity中进行处理一次就行了。
添加完这些属性以后,我们就可以在新增数据的时候,将创建人,创建时间手动设置进去,一般新增时更新人,更新时间将和创建人,创建时间一致。编辑数据的时候,手动更新更新人,更新时间。如果觉得手动麻烦,我们可以在BaseService里面统一处理,这样,只要使用service新增,编辑数据的,都会自动设置,这是通常的做法,但是JPA已经考虑到了这种情况,给我们提供了一个更加便利的方式。
2、JPA Auditing
首先,我们添加注解
这4个注解什么意思就不用多说了,非常直观。
然后我们在实体上再添加EntityListeners注解
同时我们需要启用JPA的这个特性
最后我们实现一个AuditorAware接口,用来返回当前登录用户id即可,这个用户id将会用于创建人和更新人,至于创建时间,更新时间,并不需要我们处理,系统自己会使用系统时间填充。
我们来实现这个方法
3、测试
重启应用,我们可以发现,jpa给我们自动加上了这些字段
我们来测试添加文章
数据没有异常。以后我们这就不需要使用author字段了,去create_by对应的用户名即可了。至于发布时间还是需要的,因为我们文章创建以后不一定会马上发布,一般有个草稿的过程,发布以后其他用户才能看到,这里我们暂时没有做这一步。
这里有个小问题,我们的时间默认创建的是datetime(6),多保存了6位,一般并不会影响我们使用,因为我们我们转JSON的时候,设置了date format,如果我们不需要这6位怎么办,我们需要修改Mysql方言
这样,默认生成的时间格式就是datetime(0)。
4、总结
这节介绍了一种比较优雅的添加审计信息的方法,使用这种方法,只要使用jpa进行数据操作,这些信息都会自动录入进去,代码侵入最少,而且不会出现漏掉的问题。
代码:
https://github.com/www15119258/springboot-study/tree/branch30