使用Spring Boot AOP处理方法的入参和返回值

前言

IOC和AOP是Spring 中最重要的两个模块。这里练习一下如何使用Spring Boot AOP处理方法的入参和返回值。

Spring AOP的简单介绍：

AOP(Aspect-Oriented Programming）面向切面编程，通过预编译方式和运行期动态代理实现程序功能的统一维护的一种技术。AOP能够将那些与业务⽆关，却为业务模块所共同调⽤的逻辑或责任（例如事务处理、⽇志管理、权限控制等）封装起来，便于减少系统的重复代码，降低模块间的耦合度，并有利于提高系统的可拓展性和可维护性。

Spring AOP就是基于动态代理的，如果要代理的对象，实现了某个接⼝，那么Spring AOP会使⽤JDK代理，去创建代理对象，⽽对于没有实现接⼝的对象，就⽆法使⽤ JDK代理去进⾏代理了，这时候Spring AOP会使⽤Cglib ，这时候Spring AOP会使⽤ Cglib代理 ⽣成⼀个被代理对象的⼦类来作为代理，如下图所示：

一篇详细介绍AOP的文章：细说Spring——AOP详解（AOP概览）

1. 需求场景

前段时间实习，遇到了一个需求是这样的：项目上线前，项目经理要求有一个用户私密信息的字段需要在数据库中加密存储，从数据库读取出来后需要解密，正常显示到用户界面中。

下面的DEMO中，模拟场景项目经理突然觉得这个用户的身份证号是用户隐私需要进行加密保存，保护用户的隐私，User类定义如下：

public class User {
    private Integer id;
    private String username;
    private String password;
    private String identityNum;
    //省略getter、setter、toString方法
}

2. 解决方案

因为是临时加的需求，考虑到多个实体类中都会有identityNum属性，为了不侵入原本的业务代码和数据处理代码和业务代码的解耦，一个比较好的方案是使用Spring AOP处理，以DAO层方法做切点，处理字段的加密解密。

3. 代码实现

下面使用Spring Boot+MyBatis实现DEMO，模拟上述场景和解决方案实现。

Controller层UserController类的代码：

@RestController
@RequestMapping("/users")
public class UserController {
    @Autowired
    UserService userService;
    @GetMapping
    public List<User> getAllUsers(){
        return userService.getAllUsers();
    }
    @PostMapping
    public void save(@RequestBody User user){
        userService.save(user);
    }
}

Service层UserService类代码：

@Service
public class UserService {
    @Autowired
    UserDao userDao;
    public List<User> getAllUsers() {
        return userDao.getAllUsers();
    }
    public void save(User user) {
        userDao.save(user);
    }
}

Dao层UserDao接口实现：

@Mapper
public interface UserDao {
    List<User> getAllUsers();
    void save(@Param("user") User user);
}

UserMapper.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="top.javahai.springbootdemo.dao.UserDao">
    <insert id="save">
        insert into user values (#{user.id},#{user.username},#{user.password},#{user.identityNum})
    </insert>
    <select id="getAllUsers" resultType="top.javahai.springbootdemo.entity.User">
        select id,username,password,identity_num as identityNum  from user
    </select>
</mapper>

切面类UserInfoHandler实现如下，这里只是使用字符串截取的方法模拟加密代码，使用环绕通知@Around注解实现。

@Aspect
@Component
public class UserInfoHandler {
    @Pointcut("execution(* top.javahai.springbootdemo.dao.UserDao.*(..))")
    public void pointcut(){
    }
    @Around("pointcut()")
    public Object logAround(ProceedingJoinPoint joinPoint) throws Throwable {
        //处理方法参数，如果是User就进行加密处理
        Object[] args = joinPoint.getArgs();
        for (Object arg : args) {
            if (arg instanceof List){
                if (((List) arg).get(0) instanceof User){
                    ((List<User>) arg).forEach(user->{
                        user.setIdentityNum("encode"+user.getIdentityNum());
                    });
                }
            }
            if (arg instanceof User){
                String identityNum = ((User) arg).getIdentityNum();
                ((User) arg).setIdentityNum("encode"+identityNum);
            }
        }
        //执行方法，获取返回值
        Object obj = joinPoint.proceed();
        //处理方法返回值
        if (obj instanceof List){
            if (!((List) obj).isEmpty()){
                if (((List) obj).get(0) instanceof User){
                    ((List<User>) obj).forEach(data->{
                        data.setIdentityNum(data.getIdentityNum().substring(6));
                    });
                }
            }
        }
        return obj;
    }
}

如果是在其他实体类中也存在identityNum身份证字段，则需要在@PointCut中定义多个切点，另外处理的地方需要添加多个判断。定义多个切点：

    @Pointcut("execution(* top.javahai.springbootdemo.dao.UserDao.*(..)) ||" +
            "execution(* top.javahai.springbootdemo.dao.ResumeDao.*(..))")
    public void pointcut(){}

4. 测试

通过http://localhost:8080/users接口，将保存一个新的用户数据到数据库中

查看数据库的存储：

取出所有的用户数据：

从测试结果可以看到代码可以正确的处理方法的入参和返回值。

以上为个人经验，希望能给大家一个参考，也希望大家多多支持我们。