问题：

Spring Boot：请求参数中的自定义验证

孙项禹

2023-03-14

我想验证我的控制器中的一个请求参数。请求参数应该来自给定值列表中的一个，如果不是，则应该抛出错误。在下面的代码中，我希望请求参数orderBy来自@Values准许中存在的值列表。

@RestController
@RequestMapping("/api/opportunity")
@Api(value = "Opportunity APIs")
@ValuesAllowed(propName = "orderBy", values = { "OpportunityCount", "OpportunityPublishedCount", "ApplicationCount",
        "ApplicationsApprovedCount" })
public class OpportunityController {

@GetMapping("/vendors/list")
    @ApiOperation(value = "Get all vendors")

    public ResultWrapperDTO getVendorpage(@RequestParam(required = false) String term,
            @RequestParam(required = false) Integer page, @RequestParam(required = false) Integer size,
            @RequestParam(required = false) String orderBy, @RequestParam(required = false) String sortDir) {

我已经编写了一个自定义bean验证器，但不知何故，它不起作用。即使我为查询参数传递任何随机值，也不会验证并引发错误。

@Repeatable(ValuesAllowedMultiple.class)
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = {ValuesAllowedValidator.class})
public @interface ValuesAllowed {

    String message() default "Field value should be from list of ";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};

    String propName();
    String[] values();
}

public class ValuesAllowedValidator implements ConstraintValidator<ValuesAllowed, Object> {

    private String propName;
    private String message;
    private String[] values;

    @Override
    public void initialize(ValuesAllowed requiredIfChecked) {
        propName = requiredIfChecked.propName();
        message = requiredIfChecked.message();
        values = requiredIfChecked.values();
    }

    @Override
    public boolean isValid(Object object, ConstraintValidatorContext context) {
        Boolean valid = true;
        try {
            Object checkedValue = BeanUtils.getProperty(object, propName);

            if (checkedValue != null) {
                valid = Arrays.asList(values).contains(checkedValue.toString().toLowerCase());
            } 

            if (!valid) {
                context.disableDefaultConstraintViolation();
                context.buildConstraintViolationWithTemplate(message.concat(Arrays.toString(values)))
                        .addPropertyNode(propName).addConstraintViolation();
            }
        } catch (IllegalAccessException e) {
            log.error("Accessor method is not available for class : {}, exception : {}", object.getClass().getName(), e);
            return false;
        } catch (NoSuchMethodException e) {
            log.error("Field or method is not present on class : {}, exception : {}", object.getClass().getName(), e);
            return false;
        } catch (InvocationTargetException e) {
            log.error("An exception occurred while accessing class : {}, exception : {}", object.getClass().getName(), e);
            return false;
        }
        return valid;
    }
}

共有3个答案

薛兴言

2023-03-14

在做了其他事情之后，我发现我缺少了这种依赖性。常规的验证步骤是有效的，但在我将其添加到pom之前，自定义验证器都不起作用。

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

黄向明

2023-03-14

要使此验证生效，您只需更改几件事。

控制器应使用@Valated进行注释，并且@Values准许应在方法中注释目标参数。

import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@Validated
@RestController
@RequestMapping("/api/opportunity")
public class OpportunityController {

    @GetMapping("/vendors/list")
    public String getVendorpage(
            @RequestParam(required = false)
            @ValuesAllowed(values = {
                    "OpportunityCount",
                    "OpportunityPublishedCount",
                    "ApplicationCount",
                    "ApplicationsApprovedCount"
            }) String orderBy,
            @RequestParam(required = false) String term,
            @RequestParam(required = false) Integer page, @RequestParam(required = false) Integer size,
            @RequestParam(required = false) String sortDir) {
        return "OK";
    }
}

@值sallowed应以元素类型为目标。参数，在这种情况下，您不再需要propName属性，因为Spring将验证所需的参数。

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target({ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = {ValuesAllowedValidator.class})
public @interface ValuesAllowed {

    String message() default "Field value should be from list of ";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};

    String[] values();
}

验证器：

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.util.Arrays;
import java.util.List;

public class ValuesAllowedValidator implements ConstraintValidator<ValuesAllowed, String> {

    private List<String> expectedValues;
    private String returnMessage;

    @Override
    public void initialize(ValuesAllowed requiredIfChecked) {
        expectedValues = Arrays.asList(requiredIfChecked.values());
        returnMessage = requiredIfChecked.message().concat(expectedValues.toString());
    }

    @Override
    public boolean isValid(String testValue, ConstraintValidatorContext context) {
        boolean valid = expectedValues.contains(testValue);

        if (!valid) {
            context.disableDefaultConstraintViolation();
            context.buildConstraintViolationWithTemplate(returnMessage)
                    .addConstraintViolation();
        }
        return valid;
    }
}

但是上面的代码返回HTTP 500并污染带有丑陋堆栈跟踪的日志。为了避免它，您可以将这样的@ExceptionHandler方法放在控制器正文中（因此它将仅限于此控制器），并且您可以控制HTTP状态：

