通用字段注入
我们的数据库表经常会有一些默认字段,比如 创建人,创建时间,更新人,更新时间。我们如果每次都在代码中手动设置这些通用的属性就很麻烦,所以,MybatisPlus 给我们提供了通用字段注入方法,解决了这个问题
1.1 加字段
我们添加四个字段:
注意: MySQL 中的DATE 和 DATETIME 数据类型在存储日期和时间信息时有一些区别。
DATE 数据类型用于存储日期,它只包含日期部分,不包括时间部分。例如,他可以存储像"2023-07-19"这样的日期。
DATETIME 数据类型用于存储日期和时间,他包含日期和时间2部分。例如,他可以存储像"2023-07-19 15:30:00"这样的日期和时间。DATETIME可以表示从1000年1月1日到9999年12月31日之间的任何日期和时间
因此,DATE和DATETIME的主要区别在于是否包含时间信息。如果只需要存储日期,可以使用DATE;如果需要在日期上存储时间信息,则应使用DATETIME。
1.2 设置公共Entity
对于这些通用字段,在java 中我们可以设置一个公共基类
@Data
public class BaseEntity {
@TableField
private Date createDate;
@TableField
private Date updateDate;
@TableField
private String createUser;
@TableField
private String updateUser;
}
然后 Device 类去继承他
public class Device extends BaseEntity {
}
这样做的好处就是不用每次都写重复的字段了
1.4 设置插入和更新规则
这些公共字段都是希望默认更迭的,所以要配置更新和插入规则
@Data
public class BaseEntity {
@TableField(value = "create_date", fill = FieldFill.INSERT)
private Date createDate;
@TableField(value = "update_date", fill = FieldFill.UPDATE)
private Date updateDate;
@TableField(value = "create_user", fill = FieldFill.INSERT)
private String createUser;
@TableField(value = "update_user", fill = FieldFill.UPDATE)
private String updateUser;
}
@TableField 注解有一个fill 属性,我们通过INSERT 和 UPDATE来配置更新或者插入的时机。
1.5 MpMetaObjectHandler
添加一个处理器,用于声明默认插入的值
@Component
public class MpMetaObjectHandler implements MetaObjectHandler {
/**
* 插入时的填充策略
* @param metaObject
*/
@Override
public void insertFill(MetaObject metaObject) {
this.setFieldValByName("createDate", new Date(), metaObject);
this.setFieldValByName("createUser", "admin", metaObject);
}
/**
* 更新时的填充策略
* @param metaObject
*/
@Override
public void updateFill(MetaObject metaObject) {
this.setFieldValByName("updateDate", new Date(), metaObject);
this.setFieldValByName("updateUser", "admin", metaObject);
}
}
这是一个java类,名为MpMetaObjectHandler ,它实现了 MetaObjectHandler 接口。从代码中可以看出,这个类主要定义了插入和更新时的填充策略
具体来说,当对象被插入或更新时,,这个类中的insertFill和updateFill方法会被调用。这两个方法分别用于设置创建时间(createTime)、创建用户(createUser)、更新时间(updateTime)和更新用户(updateUser)这四个字段的值。
1.6 测试
编写一个测试类
@SpringBootTest
class DeviceTests {
@Resource
private DeviceService deviceService;
@Test
void testInsert() {
Device device = new Device();
device.setDeviceId(IdUtil.simpleUUID());
device.setDeviceName("测试设备");
device.setDeviceIdentification("设备标识码1");
device.setStatus(0);
deviceService.save(device);
}
}
运行:
创建日期和创建人成功注入了
再来测试一下更新,刚才的id是21,就更新一下21。
@Test
void testUpdate() {
Device device = deviceService.getById(21);
deviceService.updateById(device);
}
没问题
1.7 关于UTC时区的大坑
注意,关于时间这里有个坑。其实我在写这篇文章的时候,时间是2023-09-06 14点,而创建时间和更新时间都不对。不信你可以?看上面的图。
因为在之前的配置里面,我们设置了jdbc的连接时区为:serverTimezone=UTC,UTC(世界标准时间),而北京时间比UTC时间早8小时,即UTC+08:00,所以我们java里面 new Date() 出来的时间和存进MySQL的时间会出现不一致的情况。
MySQL所在服务器的时间是
select @@global.time_zone,@@session.time_zone;
意思就是跟随系统,如果MySQL服务器的时区和Java服务器设置的JDBC连接时区不一致,就会出现这个大坑。
网上很多都是教你写的serverTimezone=UTC,一不小心就会陷入这个坑。
那么,怎么解决呢?
如果你做的项目数据库不在国外的话,我们只需要不配置时区,或者配置上海时区就行了。
datasource:
url: jdbc:mysql://localhost:3306/demo?useUnicode=true&characterEncoding=utf8
因为不配置时区就默认跟随系统了,倒也没问题。如果要配置时区,就写上海吧。
&serverTimezone=Asia/Shanghai
1.8 date,datetime类型对应的Java类型
在MySQL中,date类型的字段是没有时分秒的,而datetime类型有时分秒。
我们在java中都用java.util.Date即可。
java.util.Date 对象可以插入到 MySQL 中的 datetime 类型字段中。在 JDBC 中,MySQL 的驱动程序会自动将 java.util.Date 对象转换为 MySQL 的日期和时间格式。
这个转换,其实就是把Date类型,不管你是java.util.Date还是java.sql.Date,甚至是TimeStamp类型,都会转成具体的TimeStamp。
原因是mybatis内部的DateTypeHandler帮你做了处理。
public class DateTypeHandler extends BaseTypeHandler<Date> {
public DateTypeHandler() {
}
public void setNonNullParameter(PreparedStatement ps, int i, Date parameter, JdbcType jdbcType) throws SQLException {
ps.setTimestamp(i, new Timestamp(parameter.getTime()));
}
}
,Device类因为继承了父类BaseEntity,而我们用了lombok后,@Data并不能保证toString方法也继承父类。
所以,咱还得加上@ToString(callSuper = true)
@Data
@ToString(callSuper = true)
@TableName("device_info")
public class Device extends BaseEntity {
}
ok,接下来我们改造一下list方法。
@GetMapping("/list")
public List<Device> list(){
List<Device> list = deviceService.list();
System.out.println(list);
return deviceService.list();
}
访问:http://localhost:8080/v1/device/list
[Device(super=BaseEntity(createDate=Wed Sep 06 00:00:00 CST 2023, updateDate=Wed Sep 06 16:23:31 CST 2023, createUser=admin, updateUser=admin), id=21, deviceName=测试设备, deviceIdentification=设备标识码1, deviceId=77060c476f144ef39a38a335fddaf7c3, status=0)]
[Device(super=BaseEntity(createDate=Wed Sep 06 00:00:00 CST 2023, updateDate=Wed Sep 06 16:23:31 CST 2023, createUser=admin, updateUser=admin), id=21, deviceName=测试设备, deviceIdentification=设备标识码1, deviceId=77060c476f144ef39a38a335fddaf7c3, status=0)]
这是打印出来的时间:updateDate=Wed Sep 06 16:23:31 CST 2023 没问题,和数据库是一致的。
然而,返回到前台就变成了:
[{"createDate":"2023-09-05T16:00:00.000+00:00","updateDate":"2023-09-06T08:23:31.000+00:00","createUser":"admin","updateUser":"admin","id":21,"deviceName":"测试设备","deviceIdentification":"设备标识码1","deviceId":"77060c476f144ef39a38a335fddaf7c3","status":0}]
第一次看到这个结果,我是震惊的。
为什么我在controller打印出来的时间都是对的,可返回到前台就慢了8小时呢?
揭秘:springboot中对加了@RestController或者@Controller+@ResponseBody注解的方法的返回值默认是Json格式,对date类型的数据,在返回浏览器端时,会被springboot默认的Jackson框架转换,而Jackson框架默认的时区GMT(相对于中国是少了8小时)。所以最终返回到前端结果是相差8小时。
知道了原因,怎么解决呢?
一种最简单的方法就是,把Date类型转换位String类型,再返回。
可以是可以,但是总觉得不太好。
另一种办法,也是我比较推荐的,设置json的日期转换格式。
@TableField(value = "create_date", fill = FieldFill.INSERT)
@JsonFormat(pattern = "yyyy-MM-dd",timezone="GMT+8")
private Date createDate;
@TableField(value = "update_date", fill = FieldFill.UPDATE)
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss",timezone="GMT+8")
private Date updateDate;
这样就可以了,这个问题本质是因为json默认时区比北京时间慢了8小时所致,所以加上这8小时即可。