MyBatis(十三) 自定义 TypeHandler

一、Mybatis 内置的 TypeHandler

　　Mybatis 在数据交换时就会用到 TypeHandler 类型处理器，比如：从JavaType->JdbcType的转化过程，上面是 Mybatis 自带的 TypeHandler，一般情况下够我们使用了，但是有时候需要特殊处理一些数据，就需要我们自己定义一个 TypeHandler 来处理。

二、自定义 TypeHandler

• 要自定义一个　TypeHandler　需要实现TypeHandler接口；或者继承BaseTypeHandler。
• 在配置文件中配置这个 TypeHandler。

三、自定义 TypeHandler 来处理枚举类

• 需求：
  
  • 数据库中每个 employee 对应一个状态。
  • 存入数据库中的是该状态的状态码。
  • 显示到页面的是该状态的提示信息。

1、存放状态的枚举类

    public enum EmpStatus {
        LOGIN(100,"用户已登录"),
        LOGOUT(200,"用户已注销"),
        REMOVE(300,"用户已被移除");

        private Integer code;
        private String msg;
        private EmpStatus(Integer code,String msg) {
            this.code = code;
            this.msg = msg;
        }
        public Integer getCode() {
            return code;
        }
        public void setCode(Integer code) {
            this.code = code;
        }
        public String getMsg() {
            return msg;
        }
        public void setMsg(String msg) {
            this.msg = msg;
        }

        //根据状态码返回当前枚举类
        public static EmpStatus getEmpStatusByCode(Integer code) {
            switch (code) {
                case 100:
                    return LOGIN;
                case 200:
                    return LOGOUT;  
                case 300:
                    return REMOVE;
                default:
                    return LOGOUT;  
            }
        }
    }

2、定义 TypeHandler 处理该枚举类：

    import java.sql.CallableStatement;
    import java.sql.PreparedStatement;
    import java.sql.ResultSet;
    import java.sql.SQLException;
    import org.apache.ibatis.type.JdbcType;
    import org.apache.ibatis.type.TypeHandler;
    import cn.edu.pzhu.cg.entities.EmpStatus;

    public class MyEmpStatusTypeHandler implements TypeHandler<EmpStatus>{

        /*
         * 设置 sql 语句参数值，定义当前数据如何保存到数据库中
         */
        @Override
        public void setParameter(PreparedStatement ps, int i, EmpStatus parameter, JdbcType jdbcType) throws SQLException {
            System.out.println("要保存的状态码为: " + parameter.getCode());
            ps.setString(i, parameter.getCode().toString());
        }
        //从数据库中取出数据
        @Override
        public EmpStatus getResult(ResultSet rs, String columnName) throws SQLException {
            int code = rs.getInt(columnName);
            System.out.println("从数据库中获取到的状态码为: " + code);
            //根据从数据库中拿到的一个枚举状态码返回一个枚举类
            EmpStatus status = EmpStatus.getEmpStatusByCode(code);
            return status;
        }

        @Override
        public EmpStatus getResult(ResultSet rs, int columnIndex) throws SQLException {
            int code = rs.getInt(columnIndex);
            System.out.println("从数据库中获取到的状态码为: " + code);
            EmpStatus status = EmpStatus.getEmpStatusByCode(code);
            return status;
        }

        @Override
        public EmpStatus getResult(CallableStatement cs, int columnIndex) throws SQLException {
            int code = cs.getInt(columnIndex);
            System.out.println("从数据库中获取到的状态码为: " + code);
            EmpStatus status = EmpStatus.getEmpStatusByCode(code);
            return status;
        }

    }

在上面的 TypeHandler 中在存入数据时，是将每个状态的状态码存放在数据库中，而在取数据时，通过该状态码去获取对应的枚举对象，并返回。

3、配置 TypeHandler

• 在全局配置文件中配置：

    <typeHandlers>
        <typeHandler handler="cn.edu.pzhu.cg.typehandler.MyEmpStatusTypeHandler" javaType="cn.edu.pzhu.cg.entities.EmpStatus"/>
    </typeHandlers>

   在全局配置文件中配置后，每次处理当前这个枚举类都会去使用自定义的这个 TypeHandler；也可以在 resultMap 处理结果集时去引用这个 TypeHandler，这样当需要使用这个 TypeHandler 时再去引用，更加灵活。

    <resultMap type="cn.edu.pzhu.cg.entities.Employee" id="MyEmpStatus">
            <id column="id" property="id"/>
            <result column="last_name" property="lastName"/>
            <result column="age" property="age"/>
            <result column="dept_id" property="department.id"/>
            <result column="dept_name" property="department.departmentName"/>

            <!-- 处理当前字段去使用自定义的 TyprHandler -->
            <result column="emp_status" property="empStatus"  
                    typeHandler="cn.edu.pzhu.cg.typehandler.MyEmpStatusTypeHandler"/> 
        </resultMap>
        <select id="getEmployeeStatusById" resultMap="MyEmpStatus">
            select * from employee where id=#{id}
        </select>

4、测试

• 测试插入：

    @Test
    public void testAddEmployee() {
        Employee employee = new Employee(null, "enum3", 22, "enum3@qq.com");
        employee.setEmpStatus(EmpStatus.LOGOUT);
        mapper.addEmployee(employee);

        sqlSession.commit();
    }

数据库中的记录：

• 测试查询：

    @Test
    public void testQuery() {
        Employee employee = mapper.getEmployeeStatusById(18);
        //输入枚举对象
        System.out.println(employee.getEmpStatus());
    }

结果: