MyBatis自定义类型处理器 TypeHandler(通俗易懂,效率起飞),处理jsonb、数组、枚举类型。支持MybatisPlus

本文主要是介绍MyBatis自定义类型处理器 TypeHandler(通俗易懂,效率起飞),处理jsonb、数组、枚举类型。支持MybatisPlus,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

一 使用场景

在项目开发过程中,我们经常遇到这样的情况:Java 对象中的数据类型与数据库中的字段类型不一致。这时,我们需要在保存数据到数据库和从数据库检索数据时进行类型转换。例如:

  • 对于一些数据库特有的数据类型(如 PostgreSQL 的 jsonb 或数组类型),这些类型可能不被 MyBatis 默认支持,因此需要特殊处理。
  • 在 Java 实体(JavaBean)中,可能有一些字段是枚举(Enum)类型或特殊类型,而在数据库中,这些数据可能需要存储为字符串(String)或整数(Integer)。
  • 同样,你的 Java 实体可能有日期(Date)类型的字段,而在数据库中,相应的字段可能是以字符串(varchar)形式存储的日期。

这些类型不匹配的情况会导致大量的手动数据类型转换,这不仅麻烦,而且容易出错。为了解决这个问题,MyBatis 提供了一种功能强大的机制:TypeHandler 类型处理器。通过实现和使用类型处理器,我们可以自动化地进行数据类型转换,简化代码,提高开发效率。类型处理器使得 MyBatis 能够智能地处理那些它默认不支持的数据库字段类型,同时也方便了开发者在复杂数据类型和数据库类型之间进行无缝转换。

二 类型处理器 TypeHandler简介

在 MyBatis 中,TypeHandler(类型处理器)的主要作用是帮助我们在 Java 代码中使用的数据类型(JavaType)和数据库中的数据类型(JdbcType)之间进行转换。这就像是在 Java 世界和数据库世界之间搭建了一座桥梁。

  1. 当你需要把数据从 Java 发送到数据库时(比如,插入或更新数据),TypeHandler 确保 Java 类型的数据能够转换成数据库能够理解的格式。这个过程涉及到使用 PreparedStatement,它是一种预编译的 SQL 语句。TypeHandler 负责把 Java 类型的数据正确地放置到 SQL 语句的参数中。

  2. 当你从数据库获取数据时(比如,查询操作),TypeHandler 确保从数据库中获取的数据(通过 ResultSetCallableStatement)能够转换成 Java 程序中能够使用的格式。这样,你就可以在 Java 程序中方便地处理数据库返回的数据。

重要的一点是,MyBatis 已经内置了许多常见基本类型(如整数、字符串等)的类型处理器。这意味着对于这些基本数据类型,MyBatis 能够自动进行 Java 类型和数据库类型之间的转换,你无需做额外工作。

但是,如果你需要处理一些特殊的数据类型(这些类型可能不是基本类型,比如某种特定格式的字符串,或者是你自定义的复杂类型),MyBatis 就无法直接处理了。在这种情况下,你就需要自定义类型处理器。通过自定义类型处理器,你可以指定如何将这些特殊的 Java 类型数据转换为数据库可以理解的类型,反之亦然。

三 自定义 TypeHandler

TypeHandler<T> 接口在 MyBatis 中起着桥梁的作用,它连接了 Java 程序中的数据类型和数据库中的数据类型。这个接口确保了你在 Java 代码中使用的数据类型可以正确地转换成数据库能理解的格式,反之亦然。简单来说,它就像是一个翻译器,帮助 Java 代码和数据库之间进行数据交流。

