扔掉工具类！MyBatis 一个简单配置搞定加密、解密，不能太方便了～！("MyBatis轻松配置实现加密解密，无需工具类，便捷高效！")

原创

ithorizon 6个月前 (10-21) 阅读数 28 #后端开发

MyBatis轻松配置实现加密解密，无需工具类，便捷高效！

一、引言

在Java开发中，数据加密和解密是保护数据可靠的重要手段。MyBatis 作为一款优秀的持久层框架，其提供了灵活的配置方案来实现加密和解密功能。本文将介绍怎样通过简洁的配置，在MyBatis中实现加密和解密，无需编写额外的工具类，让开发更加便捷高效。

二、加密解密需求背景

在实际项目中，我们大概会遇到需要对敏感数据进行加密和解密的需求，如用户密码、银行卡号等。为了确保数据可靠，我们通常会在数据库层面进行加密存储，而在应用层面进行解密操作。MyBatis 提供了 TypeHandler 接口，可以让我们自定义类型转换器，从而实现加密和解密功能。

三、MyBatis 实现加密解密的步骤

下面将详细介绍怎样在 MyBatis 中实现加密和解密，重点包括以下步骤：

1. 创建自定义加密解密工具类

虽然标题中提到不需要工具类，但这里我们仍然需要创建一个简洁的加密解密工具类，用于实现加密和解密算法。以下是一个简洁的AES加密解密工具类示例：


import javax.crypto.Cipher;
import javax.crypto.KeyGenerator;
import javax.crypto.SecretKey;
import javax.crypto.spec.SecretKeySpec;
import java.util.Base64;
public class AESUtil {
    private static final String ALGORITHM = "AES";
    private static final int KEY_SIZE = 128;
    public static String encrypt(String data, String key) throws Exception {
        KeyGenerator keyGenerator = KeyGenerator.getInstance(ALGORITHM);
        keyGenerator.init(KEY_SIZE);
        byte[] keyBytes = key.getBytes();
        SecretKey secretKey = new SecretKeySpec(keyBytes, ALGORITHM);
        Cipher cipher = Cipher.getInstance(ALGORITHM);
        cipher.init(Cipher.ENCRYPT_MODE, secretKey);
        byte[] encryptedBytes = cipher.doFinal(data.getBytes());
        return Base64.getEncoder().encodeToString(encryptedBytes);
    }
    public static String decrypt(String encryptedData, String key) throws Exception {
        KeyGenerator keyGenerator = KeyGenerator.getInstance(ALGORITHM);
        keyGenerator.init(KEY_SIZE);
        byte[] keyBytes = key.getBytes();
        SecretKey secretKey = new SecretKeySpec(keyBytes, ALGORITHM);
        Cipher cipher = Cipher.getInstance(ALGORITHM);
        cipher.init(Cipher.DECRYPT_MODE, secretKey);
        byte[] decryptedBytes = cipher.doFinal(Base64.getDecoder().decode(encryptedData));
        return new String(decryptedBytes);
    }
}

2. 创建自定义 TypeHandler

接下来，我们需要创建一个自定义的 TypeHandler，用于在 MyBatis 中进行加密和解密操作。以下是一个自定义的AES加密解密 TypeHandler 示例：


import org.apache.ibatis.type.BaseTypeHandler;
import org.apache.ibatis.type.JdbcType;
import java.sql.CallableStatement;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
public class AESTypeHandler extends BaseTypeHandler {
    private static final String ENCRYPTION_KEY = "your_encryption_key";
    @Override
    public void setNonNullParameter(PreparedStatement ps, int i, String parameter, JdbcType jdbcType) throws SQLException {
        try {
            String encryptedData = AESUtil.encrypt(parameter, ENCRYPTION_KEY);
            ps.setString(i, encryptedData);
        } catch (Exception e) {
            throw new SQLException("Error encrypting data", e);
        }
    }
    @Override
    public String getNullableResult(ResultSet rs, String columnName) throws SQLException {
        try {
            String encryptedData = rs.getString(columnName);
            return AESUtil.decrypt(encryptedData, ENCRYPTION_KEY);
        } catch (Exception e) {
            throw new SQLException("Error decrypting data", e);
        }
    }
    @Override
    public String getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
        try {
            String encryptedData = rs.getString(columnIndex);
            return AESUtil.decrypt(encryptedData, ENCRYPTION_KEY);
        } catch (Exception e) {
            throw new SQLException("Error decrypting data", e);
        }
    }
    @Override
    public String getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
        try {
            String encryptedData = cs.getString(columnIndex);
            return AESUtil.decrypt(encryptedData, ENCRYPTION_KEY);
        } catch (Exception e) {
            throw new SQLException("Error decrypting data", e);
        }
    }
}

3. 配置 MyBatis 映射文件

在 MyBatis 的映射文件中，我们需要为需要加密和解密的字段指定自定义的 TypeHandler。以下是一个示例：


<resultMap id="userResultMap" type="User">
    <id column="id" property="id" />
    <result column="username" property="username" />
    <result column="password" property="password" typeHandler="com.example.AESTypeHandler" />
</resultMap>

4. 测试加密解密效果

完成以上配置后，我们可以进行测试，确保加密和解密功能按预期工作。以下是一个简洁的测试类示例：


import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
public class MyBatisEncryptionTest {
    public static void main(String[] args) {
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build();
        try (SqlSession session = sqlSessionFactory.openSession()) {
            UserMapper userMapper = session.getMapper(UserMapper.class);
            User user = userMapper.selectById(1);
            System.out.println("Decrypted password: " + user.getPassword());
        }
    }
}