mybatis自定义类型控制器（TypeHandler）处理将字符串处理为集合

1. 问题：

假设这么一个场景

localurl里面的值大概这样：dwad21.jpg,dwad22.jpg,dwad.23.jpg 是一个字符串

如果我在sql表中有一个字段（local_url）是本地图片资源的多个url字符串拼接值。我想在java后端中不进行额外的转换就取值加值。我需要的是里面的dwad21.jpg，最好做集合处理。

🌴 最好的情况就是使用sql映射到对象的时候就把把字符串变成集合dwad21.jpg,dwad22.jpg,dwad.23.jpg => {dwad21.jpg,dwad22.jpg,dwad.23.jpg}

🌴 然后使用insert或者update的时候自动把集合变成字符串{dwad21.jpg,dwad22.jpg,dwad.23.jpg} =>dwad21.jpg,dwad22.jpg,dwad.23.jpg

2. 解决思路：

2.1.typehandler官网介绍

主要是对请求数据或者接受数据进行自定义映射处理。

我只能说mybaits非常任性了提供了自定义类型转换器。

mybatis官网=>配置=>类型处理器
《------------------------------------------------------------------》
功能：MyBatis 在设置预处理语句（PreparedStatement）中的参数或从结果集中取出一个值时， 都会用类型处理器将获取到的值以合适的方式转换成 Java 类型。

下面是常用的数据类型的默认使用的类型处理器。

2.2. 创建自定义handler

你可以重写已有的类型处理器或创建你自己的类型处理器来处理不支持的或非标准的类型。 具体做法为：

1. 实现 org.apache.ibatis.type.TypeHandler 接口，
2. 继承一个很便利的类 org.apache.ibatis.type.BaseTypeHandler， 并且可以（可选地）将它映射到一个 JDBC 类型。比如：

在大部分使用场景中mybaitis的默认类型转换器就可以帮助大家的java对象到jdbc对象的转换。

但是我的整的花活显然不是满足。正好mybatis允许我们自定义类转换器。

我们这里使用实现接口的方法进行类型控制器的声明

public class StringToListTypeHandler implements TypeHandler<List<String>> {

    @Override
    public void setParameter(PreparedStatement ps, int i, List<String> parameter, JdbcType jdbcType) throws SQLException {
        if (parameter != null) {
            ps.setString(i, String.join(",", parameter));
        } else {
            ps.setNull(i, jdbcType.TYPE_CODE);
        }
    }

    @Override
    public List<String> getResult(ResultSet rs, String columnName) throws SQLException {
        String columnValue = rs.getString(columnName);
        return convertStringToList(columnValue);
    }

    @Override
    public List<String> getResult(ResultSet rs, int columnIndex) throws SQLException {
        String columnValue = rs.getString(columnIndex);
        return convertStringToList(columnValue);
    }

    @Override
    public List<String> getResult(CallableStatement cs, int columnIndex) throws SQLException {
        String columnValue = cs.getString(columnIndex);
        return convertStringToList(columnValue);
    }

    private List<String> convertStringToList(String columnValue) {
        if (columnValue != null) {
            return Arrays.asList(columnValue.split(","));
        } else {
            return null;
        }
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

• setParameter 方法：这个方法用于将 Java 对象的参数设置到 PreparedStatement 中，通常用于将参数绑定到 SQL 语句中的占位符。在这个示例中，它将 List 类型的参数转换为逗号分隔的字符串，并设置到 PreparedStatement 中。如果参数为 null，它将设置为数据库类型的 null 值。

• getResult(ResultSet rs, String columnName)：从 ResultSet 对象中获取结果，根据列名 columnName 获取对应的列的值。

• getResult(ResultSet rs, int columnIndex)：从 ResultSet 对象中获取结果，根据列索引 columnIndex 获取对应的列的值。

• getResult(CallableStatement cs, int columnIndex)：从 CallableStatement 对象中获取结果，根据列索引 columnIndex 获取对应的列的值。通常，这种情况用于从存储过程中获取结果。
  🌴一般只实现一个方法即可

2.3. 注册类型转换器

要注意 MyBatis 不会通过检测数据库元信息来决定使用哪种类型，所以你必须在参数和结果映射中指明字段是 VARCHAR 类型

<typeHandlers>
    <typeHandler handler="com.chen.behindimagesmanage.handler.StringToListTypeHandler" javaType="java.util.List" jdbcType="VARCHAR"/>
</typeHandlers>
1
2
3

当然这里也可以配置别名，如果这里设置了类型在mapper里就可以不用设置了。

2.4. mapper使用类型转换器

1. mapper xml文件

DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">

<mapper namespace="com.chen.behindimagesmanage.dao.FileDao">

    
    <resultMap id="imageMetaDataResultMap" type="com.chen.behindimagesmanage.pojo.ImageMetaData">
        <id property="id" column="id" />
        <result property="md5" column="md5" />
        <result property="aliyunUrl" column="aliyun_url" />
        <result property="localUrl" column="local_url" typeHandler="com.chen.behindimagesmanage.handler.StringToListTypeHandler" />
        <result property="version" column="version" />
    resultMap>
    <select id="getAllImg" resultMap="com.chen.behindimagesmanage.pojo.ImageMetaData">
        SELECT * FROM image_metadata
    select>



    
    <parameterMap id="imageMetaDataParamMap" type="com.chen.behindimagesmanage.pojo.ImageMetaData">
        <parameter property="id" jdbcType="INTEGER" javaType="java.lang.Integer" mode="IN"/>
        <parameter property="md5" jdbcType="VARCHAR" javaType="java.lang.String" mode="IN"/>
        <parameter property="aliyunUrl" jdbcType="VARCHAR" javaType="java.lang.String" mode="IN"/>
        <parameter property="localUrl" typeHandler="com.chen.behindimagesmanage.handler.StringToListTypeHandler"/>
        <parameter property="version" jdbcType="INTEGER" javaType="int" mode="IN"/>
    parameterMap>
    <update id="updateLocalUrl"
    >
        UPDATE image_metadata SET  local_url= #{localUrl,typeHandler = com.chen.behindimagesmanage.handler.StringToListTypeHandler}, version = #{localUrl} + 1 WHERE version = #{vsersion}
    update>

mapper>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

2. mapper接口层

@Mapper
public interface FileDao {
    /**
     * 获取所有img归属信息
     * @return 所有归属信息
     */
    List<ImageMetaData> getAllImg();

    /**
     * 更新元数据归属服务器
     * @param imageMetaData 更新的元数据列
     * @return 影响行
     */
    int updateLocalUrl(ImageMetaData imageMetaData);
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16