Mybatis中使用Handler对字段进行统一处理

最新推荐文章于 2025-11-02 23:45:21 发布

原创最新推荐文章于 2025-11-02 23:45:21 发布 · 3.6k 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#Mybatis #Handler #统一处理

Mybatis 专栏收录该内容

4 篇文章

订阅专栏

本文介绍如何使用MyBatis的TypeHandler实现对特定字段的统一加密与解密操作，通过自定义的EnDecodeTypeHandler类，确保敏感信息如中文姓名的安全存储与正确读取。

Mybatis3里面支持在字段后面添加一个Handler，以便对该字段进行统一处理。我们还可以写一个代理类，用来对该字段进行特殊处理，这样写的话会导致对之前的代码修改很多，而且可能遗漏，造成风险。所以在Handler里面对字段的新老内容进行统一处理是最佳实践。

比如要对中文name字段进行统一encode：

EnDecodeTypeHandler.java

package com.mybatis.handler;

import org.apache.commons.lang3.StringUtils;
import org.apache.ibatis.type.BaseTypeHandler;
import org.apache.ibatis.type.JdbcType;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.UnsupportedEncodingException;
import java.net.URLDecoder;
import java.net.URLEncoder;
import java.sql.CallableStatement;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;

/**
 * 针对String字段进行TDE加密
 * Created by YLC on 2017/12/14 0014.
 */
public class EnDecodeTypeHandler extends BaseTypeHandler {

    Logger logger = LoggerFactory.getLogger(EnDecodeTypeHandler.class);

    @Override
    public void setNonNullParameter(PreparedStatement preparedStatement, int i, Object o, JdbcType jdbcType) throws SQLException {
        String value = String.valueOf(o);
        if(StringUtils.isBlank(value)){
            logger.warn("字段为空，不加密");
        }else{
            try {
                preparedStatement.setString(i, encode(value));
            }catch (Exception e){
                logger.error("index:{}, 加密失败", i, e);
                e.printStackTrace();
                throw new RuntimeException(e);
            }
        }
    }

    @Override
    public Object getNullableResult(ResultSet resultSet, String s) throws SQLException {
        return decode(resultSet.getString(s), "resultSet.getString(i)"+s);
    }

    @Override
    public Object getNullableResult(ResultSet resultSet, int i) throws SQLException {
        return decode(resultSet.getString(i), "resultSet.getString(i)"+i);
    }

    @Override
    public Object getNullableResult(CallableStatement callableStatement, int i) throws SQLException {
        return decode(callableStatement.getString(i), "callableStatement.getString(i)"+i);
    }

    private String encode(String value){
        try {
            return URLEncoder.encode(value, "UTF-8");
        } catch (UnsupportedEncodingException e) {
            e.printStackTrace();
        }
        return null;
    }

    private String decode(String value, String sign){
        try {
            return URLDecoder.decode(value, "UTF-8");
        }catch (Exception e){
            logger.error("{}, 解密失败", sign, e);
            e.printStackTrace();
            throw new RuntimeException(e);
        }
    }
}

在sqlmap中也要进行处理：

<resultMap id="BaseResultMap" type="com.Member" >
  <id column="id" property="id" jdbcType="BIGINT" />
  <result column="name" property="name" jdbcType="VARCHAR" typeHandler="com.mybatis.handler.EnDecodeTypeHandler"/>
</resultMap>

如果有多个ResultMap都要加上handler配置。

插入数据的时候：

<insert id="insert" parameterType="com.Member">
  insert into sam_member (id, name)
    values (#{id,jdbcType=BIGINT}, 
    #{name,jdbcType=VARCHAR, typeHandler=com.mybatis.handler.EnDecodeTypeHandle)
</insert>

这样在插入和查询的时候通过Handler对字段进行处理，改动很小。