避免踩坑！详解MyBatis-Plus的@TableField注解自动注入坑点

2023-12-08 19:28:11

揭秘 MyBatis-Plus @TableField 注解的自动注入奥秘

在 MyBatis-Plus 的 ORM 世界中，@TableField 注解扮演着至关重要的角色，它简化了实体类属性与数据库表字段之间的映射。但在这个看似便利的功能背后，却暗藏着几个你不可不知的坑点。让我们一起踏上探险之旅，深入剖析 @TableField 注解的自动注入机制，避开陷阱，掌握精髓。

自动注入的深坑

虽然 @TableField 注解提供了自动注入数据的便利，但它也隐藏着一些需要注意的陷阱：

坑点 1：类型不一致

当实体类属性类型与数据库表字段类型不一致时，MyBatis-Plus 会毫不客气地抛出异常。就好比你试图把方块塞进圆孔，结果可想而知。

解决办法： 确保实体类属性类型与数据库表字段类型保持一致，就像一对完美的搭档，一个眼神便知心意。

坑点 2：字段名不一致

当实体类属性名与数据库表字段名不一致时，MyBatis-Plus 就好像迷失了方向，找不到家门。数据注入自然也无从谈起。

解决办法： 让实体类属性名与数据库表字段名亲密无间，就像一对孪生兄弟，相互映照。

坑点 3：空值问题

如果实体类属性值为空，MyBatis-Plus 就会无动于衷，不会进行自动注入。就好像一个空空如也的容器，无法容纳任何东西。

解决办法： 确保实体类属性值不为空，就像填满一个容器，让它生机勃勃。

坑点 4：主键问题

实体类如果没有主键，MyBatis-Plus 就好像失去了指南针，找不到正确的数据归宿。自动注入自然也就无法进行。

解决办法： 为实体类配备一个主键，就像给迷路者指明方向，让他们找到回家的路。

源码探秘

为了更深入地理解 @TableField 注解的自动注入机制，我们不妨潜入 MyBatis-Plus 的源码中一探究竟。

在 org.mybatis.plus.mapper.MetaObjectHandler 类中，我们发现了 setFieldValByName 方法，它肩负着自动注入数据的重任。

代码示例：

@Override
public void setFieldValByName(String propertyName, Object propertyValue, EntityTable entityTable, FieldInfo fieldInfo) {
    if (propertyValue != null && propertyValue != NOSPECIFIED) {
        if (fieldInfo.getFieldType() == String.class && propertyValue instanceof BigDecimal) {
            // 修复BigDecimal类型返回String精度丢失问题
            propertyValue = ((BigDecimal) propertyValue).toPlainString();
        }
        if (isUtcTime(fieldInfo)) {
            // 字段类型是日期且属性值是字符串的情况下进行转换
            if (propertyValue instanceof String) {
                propertyValue = LocalDateTime.parse((String) propertyValue, datePattern);
            }
        } else if (needFormat(fieldInfo)) {
            if (propertyValue instanceof String) {
                propertyValue = formatValue((String) propertyValue, fieldInfo);
            }
        }

        setFieldVal(fieldInfo, propertyValue);
    }
}

从代码中可以看出，在自动注入数据之前，MyBatis-Plus 会进行一系列的检查，确保数据类型匹配、字段名一致、属性值不为空，以及主键的存在。只有通过这些检查，数据才能顺利注入。

结语

通过对 @TableField 注解自动注入机制的深入探讨，我们了解了它的强大功能和潜在的陷阱。在实际应用中，只要避开这些坑点，你就能尽情享受 @TableField 注解带来的便利，让数据注入变得轻而易举。

常见问题解答

问：如何避免类型不一致的坑点？
答：确保实体类属性类型与数据库表字段类型保持一致。
问：如何解决字段名不一致的坑点？
答：让实体类属性名与数据库表字段名亲密无间。
问：如何应对空值问题？
答：确保实体类属性值不为空。
问：为什么需要给实体类配备主键？
答：主键为自动注入数据提供了明确的归宿。
问：如何查看 @TableField 注解的源码？
答：在 org.mybatis.plus.mapper.MetaObjectHandler 类中找到 setFieldValByName 方法。