Spring REST API验证

曾经终败给现在 2023-02-15 05:14 29阅读 0赞

在Spring MVC中，只需在`@RequestBody`上注释一个`@Valid`即可触发验证过程。

> **注意**  
> 有关完整的源代码，请参考此– [Spring Boot Ajax示例][Spring Boot Ajax]

*PS已通过Spring Boot 1.5.1.RELEASE测试（Spring 4.3.6.RELEASE）*

## 1. JSR 303验证 ##

在bean上添加JSR303批注。

package com.mkyong.model;
    
    import org.hibernate.validator.constraints.NotBlank;
    
    public class SearchCriteria {
    
        @NotBlank(message = "username can't empty!")
        String username;
    
        public String getUsername() {
            return username;
        }
    
        public void setUsername(String username) {
            this.username = username;
        }
    }

## 2. @有效@RequestBody ##

一个Spring REST API，第二个参数`Errors`对象将包含验证细节。

package com.mkyong.controller;
    
    import com.mkyong.model.AjaxResponseBody;
    import com.mkyong.model.SearchCriteria;
    import com.mkyong.model.User;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.http.ResponseEntity;
    import org.springframework.validation.Errors;
    import org.springframework.web.bind.annotation.PostMapping;
    import org.springframework.web.bind.annotation.RequestBody;
    import org.springframework.web.bind.annotation.RestController;
    
    import javax.validation.Valid;
    import java.util.List;
    import java.util.stream.Collectors;
    
    @RestController
    public class SearchController {
    
        @PostMapping("/api/search")
        public ResponseEntity<?> search(
    		@Valid @RequestBody SearchCriteria search, Errors errors) {
    
            Result result = new Result();
    
            //If error, just return a 400 bad request, along with the error message
            if (errors.hasErrors()) {
    
    			// get all errors 
                result.setMsg(errors.getAllErrors()
    				.stream()
    				.map(x -> x.getDefaultMessage())
    				.collect(Collectors.joining(",")));
    				
                return ResponseEntity.badRequest().body(result);
    
            }
    
            List<User> users = //get users...
            if (users.isEmpty()) {
                result.setMsg("no user found!");
            } else {
                result.setMsg("success");
            }
            result.setResult(users);
    
            return ResponseEntity.ok(result);
    
        }
    
    }

## 参考文献 ##

1.  [JSR 303：Bean验证][JSR 303_Bean]
2.  [Spring Boot Ajax示例][Spring Boot Ajax]

标签： [jsr303][] [休息][Link 1] [春天mvc][mvc] [有效][Link 2] [验证][Link 3]

> 翻译自: [https://mkyong.com/spring-mvc/spring-rest-api-validation/][https_mkyong.com_spring-mvc_spring-rest-api-validation]

[Spring Boot Ajax]: http://www.mkyong.com/spring-boot/spring-boot-ajax-example/
[JSR 303_Bean]: https://jcp.org/en/jsr/detail?id=303
[jsr303]: https://mkyong.com/tag/jsr303/
[Link 1]: https://mkyong.com/tag/rest/
[mvc]: https://mkyong.com/tag/spring-mvc/
[Link 2]: https://mkyong.com/tag/valid/
[Link 3]: https://mkyong.com/tag/validation/
[https_mkyong.com_spring-mvc_spring-rest-api-validation]: https://mkyong.com/spring-mvc/spring-rest-api-validation/