public interface TypeHandler<T> {/*** 设置 PreparedStatement 的指定参数。* * @param ps        PreparedStatement 对象。* @param index     参数在 PreparedStatement 中的位置。* @param parameter 要设置的参数值。* @param jdbcType  JDBC 类型。这是一个可选参数,可以用来控制设置参数时的行为。* @throws SQLException 如果在设置参数时发生 SQL 异常。*/void setParameter(PreparedStatement ps, int index, T parameter, JdbcType jdbcType) throws SQLException;/*** 从 ResultSet 中获取数据并转换为 Java 类型。* * @param rs        ResultSet 对象。* @param columnName 要获取的数据的列名。* @return 转换后的 Java 类型数据。* @throws SQLException 如果在获取数据时发生 SQL 异常。*/T getResult(ResultSet rs, String columnName) throws SQLException;/*** 从 ResultSet 中获取数据并转换为 Java 类型。* * @param rs         ResultSet 对象。* @param columnIndex 要获取的数据的列索引。* @return 转换后的 Java 类型数据。* @throws SQLException 如果在获取数据时发生 SQL 异常。*/T getResult(ResultSet rs, int columnIndex) throws SQLException;/*** 从 CallableStatement 中获取数据并转换为 Java 类型。* * @param cs         CallableStatement 对象。* @param columnIndex 要获取的数据的列索引。* @return 转换后的 Java 类型数据。* @throws SQLException 如果在获取数据时发生 SQL 异常。*/T getResult(CallableStatement cs, int columnIndex) throws SQLException;
}

接口中的方法分别处理不同的数据转换场景:

  1. setParameter(PreparedStatement ps, int index, T parameter, JdbcType jdbcType)

    • 当你在 Java 代码中执行一个 SQL 语句并且需要向这个语句中传入参数时,这个方法就发挥作用了。
    • 它告诉 MyBatis 如何将 Java 类型的数据(parameter)转换成数据库能理解的格式,并把它放在 SQL 语句的正确位置(index)。
  2. getResult(ResultSet rs, String columnName)

    • 当你执行了一个 SQL 查询并从数据库得到结果集(ResultSet)时,这个方法帮助你把结果集中某一列的数据取出,并转换成 Java 类型的数据。
    • 你告诉它具体要转换哪一列(columnName),它就会处理这一列的数据。
  3. getResult(ResultSet rs, int columnIndex)

    • 这个方法和上一个方法类似,但它是通过列的索引(位置)而不是列的名称来获取数据的。
    • 它也是用来把结果集中的数据转换成 Java 类型的数据。
  4. getResult(CallableStatement cs, int columnIndex)

    • 这个方法用在存储过程的场景。存储过程是在数据库中执行的一系列操作,它可以返回多个结果。
    • 当你调用一个存储过程并想要处理返回的结果时,这个方法就会根据你指定的列索引来获取并转换这些结果。

总的来说,TypeHandler<T> 就像是一个双向翻译器,它确保 Java 程序和数据库在数据类型上的沟通是流畅和准确的。

四 创建自定义处理器

实际开发中,我们可以继承 org.apache.ibatis.type.BaseTypeHandler 类型来实现自定义类型处理器。

这个类型是抽象类型,实现了 TypeHandler 的方法进行通用流程的封装,做了异常处理,并定义了几个类似的抽象方法,如下所示。继承 BaseTypeHandler 类型可以极大地降低开发难度。

下面定义三种常用的自定义处理器:

自定义处理器1:数组类型

public class IntegerArrayTypeHandler extends BaseTypeHandler<Integer[]> {@Overridepublic void setNonNullParameter(PreparedStatement ps, int i, Integer[] parameter, JdbcType jdbcType) throws SQLException {// 将Java类型转换为数据库类型Array array = ps.getConnection().createArrayOf("integer", parameter);ps.setArray(i, array);}@Overridepublic Integer[] getNullableResult(ResultSet rs, String columnName) throws SQLException {// 从数据库类型转换为Java类型Array array = rs.getArray(columnName);return (Integer[]) array.getArray();}@Overridepublic Integer[] getNullableResult(ResultSet rs, int columnIndex) throws SQLException {Array array = rs.getArray(columnIndex);return (Integer[]) array.getArray();}@Overridepublic Integer[] getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {Array array = cs.getArray(columnIndex);return (Integer[]) array.getArray();}
}

自定义处理器2:jsonb类型

import org.apache.ibatis.type.JdbcType;
import org.apache.ibatis.type.TypeHandler;
import org.postgresql.util.PGobject;import java.sql.CallableStatement;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;public class JsonbTypeHandler implements TypeHandler<String> {@Overridepublic void setParameter(PreparedStatement ps, int i, String parameter, JdbcType jdbcType) throws SQLException {PGobject jsonObject = new PGobject();jsonObject.setType("jsonb");jsonObject.setValue(parameter);ps.setObject(i, jsonObject);}@Overridepublic String getResult(ResultSet rs, String columnName) throws SQLException {return rs.getString(columnName);}@Overridepublic String getResult(ResultSet rs, int columnIndex) throws SQLException {return rs.getString(columnIndex);}@Overridepublic String getResult(CallableStatement cs, int columnIndex) throws SQLException {return cs.getString(columnIndex);}
}

自定义处理器3:枚举类型

