Springboot 使用自定义注解结合AOP方式校验接口参数

简介: Springboot 使用自定义注解结合AOP方式校验接口参数
aspectjrt
1.8.9
com.alibaba
fastjson
1.2.58
org.springframework.boot
spring-boot-starter-web
新建自定义注解,ParamCheck.java :
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
• @Author : JCccc
• @CreateTime : 2020/5/14
• @Description :
**/
@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
public @interface ParamCheck {
/**
• 是否非空,默认不能为空
*/
boolean notNull() default true;
/**
• 默认值
• @return
*/
String defaultValue() default “”;
}

简单描述:

ElementType.PARAMETER 使用于参数
boolean notNull() default true; 要求参数不为空,默认开启,可以自己传
String defaultValue() default “”; 默认值,默认设置 “”,可以自己传
接下来新建 参数校验的AOP实现类,ParamValidAop.java:
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.*;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.stereotype.Component;
import org.springframework.util.StringUtils;
import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
/**
• @Author : JCccc
• @CreateTime : 2020/5/14
• @Description :
**/
@Component
@Aspect
public class ParamValidAop {
/**
• 定义有一个切入点,范围为web包下的类
*/
@Pointcut(“execution(public * com.bsapple.vshop.controller….(…))”)
public void checkParam() {
}
@Before(“checkParam()”)
public void doBefore(JoinPoint joinPoint) {
}
/**
• 检查参数是否为空
*/
@Around(“checkParam()”)
public Object doAround(ProceedingJoinPoint pjp) throws Throwable {
MethodSignature signature = ((MethodSignature) pjp.getSignature());
//得到拦截的方法
Method method = signature.getMethod();
//获取方法参数注解,返回二维数组是因为某些参数可能存在多个注解
Annotation[][] parameterAnnotations = method.getParameterAnnotations();
if (parameterAnnotations == null || parameterAnnotations.length == 0) {
return pjp.proceed();
}
//获取方法参数名
String[] paramNames = signature.getParameterNames();
//获取参数值
Object[] paranValues = pjp.getArgs();
//获取方法参数类型
Class<?>[] parameterTypes = method.getParameterTypes();
for (int i = 0; i < parameterAnnotations.length; i++) {
for (int j = 0; j < parameterAnnotations[i].length; j++) {
//如果该参数前面的注解不为空并且是ParamCheck的实例,并且notNull()=true,并且默认值为空,则进行非空校验
if (parameterAnnotations[i][j] != null && parameterAnnotations[i][j] instanceof ParamCheck && ((ParamCheck) parameterAnnotations[i][j]).notNull() && StringUtils.isEmpty(((ParamCheck)parameterAnnotations[i][j]).defaultValue())) {
paramIsNull(paramNames[i], paranValues[i], parameterTypes[i] == null ? null : parameterTypes[i].getName());
break;
}
//如果该参数前面的注解不为空并且是ParamCheck的实例,并且默认值不为空,并且参数值为空,则进行赋默认值
if(parameterAnnotations[i][j] != null && parameterAnnotations[i][j] instanceof ParamCheck && !StringUtils.isEmpty(((ParamCheck)parameterAnnotations[i][j]).defaultValue()) && (paranValues[i] == null || StringUtils.isEmpty(paranValues[i].toString()))){
paranValues[i] = putParam(((ParamCheck)parameterAnnotations[i][j]).defaultValue(), parameterTypes[i]);
}
}
}
return pjp.proceed(paranValues);
}
/**
• 在切入点return内容之后切入内容(可以用来对处理返回值做一些加工处理)
• @param joinPoint
*/
@AfterReturning(“checkParam()”)
public void doAfterReturning(JoinPoint joinPoint) {
}
/**
• 参数非空校验,如果参数为空,则抛出ParamIsNullException异常
• @param paramName
• @param value
• @param parameterType
*/
private void paramIsNull(String paramName, Object value, String parameterType) {
if (value == null || “”.equals(value.toString().trim())) {
throw new ParamIsNullException(paramName, parameterType,“参数为空”);
}
}
private Object putParam(Object value, Class<?> parameterType) {
return CastValueTypeUtil.parseValue(parameterType, value.toString());
}
}

