【MyBatis学习16】自定义类型处理器typeHandlers介绍
2017-03-24 11:06
567 查看
本文博客地址:http://blog.csdn.net/soonfly/article/details/65628372 (转载请注明出处)
我们在写mapper映射器的配置文件时,不经意间已经用到类型转换,不过是mybatis帮我们完成的。
像上面例子,只需要向update方法传入一个user对象,mybatis利用反射拆开user对象,然后根据对象中的字段在预处理语句(PreparedStatement)中设置参数,并且根据字段的类型,使用setXXX()方式设置相应的值。XXX可以是Integer,String,Date等Java类型。
同理,在从结果集(ResultSet)中取出一个值时,将使用rs.getInt、rs.getString、rs.getTimeStamp等方法将数据转换为Java对象。
那么问题来了,javaType和jdbcType的转换关系由谁来定呢?这就是类型处理器(type handlers)的功能所在。
比如java.lang.String转成JDBC.Varchar,java.lang.Integer转成JDBC.int。MyBatis使用内建的类型处理器能转换所有的基本数据类型、基本类型的包装类型、byte[] 、java.util.Date、java.sql.Date、java,sql.Time、java.sql.Timestamp、java枚举类型等。
不过对于自定义的类型怎么办呢?
假设上面的address在数据库字段类型是varchar(50),但是在JAVA twm.mybatisdemo.pojo.User类中的address字段并不是String类型,而是一个自定义的
碰到这种情况,mybatis基本懵逼了。。。
如果运行的话就报错误:
Type handler was null on parameter mapping for property ‘address’. It
was either not specified and/or could not be found for the javaType /
jdbcType combination specified.
address字段需要传递给
因此,需要创建一个自定义的类型处理器(TypeHandler)了
1、创建类型处理器:
通过ide自动生成代码,可以看到父类BaseTypeHandler有四个方法需要我们实现,包括三个get方法,一个set方法。
2、实现get方法
三个get方法都是用于将数据库获得的记录集里的address字段转成java Address类型的对象。
所以我们首先给Address类增加一个构造方法,用途:根据字符串生成一个实例对象。
然后实现AddressTypeHandler类中的三个get方法:(有强迫症,不喜欢看arg0,arg1。所以顺便也改一下)
3、实现set方法
set方法是用来将java类型转成数据库存储的类型。
这里我们先实现一下Address类的toString()方法(如果toString另有它用,那么就另外用一个方法名)
然后实现AddressTypeHandler类中的setNonNullParameter
4、在myBatis配置文件中注册该类
这里有个小插曲,我当时在配置文件最后插入了这段,结果提示错误:
The content of element type “configuration” must match
“(properties?,settings?,typeAliases?,typeHandlers?,objectFactory?,objectWrapperFactory?,reflectorFactory?,plugins?,environments?,databaseIdProvider?,mappers?)”.
原来在configuration里的标签,必须按照提示的这个顺序写,不然就报错。
因此typeHandlers必须放在environments前面,typeAliases后面。
回顾一下,是不是感觉跟序列化/反序列化这套路很相似?
本文博客地址:http://blog.csdn.net/soonfly/article/details/65628372 (转载请注明出处)
我们在写mapper映射器的配置文件时,不经意间已经用到类型转换,不过是mybatis帮我们完成的。
<update id="update" parameterType="twm.mybatisdemo.pojo.User"> update user set username=#{username},password=#{password},address=#{address} where id=#{id} </update>
像上面例子,只需要向update方法传入一个user对象,mybatis利用反射拆开user对象,然后根据对象中的字段在预处理语句(PreparedStatement)中设置参数,并且根据字段的类型,使用setXXX()方式设置相应的值。XXX可以是Integer,String,Date等Java类型。
同理,在从结果集(ResultSet)中取出一个值时,将使用rs.getInt、rs.getString、rs.getTimeStamp等方法将数据转换为Java对象。
那么问题来了,javaType和jdbcType的转换关系由谁来定呢?这就是类型处理器(type handlers)的功能所在。
比如java.lang.String转成JDBC.Varchar,java.lang.Integer转成JDBC.int。MyBatis使用内建的类型处理器能转换所有的基本数据类型、基本类型的包装类型、byte[] 、java.util.Date、java.sql.Date、java,sql.Time、java.sql.Timestamp、java枚举类型等。
不过对于自定义的类型怎么办呢?
假设上面的address在数据库字段类型是varchar(50),但是在JAVA twm.mybatisdemo.pojo.User类中的address字段并不是String类型,而是一个自定义的
Address类型:
public class Address { String province; String city; public Address() {} public Address(String province, String city) { this.province = province; this.city = city; } //getter and setter...... }
碰到这种情况,mybatis基本懵逼了。。。
如果运行的话就报错误:
Type handler was null on parameter mapping for property ‘address’. It
was either not specified and/or could not be found for the javaType /
jdbcType combination specified.
address字段需要传递给
#{address},而address字段是Address类型的,MyBatis并不知道该怎样来处理这个类型的对象。
因此,需要创建一个自定义的类型处理器(TypeHandler)了
1、创建类型处理器:
class AddressTypeHandler extends BaseTypeHandler<Address>{ }
通过ide自动生成代码,可以看到父类BaseTypeHandler有四个方法需要我们实现,包括三个get方法,一个set方法。
2、实现get方法
三个get方法都是用于将数据库获得的记录集里的address字段转成java Address类型的对象。
所以我们首先给Address类增加一个构造方法,用途:根据字符串生成一个实例对象。
//假设我们存储在db中的字符串是以","号分隔省市关系的 public Address(String address) { if (address != null) { String[] segments = address.split(","); if (segments.length > 1) { this.province = segments[0]; this.city = segments[1]; } else if (segments.length > 0) { this.city = segments[0]; } } }
然后实现AddressTypeHandler类中的三个get方法:(有强迫症,不喜欢看arg0,arg1。所以顺便也改一下)
@Override public Address getNullableResult(ResultSet rSet, String columnName) throws SQLException { return new Address(rSet.getString(columnName)); } @Override public Address getNullableResult(ResultSet rSet, int columnIndex) throws SQLException { return new Address(rSet.getString(columnIndex)); } @Override public Address getNullableResult(CallableStatement cStatement, int columnIndex) throws SQLException { return new Address(cStatement.getString(columnIndex)); }
3、实现set方法
set方法是用来将java类型转成数据库存储的类型。
这里我们先实现一下Address类的toString()方法(如果toString另有它用,那么就另外用一个方法名)
@Override public String toString() { return this.province + "," + this.city; }
然后实现AddressTypeHandler类中的setNonNullParameter
@Override public void setNonNullParameter(PreparedStatement pStatement, int index, Address address, JdbcType jdbcType) throws SQLException { pStatement.setString(index, address.toString()); }
4、在myBatis配置文件中注册该类
<!-- 注册自定义类型处理器 --> <typeHandlers> <typeHandler handler="twm.mybatisdemo.type.AddressTypeHandler" /> </typeHandlers>
这里有个小插曲,我当时在配置文件最后插入了这段,结果提示错误:
The content of element type “configuration” must match
“(properties?,settings?,typeAliases?,typeHandlers?,objectFactory?,objectWrapperFactory?,reflectorFactory?,plugins?,environments?,databaseIdProvider?,mappers?)”.
原来在configuration里的标签,必须按照提示的这个顺序写,不然就报错。
因此typeHandlers必须放在environments前面,typeAliases后面。
回顾一下,是不是感觉跟序列化/反序列化这套路很相似?
本文博客地址:http://blog.csdn.net/soonfly/article/details/65628372 (转载请注明出处)
相关文章推荐
- MyBatis:自定义类型转换器(typeHandlers)
- mybatis自定义类型处理器TypehHandler示例详解
- mybatis自定义类型处理器-TypehHandler
- MyBatis(3.2.3)类型处理器TypeHandlers的简单示例
- JavaWeb学习笔记-mybatis-12-mybatis配置-类型处理typeHandlers
- MyBatis:自定义类型转换器(typeHandlers)
- mybatis 自定义类处理器typehandlers
- mybatis自定义类型处理器处理枚举类型
- Mybatis自定义类型处理器
- 【MyBatis学习07】输出类型resultType及输出参数映射resultMap
- Mybatis 内置 Java 类型别名与 typeHandlers
- MyBatis源码解析(十)——Type类型模块之类型处理器TypeHandler
- Mybatis配置报错元素类型为 "configuration" 的内容必须匹配 "(properties?,settings?,typeAliases?,typeHandlers?,objectFa
- MyBatis源码解析(十)——Type类型模块之类型处理器TypeHandler
- 15.0 Mybatsi_扩展_自定义类型处理器_MyBatis中枚举类型的默认处理
- mybatis的配置元素--typeHandler类型处理器
- Mybatis学习之自定义别名Typealiases(四)
- Mybatis实现自定义的类型转换器TypeHandler
- Mybatis 内置 Java 类型别名与 typeHandlers
- Mybatis学习之自定义typehandler(四)