Mybatis-BaseTypeHandler实现数据层数据加解密

需求:数据库保存的数据需要加密,然后查询的时候解密
解决方案:继承BaseTypeHandler,然后重写具体的set、get方法。本文加解密使用了Base64算法。

一、创建实体类

student

package org.spring.springboot.entity;

public class Student {
	private Integer id;
	private String name;
	private String course;
	private String score;

	@Override
	public String toString() {
		return "Student [id=" + id + ", name=" + name + ", course=" + course + ", score=" + score + "]";
	}

	public Integer getId() {
		return id;
	}

	public void setId(Integer id) {
		this.id = id;
	}

	public String getName() {
		return name;
	}

	public void setName(String name) {
		this.name = name;
	}

	public String getCourse() {
		return course;
	}

	public void setCourse(String course) {
		this.course = course;
	}

	public String getScore() {
		return score;
	}

	public void setScore(String score) {
		this.score = score;
	}
}

二、加密和解密工具类

AES、AESTypeHandler

package org.spring.springboot.controller;

import java.util.Base64;

public class AES {
	public static String encrypt(String src) {
		try {
			String result = Base64.getEncoder().encodeToString(src.getBytes("UTF-8"));
			return result;	
		} catch (Exception e) {
			throw new RuntimeException("encrypt fail!", e);
		}
	}

	public static String decrypt(String src) {
		try {
			 byte[] asBytes = Base64.getDecoder().decode(src);
		     String result = new String(asBytes,"UTF-8");
		     return result;
		} catch (Exception e) {
			throw new RuntimeException("decrypt fail!", e);
		}
	}
}
package org.spring.springboot.controller;

import java.sql.CallableStatement;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import org.apache.ibatis.type.BaseTypeHandler;
import org.apache.ibatis.type.JdbcType;

public class AESTypeHandler extends BaseTypeHandler<Object> {

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

	@Override
	public Object getNullableResult(ResultSet rs, String columnName) throws SQLException {
		String columnValue = rs.getString(columnName);
		return AES.decrypt(columnValue);
	}

	@Override
	public Object getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
		String columnValue = rs.getString(columnIndex);
		return AES.decrypt(columnValue);
	}
	
	@Override
	public String getNullableResult(CallableStatement cs, int columnIndex)
			throws SQLException {
		String columnValue = cs.getString(columnIndex);
		return AES.decrypt(columnValue);
	}
}

三、DAO层和Service层代码

指明一个类是 Mapper 有如下两种方式

1:是在具体的 Mapper 上添加 @Mapper 注解,表明该接口是一个 MyBatis 中的 Mapper。这种方式就是需要在每一个 Mapper 上都添加注解。
2:在主启动类上添加 @MapperScan(“com.example.demo.mapper”) 注解,表示扫描 com.example.demo.mapper 包下的所有接口作为 Mapper。这样就不需要在每个接口上配置 @Mapper 注解了。

StudentMapper

package org.spring.springboot.mapper;

import java.util.List;
import org.apache.ibatis.annotations.Mapper;
import org.spring.springboot.entity.Student;
import org.springframework.stereotype.Repository;

@Mapper
@Repository
public interface StudentMapper {
	//查询
    Student selectStudentById(int id);
    //新增
    boolean insertStudent(List<Student> student);
}

StudentService

package org.spring.springboot.service;

import java.util.ArrayList;
import java.util.List;
import org.spring.springboot.entity.Student;
import org.spring.springboot.entity.User;
import org.spring.springboot.mapper.StudentMapper;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
public class StudentService {
	
	@Autowired
	private StudentMapper studentMapper;
	
	//查询
	public Student selectStudentById(int id) {
		return studentMapper.selectStudentById(id);
	}
	
	//批量新增
    public boolean insertStudent() {
    	List<Student> list = new ArrayList<>();
    	for (int i = 0; i <2; i++) {
    		Student student = new Student();
    		student.setCourse(String.valueOf(i*10));
    		student.setName("刘"+i);
    		student.setScore(String.valueOf(i*10));
    		list.add(student);
        }
    	studentMapper.insertStudent(list);
        return true;
    }   
}

四、配置文件

