在MyBatis-Plus中实现字段加密与解密

最新推荐文章于 2025-04-30 14:30:18 发布

谢谢蟹黄堡

最新推荐文章于 2025-04-30 14:30:18 发布

阅读量2.3k

点赞数 5

文章标签： mybatis 加解密

本文链接：https://blog.youkuaiyun.com/qq_38978882/article/details/135385792

版权

在MyBatis-Plus中实现字段加密与解密通常涉及以下步骤：

定义加密解密服务：首先，你需要定义一个服务来处理加密和解密的逻辑。
创建自定义TypeHandler：然后，你需要创建一个自定义的TypeHandler来使用这个服务来加密和解密数据。
配置MyBatis-Plus：将自定义的TypeHandler配置到MyBatis-Plus中。
使用TypeHandler：在你的实体类中使用自定义的TypeHandler。
执行写入和查询操作：使用MyBatis-Plus的通常方法来执行写入和查询操作。

以下是详细的步骤和示例：

步骤 1: 定义加密解密服务

public interface CryptoService {
    String encrypt(String input);
    String decrypt(String encrypted);
}

public class AesCryptoServiceImpl implements CryptoService {

    // 用于加密和解密的密钥
    private static final String SECRET_KEY = "your-secret-key";

    @Override
    public String encrypt(String input) {
        // 实现加密逻辑
        // ...
    }

    @Override
    public String decrypt(String encrypted) {
        // 实现解密逻辑
        // ...
    }
}

步骤 2: 创建自定义TypeHandler

import org.apache.ibatis.type.JdbcType;
import org.apache.ibatis.type.TypeHandler;

import java.sql.CallableStatement;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;

public class EncryptTypeHandler implements TypeHandler<String> {

    private final CryptoService cryptoService;

    public EncryptTypeHandler() {
        this.cryptoService = new AesCryptoServiceImpl(); // Or inject it if using Spring or similar
    }

    @Override
    public void setParameter(PreparedStatement ps, int i, String parameter, JdbcType jdbcType) throws SQLException {
        ps.setString(i, cryptoService.encrypt(parameter));
    }

    @Override
    public String getResult(ResultSet rs, String columnName) throws SQLException {
        return cryptoService.decrypt(rs.getString(columnName));
    }

    @Override
    public String getResult(ResultSet rs, int columnIndex) throws SQLException {
        return cryptoService.decrypt(rs.getString(columnIndex));
    }

    @Override
    public String getResult(CallableStatement cs, int columnIndex) throws SQLException {
        return cryptoService.decrypt(cs.getString(columnIndex));
    }
}

步骤 3: 配置MyBatis-Plus

在mybatis-config.xml中注册TypeHandler：

<typeHandlers>
    <typeHandler handler="com.yourpackage.EncryptTypeHandler"/>
</typeHandlers>

或者如果你使用Java配置：

@Bean
public MybatisSqlSessionFactoryBean sqlSessionFactory() throws IOException {
    MybatisSqlSessionFactoryBean sqlSessionFactory = new MybatisSqlSessionFactoryBean();
    // ...其他配置
    sqlSessionFactory.setTypeHandlers(new TypeHandler[]{new EncryptTypeHandler()});
    return sqlSessionFactory;
}

步骤 4: 使用TypeHandler

在你的实体类中指定字段使用自定义TypeHandler：

import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableName;

@TableName(value = "user",autoResultMap = true)
public class User {
    // ...其他字段

    @TableField(typeHandler = EncryptTypeHandler.class)
    private String sensitiveData;

    // ...getters and setters
}

步骤 5: 执行写入和查询操作

写入操作：

User user = new User();
user.setSensitiveData("Some sensitive data");

userMapper.insert(user); // sensitiveData字段将自动加密

查询操作：

User user = userMapper.selectById(1);
System.out.println(user.getSensitiveData()); // sensitiveData字段将自动解密

确保在实际部署中使用安全的密钥管理策略，不要将密钥硬编码在代码中，而应该使用环境变量或密钥管理服务来存储密钥。加密和解密逻辑应该能够抵御常见的安全威胁，并且遵循最佳安全实践。