需要注意,这个路径是你准备添加校验的controller的路径,改成你自己的:

然后是校验参数里面使用到的参数转换工具类,CastValueTypeUtil.java:

import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Date;
/**
*转换object类型
**/
public class CastValueTypeUtil {
public static Object parseValue(Class<?> parameterTypes, String value) {
if(value==null || value.trim().length()==0){
return null;
}
value = value.trim();
if (Byte.class.equals(parameterTypes) || Byte.TYPE.equals(parameterTypes)) {
return parseByte(value);
} else if (Boolean.class.equals(parameterTypes) || Boolean.TYPE.equals(parameterTypes)) {
return parseBoolean(value);
}/* else if (Character.class.equals(fieldType) || Character.TYPE.equals(fieldType)) {
return value.toCharArray()[0];
}*/ else if (String.class.equals(parameterTypes)) {
return value;
} else if (Short.class.equals(parameterTypes) || Short.TYPE.equals(parameterTypes)) {
return parseShort(value);
} else if (Integer.class.equals(parameterTypes) || Integer.TYPE.equals(parameterTypes)) {
return parseInt(value);
} else if (Long.class.equals(parameterTypes) || Long.TYPE.equals(parameterTypes)) {
return parseLong(value);
} else if (Float.class.equals(parameterTypes) || Float.TYPE.equals(parameterTypes)) {
return parseFloat(value);
} else if (Double.class.equals(parameterTypes) || Double.TYPE.equals(parameterTypes)) {
return parseDouble(value);
} else if (Date.class.equals(parameterTypes)) {
return parseDate(value);
} else {
throw new RuntimeException(“request illeagal type, type must be Integer not int Long not long etc, type=” + parameterTypes);
}
}
public static Byte parseByte(String value) {
try {
value = value.replaceAll(" ", “”);
return Byte.valueOf(value);
} catch(NumberFormatException e) {
throw new RuntimeException(“parseByte but input illegal input=” + value, e);
}
}
public static Boolean parseBoolean(String value) {
value = value.replaceAll(" ", “”);
if (Boolean.TRUE.toString().equalsIgnoreCase(value)) {
return Boolean.TRUE;
} else if (Boolean.FALSE.toString().equalsIgnoreCase(value)) {
return Boolean.FALSE;
} else {
throw new RuntimeException(“parseBoolean but input illegal input=” + value);
}
}
public static Integer parseInt(String value) {
try {
value = value.replaceAll(" ", “”);
return Integer.valueOf(value);
} catch(NumberFormatException e) {
throw new RuntimeException(“parseInt but input illegal input=” + value, e);
}
}
public static Short parseShort(String value) {
try {
value = value.replaceAll(" ", “”);
return Short.valueOf(value);
} catch(NumberFormatException e) {
throw new RuntimeException(“parseShort but input illegal input=” + value, e);
}
}
public static Long parseLong(String value) {
try {
value = value.replaceAll(" ", “”);
return Long.valueOf(value);
} catch(NumberFormatException e) {
throw new RuntimeException(“parseLong but input illegal input=” + value, e);
}
}
public static Float parseFloat(String value) {
try {
value = value.replaceAll(" ", “”);
return Float.valueOf(value);
} catch(NumberFormatException e) {
throw new RuntimeException(“parseFloat but input illegal input=” + value, e);
}
}
public static Double parseDouble(String value) {
try {
value = value.replaceAll(" ", “”);
return Double.valueOf(value);
} catch(NumberFormatException e) {
throw new RuntimeException(“parseDouble but input illegal input=” + value, e);
}
}
public static Date parseDate(String value) {
try {
String datePattern = “yyyy-MM-dd HH:mm:ss”;
SimpleDateFormat dateFormat = new SimpleDateFormat(datePattern);
return dateFormat.parse(value);
} catch(ParseException e) {
throw new RuntimeException(“parseDate but input illegal input=” + value, e);
}
}
}
然后是新建一个自定义异常,专门用于校验参数为空的时候抛出,ParamIsNullException.java:
/**
• @Author : JCccc
• @CreateTime : 2020/5/14
• @Description :
**/
public class ParamIsNullException extends RuntimeException {
private final String parameterName;
private final String parameterType;
private final String message;
public ParamIsNullException(String parameterName, String parameterType, String message) {
super();
this.parameterName = parameterName;
this.parameterType = parameterType;
this.message = message;
}
@Override
public String getMessage() {
return “请求参数类型:” + this.parameterType + “,参数名: '” + this.parameterName + message;
}
public final String getParameterName() {
return this.parameterName;
}
public final String getParameterType() {
return this.parameterType;
}
}

