springboot aop方式实现接口入参校验的示例代码

 更新时间:2023年08月24日 14:58:06   作者:夜空下的星  
在实际开发项目中,我们常常需要对接口入参进行校验,本文主要介绍了springboot aop方式实现接口入参校验的示例代码,具有一定的参考价值,感兴趣的可以了解一下

一、前言

在实际开发项目中,我们常常需要对接口入参进行校验,如果直接在业务代码中进行校验,则会显得代码非常冗余,也不够优雅,那么我们可以使用aop的方式校验,这样则会显得更优雅。

二、如何实现?

1.添加maven依赖

<dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

2.定义一个工具类ValidationUtil

import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import javax.servlet.http.HttpServletRequest;
import javax.validation.ConstraintViolation;
import javax.validation.Validation;
import javax.validation.Validator;
import javax.validation.ValidatorFactory;
import java.util.ArrayList;
import java.util.List;
import java.util.Set;
public class ValidationUtil {
    private static ValidationUtil util;
    private Validator validator;
    public ValidationUtil() {
        // TODO Auto-generated constructor stub
        ValidatorFactory factory = Validation.buildDefaultValidatorFactory();
        this.validator = factory.getValidator();
    }
/**
     * @return the validator
     */
    public Validator getValidator() {
        return validator;
    }
    public static ValidationUtil getValidationUtil() {
        if (util == null) {
            util = new ValidationUtil();
        }
        return util;
    }
    public static List<CheckErrorResultDto> validate(Object o) {
        Set<ConstraintViolation<Object>> set = ValidationUtil
                .getValidationUtil().getValidator().validate(o);
        List<CheckErrorResultDto> errorList = null;
        HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder
                .getRequestAttributes()).getRequest();
        for (ConstraintViolation<Object> cv : set) {
            if (errorList == null) {
                errorList = new ArrayList<CheckErrorResultDto>();
            }
            String message = MessageResolver.getMessage(request,
                    cv.getMessage());
            errorList.add(new CheckErrorResultDto(cv.getPropertyPath()
                    .toString(), message));
        }
        return errorList;
    }
    public static List<CheckErrorResultDto> validate(Object o,Class<?> ...c) {
        Set<ConstraintViolation<Object>> set = ValidationUtil
                .getValidationUtil().getValidator().validate(o,c);
        List<CheckErrorResultDto> errorList = null;
        HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder
                .getRequestAttributes()).getRequest();
        for (ConstraintViolation<Object> cv : set) {
            if (errorList == null) {
                errorList = new ArrayList<CheckErrorResultDto>();
            }
            String message = MessageResolver.getMessage(request,
                    cv.getMessage());
            errorList.add(new CheckErrorResultDto(cv.getPropertyPath()
                    .toString(), message));
        }
        return errorList;
    }

3.校验错误信息实体类。

import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class CheckErrorResultDto {
    private String fieldName;
    private String msg;
}

4.编写校验AOP

import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.context.annotation.EnableAspectJAutoProxy;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.List;
@Order(1)
@Aspect
@Component
@EnableAspectJAutoProxy(exposeProxy=true)
public class ValidAop {
    /**
     * 校验传入实体
     *
     * @param pjp
     * @throws Throwable
     */
    @Around("@annotation(com.smartcitysz.dp.dataasset.aop.annotation.Valid)")
    public Object aroundExec(ProceedingJoinPoint pjp) throws Throwable {
        MethodSignature ms = (MethodSignature) pjp.getSignature();
        Method method = ms.getMethod();
        Valid annotation = method.getAnnotation(Valid.class);
        if (annotation != null) {
            List<CheckErrorResultDto> errorList=new ArrayList<CheckErrorResultDto>();
            Object[] args=pjp.getArgs();
            Class<?>[] checkToken = annotation.value();
            Class<?>[] group = annotation.group();
            for (Class c : checkToken) {
                for (Object obj : args) {
                    if (c == obj.getClass()) {
                        List<CheckErrorResultDto> result=null;
                        if(group.length<1){
                            result= ValidationUtil.validate(obj);
                        }else{
                            result= ValidationUtil.validate(obj,group);
                        }
                        if(result!=null)
                            errorList.addAll(result);
                    }
                }
            }
            if(errorList.size()>0){
                ResponseData vo=new ResponseData();
                vo.setCode(ApiCodeEnum.ILLEGAL_PARAMETER.getCode());
                vo.setMsg(ApiCodeEnum.ILLEGAL_PARAMETER.getMsg());
                vo.setData(errorList);
                return vo;
            }
        }
        return pjp.proceed();
    }
}

5.定义一个校验注解Valid

import java.lang.annotation.*;
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Valid {
    Class<?>[] value() default {};
    Class<?>[] group() default {};
}

6.最后在Controller定义的接口上加上注解指定要校验的对象即可。

到此这篇关于springboot aop方式实现接口入参校验的示例代码的文章就介绍到这了,更多相关springboot aop接口入参校验内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • matplotlib 向任意位置添加一个子图(axes)

    matplotlib 向任意位置添加一个子图(axes)

    这篇文章主要介绍了matplotlib 向任意位置添加一个子图(axes),文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2021-04-04
  • python安装第三方包的三种方法图文详解

    python安装第三方包的三种方法图文详解

    安装Python第三方包有多种方法,下面这篇文章主要给大家介绍了关于python安装第三方包的三种方法,文中通过图文的非常详细,需要的朋友可以参考下
    2024-03-03
  • Python实现删除重复视频文件的方法详解

    Python实现删除重复视频文件的方法详解

    这篇文章主要为大家详细介绍了如何利用Python实现删除重复视频文件功能,文中的示例代码讲解详细,对我们学习Python有一定帮助,需要的可以参考一下
    2022-10-10
  • Python 3.x 新特性及10大变化

    Python 3.x 新特性及10大变化

    这篇文章主要介绍了Python 3.x 新特性及10大变化,本文讲解了Python之父Guido van Rossum谈到了Python 3.0的构思,Python3版本的一些变化如print() and exec() 函数、整数及除法、input()代替raw_input()等,需要的朋友可以参考下
    2015-06-06
  • Python序列操作之进阶篇

    Python序列操作之进阶篇

    序列sequence是python中最基本的数据结构,本文是Python序列操作的进阶篇,本文先对序列做一个简单的概括,之后将详细讲解下关于序列的操作方法。文中通过示例代码介绍的很详细,有需要的朋友们可以参考借鉴,下面来一起看看吧。
    2016-12-12
  • 用OpenCV将视频分解成单帧图片,图片合成视频示例

    用OpenCV将视频分解成单帧图片,图片合成视频示例

    今天小编就为大家分享一篇用OpenCV将视频分解成单帧图片,图片合成视频示例,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2019-12-12
  • 浅谈python函数之作用域(python3.5)

    浅谈python函数之作用域(python3.5)

    下面小编就为大家带来一篇浅谈python函数之作用域(python3.5)。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-10-10
  • Python魔法方法 容器部方法详解

    Python魔法方法 容器部方法详解

    这篇文章主要介绍了Python魔法方法 容器部方法详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-01-01
  • python读取几个G的csv文件方法

    python读取几个G的csv文件方法

    今天小编就为大家分享一篇python读取几个G的csv文件方法,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2019-01-01
  • 图文详解Python如何导入自己编写的py文件

    图文详解Python如何导入自己编写的py文件

    有时候自己写了一个py文件,想要把它导入到另一个py文件里面,所以下面这篇文章主要给大家介绍了关于Python如何导入自己编写的py文件的相关资料,需要的朋友可以参考下
    2021-11-11

最新评论