В предыдущей статье https://juejin.cn/post/6844903551362138119 параметры аннотации @RequestBody проверяются через АОП Таким образом, для @PathVariable и @RequestParam нет соответствующего механизма проверки @Valid + BindingResult, который по умолчанию поставляется с Spring MVC. Затем в это время проверка может выполняться только для кода один за другим.
Сначала объясните использование двух аннотаций @PathVariable и @RequestParam.
1. Пояснение к оригинальной версии
1.1 @PathVariable
1.1.1 REST-стиль
Формат: path/1/catalpaFlat например:
@GetMapping("path/{isInt}/{isString}")
public ResponseVO pathGet(@PathVariable Integer isInt,
@PathVariable String isString) {
log.info("int:" + isInt);
log.info("String:" + isString);
JSONObject resultJson = new JSONObject();
resultJson.put("isInt", isInt);
resultJson.put("isString", isString);
return new ResponseVO(HttpStatus.OK.value(), "pathGet", resultJson);
}
запрос: http://локальный:8888/путь/3/дадас
1.1.2 Проверка
проверка кода
if(isInt < 2){
return new ResponseVO(HttpStatus.BAD_REQUEST.value(), "pathGet", "isInt must be more than 2");
}
Для проверки кода я лично думаю, что это немного лишнее, если только это не какие-то особые потребности.
1.2 @RequestParam
1.2.1 Отправка формы (запрос)
Формат: запрос?isInt=2&isString=catalpaFlat
@GetMapping("query?")
public ResponseVO queryGet(@RequestParam Integer isInt,
@RequestParam String isString) {
log.info("int:" + isInt);
log.info("String:" + isString);
JSONObject resultJson = new JSONObject();
resultJson.put("isInt", isInt);
resultJson.put("isString", isString);
return new ResponseVO(HttpStatus.OK.value(), "queryGet", resultJson);
}
1.2.2 Проверка
Также требуется проверка кода
if(isInt < 2){
return new ResponseVO(HttpStatus.BAD_REQUEST.value(), "queryGet", "isInt must be more than 2");
}
Поскольку @Valid + BindingResult можно использовать только для аннотации типа @ResponseBody.
2. Улучшенная версия АОП
Чувствуется, что исходная версия должна быть проверена в коде.Пока используются @PathVariable и @RequestParam, должна быть выполнена волна проверки параметров, поэтому мне интересно, можем ли мы добавить к ней проверку аннотаций, таких как @Valid , Это уменьшает объем кода и делает его более элегантным.
2.1 Уровень интерфейса (IDAL)
Следующий код является измененным кодом:
- @ParameterValid эквивалентен @Valid, а правила проверки параметров настраиваются в его свойствах.
- @PathAndQueryParamValid эквивалентен pointcut АОП.
@PathAndQueryParamValid
@GetMapping("path/{isInt}/{isString}")
public ResponseVO pathGet(@PathVariable @ParameterValid(type = Integer.class, msg = "isInt must be more than 2", isMin = true, min = 2) Integer isInt,
@PathVariable @ParameterValid(type = String.class, msg = "isString is empty") String isString) {
log.info("int:" + isInt);
log.info("String:" + isString);
JSONObject resultJson = new JSONObject();
resultJson.put("isInt", isInt);
resultJson.put("isString", isString);
return new ResponseVO(HttpStatus.OK.value(), "pathGet", resultJson);
}
@GetMapping("query")
@PathAndQueryParamValid
public ResponseVO queryGet(@RequestParam @ParameterValid(type = Integer.class, msg = "isInt must be more than 2 ", isMin = true, min = 2) Integer isInt,
@RequestParam @ParameterValid(type = String.class, msg = "isString is empty") String isString) {
log.info("int:" + isInt);
log.info("String:" + isString);
JSONObject resultJson = new JSONObject();
resultJson.put("isInt", isInt);
resultJson.put("isString", isString);
return new ResponseVO(HttpStatus.OK.value(), "queryGet", resultJson);
}
2.2 Пользовательские аннотации
2.2.1 @PathAndQueryParamValid
Просто для аннотаций типа метода:
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface PathAndQueryParamValid {
}
2.2.1 @ParameterValid
@ParameterValid может добавлять собственные правила проверки в соответствии с реальными потребностями бизнеса:
@Documented
@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
public @interface ParameterValid {
Class<?> type();
String msg();
boolean request() default true;
boolean isEmpty() default true;
boolean isBlank() default true;
boolean isNull() default false;
int min() default 0;
int max() default 0;
int[] section() default {0,0};
boolean isMin() default false;
boolean isMax() default false;
boolean isSection() default false;
}
2.3 АОП-аспект (выделено 1)
- Получите имя метода pointcut и имя класса через joinPoint, что очень пригодится позже (курсив)
- Получить параметры метода через JoinPoint
- Вызов (выделение 2) ParamValidSupport
- AdvanceResponseSupport такой же, как и в предыдущей статье, но на самом деле это просто ответ.
@Aspect
@Component
public class PathAndQueryParamValidAspect {
private static final Logger log = LoggerFactory.getLogger(PathAndQueryParamValidAspect.class);
@Before("@annotation(paramValid)")
public void paramValid(JoinPoint joinPoint, PathAndQueryParamValid paramValid) {
String className = joinPoint.getTarget().getClass().getName();
String methodName = joinPoint.getSignature().getName();
Object[] param = joinPoint.getArgs();
try {
List<String> errorLists = ParamValidSupport.get().validate(className, methodName,
ParameterValid.class, param);
if (errorLists != null) {
AdvanceResponseSupport.advanceResponse(
new ResponseVO(HttpStatus.BAD_REQUEST.value(), "parameter empty", errorLists));
}
} catch (NotFoundException | NoSuchMethodException | ClassNotFoundException e) {
log.error("e-name：" + e.getClass().getName() + "： message：" + e.getMessage());
}
}
}
2.4 Проверка (выделено 2)
- Получить CtClass и CtMethod в соответствии с ClassPool через имя метода и имя класса
- Чтобы получить аннотации параметров, проанализируйте правила аннотации параметров для проверки параметров.
(Здесь можно провести рефакторинг только для проверки двух типов int и string, а также можно добавить другие требования. Сначала представьте основной контент)
public class ParamValidSupport {
private static final Logger logger = LoggerFactory.getLogger(ParamValidSupport.class);
private static final String PARAM_TYPE_ERROR = "param type error";
private static final String INT_PARAM_ERROR = "Invalid interva";
private static final int INT_PARAM_TYPE_MAX_SIZE = 2;
private static final int INT_PARAM_SIZE_SUBSCRIPT_MIN = 0;
private static final int INT_PARAM_SIZE_SUBSCRIPT_MAX = 0;
private static final int STRING_SIZE = 2;
private static final char STRING_TYPE_END = '}';
private static final char STRING_TYPE_BEGIN = '{';
private static final char STRING_EMPTY_DOUBLE_CHARACTER = '"';
private static final char STRING_EMPTY_SINGLE_CHARACTER = '\'';
private static ParamValidSupport mInstance;
private ParamValidSupport() {
}
public static ParamValidSupport get() {
if (mInstance == null) {
synchronized (ParamValidSupport.class) {
if (mInstance == null) {
mInstance = new ParamValidSupport();
}
}
}
return mInstance;
}
/**
* 校验
*/
public List<String> validate(String className, String methodName,
Class<?> annotationClass, Object[] args)
throws NotFoundException, NoSuchMethodException, ClassNotFoundException {
if (StringUtils.isBlank(className)) {
return null;
}
if (StringUtils.isBlank(methodName)) {
return null;
}
if (annotationClass == null) {
return null;
}
ClassPool pool = ClassPool.getDefault();
CtClass ct = pool.get(className);
CtMethod ctMethod = ct.getDeclaredMethod(methodName);
Object[][] parameterAnnotations = ctMethod.getParameterAnnotations();
List<String> errorLists = new ArrayList<>();
for (int i = 0; i < parameterAnnotations.length; i++) {
Object[] parameterAnnotation = parameterAnnotations[i];
Object param = args[i];
for (Object object : parameterAnnotation) {
Annotation annotation = (Annotation) object;
Class<? extends Annotation> aClass = annotation.annotationType();
if (aClass.equals(annotationClass)) {
boolean isEmpty = ((ParameterValid) object).isEmpty();
if (isEmpty) {
ParameterValid parameterValid = (ParameterValid) object;
String errorMsg = parameterValid.msg();
if (Integer.class.isAssignableFrom(param.getClass())){
int paramInt = (int) param;
if (parameterValid.isMin() && paramInt < parameterValid.min()) {
errorLists.add(errorMsg);
}
if (parameterValid.isMax() && paramInt < parameterValid.max()) {
errorLists.add(errorMsg);
}
if (parameterValid.isSection()) {
int[] section = parameterValid.section();
if (section.length != INT_PARAM_TYPE_MAX_SIZE) {
logger.error(INT_PARAM_ERROR);
throw new ParameterValidException(INT_PARAM_ERROR);
}
if (!(paramInt > section[INT_PARAM_SIZE_SUBSCRIPT_MIN] && paramInt < section[INT_PARAM_SIZE_SUBSCRIPT_MAX])) {
errorLists.add(errorMsg);
} else if (!(paramInt > section[INT_PARAM_SIZE_SUBSCRIPT_MAX] && paramInt < section[INT_PARAM_SIZE_SUBSCRIPT_MIN])) {
errorLists.add(errorMsg);
}
}
}
if (String.class.isAssignableFrom(param.getClass())){
String paramStr = (String) param;
if (parameterValid.isNull()) {
if (StringUtils.isEmpty(paramStr)) {
errorLists.add(errorMsg);
}
} else {
if (parameterValid.isBlank()) {
if (StringUtils.isBlank(paramStr)) {
errorLists.add(errorMsg);
} else {
int length = paramStr.length();
char begin = paramStr.charAt(0);
char end = paramStr.charAt(length - 1);
if (STRING_TYPE_BEGIN == begin &&
STRING_TYPE_END == end) {
errorLists.add(errorMsg);
}
if (length == STRING_SIZE && STRING_EMPTY_DOUBLE_CHARACTER == begin
&& STRING_EMPTY_DOUBLE_CHARACTER == end) {
errorLists.add(errorMsg);
}
if (length == STRING_SIZE && STRING_EMPTY_SINGLE_CHARACTER == begin
&& STRING_EMPTY_SINGLE_CHARACTER == end) {
errorLists.add(errorMsg);
}
}
}
}
}
}
}
}
}
if (errorLists.size() != 0) {
return errorLists;
}
return null;
}
}