|
| 1 | +/* |
| 2 | + * Copyright 2020-2022 the original author or authors. |
| 3 | + * |
| 4 | + * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | + * you may not use this file except in compliance with the License. |
| 6 | + * You may obtain a copy of the License at |
| 7 | + * |
| 8 | + * https://www.apache.org/licenses/LICENSE-2.0 |
| 9 | + * |
| 10 | + * Unless required by applicable law or agreed to in writing, software |
| 11 | + * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | + * See the License for the specific language governing permissions and |
| 14 | + * limitations under the License. |
| 15 | + */ |
| 16 | + |
| 17 | +package org.springframework.graphql.data.method.annotation.support; |
| 18 | + |
| 19 | +import java.lang.annotation.Annotation; |
| 20 | +import java.util.Set; |
| 21 | + |
| 22 | +import javax.validation.ConstraintViolation; |
| 23 | +import javax.validation.ConstraintViolationException; |
| 24 | +import javax.validation.Validator; |
| 25 | + |
| 26 | +import org.springframework.context.ApplicationContext; |
| 27 | +import org.springframework.core.annotation.AnnotationUtils; |
| 28 | +import org.springframework.graphql.data.method.HandlerMethod; |
| 29 | +import org.springframework.lang.Nullable; |
| 30 | +import org.springframework.util.Assert; |
| 31 | +import org.springframework.validation.annotation.Validated; |
| 32 | +import org.springframework.validation.beanvalidation.LocalValidatorFactoryBean; |
| 33 | +import org.springframework.validation.beanvalidation.SpringValidatorAdapter; |
| 34 | + |
| 35 | +/** |
| 36 | + * Helper class to apply standard bean validation to a {@link HandlerMethod}. |
| 37 | + * |
| 38 | + * @author Brian Clozel |
| 39 | + * @author Rossen Stoyanchev |
| 40 | + * @since 1.0 |
| 41 | + */ |
| 42 | +final class HandlerMethodValidationHelper { |
| 43 | + |
| 44 | + private final Validator validator; |
| 45 | + |
| 46 | + |
| 47 | + /** |
| 48 | + * Constructor with the {@link Validator} instance to use. |
| 49 | + */ |
| 50 | + public HandlerMethodValidationHelper(Validator validator) { |
| 51 | + Assert.notNull(validator, "validator should not be null"); |
| 52 | + if (validator instanceof LocalValidatorFactoryBean) { |
| 53 | + this.validator = ((LocalValidatorFactoryBean) validator).getValidator(); |
| 54 | + } |
| 55 | + else if (validator instanceof SpringValidatorAdapter) { |
| 56 | + this.validator = validator.unwrap(Validator.class); |
| 57 | + } |
| 58 | + else { |
| 59 | + this.validator = validator; |
| 60 | + } |
| 61 | + } |
| 62 | + |
| 63 | + |
| 64 | + /** |
| 65 | + * Validate the input values to a the {@link HandlerMethod} and throw a |
| 66 | + * {@link ConstraintViolationException} in case of violations. |
| 67 | + * @param handlerMethod the handler method to validate |
| 68 | + * @param arguments the input argument values |
| 69 | + */ |
| 70 | + public void validate(HandlerMethod handlerMethod, Object[] arguments) { |
| 71 | + Set<ConstraintViolation<Object>> result = |
| 72 | + this.validator.forExecutables().validateParameters( |
| 73 | + handlerMethod.getBean(), handlerMethod.getMethod(), arguments, |
| 74 | + determineValidationGroups(handlerMethod)); |
| 75 | + if (!result.isEmpty()) { |
| 76 | + throw new ConstraintViolationException(result); |
| 77 | + } |
| 78 | + } |
| 79 | + |
| 80 | + /** |
| 81 | + * Determine the validation groups to apply to a handler method, specified |
| 82 | + * through the {@link Validated} annotation on the method or on the class. |
| 83 | + * @param method the method to check |
| 84 | + * @return the applicable validation groups as a Class array |
| 85 | + */ |
| 86 | + private Class<?>[] determineValidationGroups(HandlerMethod method) { |
| 87 | + Validated annotation = findAnnotation(method, Validated.class); |
| 88 | + return (annotation != null ? annotation.value() : new Class<?>[0]); |
| 89 | + } |
| 90 | + |
| 91 | + @Nullable |
| 92 | + private static <A extends Annotation> A findAnnotation(HandlerMethod method, Class<A> annotationType) { |
| 93 | + A annotation = AnnotationUtils.findAnnotation(method.getMethod(), annotationType); |
| 94 | + if (annotation == null) { |
| 95 | + annotation = AnnotationUtils.findAnnotation(method.getBeanType(), annotationType); |
| 96 | + } |
| 97 | + return annotation; |
| 98 | + } |
| 99 | + |
| 100 | + |
| 101 | + /** |
| 102 | + * Factory method for {@link HandlerMethodValidationHelper} if a |
| 103 | + * {@link Validator} can be found. |
| 104 | + * @param context the context to look up a {@code Validator} bean from |
| 105 | + * @return the helper instance, or {@code null |
| 106 | + */ |
| 107 | + @Nullable |
| 108 | + public static HandlerMethodValidationHelper createIfValidatorAvailable(ApplicationContext context) { |
| 109 | + Validator validator = context.getBeanProvider(Validator.class).getIfAvailable(); |
| 110 | + return (validator != null ? new HandlerMethodValidationHelper(validator) : null); |
| 111 | + } |
| 112 | + |
| 113 | +} |
0 commit comments