How to check Spring MVC @PathVariable values?

Question

For a simple RESTful JSON api implemented in Spring MVC, can I use Bean Validation (JSR-303) to check the path variables passed to the handler method?

For example:

 @RequestMapping(value = "/number/{customerNumber}")
 @ResponseBody
 public ResponseObject searchByNumber(@PathVariable("customerNumber") String customerNumber) {
 ...
 }

Here I need to check the length of the customerNumber variable using a Bean check. Is this possible with Spring MVC v3.xx? If not, what is the best approach for this type of validation?

Thanks.

Answer 1

Spring does not support @javax.validation.Valid @PathVariableannotated parameters @PathVariablein handler methods. There was a request for improvement, but it is still not resolved .

- org.springframework.validation.annotation.Validated .

Answer 2

: org.springframework.validation.annotation.Validated RequestParam PathVariable.

 *
 * Variant of JSR-303 {@link javax.validation.Valid}, supporting the
 * specification of validation groups. Designed for convenient use with
 * Spring JSR-303 support but not JSR-303 specific.
 *

step.1 init ValidationConfig

@Configuration
public class ValidationConfig {
    @Bean
    public MethodValidationPostProcessor methodValidationPostProcessor() {
        MethodValidationPostProcessor processor = new MethodValidationPostProcessor();
        return processor;
    }
}

step.2 @Validated , :

@RequestMapping(value = "poo/foo")
@Validated
public class FooController {
...
}

step.3 validators :

   @RequestMapping(value = "{id}", method = RequestMethod.DELETE)
   public ResponseEntity<Foo> delete(
           @PathVariable("id") @Size(min = 1) @CustomerValidator int id) throws RestException {
        // do something
        return new ResponseEntity(HttpStatus.OK);
    }

. :

@Component
public class BindExceptionResolver implements HandlerExceptionResolver {

    @Override
    public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
        if (ex.getClass().equals(BindException.class)) {
            BindException exception = (BindException) ex;

            List<FieldError> fieldErrors = exception.getFieldErrors();
            return new ModelAndView(new MappingJackson2JsonView(), buildErrorModel(request, response, fieldErrors));
        }
    }
}

Answer 3

:

@GetMapping(value = {"/", "/{hash:[a-fA-F0-9]{40}}"})
public String request(@PathVariable(value = "hash", required = false) String historyHash)
{
    // Accepted requests: either "/" or "/{40 character long hash}"
}

, PathVariables , .

Answer 4

@PathVariable , . , pathVariable . pathVariable , :

• url (, href jsp). @Valid , ;
• "" URL-. , no @Valid , .

,    Spring ExceptionHandlers,    json, .    , .

CustomerNumber, , ( CharSequence , , String)

public class CustomerNumber implements CharSequence {

    private String customerNumber;

    public CustomerNumber(String customerNumber) {
        this.customerNumber = customerNumber;
    }

    @Override
    public String toString() {
        return customerNumber == null ? null : customerNumber.toString();
    }

    @Override
    public int length() {
        return customerNumber.length();
    }

    @Override
    public char charAt(int index) {
        return customerNumber.charAt(index);
    }

    @Override
    public CharSequence subSequence(int start, int end) {
        return customerNumber.subSequence(start, end);
    }

    @Override
    public boolean equals(Object obj) {
        return customerNumber.equals(obj);
    }

    @Override
    public int hashCode() {
        return customerNumber.hashCode();
    }
}

, ( , )

public class CustomerNumberEditor extends PropertyEditorSupport {

    @Override
    public void setAsText(String text) throws IllegalArgumentException {

        if (StringUtils.hasText(text) && !StringUtils.containsWhitespace(text) && text.length() == YOUR_LENGTH) {
            setValue(new CustomerNumber(text));
        } else {
            throw new IllegalArgumentException();
            // you could also subclass and throw IllegalArgumentException
            // in order to manage a more detailed error message
        }
    }

    @Override
    public String getAsText() {
        return ((CustomerNumber) this.getValue()).toString();
    }
}

@InitBinder
public void initBinder(WebDataBinder binder) {

    binder.registerCustomEditor(CustomerNumber.class, new CustomerNumberEditor());
    // ... other editors
}

, CustomerNumber String ( ResponseObject...)

@RequestMapping(value = "/number/{customerNumber}")
@ResponseBody
public ResponseObject searchByNumber(@PathVariable("customerNumber") CustomerNumber customerNumber) {
    ...
}

Answer 5

@PathVariable Spring MVC bean-:

@RestController
@RequestMapping("/user")
public class UserController {

    @GetMapping("/{id}")
    public void get(@Valid GetDto dto) {
        // dto.getId() is the path variable
    }

}

:

@Data
public class GetDto {
     @Min(1) @Max(99)
     private long id;
}

, ({id}) (id);

Answer 6

bean . JSR-303? , URL @PathVariable spring 3 mvc