MyBatis-Plus中PostgreSQL UUID类型主键的实践指南

背景介绍

在Java应用开发中，MyBatis-Plus作为MyBatis的增强工具，极大地简化了数据库操作。当使用PostgreSQL数据库时，UUID类型作为主键是一种常见的设计选择。然而，在实际开发中，开发者可能会遇到UUID类型主键与MyBatis-Plus自动填充机制不兼容的问题。

问题分析

当实体类的主键字段定义为UUID类型，并配置@TableId(type = IdType.ASSIGN_UUID)时，MyBatis-Plus内置的主键生成策略会生成字符串类型的UUID值。在尝试将这个字符串值赋给UUID类型的字段时，会出现类型转换异常。

解决方案

方案一：使用String类型作为主键字段

最简单的解决方案是将实体类的主键字段类型改为String：

@Getter
@Setter
public class Actor {
    @TableId(value = "id", type = IdType.ASSIGN_UUID)
    private String id;
    // 其他字段...
}

这种方式完全避免了类型转换问题，但牺牲了类型安全性。

方案二：自定义TypeHandler

对于坚持使用UUID类型的开发者，可以自定义TypeHandler来处理类型转换：

@MappedTypes({UUID.class})
public class UuidTypeHandler implements TypeHandler<UUID> {
    @Override
    public void setParameter(PreparedStatement ps, int i, UUID parameter, JdbcType jdbcType) 
        throws SQLException {
        if (parameter == null) {
            ps.setObject(i, null, Types.OTHER);
        } else {
            ps.setObject(i, parameter.toString(), Types.OTHER);
        }
    }

    @Override
    public UUID getResult(ResultSet rs, String columnName) throws SQLException {
        return toUUID(rs.getString(columnName));
    }

    // 其他必要方法实现...
    
    private static UUID toUUID(String val) {
        if (StringUtils.isNotBlank(val)) {
            try {
                return UUID.fromString(val);
            } catch (IllegalArgumentException e) {
                LOG.warn("Bad UUID found: {}", val);
            }
        }
        return null;
    }
}

方案三：JDBC连接参数配置

在PostgreSQL的JDBC连接URL中添加stringtype=unspecified参数：

spring.datasource.url=jdbc:postgresql://host:port/database?stringtype=unspecified

这个参数告诉JDBC驱动不要预设参数类型，让PostgreSQL服务器自行推断类型。

方案四：自定义ID生成器

实现IdentifierGenerator接口，直接生成UUID类型的主键：

@Component
public class CustomIdGenerator implements IdentifierGenerator {
    @Override
    public String nextUUID(Object entity) {
        return UUID.randomUUID().toString();
    }
    
    // 其他必要方法实现...
}

最佳实践建议

1. 简单场景：如果对类型安全要求不高，直接使用String类型作为主键字段是最简单的解决方案。

2. 类型安全场景：如果需要严格的类型安全，建议组合使用自定义TypeHandler和JDBC连接参数配置。

3. 代码生成：使用MyBatis-Plus代码生成器时，可以通过自定义类型转换器正确处理PostgreSQL的uuid类型：

.typeConvertHandler((globalConfig, typeRegistry, metaInfo) -> {
    if (metaInfo.getTypeName().equals("uuid")) {
        return new UUIDColumnType();
    }
    // 其他类型处理...
})

注意事项

1. MyBatis-Plus 3.5.8版本后，虽然不会抛出异常，但会打印警告日志，提醒开发者类型不匹配的问题。

2. 对于复杂的自定义需求，可以考虑重写实体类的setId方法，手动处理类型转换：

public void setId(Object id) {
    if (id instanceof UUID) {
        this.id = (UUID) id;
    } else {
        this.id = UUID.fromString(id.toString());
    }
}

3. 在使用JSON类型字段时，PostgreSQL的jsonb类型也需要特殊处理，可以通过类似的方式自定义类型处理器。

通过以上方案，开发者可以灵活地在MyBatis-Plus中使用PostgreSQL的UUID类型作为主键，同时保持代码的健壮性和可维护性。