Mybatis 结合枚举类型

蔚落 2022-04-04 05:54 267阅读 0赞

### 文章目录 ###

*   *   *   *   *  前言
                 *  typeHandler 类型处理器
                 *  枚举类型默认的 typeHandler
                 *  Mybatis 结合枚举最简单的方式
                 *   *  定义枚举类
                     *  准备一个表
                     *  最简单的方式
                 *  使用 Mybatis 的 EnumOrdinalTypeHandler
                 *   *  类的路径
                     *  使用 EnumOrdinalTypeHandler 存储的是索引
                     *  如果使用 Mybatis 代码自动生成工具
                     *  如果修改已有的 xml
                     *  看数据库结果
                 *  参考内容

##### 前言 #####

> 在使用 Mybitas 的时候我们一般很少关注数据库类型和 Java 类型转化这件事，其实 Mybatis 已经为我们做了这件工作，本文就枚举类型的使用进行一个小小的举例

##### typeHandler 类型处理器 #####

> 无论是 MyBatis 在预处理语句（PreparedStatement）中设置一个参数时，还是从结果集中取出一个值时， 都会用类型处理器将获取的值以合适的方式转换成 Java 类型。下表描述了一些默认的类型处理器。

<table> 
 <thead> 
  <tr> 
   <th>类型处理器</th> 
   <th>Java 类型</th> 
   <th>JDBC 类型</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>BooleanTypeHandler</td> 
   <td>java.lang.Boolean, boolean</td> 
   <td>数据库兼容的 BOOLEAN</td> 
  </tr> 
  <tr> 
   <td>ByteTypeHandler</td> 
   <td>java.lang.Byte, byte</td> 
   <td>数据库兼容的 NUMERIC 或 BYTE</td> 
  </tr> 
  <tr> 
   <td>ShortTypeHandler</td> 
   <td>java.lang.Short, short</td> 
   <td>数据库兼容的 NUMERIC 或 SHORT INTEGER</td> 
  </tr> 
  <tr> 
   <td>IntegerTypeHandler</td> 
   <td>java.lang.Integer, int</td> 
   <td>数据库兼容的 NUMERIC 或 INTEGER</td> 
  </tr> 
  <tr> 
   <td>LongTypeHandler</td> 
   <td>java.lang.Long, long</td> 
   <td>数据库兼容的 NUMERIC 或 LONG INTEGER</td> 
  </tr> 
  <tr> 
   <td>FloatTypeHandler</td> 
   <td>java.lang.Float, float</td> 
   <td>数据库兼容的 NUMERIC 或 FLOAT</td> 
  </tr> 
  <tr> 
   <td>DoubleTypeHandler</td> 
   <td>java.lang.Double, double</td> 
   <td>数据库兼容的 NUMERIC 或 DOUBLE</td> 
  </tr> 
  <tr> 
   <td>BigDecimalTypeHandler</td> 
   <td>java.math.BigDecimal</td> 
   <td>数据库兼容的 NUMERIC 或 DECIMAL</td> 
  </tr> 
  <tr> 
   <td>StringTypeHandler</td> 
   <td>java.lang.String</td> 
   <td>CHAR, VARCHAR</td> 
  </tr> 
  <tr> 
   <td>ClobReaderTypeHandler</td> 
   <td>java.io.Reader</td> 
   <td>-</td> 
  </tr> 
  <tr> 
   <td>ClobTypeHandler</td> 
   <td>java.lang.String</td> 
   <td>CLOB, LONGVARCHAR</td> 
  </tr> 
  <tr> 
   <td>NStringTypeHandler</td> 
   <td>java.lang.String</td> 
   <td>NVARCHAR, NCHAR</td> 
  </tr> 
  <tr> 
   <td>NClobTypeHandler</td> 
   <td>java.lang.String</td> 
   <td>NCLOB</td> 
  </tr> 
  <tr> 
   <td>BlobInputStreamTypeHandler</td> 
   <td>java.io.InputStream</td> 
   <td>-</td> 
  </tr> 
  <tr> 
   <td>ByteArrayTypeHandler</td> 
   <td>byte[]</td> 
   <td>数据库兼容的字节流类型</td> 
  </tr> 
  <tr> 
   <td>BlobTypeHandler</td> 
   <td>byte[]</td> 
   <td>BLOB, LONGVARBINARY</td> 
  </tr> 
  <tr> 
   <td>DateTypeHandler</td> 
   <td>java.util.Date</td> 
   <td>TIMESTAMP</td> 
  </tr> 
  <tr> 
   <td>DateOnlyTypeHandler</td> 
   <td>java.util.Date</td> 
   <td>DATE</td> 
  </tr> 
  <tr> 
   <td>TimeOnlyTypeHandler</td> 
   <td>java.util.Date</td> 
   <td>TIME</td> 
  </tr> 
  <tr> 
   <td>SqlTimestampTypeHandler</td> 
   <td>java.sql.Timestamp</td> 
   <td>TIMESTAMP</td> 
  </tr> 
  <tr> 
   <td>SqlDateTypeHandler</td> 
   <td>java.sql.Date</td> 
   <td>DATE</td> 
  </tr> 
  <tr> 
   <td>SqlTimeTypeHandler</td> 
   <td>java.sql.Time</td> 
   <td>TIME</td> 
  </tr> 
  <tr> 
   <td>ObjectTypeHandler</td> 
   <td>Any</td> 
   <td>OTHER 或未指定类型</td> 
  </tr> 
  <tr> 
   <td><code>EnumTypeHandler</code></td> 
   <td>Enumeration Type</td> 
   <td>VARCHAR-任何兼容的字符串类型，存储枚举的名称（而不是索引）</td> 
  </tr> 
  <tr> 
   <td><code>EnumOrdinalTypeHandler</code></td> 
   <td>Enumeration Type</td> 
   <td>任何兼容的 NUMERIC 或 DOUBLE 类型，存储枚举的索引（而不是名称）。</td> 
  </tr> 
  <tr> 
   <td>InstantTypeHandler</td> 
   <td>java.time.Instant</td> 
   <td>TIMESTAMP</td> 
  </tr> 
  <tr> 
   <td>LocalDateTimeTypeHandler</td> 
   <td>java.time.LocalDateTime</td> 
   <td>TIMESTAMP</td> 
  </tr> 
  <tr> 
   <td>LocalDateTypeHandler</td> 
   <td>java.time.LocalDate</td> 
   <td>DATE</td> 
  </tr> 
  <tr> 
   <td>LocalTimeTypeHandler</td> 
   <td>java.time.LocalTime</td> 
   <td>TIME</td> 
  </tr> 
  <tr> 
   <td>OffsetDateTimeTypeHandler</td> 
   <td>java.time.OffsetDateTime</td> 
   <td>TIMESTAMP</td> 
  </tr> 
  <tr> 
   <td>OffsetTimeTypeHandler</td> 
   <td>java.time.OffsetTime</td> 
   <td>TIME</td> 
  </tr> 
  <tr> 
   <td>ZonedDateTimeTypeHandler</td> 
   <td>java.time.ZonedDateTime</td> 
   <td>TIMESTAMP</td> 
  </tr> 
  <tr> 
   <td>YearTypeHandler</td> 
   <td>java.time.Year</td> 
   <td>INTEGER</td> 
  </tr> 
  <tr> 
   <td>MonthTypeHandler</td> 
   <td>java.time.Month</td> 
   <td>INTEGER</td> 
  </tr> 
  <tr> 
   <td>YearMonthTypeHandler</td> 
   <td>java.time.YearMonth</td> 
   <td>VARCHAR or LONGVARCHAR</td> 
  </tr> 
  <tr> 
   <td>JapaneseDateTypeHandler</td> 
   <td>java.time.chrono.JapaneseDate</td> 
   <td>DATE</td> 
  </tr> 
 </tbody> 