StudentMapper.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="org.spring.springboot.mapper.StudentMapper">
   <resultMap id="StudentMapperResultMap" type="org.spring.springboot.entity.Student">
      <result column="id" jdbcType="INTEGER" property="id"></result>
      <result column="name" jdbcType="VARCHAR" property="name"></result>
      <result column="course" jdbcType="VARCHAR" property="course"></result>
      <!--加密列 score  -->
      <result column="score" jdbcType="VARCHAR" property="score" typeHandler="org.spring.springboot.controller.AESTypeHandler"></result>
   </resultMap>
   
   <select id="selectStudentById" resultMap="StudentMapperResultMap">
      select * from student where id = #{id}
   </select>
   
   <insert id="insertStudent" parameterType="org.spring.springboot.entity.Student"> 
      insert into student (id,name,course,score)  values
      <foreach collection="list" item="student" separator=",">
         <!--加密列 score  -->
         (#{student.id},#{student.name},#{student.course},#{student.score,typeHandler=org.spring.springboot.controller.AESTypeHandler}) 
      </foreach>
   </insert>
   
</mapper>

application.yml

server:
  port: 8086
 
spring:
  datasource:
    username: root
    password: root
    url: jdbc:mysql://10.*.*.*:3306/springboot?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=UTC
    driver-class-name: com.mysql.cj.jdbc.Driver
 
mybatis:
  mapper-locations: classpath:mapping/*Mapper.xml
  type-aliases-package: org.spring.springboot.entity

#showSql
logging:
  level:
    com:
      example:
        mapper : debug

五、执行结果

1.利用postman测试如下

1.1新增http://localhost:8086/StudentController/insertStudent
在这里插入图片描述
在这里插入图片描述
1.2查询http://localhost:8086/StudentController/selectById/5
在这里插入图片描述

六、代码地址及项目结构

下载地址,欢迎star!
springboot-typehandler
整体项目结构
在这里插入图片描述
参考文章
https://blog.youkuaiyun.com/qq_31289187/article/details/104761910
https://www.cnblogs.com/wangjuns8/p/8688815.html
https://blog.youkuaiyun.com/qq_37433657/article/details/105725020
https://blog.youkuaiyun.com/weixin_43430525/article/details/85783053

<think>嗯,用户想了解如何使用MyBatis-Plus 3.4的拦截器来实现敏感数据加密。我之前处理过类似的问题,记得MyBatis-Plus的拦截器可以用来在SQL执行前后进行自定义处理。首先,我需要确认用户提到的MyBatis-Plus版本是3.4,这可能涉及到特定的API,比如MetaObjectHandler或者自定义的TypeHandler。 根据引用[1],里面提到了自定义TypeHandler来实现加密解密逻辑,同时在配置中注册它,并在实体类中使用。这可能是一个关键点。不过用户提到的是拦截器,而TypeHandler通常用于类型转换,可能在数据写入和读取时处理加密解密。而拦截器比如InnerInterceptor可能用于更底层的SQL处理,比如分页或者乐观锁,如引用[5]中的例子。 但用户的问题明确提到“拦截器”,所以可能需要结合两种方法。例如,在插入或更新时,使用拦截器来拦截参数,并对其中的敏感字段进行加密。或者,可能需要在TypeHandler中处理加密,而拦截器用于某些其他操作,比如自动添加加密逻辑。 另外,引用[3]提到了元对象处理器接口,这可能是在插入或更新时自动填充某些字段,比如版本号。或许加密也可以在元对象处理器中处理,但需要确认是否适合。 步骤可能包括:定义加密服务接口,创建自定义TypeHandler,在实体类中指定该TypeHandler,并在MyBatis配置中注册。同时,可能需要在拦截器中处理参数,比如在更新或插入前加密数据,查询后解密数据。或者,使用TypeHandler在数据写入数据库前加密,读取时解密,这样拦截器可能不需要处理具体的加密逻辑,而是TypeHandler自动处理。 需要确保加密逻辑在数据持久化时自动应用。例如,在实体类的字段上使用@TableField(typeHandler = EncryptTypeHandler.class),这样MyBatis-Plus在读写该字段时会自动调用TypeHandler的setParameter和getResult方法,从而进行加密和解密。 同时,参考引用[5]中的配置类,用户可能需要添加自定义的拦截器,但可能更直接的是使用TypeHandler。不过用户明确提到拦截器,可能需要澄清是否必须使用拦截器,或者TypeHandler是否足够。或者,拦截器用于更复杂的场景,比如全局处理所有敏感字段,而无需在每个字段上标注TypeHandler。 可能需要分步骤来:首先实现加密解密的逻辑,然后通过TypeHandler或拦截器来应用。根据引用[1]的步骤,自定义TypeHandler可能更直接。但用户的问题提到拦截器,所以可能需要结合两者,或者说明拦截器的另一种实现方式。 例如,可以创建一个实现InnerInterceptor接口的拦截器,重写beforePrepare方法,在参数设置前进行加密,在结果处理时进行解密。不过这可能比较复杂,需要处理不同的SQL操作类型,如INSERT、UPDATE、SELECT等。 总结可能的步骤:1. 创建加密工具类;2. 自定义TypeHandler处理字段级别的加密;3. 在实体类中使用该TypeHandler;4. 注册TypeHandler到MyBatis配置。或者,使用拦截器在SQL执行前后处理参数和结果集。 需要查阅MyBatis-Plus的文档,确认拦截器和TypeHandler的最佳实践。根据现有引用,引用[1]使用TypeHandler,而引用[5]使用拦截器处理乐观锁和分页。因此,可能两者都可以,但TypeHandler更适合字段级别的处理,而拦截器更适合全局处理或更复杂的逻辑。 因此,回答应该结合引用[1]中的步骤,使用TypeHandler实现加密解密,并可能提到拦截器的其他用途,或者如何结合拦截器进行更高级的处理。但用户的问题是关于拦截器的实现方式,可能需要调整方法,或者说明TypeHandler是更合适的解决方案,而拦截器可能用于其他方面。 可能的混淆点:TypeHandler和拦截器的不同作用。TypeHandler用于处理单个字段的Java类型到JDBC类型的转换,适合加密解密单个字段。拦截器可以拦截整个SQL语句,处理参数和结果集,适合更广泛的操作,比如全局加密多个字段,或者根据条件动态处理。 因此,正确的实现方式可能是使用TypeHandler处理字段级别的加密,如引用[1]所述,而拦截器可能用于更复杂的场景。但用户的问题明确询问拦截器,所以可能需要解释如何通过拦截器来实现,或者指出TypeHandler是更常见的方法,而拦截器可以辅助其他处理。 最终,可能需要按照引用[1]的方法,使用TypeHandler,并在回答中说明这是MyBatis-Plus推荐的字段级加密方式,同时可能提及拦截器可以用于其他方面的增强,如自动触发加密逻辑,或者在特定操作前后进行处理。</think>### 如何使用 MyBatis-Plus 3.4 拦截器实现敏感数据加密? #### 实现步骤 1. **定义加密解密工具类** 实现对称加密(如 AES)或非对称加密算法,提供加密和解密方法。例如: ```java public class EncryptUtils { public static String encrypt(String data) { /* 加密逻辑 */ } public static String decrypt(String encryptedData) { /* 解密逻辑 */ } } ``` 2. **创建自定义 TypeHandler** 继承 `BaseTypeHandler`,在数据写入数据库前加密,读取时解密。这是字段级加密的核心逻辑[^1]。 ```java public class EncryptTypeHandler extends BaseTypeHandler<String> { @Override public void setNonNullParameter(PreparedStatement ps, int i, String parameter, JdbcType jdbcType) { ps.setString(i, EncryptUtils.encrypt(parameter)); } @Override public String getNullableResult(ResultSet rs, String columnName) { return EncryptUtils.decrypt(rs.getString(columnName)); } // 其他重写方法... } ``` 3. **实体类标注 TypeHandler** 在敏感字段上使用 `@TableField` 注解绑定自定义 TypeHandler: ```java public class User { @TableField(typeHandler = EncryptTypeHandler.class) private String phoneNumber; // 其他字段... } ``` 4. **注册 TypeHandler** 在 MyBatis 配置文件中添加 TypeHandler 的全局注册: ```xml <typeHandlers> <typeHandler handler="com.example.EncryptTypeHandler" javaType="java.lang.String"/> </typeHandlers> ``` 5. **通过拦截器增强控制(可选)** 若需全局拦截 SQL 操作(如记录加密日志),可自定义拦截器实现 `InnerInterceptor`: ```java public class EncryptInterceptor implements InnerInterceptor { @Override public void beforePrepare(StatementHandler sh, Connection conn, Integer transactionTimeout) { // 拦截参数并处理敏感数据(需结合反射或 MetaObject 修改字段值) } } ``` 在配置类中注册拦截器: ```java @Bean public MybatisPlusInterceptor mybatisPlusInterceptor() { MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor(); interceptor.addInnerInterceptor(new EncryptInterceptor()); return interceptor; } ``` #### 核心逻辑说明 - **TypeHandler 作用**:直接关联字段的读写操作,自动触发加密/解密[^1]。 - **拦截器适用场景**:补充全局操作(如审计日志),但字段级加密优先使用 TypeHandler[^5]。 #### 注意事项 - 加密字段需避免参与索引查询,否则需实现模糊加密(如哈希处理)。 - 加解密可能影响性能,建议仅对高敏感字段(如手机号、身份证号)使用。 ---
评论 4
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值