Spring Boot中整合Jasypt 使用自定义注解+AOP实现敏感字段的加解密

码农世界 2024-06-08 后端 84 次浏览 0个评论

😄 19年之后由于某些原因断更了三年，23年重新扬帆起航，推出更多优质博文，希望大家多多支持～
🌷 古之立大事者，不惟有超世之才，亦必有坚忍不拔之志
🎐 个人CSND主页——Micro麦可乐的博客
🐥《Docker实操教程》专栏以最新的Centos版本为基础进行Docker实操教程，入门到实战
🌺《RabbitMQ》本专栏主要介绍使用JAVA开发RabbitMQ的系列教程，从基础知识到项目实战
🌸《设计模式》专栏以实际的生活场景为案例进行讲解，让大家对设计模式有一个更清晰的理解
💕《Jenkins实战》专栏主要介绍Jenkins+Docker+Git+Maven的实战教程，让你快速掌握项目CI/CD，是2024年最新的实战教程
如果文章能够给大家带来一定的帮助！欢迎关注、评论互动～

Spring Boot中整合Jasypt 使用自定义注解+AOP实现敏感字段的加解密

前言
开始接入

步骤一：添加依赖
步骤二：配置Jasypt
步骤三：创建自定义注解
步骤四：创建AOP切面
步骤四：创建示例实体类
步骤五：创建测试Controller
步骤六：验证功能

结语

前言

在博主前面一篇文章中，相信小伙伴对 Spring Boot 中整合 Jasypt 以及加解密的方法有了一定的了解，没看过的小伙伴可以访问【Spring Boot整合Jasypt 库实现配置文件和数据库字段敏感数据的加解密】一起探讨。

本章节我们针对 Jasypt 来做一些升级的玩法，使用自定义注解 + AOP 来实现敏感字段的加解密。

开始接入

步骤一：添加依赖

首先构建我们的 Spring Boot 项目, 引入相关依赖 Jasypt 和 Spring AOP 的依赖


    org.springframework.boot
    spring-boot-starter-web


    org.springframework.boot
    spring-boot-starter-aop


    com.github.ulisesbocchio
    jasypt-spring-boot-starter
    3.0.5

步骤二：配置Jasypt

这里博主复用了上一篇教程的配置，如果你希望更深入的了解 YML配置和各项配置的说明，可以访问

【Spring Boot整合Jasypt 库实现配置文件和数据库字段敏感数据的加解密】

import com.ulisesbocchio.jasyptspringboot.annotation.EnableEncryptableProperties;
import org.jasypt.encryption.StringEncryptor;
import org.jasypt.encryption.pbe.PooledPBEStringEncryptor;
import org.jasypt.encryption.pbe.config.SimpleStringPBEConfig;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
@EnableEncryptableProperties
public class StringEncryptorConfig {
    @Bean("jasyptStringEncryptor")
    public StringEncryptor stringEncryptor() {
        PooledPBEStringEncryptor encryptor = new PooledPBEStringEncryptor();
        SimpleStringPBEConfig config = new SimpleStringPBEConfig();
        config.setPassword("password");
        config.setAlgorithm("PBEWITHHMACSHA512ANDAES_256");
        config.setKeyObtentionIterations("1000");
        config.setPoolSize("1");
        config.setProviderName("SunJCE");
        config.setSaltGeneratorClassName("org.jasypt.salt.RandomSaltGenerator");
        config.setIvGeneratorClassName("org.jasypt.iv.RandomIvGenerator");
        config.setStringOutputType("base64");
        encryptor.setConfig(config);
        return encryptor;
    }
}

步骤三：创建自定义注解

接下来，我们创建两个自定义注解，用于标记需要加解密的字段以及方法

举个例子

前端传递后端某些值需要加密入库（需要方法注解是加密）
后端返回前端某些值需要解密显示（需要方法注解是解密）

定义一个作用在字段的注解

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface JasyptField {
}

定义一个作用在方法上的注解

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface JasyptMethod {
    String value() default "ENC"; //ENC：加密 DEC：解密
}

步骤四：创建AOP切面

创建一个AOP切面，主要思路是找到方法上标注了 JasyptMethod 注解且定义枚举类型是加密还是解密，获取到对应参数 joinPoint.getArgs() 在进行加密或是获取返回对象解密，无论加密解密最后调用 proceed(Object[] args) 方法改变值

需要注意处理的问题
1、获取参数如果是字符串，直接加密字符串
2、获取参数是对象，则通过反射获取对象字段上@JasyptField注解的字段进行加密；
3、获取参数是集合，需要循环上一步骤操作
4、解密返回对象同样需要处理字符串、对象、集合操作
注意看代码解释！注意看代码解释！注意看代码解释！

import lombok.SneakyThrows;
import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.jasypt.encryption.StringEncryptor;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.stereotype.Component;
import java.lang.reflect.Field;
import java.util.List;
@Aspect
@Component
@Slf4j
public class JasyptAspect {
    //注入加密类
    private final StringEncryptor stringEncryptor;
    // jasyptStringEncryptor 配置类中定义的名称
    public JasyptAspect(@Qualifier("jasyptStringEncryptor") StringEncryptor stringEncryptor) {
        this.stringEncryptor = stringEncryptor;
    }
    @Pointcut("@annotation(JasyptMethod)")
    public void pointCut() {
    }
    @SneakyThrows
    @Around("pointCut())")
    public Object jasyptAround(ProceedingJoinPoint joinPoint) {
        Object proceed;
        //获取注解类
        JasyptMethod jasyptMethod = ((MethodSignature) joinPoint.getSignature()).getMethod().getAnnotation(JasyptMethod.class);
        //获取注解传递值
        String value = jasyptMethod.value();
        //获取参数
        Object[] args = joinPoint.getArgs();
        // 这里可以定义常量或枚举判断，博主就直接判断了
        if(value.equals("ENC")){
            for(int i=0 ; i < args.length ; i++){
                // 判断字符串还是对象
                if(args[i] instanceof String) {
                    args[i] = stringEncryptor.encrypt(String.valueOf(args[i]));
                }else {
                    //对象 还分集合还是单个对象
                    boolean isList = (args[i] instanceof List);
                    handlerArgs(args[i], value, isList);
                }
            }
            proceed = joinPoint.proceed(args);
        }else{
            proceed = joinPoint.proceed();
            // 判断字符串还是对象
            if(proceed instanceof String) {
                proceed = stringEncryptor.decrypt(String.valueOf(proceed));
            }else {
                //对象 还分集合还是单个对象
                boolean isList = (proceed instanceof List);
                handlerArgs(proceed, value, isList);
            }
        }
        return proceed;
    }
    /**
     * 处理对象加解密
     * @param obj 参数对象
     * @param value 加解密值
     * @param isList 是否集合
     */
    private void handlerArgs(Object obj , String value , boolean isList){
        if(isList){
            List