</table>

##### 枚举类型默认的 typeHandler #####

> 上文已经说到，Mybatis 为不同类型的参数自动设置来不通的类型处理器，对于枚举类型来说，默认的类型处理器就是 `EnumTypeHandler`，这样一来，其实我们可以直接使用枚举类型的参数，下面枚举类型的使用种的第一种情况就适用于这种默认情况。

##### Mybatis 结合枚举最简单的方式 #####

> 我们需要先做点基础准备工作，简单说就是构造一个具有枚举类型成员变量的实体类，所以第一步自然是定义枚举类，考虑到枚举类型到多样化，我同时声明了3个枚举类

###### 定义枚举类 ######

> 一个属性一个枚举类就够了，这里展示三个枚举类是为类说明一下，默认情况下最终存到数据库到会是 枚举类型的名字 INIT

*  第一个

public enum Str1Enum { 
    	INIT("初始状态"),
    	ACTIVE("激活状态"),
    	FREEZE("冻结状态");
    	private String name;
    	public String getName() { 
    		return name;
    	}
    	Str1Enum(String name){ 
    		this.name=name;
    	}
    }

*  第二个

public enum Str2Enum { 
    	
    	INIT("init","初始化"),
    	ACTIVE("active","激活"),
    	FREEZE("freeze","冻结");
    	
