快速开始 Mybatis TypeHandler

本文介绍了MyBatis框架中的TypeHandler组件,用于处理Java对象与数据库数据类型间的转换,包括不匹配类型转换、特殊处理如List转String和Object转JSON,以及如何在实体类中使用@TableField进行自动转换。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >


theme: orange

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

MyBatis TypeHandler 介绍

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

TypeHandler可以用于以下场景:

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

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

List转换为String

```java

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> {

@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

```java 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 {

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字符串之间的转换,可以根据需要进行修改。

使用

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

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

### 在 MyBatis 中注册 TypeHandler 的方法 在 MyBatis 中,`TypeHandler` 是用于处理 JDBC 类型和 Java 类型之间转换的关键组件。以下是几种常见的 `TypeHandler` 注册方式及其示例。 #### 1. **通过 XML 配置文件注册** 可以在 MyBatis 的全局配置文件中使用 `<typeHandlers>` 标签来注册 `TypeHandler`。这种方式适用于需要统一管理多个 `TypeHandler` 场景。 ```xml <configuration> <typeHandlers> <!-- 方式一:指定具体的 handler --> <typeHandler handler="org.mybatis.example.ExampleTypeHandler" javaType="java.lang.String" jdbcType="VARCHAR"/> <!-- 方式二:仅声明 handler,默认会自动匹配对应的 Java 和 JDBC 类型 --> <typeHandler handler="com.example.MyCustomTypeHandler"/> </typeHandlers> </configuration> ``` 上述代码展示了两种不同的注册形式[^1]。第一种显式指定了 `javaType` 和 `jdbcType` 参数;第二种则依赖框架根据 `TypeHandler` 的实现逻辑自行推断适用的类型。 --- #### 2. **通过注解方式注册** 如果希望减少 XML 文件中的冗余配置,可以利用注解的方式完成 `TypeHandler` 的注册。具体来说,在自定义的 `TypeHandler` 上添加 `@MappedTypes` 和 `@MappedJdbcTypes` 注解即可。 ```java import org.apache.ibatis.type.BaseTypeHandler; import org.apache.ibatis.type.JdbcType; import org.apache.ibatis.type.MappedJdbcTypes; import org.apache.ibatis.type.MappedTypes; import java.sql.CallableStatement; import java.sql.PreparedStatement; import java.sql.ResultSet; import java.sql.SQLException; @MappedTypes(String.class) // 映射到 Java 类型 @MappedJdbcTypes(JdbcType.VARCHAR) // 映射到 JDBC 类型 public class CustomStringTypeHandler extends BaseTypeHandler<String> { @Override public void setNonNullParameter(PreparedStatement ps, int i, String parameter, JdbcType jdbcType) throws SQLException { ps.setString(i, parameter); } @Override public String getNullableResult(ResultSet rs, String columnName) throws SQLException { return rs.getString(columnName); } @Override public String getNullableResult(ResultSet rs, int columnIndex) throws SQLException { return rs.getString(columnIndex); } @Override public String getNullableResult(CallableStatement cs, int columnIndex) throws SQLException { return cs.getString(columnIndex); } } ``` 当 MyBatis 扫描到此类时,它会自动识别并加载这个 `TypeHandler` 到系统中[^3]。 --- #### 3. **通过 Mapper 接口扫描包路径注册** 对于基于 Spring Boot 或其他容器化环境的应用程序,通常推荐使用更简洁的方式来注册所有的 `TypeHandler`。可以通过设置 `mybatis-config.xml` 或者 Spring Boot 属性文件中的参数,让 MyBatis 自动扫描特定包下的所有 `TypeHandler` 实现类。 ```properties # application.properties mybatis.type-handlers-package=com.example.typehandlers ``` 或者在 `mybatis-config.xml` 中: ```xml <configuration> <typeHandlers> <package name="com.example.typehandlers"/> </typeHandlers> </configuration> ``` 这样做的好处是可以完全避免手动逐个注册每一个 `TypeHandler`,从而提高开发效率[^2]。 --- ### 总结 以上三种方式分别适合不同规模和复杂度的项目需求。小型项目可以选择直接通过 XML 进行简单配置;而大型分布式系统可能更适合采用注解或包路径扫描的形式以降低维护成本。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值