快速开始 Mybatis TypeHandler

站长

2023年09月07日 01:35 · 阅读数 9

MyBatis TypeHandler是MyBatis框架中的举足轻重的组件之一，用于处理Java对象和数据库中的数据类型之间的转换。

MyBatis TypeHandler 介绍

MyBatis TypeHandler是MyBatis框架中的一个重要组件，用于处理Java对象和数据库中的数据类型之间的转换。在MyBatis中，每个Java类型都需要对应一个TypeHandler，用于将Java类型转换为JDBC类型，或将JDBC类型转换为Java类型。

TypeHandler可以用于以下场景：

数据库中的数据类型与Java类型不匹配，需要进行类型转换。
数据库中的数据类型与Java类型匹配，但需要进行特殊处理，例如将List转换为String，或将Object转换为JSON字符串。
数据库中的数据类型与Java类型匹配，但需要进行自定义转换，例如将Java的枚举类型转换为数据库中的字符串类型。使用TypeHandler可以简化代码，提高开发效率，同时也可以避免一些常见的错误，例如空指针异常、类型转换异常等。

在MyBatis中，可以通过实现TypeHandler接口来自定义TypeHandler，也可以使用MyBatis提供的一些默认的TypeHandler，例如StringTypeHandler、IntegerTypeHandler等。

List转换为String


import org.apache.ibatis.type.JdbcType;
import org.apache.ibatis.type.TypeHandler;
import java.sql.CallableStatement;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.Collections;
import java.util.List;
import java.util.stream.Collectors;

@MappedJdbcTypes(JdbcType.VARCHAR)
@MappedTypes(List.class)
@Slf4j
public class ListToStringTypeHandler implements TypeHandler<List<String>> {

    @Override
    public void setParameter(PreparedStatement ps, int i, List<String> parameter, JdbcType jdbcType) throws SQLException {
        if (parameter == null || parameter.isEmpty()) {
            ps.setString(i, "");
        } else {
            String value = parameter.stream().collect(Collectors.joining(","));
            ps.setString(i, value);
        }
    }

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

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

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

    private List<String> convertToList(String value) {
        if (value == null || value.isEmpty()) {
            return Collections.emptyList();
        } else {
            return List.of(value.split(","));
        }
    }
}

代码中，实现了TypeHandler接口，并重写了setParameter、getResult等方法。其中，setParameter方法将List转换为String类型，并设置到PreparedStatement中；getResult方法从ResultSet或CallableStatement中获取String类型的值，并将其转换为List类型。

需要注意的是，如果List为空或为null，需要将其转换为空字符串或空List，避免出现空指针异常或其他问题。在本示例代码中，使用了Java 8中的Stream API和Collections类来实现List和String之间的转换，可以根据需要进行修改。

另外，还需要加入注解@MappedJdbcTypes(JdbcType.VARCHAR) @MappedTypes(List.class)，这样，在MyBatis执行SQL语句时，就会自动调用TypeHandler来处理List和String之间的转换。

Object 转换成 Json

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.ibatis.type.JdbcType;
import org.apache.ibatis.type.TypeHandler;
import java.io.IOException;
import java.sql.CallableStatement;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;

public class ObjectToJsonTypeHandler implements TypeHandler<Object> {

    private static final ObjectMapper objectMapper = new ObjectMapper();

    @Override
    public void setParameter(PreparedStatement ps, int i, Object parameter, JdbcType jdbcType) throws SQLException {
        if (parameter == null) {
            ps.setString(i, null);
        } else {
            try {
                String value = objectMapper.writeValueAsString(parameter);
                ps.setString(i, value);
            } catch (JsonProcessingException e) {
                throw new SQLException("Failed to convert object to JSON", e);
            }
        }
    }

    @Override
    public Object getResult(ResultSet rs, String columnName) throws SQLException {
        String value = rs.getString(columnName);
        return convertToObject(value);
    }

    @Override
    public Object getResult(ResultSet rs, int columnIndex) throws SQLException {
        String value = rs.getString(columnIndex);
        return convertToObject(value);
    }

    @Override
    public Object getResult(CallableStatement cs, int columnIndex) throws SQLException {
        String value = cs.getString(columnIndex);
        return convertToObject(value);
    }

    private Object convertToObject(String value) throws SQLException {
        if (value == null) {
            return null;
        } else {
            try {
                return objectMapper.readValue(value, Object.class);
            } catch (IOException e) {
                throw new SQLException("Failed to convert JSON to object", e);
            }
        }
    }
}

代码中，实现了TypeHandler接口，并重写了setParameter、getResult等方法。其中，setParameter方法将Object转换为JSON字符串，并设置到PreparedStatement中；getResult方法从ResultSet或CallableStatement中获取JSON字符串，并将其转换为Object类型。

需要注意的是，如果Object为null，需要将其转换为null字符串，避免出现空指针异常或其他问题。在本示例代码中，使用了Jackson库来实现Object和JSON字符串之间的转换，可以根据需要进行修改。

使用

    @TableField(value = "keywords", typeHandler = ListStringTypeHandler.class)
    private List<String> keywords;

使用的方式就是在实体类中想要进行类型转换的字段加上注解@TableField,这是不管是设置值还是获取值的时候就会自动进行类型转换。