Mybatis之typeHandler

Mybatis 之typeHandler

问题

经常在项目上遇到一些Mysql的字段在基本定义类型以外的数据，比如geometry地理信息数据、列表、JSON数据等，这些数据都尝试通过一个字段存储，这时候可以用上mybatis中TypeHandler自定义数据映射。

BaseTypeHandler

BaseTypeHandler 类是 MyBatis 中用于处理数据库类型和 Java 类型之间转换的基本抽象类。它有一些方法，可以根据需要进行覆盖来实现自定义类型处理器。以下是 BaseTypeHandler 中的一些主要方法和它们的作用：

1. setParameter 方法：

   void setParameter(PreparedStatement ps, int i, T parameter, JdbcType jdbcType) throws SQLException

   该方法用于将 Java 对象（parameter）转换为数据库字段类型，并将转换后的值设置到 PreparedStatement 对象中的指定索引位置（i）。在这个方法中实现将 Java 对象转换为数据库字段的逻辑。jdbcType 参数指定了 JDBC 数据类型，可以根据需要进行处理。

2. getResult、getResult 方法：

   该方法用于从 ResultSet 中获取数据库字段值，并将其转换为 Java 对象。在这个方法中实现将数据库字段值转换为 Java 对象的逻辑。通常，你会根据列名（columnName）从 ResultSet 中获取字段的值。

3. getNullableResult、getNullableResult 方法：

   这个方法类似于 getResult 方法，但用于从 CallableStatement 中获取数据库字段值，并将其转换为 Java 对象。需要根据列名从 CallableStatement 中获取字段值。

4. setNonNullParameter 方法：

   这个方法是 setParameter 方法的辅助方法，用于设置非空参数到 PreparedStatement 对象中时执行类型转换。如果确定参数不会为 null，可以使用这个方法来处理非空参数的情况。

转化为List数据

数据库使用字符串存储

mysql数据格式是为"1,2,3"

java中解析实体对象类型为"List"

1.自定义StringTypeHandler

@MappedJdbcTypes(JdbcType.VARCHAR)
@MappedTypes({List.class})
public class StringTypeHandler extends BaseTypeHandler<List<String>> {

    private static final String DELIM = ",";

    @Override
    public void setNonNullParameter(PreparedStatement preparedStatement, int i, List<String> strings, JdbcType jdbcType) throws SQLException {
        String value = StringUtils.collectionToDelimitedString(strings, DELIM);
        preparedStatement.setString(i, value);
    }

    @Override
    public List<String> getNullableResult(ResultSet resultSet, String s) throws SQLException {
        String value = resultSet.getString(s);
        return Arrays.asList(StringUtils.tokenizeToStringArray(value, DELIM));
    }

    @Override
    public List<String> getNullableResult(ResultSet resultSet, int i) throws SQLException {
        String value = resultSet.getString(i);
        return Arrays.asList(StringUtils.tokenizeToStringArray(value, DELIM));
    }

    @Override
    public List<String> getNullableResult(CallableStatement callableStatement, int i) throws SQLException {
        String value = callableStatement.getString(i);
        return Arrays.asList(StringUtils.tokenizeToStringArray(value, DELIM));
    }
}

2.实体类

import com.baomidou.mybatisplus.annotation.*;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.apache.ibatis.type.JdbcType;

import java.io.Serializable;
import java.time.LocalDateTime;
import java.util.List;


@Data
@TableName(value = "process", autoResultMap = true)
@AllArgsConstructor
@NoArgsConstructor
@Builder
public class ProcessEntity implements Serializable {

    private static final long serialVersionUID = 1L;

    /**
     * 主键
     */
    private String id;

 
    /**
     * 角色列表Ids
     */
    @TableField(typeHandler = StringTypeHandler.class, jdbcType = JdbcType.VARCHAR)
    private List<String> roles;
 


}

3.在实体类xml文件中定义实体类

<mapper namespace="com.wn.wnn.mapper.ProcessMapper">
    
    <resultMap id="BaseResultMap" type="com.wn.wnn.entity.ProcessEntity">
        <id column="id" property="id"/>
        <result column="roles" property="roles"
                typeHandler="com.wn.wnn.mapper.ProcessMapper.type.StringTypeHandler" jdbcType="VARCHAR"/>
    resultMap>
    mapper>