MyBatis自定義TypeHandler實現(xiàn)字段加密解密

更新時間：2025年03月16日 15:06:14 作者：小黑屋說YYDS

本文主要介紹了MyBatis自定義TypeHandler實現(xiàn)字段加密解密,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧

前言

今天簡單介紹利用MyBatis的TypeHandler接口實現(xiàn)字段的加解密。

字段的加密和解密，實現(xiàn)方式確實有好幾種。比如，在業(yè)務(wù)層實現(xiàn)、在數(shù)據(jù)庫層面實現(xiàn)等等，但是這些相對來說，耦合性稍微強(qiáng)那么一點點，而且涉及到改動的話，改動的地方比較多；所以最好的就是統(tǒng)一管理這些功能。

一、TypeHandler接口

Mybatis的TypeHandler類型轉(zhuǎn)換器是負(fù)責(zé)Java類和jdbc類型之間的轉(zhuǎn)換。

主要涉及到下面這幾個類：

TypeHandler 類型轉(zhuǎn)換器的頂層接口。
BaseTypeHandler 抽象類繼承自TypeHandler，Mybatis中所有的類型轉(zhuǎn)換器實現(xiàn)均繼承他。
TypeHandlerRegistry 類型轉(zhuǎn)換器注冊器，負(fù)責(zé)存儲類型轉(zhuǎn)換器。
TypeAliasRegistry 類型別名轉(zhuǎn)換器，用來存儲類型與別名的對應(yīng)關(guān)系。

其主要作用就是：

可以指定我們在Java實體類所包含的自定義類型存入數(shù)據(jù)庫后的類型是什么。
從數(shù)據(jù)庫中取出該數(shù)據(jù)后自動轉(zhuǎn)換為我們自定義的Java類型。

所以來實現(xiàn)簡單的字段加密和解密比較方便。

二、實現(xiàn)

1、定義一個實體類包裝對象表示我們要加密的數(shù)據(jù)對象。

/**
 * 編寫一個實體類，凡是此實體類的數(shù)據(jù)都表示需要加解密
 */
@Data
public class Encrypt {
    private String value;
}

2、實現(xiàn)TypeHandler<T>接口，我們這實現(xiàn)BaseTypeHandler<T>。

@MappedJdbcTypes(JdbcType.VARCHAR) // 表示該Handler處理的java類型
@MappedTypes(Encrypt.class) // 表示處理器處理的Jdbc類型
public class EncryptTypeHandler extends BaseTypeHandler<Encrypt> {

    private static final byte[] KEYS = "12345678abcdefgh".getBytes(StandardCharsets.UTF_8);

    /**
     * 設(shè)置參數(shù)
     */
    @Override
    public void setNonNullParameter(PreparedStatement ps, int i, Encrypt parameter, JdbcType jdbcType) throws SQLException {
        if (parameter == null || parameter.getValue() == null) {
            ps.setString(i, null);
            return;
        }
        AES aes = SecureUtil.aes(KEYS);
        String encrypt = aes.encryptHex(parameter.getValue());
        ps.setString(i, encrypt);
    }

    /**
     * 獲取值
     */
    @Override
    public Encrypt getNullableResult(ResultSet rs, String columnName) throws SQLException {
        return decrypt(rs.getString(columnName));
    }

    /**
     * 獲取值
     */
    @Override
    public Encrypt getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
        return decrypt(rs.getString(columnIndex));
    }

    /**
     * 獲取值
     */
    @Override
    public Encrypt getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
        return decrypt(cs.getString(columnIndex));
    }

    public Encrypt decrypt(String value) {
        if (null == value) {
            return null;
        }
        return new Encrypt(SecureUtil.aes(KEYS).decryptStr(value));
    }
}

3、配置Handler，配置的方式有集中；如果是MyBatisPlus，直接在字段注解上面添加即可；
這里是MyBatis，所以可以寫在配置文件中，也可以寫在XML映射文件中，我們這里寫在配置文件中。

# 指定自定義TypeHandler的包位置
mybatis.type-handlers-package=com.mybatis.typehandler

至此，關(guān)于自定義TypeHandler的開發(fā)就此完成，直接使用即可。

另外，基于自定義TypeHandler不僅可以實現(xiàn)自定義加解密，還可以實現(xiàn)特定數(shù)據(jù)類型的轉(zhuǎn)換，這里以數(shù)據(jù)庫類型為varchar映射Java對象類型的List集合類型為例說明。

還是自定義TypeHandler類，以逗號[,]分割為集合如下：

/**
 * 特定類型轉(zhuǎn)換TypeHandler
 */
@MappedJdbcTypes(JdbcType.VARCHAR)
@MappedTypes(List.class)
public class ListTypeHandler extends BaseTypeHandler<List<String>> {

    @Override
    public void setNonNullParameter(PreparedStatement ps, int i, List<String> parameter, JdbcType jdbcType) throws SQLException {
        if (null == parameter || parameter.isEmpty()) {
            ps.setString(i, null);
            return;
        }
        ps.setString(i, String.join(",", parameter));
    }

    @Override
    public List<String> getNullableResult(ResultSet rs, String columnName) throws SQLException {
        final String value = rs.getString(columnName);
        if (StringUtils.hasText(value)) {
            return Arrays.asList(value.split(","));
        }
        return null;
    }

    @Override
    public List<String> getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
        final String value = rs.getString(columnIndex);
        if (StringUtils.hasText(value)) {
            return Arrays.asList(value.split(","));
        }
        return null;
    }

    @Override
    public List<String> getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
        final String value = cs.getString(columnIndex);
        if (StringUtils.hasText(value)) {
            return Arrays.asList(value.split(","));
        }
        return null;
    }
}

4、使用
定義數(shù)據(jù)庫對象類，如下：

@Data
public class Customer {

    private Integer id;
    private Encrypt phone; // 表示要加密的字段
    private List<String> address; // 對應(yīng)數(shù)據(jù)庫字段address
    
}

建表語句：

CREATE TABLE `customer` (
  `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT COMMENT '主鍵',
  `phone` varchar(64) DEFAULT NULL COMMENT '手機(jī)號',
  `address` varchar(200) DEFAULT NULL COMMENT '地址',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='客戶表';

Mapper接口：

public interface CustomerMapper {

    int addCustomer(@Param("phone") Encrypt phone, @Param("address") String address);

    Customer findCustomer(@Param("phone") Encrypt phone);

}

Mapper接口XML：

 	<insert id="addCustomer">
        insert into customer(phone,address) values (#{phone},#{address})
    </insert>

    <select id="findCustomer" resultMap="BaseResultMapper">
        select * from customer where phone = #{phone}
    </select>

Controller接口：

@RestController
public class CustomerController {

    @Autowired
    private CustomerMapper customerMapper;

    @GetMapping("/addCustomer")
    public String addCustomer(@RequestParam("phone") String phone, @RequestParam("address") String address) {
        int result = customerMapper.addCustomer(new Encrypt(phone), address);
        return "添加結(jié)果: " + result;
    }

    @GetMapping("/findCustomer")
    public Customer findCustomer(@RequestParam("phone") String phone) {
        return customerMapper.findCustomer(new Encrypt(phone));
    }
}

數(shù)據(jù)庫數(shù)據(jù)：

在這里插入圖片描述