关于springboot:SpringBoot系列-Mybatis-之自定义类型转换-TypeHandler

SpringBoot 系列 Mybatis 之自定义类型转换 TypeHandler

在应用 mybatis 进行 db 操作的时候，咱们常常会干的一件事件就是将 db 中字段映射到 java bean，通常咱们应用 ResultMap 来实现映射，通过这个标签能够指定两者的绑定关系，那么如果 java bean 中的字段类型与 db 中的不一样，应该怎么解决呢？

如 db 中为 timestamp, 而 java bean 中定义的却是 long

通过 BaseTypeHandler 来实现自定义的类型转换

<!– more –>

应用 mysql 作为本文的实例数据库，新增一张表

CREATE TABLE `money` (`id` int(11) unsigned NOT NULL AUTO_INCREMENT,
  `name` varchar(20) NOT NULL DEFAULT ''COMMENT' 用户名 ',
  `money` int(26) NOT NULL DEFAULT '0' COMMENT '钱',
  `is_deleted` tinyint(1) NOT NULL DEFAULT '0',
  `create_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创立工夫',
  `update_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '更新工夫',
  PRIMARY KEY (`id`),
  KEY `name` (`name`)
) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8mb4;

本文借助 SpringBoot 2.2.1.RELEASE + maven 3.5.3 + IDEA进行开发

pom 依赖如下

<dependencies>
    <dependency>
        <groupId>org.mybatis.spring.boot</groupId>
        <artifactId>mybatis-spring-boot-starter</artifactId>
        <version>2.2.0</version>
    </dependency>
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
    </dependency>
</dependencies>

db 配置信息 application.yml

spring:
  datasource:
    url: jdbc:mysql://127.0.0.1:3306/story?useUnicode=true&characterEncoding=UTF-8&useSSL=false&serverTimezone=Asia/Shanghai
    username: root
    password:

留神下面 case 中的 create_at 与 update_at 的类型都是timestmap，咱们定义的 Entity 如下

@Data
public class MoneyPo {
    private Integer id;

    private String name;

    private Long money;

    private Integer isDeleted;

    private Timestamp createAt;

    private Long updateAt;
}

定义一个简略的查问接口，这里间接应用注解的形式（至于 xml 的写法差异也不大）

/**
 * 主键查问
 *
 * @param id id
 * @return {@link MoneyPo}
 */
@Select("select * from money where id = #{id}")
@Results(id = "moneyResultMap", value = {@Result(property = "id", column = "id", id = true, jdbcType = JdbcType.INTEGER),
        @Result(property = "name", column = "name", jdbcType = JdbcType.VARCHAR),
        @Result(property = "money", column = "money", jdbcType = JdbcType.INTEGER),
        @Result(property = "isDeleted", column = "is_deleted", jdbcType = JdbcType.TINYINT),
        @Result(property = "createAt", column = "create_at", jdbcType = JdbcType.TIMESTAMP),
//            @Result(property = "updateAt", column = "update_at", jdbcType = JdbcType.TIMESTAMP)})
        @Result(property = "updateAt", column = "update_at", jdbcType = JdbcType.TIMESTAMP, typeHandler = Timestamp2LongHandler.class)})
MoneyPo getById(@Param("id") int id);

// 对于 SelectProvider 的应用，前面再说，次要是动静 sql 的演示
@SelectProvider(type = MoneyService.class, method = "getByIdSql")
@ResultMap(value = "moneyResultMap")
MoneyPo getByIdForProvider(@Param("id") int id);

阐明：

@Results：这个注解与 ResultMap 标签成果统一，次要用于定义 db 的字段与 java bean 的映射关系
id = "moneyResultMap" 这个 id 定义，能够实现 @Results 的复用
@Result: 关注下 updateAt 的 typeHandler，这里指定了自定义的 TypeHandler，来实现 JdbcType.TEMSTAMP 与 Java Bean 中的 long 的转换

自定义类型转换，次要是继承 BaseTypeHandler 类，泛型的类型为 Java Bean 中的类型

/**
 * 自定义类型转换：将数据库中的日期类型，转换成 long 类型的工夫戳
 *
 * 三种注册形式：* 1. 间接在 result 标签中，指定 typeHandler，如 @Result(property = "updateAt", column = "update_at", jdbcType = JdbcType.TIMESTAMP, typeHandler = Timestamp2LongHandler.class)
 * 2. 在 SqlSessionFactory 实例中，注册 在 SqlSessionFactory 实例中.setTypeHandlers(new Timestamp2LongHandler());
 * 3.xml 配置，<typeHandler handler="com.git.hui.boot.mybatis.handler.Timestamp2LongHandler"/>
 *
 * @author yihui
 * @date 2021/7/7
 */
@MappedTypes(value = Long.class)
@MappedJdbcTypes(value = {JdbcType.DATE, JdbcType.TIME, JdbcType.TIMESTAMP})
public class Timestamp2LongHandler extends BaseTypeHandler<Long> {

    /**
     * 将 java 类型，转换为 jdbc 类型
     *
     * @param preparedStatement
     * @param i
     * @param aLong             毫秒工夫戳
     * @param jdbcType          db 字段类型
     * @throws SQLException
     */
    @Override
    public void setNonNullParameter(PreparedStatement preparedStatement, int i, Long aLong, JdbcType jdbcType) throws SQLException {if (jdbcType == JdbcType.DATE) {preparedStatement.setDate(i, new Date(aLong));
        } else if (jdbcType == JdbcType.TIME) {preparedStatement.setTime(i, new Time(aLong));
        } else if (jdbcType == JdbcType.TIMESTAMP) {preparedStatement.setTimestamp(i, new Timestamp(aLong));
        }
    }