到这里,其实可以看到自定义注解以及AOP已经实现完毕。

接下来是做一下,统一的返回参以及全局异常捕获,

新建接口BaseErrorInfoInterface.java:

/**
• @Author:JCccc
• @Description:此接口用于返回码枚举使用
• @Date: created in 15:11 2019/5/3
*/
public interface BaseErrorInfoInterface {
/** 错误码*/
String getResultCode();
/** 错误描述*/
String getResultMsg();
}
返回码的枚举类,CommonEnum.java:
/**
• @Author:JCccc
• @Description:
• @Date: created in 15:13 2019/5/3
*/
public enum CommonEnum implements BaseErrorInfoInterface {
// 数据操作错误定义
SUCCESS(“200”, “成功!”),
BODY_NOT_MATCH(“400”, “请求的数据格式不符!”),
SIGNATURE_NOT_MATCH(“401”, “请求的数字签名不匹配!”),
NOT_FOUND(“404”, “未找到该资源!”),
INTERNAL_SERVER_ERROR(“500”, “服务器内部错误!”),
SERVER_BUSY(“503”, “服务器正忙,请稍后再试!”),
REQUEST_METHOD_SUPPORT_ERROR(“40001”,“当前请求方法不支持”);
/**
• 错误码
*/
private String resultCode;
/**
• 错误描述
*/
private String resultMsg;
CommonEnum(String resultCode, String resultMsg) {
this.resultCode = resultCode;
this.resultMsg = resultMsg;
}
@Override
public String getResultCode() {
return resultCode;
}
@Override
public String getResultMsg() {
return resultMsg;
}
}
然后是一个简单的返回体专用类,ResultBody.java:
相关文章
|
7天前
|
NoSQL Java Redis
Spring Boot 自动配置机制:从原理到自定义
Spring Boot 的自动配置机制通过 `spring.factories` 文件和 `@EnableAutoConfiguration` 注解,根据类路径中的依赖和条件注解自动配置所需的 Bean,大大简化了开发过程。本文深入探讨了自动配置的原理、条件化配置、自定义自动配置以及实际应用案例,帮助开发者更好地理解和利用这一强大特性。
49 14
|
2月前
|
XML Java 数据格式
使用完全注解的方式进行AOP功能实现(@Aspect+@Configuration+@EnableAspectJAutoProxy+@ComponentScan)
本文介绍了如何使用Spring框架的注解方式实现AOP(面向切面编程)。当目标对象没有实现接口时,Spring会自动采用CGLIB库进行动态代理。文中详细解释了常用的AOP注解,如`@Aspect`、`@Pointcut`、`@Before`等,并提供了完整的示例代码,包括业务逻辑类`User`、配置类`SpringConfiguration`、切面类`LoggingAspect`以及测试类`TestAnnotationConfig`。通过这些示例,展示了如何在方法执行前后添加日志记录等切面逻辑。
336 2
使用完全注解的方式进行AOP功能实现(@Aspect+@Configuration+@EnableAspectJAutoProxy+@ComponentScan)
|
1月前
|
JSON Java 数据库
SpringBoot项目使用AOP及自定义注解保存操作日志
SpringBoot项目使用AOP及自定义注解保存操作日志
50 1
|
27天前
|
安全 Java 应用服务中间件
如何将Spring Boot应用程序运行到自定义端口
如何将Spring Boot应用程序运行到自定义端口
42 0
|
3月前
Micronaut AOP与代理机制:实现应用功能增强,无需侵入式编程的秘诀
AOP(面向切面编程)能够帮助我们在不修改现有代码的前提下,为应用程序添加新的功能或行为。Micronaut框架中的AOP模块通过动态代理机制实现了这一目标。AOP将横切关注点(如日志记录、事务管理等)从业务逻辑中分离出来,提高模块化程度。在Micronaut中,带有特定注解的类会在启动时生成代理对象,在运行时拦截方法调用并执行额外逻辑。例如,可以通过创建切面类并在目标类上添加注解来记录方法调用信息,从而在不侵入原有代码的情况下增强应用功能,提高代码的可维护性和可扩展性。
74 1
|
1月前
|
安全 Java 编译器
什么是AOP面向切面编程?怎么简单理解?
本文介绍了面向切面编程(AOP)的基本概念和原理,解释了如何通过分离横切关注点(如日志、事务管理等)来增强代码的模块化和可维护性。AOP的核心概念包括切面、连接点、切入点、通知和织入。文章还提供了一个使用Spring AOP的简单示例,展示了如何定义和应用切面。
137 1
什么是AOP面向切面编程?怎么简单理解?
|
1月前
|
XML Java 开发者
论面向方面的编程技术及其应用(AOP)
【11月更文挑战第2天】随着软件系统的规模和复杂度不断增加,传统的面向过程编程和面向对象编程(OOP)在应对横切关注点(如日志记录、事务管理、安全性检查等)时显得力不从心。面向方面的编程(Aspect-Oriented Programming,简称AOP)作为一种新的编程范式,通过将横切关注点与业务逻辑分离,提高了代码的可维护性、可重用性和可读性。本文首先概述了AOP的基本概念和技术原理,然后结合一个实际项目,详细阐述了在项目实践中使用AOP技术开发的具体步骤,最后分析了使用AOP的原因、开发过程中存在的问题及所使用的技术带来的实际应用效果。
67 5
|
3月前
Micronaut AOP与代理机制:实现应用功能增强,无需侵入式编程的秘诀
【9月更文挑战第9天】AOP(面向切面编程)通过分离横切关注点提高模块化程度,如日志记录、事务管理等。Micronaut AOP基于动态代理机制,在应用启动时为带有特定注解的类生成代理对象,实现在运行时拦截方法调用并执行额外逻辑。通过简单示例展示了如何在不修改 `CalculatorService` 类的情况下记录 `add` 方法的参数和结果,仅需添加 `@Loggable` 注解即可。这不仅提高了代码的可维护性和可扩展性,还降低了引入新错误的风险。
54 13
|
2月前
|
Java 容器
AOP面向切面编程
AOP面向切面编程
47 0
|
4月前
|
XML Java 数据格式
Spring5入门到实战------11、使用XML方式实现AOP切面编程。具体代码+讲解
这篇文章是Spring5框架的AOP切面编程教程,通过XML配置方式,详细讲解了如何创建被增强类和增强类,如何在Spring配置文件中定义切入点和切面,以及如何将增强逻辑应用到具体方法上。文章通过具体的代码示例和测试结果,展示了使用XML配置实现AOP的过程,并强调了虽然注解开发更为便捷,但掌握XML配置也是非常重要的。
Spring5入门到实战------11、使用XML方式实现AOP切面编程。具体代码+讲解