    	private String key;
    	private String value;
    	public String getKey() { 
    		return key;
    	}
    	public String getValue() { 
    		return value;
    	}
    	Str2Enum(String key,String value){ 
    		this.key=key;
    		this.value=value;
    	}
    }

*  第三个

public enum Str3Enum { 
    	INIT(10,"初始化"),
    	ACTIVE(20,"激活"),
    	FREEZE(30,"冻结");
    	
    	private int key;
    	private String value;
    	public int getKey() { 
    		return key;
    	}
    	public String getValue() { 
    		return value;
    	}
    	
    	Str3Enum(int key,String value){ 
    		this.key=key;
    		this.value=value;
    	}
    }

###### 准备一个表 ######

create table ENUM_DEMO
    (
    	ID bigint not null
    		primary key,
    	STR1 varchar(32) null,
    	STR2 varchar(32) null,
    	STR3 varchar(32) null
    );

![在这里插入图片描述][20181215144537618.jpg]

###### 最简单的方式 ######

> Mybatis+Maven 自动生成代码  
> [Mybatis 自动生成代码配置 -Spring + Maven 环境][Mybatis _ -Spring _ Maven]

> 使用 Mybatis 默认的类型处理器，只需要在自动生成 Mybatis 相关内容的时候指定一下涉及字段的 javaType

*  向数据库插入一条数据

@Test
    	public void test(){ 
    		EnumDemoEntity record=new EnumDemoEntity();
    		record.setId(1l);
    		record.setStr1(Str1Enum.INIT);
    		record.setStr2(Str2Enum.INIT);
    		record.setStr3(Str3Enum.INIT);
    		enumDemoEntityMapper.insert(record);
    	}

![在这里插入图片描述][20181215151420479.jpg]

##### 使用 Mybatis 的 EnumOrdinalTypeHandler #####

> 上文提到，Mybatis 自带的枚举类型的类型处理器是 EnumTypehandler,其会保存枚举的名称，Mybatis 自带了另外一种枚举类型c处理器  
> `EnumOrdinalTypeHandler`，如上表中标红的部分，EnumTypeHandler 存储枚举的名称，EnumOrdinalTypeHandler 存储枚举的索引  
> 如果需要使用这个枚举类型处理器,则需要额外做一些工作

###### 类的路径 ######

//EnumTypeHandler
    org.apache.ibatis.type.EnumTypeHandler
    //EnumOrdinalTypeHandler
    org.apache.ibatis.type.EnumOrdinalTypeHandler

###### 使用 EnumOrdinalTypeHandler 存储的是索引 ######

> 需要修改数据库类型为 整形，而且EnumOrdinalTypeHandler 的起始数是0

create table ENUM_DEMO
    (
    	ID bigint not null
    		primary key,
    	STR1 varchar(32) null,
    	STR2 varchar(32) null,
    	STR3 int null
    );

###### 如果使用 Mybatis 代码自动生成工具 ######

###### 如果修改已有的 xml ######

*  搜索的部分:指定 typeHandler

*  插入的部分:指定 typeHandler

<insert id="insert" parameterType="com.bestcxx.stu.springmybatis.model.EnumDemoEntity" >
        insert into ENUM_DEMO (ID, STR1, STR2, 
          STR3)
        values (#{id,jdbcType=BIGINT}, #{str1,jdbcType=VARCHAR}, #{str2,jdbcType=VARCHAR}, 
          #{str3,jdbcType=VARCHAR,typeHandler=org.apache.ibatis.type.EnumOrdinalTypeHandler})
      </insert>

###### 看数据库结果 ######

> STR3 字段由之前的 INIT 变为了索引序数 0  
> ![在这里插入图片描述][20181215162106490.jpg]

##### 参考内容 #####

\[1\]、http://www.mybatis.org/mybatis-3/zh/configuration.html\#typeHandlers  
\[2\]、《深入浅出 Mybatis 技术原理与实战》

[20181215144537618.jpg]: /images/20220404/9177b6222ac04b6ba5b915df2ed36490.png
[Mybatis _ -Spring _ Maven]: https://blog.csdn.net/bestcxx/article/details/79387763
[20181215151420479.jpg]: /images/20220404/a372d185be224506a37853af71f364f6.png
[20181215162106490.jpg]: /images/20220404/e58da00578ec4662ab93db96fe93dfb1.png