  1. 定义枚举类
    假设有一个枚举类 StatusEnum,它有两个值:ACTIVE 和 INACTIVE。
public enum StatusEnum {ACTIVE,INACTIVE;public static StatusEnum fromValue(String value) {for (StatusEnum status : values()) {if (status.name().equalsIgnoreCase(value)) {return status;}}throw new IllegalArgumentException("Unknown enum value: " + value);}
}
  1. 创建自定义类型处理器
    创建一个类型处理器来处理 StatusEnum:
    这个类型处理器将数据库中的字符串映射到 StatusEnum 枚举上。它假设数据库中存储的是枚举值的名称(例如,“ACTIVE” 或 “INACTIVE”)。
import org.apache.ibatis.type.BaseTypeHandler;
import org.apache.ibatis.type.JdbcType;import java.sql.CallableStatement;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;public class StatusEnumTypeHandler extends BaseTypeHandler<StatusEnum> {@Overridepublic void setNonNullParameter(PreparedStatement ps, int i, StatusEnum parameter, JdbcType jdbcType) throws SQLException {ps.setString(i, parameter.name());}@Overridepublic StatusEnum getNullableResult(ResultSet rs, String columnName) throws SQLException {String value = rs.getString(columnName);return value == null ? null : StatusEnum.fromValue(value);}@Overridepublic StatusEnum getNullableResult(ResultSet rs, int columnIndex) throws SQLException {String value = rs.getString(columnIndex);return value == null ? null : StatusEnum.fromValue(value);}@Overridepublic StatusEnum getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {String value = cs.getString(columnIndex);return value == null ? null : StatusEnum.fromValue(value);}
}

五 把TypeHandler配置到程序中有四种方法:

每一种都测试过,把踩过的坑用黑体标识了。

  1. 在Mapper.xml中声明(应用单个指定字段)
<resultMap id="BaseResultMap" type="com.xxx.EntiyDto"><result column="enum1" jdbcType="INTEGER" property="enum1" typeHandler="com.xxx.handler.IntegerArrayTypeHandler"/>
</resultMap>
  1. 在springboot的yml配置文件中设置类型处理器所在的包名,不是处理器路径(应用到全局
mybatis-plus:type-handlers-package: com.xxx.handler
  1. 实体类指定类型处理器。必须在实体类上加@TableName(autoResultMap = true),否则不生效
@Data
@Accessors(chain = true)
@TableName(autoResultMap = true)
public class User {private Long id;.../*** 注意!! 必须开启映射注解** @TableName(autoResultMap = true)** 以下两种类型处理器,二选一 也可以同时存在** 注意!!选择对应的 JSON 处理器也必须存在对应 JSON 解析依赖包*/@TableField(typeHandler = IntegerArrayTypeHandler.class)private Integer[] integerArray;
}
  1. 在mybatis配置文件中设置
	<typeHandlers><typeHandler handler="com.xxx.handler.IntegerArrayTypeHandler"/></typeHandlers>

这篇关于MyBatis自定义类型处理器 TypeHandler(通俗易懂,效率起飞),处理jsonb、数组、枚举类型。支持MybatisPlus的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/574337

相关文章

mybatis的整体架构

mybatis的整体架构分为三层: 1.基础支持层 该层包括:数据源模块、事务管理模块、缓存模块、Binding模块、反射模块、类型转换模块、日志模块、资源加载模块、解析器模块 2.核心处理层 该层包括:配置解析、参数映射、SQL解析、SQL执行、结果集映射、插件 3.接口层 该层包括:SqlSession 基础支持层 该层保护mybatis的基础模块,它们为核心处理层提供了良好的支撑。

无人叉车3d激光slam多房间建图定位异常处理方案-墙体画线地图切分方案

墙体画线地图切分方案 针对问题:墙体两侧特征混淆误匹配,导致建图和定位偏差,表现为过门跳变、外月台走歪等 ·解决思路:预期的根治方案IGICP需要较长时间完成上线,先使用切分地图的工程化方案,即墙体两侧切分为不同地图,在某一侧只使用该侧地图进行定位 方案思路 切分原理:切分地图基于关键帧位置,而非点云。 理论基础:光照是直线的,一帧点云必定只能照射到墙的一侧,无法同时照到两侧实践考虑:关

【前端学习】AntV G6-08 深入图形与图形分组、自定义节点、节点动画(下)

【课程链接】 AntV G6:深入图形与图形分组、自定义节点、节点动画(下)_哔哩哔哩_bilibili 本章十吾老师讲解了一个复杂的自定义节点中,应该怎样去计算和绘制图形,如何给一个图形制作不间断的动画,以及在鼠标事件之后产生动画。(有点难,需要好好理解) <!DOCTYPE html><html><head><meta charset="UTF-8"><title>06

hdu2241(二分+合并数组)

题意:判断是否存在a+b+c = x,a,b,c分别属于集合A,B,C 如果用暴力会超时,所以这里用到了数组合并,将b,c数组合并成d,d数组存的是b,c数组元素的和,然后对d数组进行二分就可以了 代码如下(附注释): #include<iostream>#include<algorithm>#include<cstring>#include<stack>#include<que

零基础学习Redis(10) -- zset类型命令使用

zset是有序集合,内部除了存储元素外,还会存储一个score,存储在zset中的元素会按照score的大小升序排列,不同元素的score可以重复,score相同的元素会按照元素的字典序排列。 1. zset常用命令 1.1 zadd  zadd key [NX | XX] [GT | LT]   [CH] [INCR] score member [score member ...]

hdu 1166 敌兵布阵(树状数组 or 线段树)

题意是求一个线段的和,在线段上可以进行加减的修改。 树状数组的模板题。 代码: #include <stdio.h>#include <string.h>const int maxn = 50000 + 1;int c[maxn];int n;int lowbit(int x){return x & -x;}void add(int x, int num){while

hdu 2489 (dfs枚举 + prim)

题意: 对于一棵顶点和边都有权值的树,使用下面的等式来计算Ratio 给定一个n 个顶点的完全图及它所有顶点和边的权值,找到一个该图含有m 个顶点的子图,并且让这个子图的Ratio 值在所有m 个顶点的树中最小。 解析: 因为数据量不大,先用dfs枚举搭配出m个子节点,算出点和,然后套个prim算出边和,每次比较大小即可。 dfs没有写好,A的老泪纵横。 错在把index在d

【生成模型系列(初级)】嵌入(Embedding)方程——自然语言处理的数学灵魂【通俗理解】

【通俗理解】嵌入(Embedding)方程——自然语言处理的数学灵魂 关键词提炼 #嵌入方程 #自然语言处理 #词向量 #机器学习 #神经网络 #向量空间模型 #Siri #Google翻译 #AlexNet 第一节:嵌入方程的类比与核心概念【尽可能通俗】 嵌入方程可以被看作是自然语言处理中的“翻译机”,它将文本中的单词或短语转换成计算机能够理解的数学形式,即向量。 正如翻译机将一种语言

【IPV6从入门到起飞】5-1 IPV6+Home Assistant(搭建基本环境)

【IPV6从入门到起飞】5-1 IPV6+Home Assistant #搭建基本环境 1 背景2 docker下载 hass3 创建容器4 浏览器访问 hass5 手机APP远程访问hass6 更多玩法 1 背景 既然电脑可以IPV6入站,手机流量可以访问IPV6网络的服务,为什么不在电脑搭建Home Assistant(hass),来控制你的设备呢?@智能家居 @万物互联

自定义类型:结构体(续)

目录 一. 结构体的内存对齐 1.1 为什么存在内存对齐? 1.2 修改默认对齐数 二. 结构体传参 三. 结构体实现位段 一. 结构体的内存对齐 在前面的文章里我们已经讲过一部分的内存对齐的知识,并举出了两个例子,我们再举出两个例子继续说明: struct S3{double a;int b;char c;};int mian(){printf("%zd\n",s