Mybatis 学习笔记 - 自定义类型解析器

Love The Way You Lie 2023-01-16 06:42 106阅读 0赞

### Mybatis 学习笔记 - 自定义类型解析器 ###

*  定义解析器
 *   *  1. 实现 \`org.apache.ibatis.type.TypeHandler\` 接口
     *  2. 继承 \`org.apache.ibatis.type.BaseTypeHandler\`
 *  注册解析器
 *   *  1. 全局配置文件里
     *  2. PoemMapper.xml 文件里
 *  参考资料

当对象字段为自定义类型时，mybatis需要我们自己定义解析器才能很好的工作。比如`com.alibaba.fastjson.JSONObject`

大体流程：

1.  定义解析器
2.  注册解析器
3.  OK

# 定义解析器 #

两个方案：

## 1. 实现 `org.apache.ibatis.type.TypeHandler` 接口 ##

传入参数时： java类型 >> JDBC类型  
获取结果时： java类型 << JDBC类型

@MappedTypes(JSONObject.class)
    @MappedJdbcTypes(JdbcType.VARCHAR)
    public class JSONObjectHandler implements TypeHandler<JSONObject> { 
    
        private JSONObject getResult(String jsonString) throws SQLException { 
            if(jsonString != null){ 
                JSONObject jsonObject;
                try{ 
                    jsonObject = JSONObject.parseObject(jsonString);
                }catch (JSONException ex){ 
                    throw new SQLException("jsonString >> JSON 失败，jsonString:" + jsonString);
                }
                return jsonObject;
            }
            return null;
        }
    
        /** * 设置参数时 java类型 转 JDBC类型 */
        @Override
        public void setParameter(PreparedStatement preparedStatement, int parameterIndex, JSONObject jsonObject, JdbcType jdbcType) throws SQLException { 
            preparedStatement.setString(parameterIndex, jsonObject.toJSONString());
        }
        /** * 从结果集按列名取对象时 JdbcType.VARCHAR >> Java类型 */
        @Override
        public JSONObject getResult(ResultSet resultSet, String columnLabel) throws SQLException { 
            return getResult(resultSet.getString(columnLabel));
        }
        /** * 从结果集按索引取对象时 JdbcType.VARCHAR >> Java类型 */
        @Override
        public JSONObject getResult(ResultSet resultSet, int columnIndex) throws SQLException { 
            return getResult(resultSet.getString(columnIndex));
        }
    
        /** * 针对存储过程转换结果 */
        @Override
        public JSONObject getResult(CallableStatement callableStatement, int parameterIndex) throws SQLException { 
            return getResult(callableStatement.getString(parameterIndex));
        }
    
    }

## 2. 继承 `org.apache.ibatis.type.BaseTypeHandler` ##

@MappedTypes(JSONArray.class)
    @MappedJdbcTypes(JdbcType.VARCHAR)
    public class JSONArrayHandler extends BaseTypeHandler<JSONArray> { 
    
        public JSONArray getResult(String jsonString) throws SQLException { 
            if(jsonString != null){ 
                JSONArray jsonArray;
                try{ 
                    jsonArray = JSONArray.parseArray(jsonString);
                }catch (JSONException ex){ 
                    throw new SQLException("jsonString >> JSONArray 失败，jsonString:" + jsonString);
                }
                return jsonArray;
            }
            return null;
        }
    
        @Override
        public void setNonNullParameter(PreparedStatement preparedStatement, int parameterIndex, JSONArray jsonArray, JdbcType jdbcType) throws SQLException { 
            preparedStatement.setString(parameterIndex, jsonArray.toJSONString());
        }
    
        @Override
        public JSONArray getNullableResult(ResultSet resultSet, String columnLabel) throws SQLException { 
            return getResult(resultSet.getString(columnLabel));
        }
    
        @Override
        public JSONArray getNullableResult(ResultSet resultSet, int columnIndex) throws SQLException { 
            return getResult(resultSet.getString(columnIndex));
        }
    
        @Override
        public JSONArray getNullableResult(CallableStatement callableStatement, int parameterIndex) throws SQLException { 
            return getResult(callableStatement.getString(parameterIndex));
        }
    
    }

# 注册解析器 #

也有两个方式

## 1. 全局配置文件里 ##

`src/main/resources/mybatis/mybatis-config.xml`

## 2. PoemMapper.xml 文件里 ##

# 参考资料 #

[mybatis-3官方文档 - 配置 》类型处理器（typeHandlers）][mybatis-3_ - _ _typeHandlers]  
[Interface TypeHandler][]

[mybatis-demo源码 - gitee][mybatis-demo_ - gitee]

[mybatis-3_ - _ _typeHandlers]: https://mybatis.org/mybatis-3/zh/configuration.html#typeHandlers
[Interface TypeHandler]: https://mybatis.org/mybatis-3/zh/apidocs/org/apache/ibatis/type/TypeHandler.html
[mybatis-demo_ - gitee]: https://gitee.com/jerryjin0630/mybatis-demo