@ExceptionHandler(ConstraintViolationException.class)
@ResponseStatus(HttpStatus.BAD_REQUEST)
String handleConstraintViolationException(ConstraintViolationException e) {
    return "Validation error: " + e.getMessage();
}

...或者您可以将此方法放在单独的@ControlllerAdvie类中，并对此验证有更多的控制权，例如在所有控制器或仅在所需的控制器上使用它。

柴赞

2023-03-14

情况1：如果根本没有触发注释值允许，这可能是因为没有用@验证来注释控制器。

@Validated
@ValuesAllowed(propName = "orderBy", values = { "OpportunityCount", "OpportunityPublishedCount", "ApplicationCount", "ApplicationsApprovedCount" })
public class OpportunityController {
@GetMapping("/vendors/list")
public String getVendorpage(@RequestParam(required = false) String term,..{
}

案例2：如果它被触发并引发错误，则可能是由于小坚果引起的。getProperty不解析属性并引发异常。

如果上述解决方案不起作用，您可以尝试将注释移动到方法级别，并更新验证器以使用有效值列表作为参数。这对我有用。下面是示例代码。

@RestController
@RequestMapping("/api/opportunity")
@Validated
public class OpportunityController {
    @GetMapping("/vendors/list")
    public String getVendorpage(@RequestParam(required = false) String term,
            @RequestParam(required = false) Integer page, @RequestParam(required = false) Integer size,
            @ValuesAllowed(propName = "orderBy", values = { "OpportunityCount", "OpportunityPublishedCount", "ApplicationCount",
                    "ApplicationsApprovedCount" }) @RequestParam(required = false) String orderBy, @RequestParam(required = false) String sortDir) {
        return "success";
    }

@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = { ValuesAllowed.Validator.class })
public @interface ValuesAllowed {

    String message() default "Field value should be from list of ";

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};

    String propName();

    String[] values();

    class Validator implements ConstraintValidator<ValuesAllowed, String> {
        private String propName;
        private String message;
        private List<String> allowable;

        @Override
        public void initialize(ValuesAllowed requiredIfChecked) {
            this.propName = requiredIfChecked.propName();
            this.message = requiredIfChecked.message();
            this.allowable = Arrays.asList(requiredIfChecked.values());
        }

        public boolean isValid(String value, ConstraintValidatorContext context) {
            Boolean valid = value == null || this.allowable.contains(value);

            if (!valid) {
                context.disableDefaultConstraintViolation();
                context.buildConstraintViolationWithTemplate(message.concat(this.allowable.toString()))
                        .addPropertyNode(this.propName).addConstraintViolation();
            }
            return valid;
        }
    }
}

类似资料：

SpringBoot中自定义参数绑定步骤详解

本文向大家介绍SpringBoot中自定义参数绑定步骤详解，包括了SpringBoot中自定义参数绑定步骤详解的使用技巧和注意事项，需要的朋友参考一下正常情况下，前端传递来的参数都能直接被SpringMVC接收，但是也会遇到一些特殊情况，比如Date对象，当我的前端传来的一个日期时，就需要服务端自定义参数绑定，将前端的日期进行转换。自定义参数绑定也很简单，分两个步骤： 1.自定义参数转换器自定
如何使用自定义请求验证laravel数组？

如何使用自定义请求进行验证，我的请求使用数组键 [编辑][代码更新]显示错误：传递给App\Http\Controllers\Controller：：validate（）的参数1必须是给定数组的Illumbite\Http\Request的实例，
Springboot后的请求参数错误

每当页面尝试提交2MB或更大的文件时，都会发生此错误。但是参数在帖子里！我已经检查了Chrome开发工具。有人知道这个错误吗？Springboot 2.0.3。释放
Spring boot中的自定义通用请求验证程序

我是Spring boot新手，我对请求字段验证有一个问题。我想出了如何在字段级别使用注释来指定自定义错误消息：但是为了使用这些注释，我必须为每个请求类中的每个字段指定错误消息。此外，出于某种原因，我得到的回答也不是很明确：假设所有字段必须是和，是否有更优雅、更通用的方法来对每个请求进行字段验证？有人能提供一些想法如何实现请求验证器吗？
HttpClient请求的自定义头

如何将自定义标头添加到HttpClient请求？我使用方法发布JSON。我需要添加的自定义标题是这是我到目前为止所做的：
SpringBoot请求参数接收方式

本文向大家介绍SpringBoot请求参数接收方式，包括了SpringBoot请求参数接收方式的使用技巧和注意事项，需要的朋友参考一下 application/json接收 x-www-form-urlencoded、？拼接、form-data接收 UserDto 以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持呐喊教程。

Spring Boot：请求参数中的自定义验证

共有3个答案

相关问答

相关文章

相关阅读

相关工具

相关文档