    @Override
    public Long getNullableResult(ResultSet resultSet, String s) throws SQLException {return parse2time(resultSet.getObject(s));
    }

    @Override
    public Long getNullableResult(ResultSet resultSet, int i) throws SQLException {return parse2time(resultSet.getObject(i));
    }

    @Override
    public Long getNullableResult(CallableStatement callableStatement, int i) throws SQLException {return parse2time(callableStatement.getObject(i));
    }

    private Long parse2time(Object value) {if (value instanceof Date) {return ((Date) value).getTime();} else if (value instanceof Time) {return ((Time) value).getTime();} else if (value instanceof Timestamp) {return ((Timestamp) value).getTime();}
        return null;
    }
}

setNonNullParameter：将 java 类型，转换为 jdbc 类型
getNullableResult：将 jdbc 类型转 java 类型

咱们本人定义一个 TypeHandler 没啥问题，接下来就是须要它失效，一般来讲，有上面几种形式

通过 result 标签中的 typeHandler 指定

应用 xml 的形式如

<result column="update_at" property="updateAt" jdbcType="TIMESTAMP" typeHandler="com.git.hui.boot.mybatis.handler.Timestamp2LongHandler"/>

注解 @Result 的形式如

@Result(property = "updateAt", column = "update_at", jdbcType = JdbcType.TIMESTAMP, typeHandler = Timestamp2LongHandler.class)

下面的应用姿态为准确指定，如果咱们心愿利用到所有的场景，则能够通过 SqlSessionFactory 来实现

@Bean(name = "sqlSessionFactory")
public SqlSessionFactory sqlSessionFactory(DataSource dataSource) throws Exception {SqlSessionFactoryBean bean = new SqlSessionFactoryBean();
    bean.setDataSource(dataSource);
    bean.setMapperLocations(
            // 设置 mybatis 的 xml 所在位置，这里应用 mybatis 注解形式，没有配置 xml 文件
            new PathMatchingResourcePatternResolver().getResources("classpath*:mapping/*.xml"));
    // 注册 typehandler，供全局应用
    bean.setTypeHandlers(new Timestamp2LongHandler());
    return bean.getObject();}

除下面 case 之外，还有一个就是借助 mybatis-config.xml 配置文件来注册，如

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configuration
        PUBLIC "-//ibatis.apache.org//DTD Config 3.1//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
    <settings>
        <!-- 驼峰下划线格局反对 -->
        <setting name="mapUnderscoreToCamelCase" value="true"/>
    </settings>

    <typeHandlers>
        <typeHandler handler="com.git.hui.boot.mybatis.handler.Timestamp2LongHandler"/>
    </typeHandlers>
</configuration>

留神，应用下面的配置文件，须要在 SpringBoot 中指定如下配置，否则将不会失效

mybatis:
  config-location: classpath:mybatis-config.xml

springboot 配置文件，能够通过指定 type-handlers-package 来注册 TypeHandler

mybatis:
  type-handlers-package: com.git.hui.boot.mybatis.handler

本文次要介绍 db 中的类型与 java bean 中类型的映射适配策略，次要是通过继承 BaseTypeHandler 来实现自定义的类型转化

要应用自定义的 TypeHandler，有全局失效与准确指定两种形式

@Result/<result>标签中，通过 typeHandler 指定
SqlSessionFactory 全局设置 typeHandler
mybatis-config.xml 配置文件设置typeHandlers

此外本文的配置中，还反对了驼峰与下划线的互转配置，这个也属于常见的配置，通过在 mybatis-config 中如下配置即可

<setting name="mapUnderscoreToCamelCase" value="true"/>

接下来问题来了，驼峰能够和下划线互转，那么有方法实现自定义的 name 映射么，如果有晓得的小伙伴，请不吝指教

工程：https://github.com/liuyueyi/spring-boot-demo
源码：https://github.com/liuyueyi/spring-boot-demo/tree/master/spring-boot/104-mybatis-ano
源码：https://github.com/liuyueyi/spring-boot-demo/tree/master/spring-boot/103-mybatis-xml

mybatis 系列博文

【DB 系列】SpringBoot 系列 Mybatis 之 Mapper 接口与 Sql 绑定几种姿态
【DB 系列】SpringBoot 系列 Mybatis 之 Mapper 注册的几种形式
【DB 系列】Mybatis-Plus 多数据源配置
【DB 系列】Mybatis 基于 AbstractRoutingDataSource 与 AOP 实现多数据源切换
【DB 系列】Mybatis 多数据源配置与应用
【DB 系列】JdbcTemplate 之多数据源配置与应用
【DB 系列】Mybatis-Plus 代码主动生成
【DB 系列】MybatisPlus 整合篇
【DB 系列】Mybatis+ 注解整合篇
【DB 系列】Mybatis+xml 整合篇

尽信书则不如，以上内容，纯属一家之言，因集体能力无限，不免有疏漏和谬误之处，如发现 bug 或者有更好的倡议，欢送批评指正，不吝感谢

上面一灰灰的集体博客，记录所有学习和工作中的博文，欢送大家前去逛逛

一灰灰 Blog 集体博客 https://blog.hhui.top
一灰灰 Blog-Spring 专题博客 http://spring.hhui.top

关于springboot:SpringBoot系列-Mybatis-之自定义类型转换-TypeHandler

I. 环境筹备

1. 数据库筹备

2. 我的项目环境

II. 实例演示

1. entity 定义

2. Mapper 测试接口

3. 类型转换

4. TypeHandler 注册

4.1 result 标签中指定

4.2 SqlSessionFactory 全局配置

4.3 全局 xml 配置

4.4 SpringBoot 配置形式

5. 小结

III. 不能错过的源码和相干知识点

0. 我的项目

1. 一灰灰 Blog