MyBatis-Plus中JacksonTypeHandler处理泛型字段的局限与解决方案

MyBatis-Plus作为MyBatis的增强工具，提供了许多便捷功能，其中TypeHandler机制是其重要特性之一。JacksonTypeHandler是MyBatis-Plus内置的一个类型处理器，用于处理Java对象与JSON字符串之间的转换。然而，在实际使用中，开发者可能会遇到JacksonTypeHandler无法正确处理泛型字段的问题。

问题背景

当我们在实体类中定义泛型字段时，例如List<User>，由于Java的类型擦除机制，运行时无法获取完整的泛型类型信息。JacksonTypeHandler默认使用getObjectMapper().readValue(json, type)方法进行反序列化，这种方法无法保留泛型参数的具体类型信息。

问题表现

假设我们有以下实体类：

@Data
@TableName("user_groups")
public class UserGroup {
    private Long id;
    
    @TableField(typeHandler = JacksonTypeHandler.class)
    private List<User> members;
}

当从数据库读取数据时，JacksonTypeHandler可能无法正确地将JSON字符串反序列化为List<User>类型，而是可能生成List<Map>或其他非预期的类型。

解决方案

方案一：自定义TypeHandler（推荐）

我们可以通过继承BaseTypeHandler来创建自定义的类型处理器，明确指定泛型类型：

public class UserListTypeHandler extends BaseTypeHandler<List<User>> {
    private static final TypeReference<List<User>> TYPE_REFERENCE = new TypeReference<List<User>>() {};
    private final ObjectMapper objectMapper = new ObjectMapper();

    @Override
    public void setNonNullParameter(PreparedStatement ps, int i, List<User> parameter, JdbcType jdbcType) throws SQLException {
        try {
            ps.setString(i, objectMapper.writeValueAsString(parameter));
        } catch (JsonProcessingException e) {
            throw new SQLException("Error converting List<User> to JSON", e);
        }
    }

    @Override
    public List<User> getNullableResult(ResultSet rs, String columnName) throws SQLException {
        return parseJson(rs.getString(columnName));
    }

    @Override
    public List<User> getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
        return parseJson(rs.getString(columnIndex));
    }

    @Override
    public List<User> getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
        return parseJson(cs.getString(columnIndex));
    }

    private List<User> parseJson(String json) {
        if (StringUtils.isEmpty(json)) {
            return Collections.emptyList();
        }
        try {
            return objectMapper.readValue(json, TYPE_REFERENCE);
        } catch (IOException e) {
            throw new RuntimeException("Error parsing JSON to List<User>", e);
        }
    }
}

然后在实体类中使用：

@TableField(typeHandler = UserListTypeHandler.class)
private List<User> members;

方案二：简单类型处理

对于简单的泛型类型如List<Long>，可以采用更直接的处理方式：

public class LongListTypeHandler extends BaseTypeHandler<List<Long>> {
    @Override
    public void setNonNullParameter(PreparedStatement ps, int i, List<Long> parameter, JdbcType jdbcType) throws SQLException {
        ps.setString(i, StringUtils.join(parameter, ","));
    }

    @Override
    public List<Long> getNullableResult(ResultSet rs, String columnName) throws SQLException {
        return parseString(rs.getString(columnName));
    }

    // 其他重写方法...

    private List<Long> parseString(String str) {
        if (StringUtils.isEmpty(str)) {
            return Collections.emptyList();
        }
        return Arrays.stream(str.split(","))
                   .map(Long::valueOf)
                   .collect(Collectors.toList());
    }
}

最佳实践建议

1. 明确类型信息：自定义TypeHandler时应尽可能明确指定泛型类型，使用TypeReference保留类型信息。

2. 错误处理：在JSON处理过程中添加适当的错误处理，避免因数据格式问题导致系统崩溃。

3. 性能考虑：对于高频访问的字段，可以考虑缓存ObjectMapper实例或解析结果。

4. 数据验证：在反序列化后添加数据验证逻辑，确保数据的完整性和正确性。

5. 文档记录：为自定义TypeHandler添加详细的文档说明，方便团队其他成员理解和使用。

通过以上解决方案，开发者可以有效地解决MyBatis-Plus中JacksonTypeHandler处理泛型字段的问题，确保数据在Java对象和数据库之间的正确转换。