在REST应用程序中抛出BindException而不是MethodArgumentNotValidException

时间:2014-04-22 05:27:53

标签: java spring rest exceptionhandler

我有一个简单的Spring Rest Controller和一些验证。我的理解是验证失败会抛出MethodArgumentNotValidException。但是,我的代码抛出了BindException。在调试消息中,我还看到应用程序返回null ModelAndView。

为什么Rest Controller会抛出BindException或返回null ModelAndView?

注意:我正在使用curl测试我的Web应用程序并进行HTTP POST

curl -X POST http://localhost:8080/tasks

我故意省略“name”参数,该参数是标有@NotNull和@NotBlank注释的必填字段。

我的控制器:

@RestController
public class TasksController {

    private static Logger logger = Logger.getLogger(TasksController.class);

    @Autowired
    private MessageSource messageSource;

    @Autowired
    private Validator validator;

    @InitBinder
    protected void initBinder(WebDataBinder binder){
        binder.setValidator(this.validator);
    }         


    @RequestMapping(value = "/tasks", method = RequestMethod.POST)
    public Task createTask(@Valid TasksCommand tasksCommand){

        Task task = new Task();
        task.setName(tasksCommand.getName());
        task.setDue(tasksCommand.getDue());
        task.setCategory(tasksCommand.getCategory());

        return task;
    }
}

我的“命令”类(包含验证注释)

public class TasksCommand {

    @NotBlank
    @NotNull
    private String name;

    private Calendar due;

    private String category;

    ... getters & setters ommitted ...
}

我的RestErrorHandler类:

@ControllerAdvice
public class RestErrorHandler {

    private static Logger logger = Logger.getLogger(RestErrorHandler.class);

    @Autowired
    private MessageSource messageSource;

    @ExceptionHandler(MethodArgumentNotValidException.class)
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ResponseBody
    public ErrorsList processErrors(MethodArgumentNotValidException ex){
        logger.info("error handler invoked ...");
        BindingResult result = ex.getBindingResult();
        List<FieldError> fieldErrorList = result.getFieldErrors();

        ErrorsList errorsList = new ErrorsList();
        for(FieldError fieldError: fieldErrorList){
            Locale currentLocale = LocaleContextHolder.getLocale();
            String errorMessage = messageSource.getMessage(fieldError, currentLocale);

            logger.info("adding error message - " + errorMessage + " - to errorsList");
            errorsList.addFieldError(fieldError.getField(), errorMessage);
        }

        return errorsList;
    }
}

用@ExceptionHandler(...)注释标记的processErrors方法永远不会被调用。如果我尝试使用@ExceptionHandler(...)注释捕获BindException,则会调用该处理程序方法。

我有几个支持类 - Task,TaskCommand,Error和ErrorsList - 我可以根据需要发布代码。

1 个答案:

答案 0 :(得分:3)

问题在于我的curl命令。

curl -d发送Content-Type“application / x-www-form-urlencoded”。因此,Spring将数据解释为Web表单数据(而不是JSON)。 Spring使用FormHttpMessageConverter将POST主体转换为域对象,并导致BindException。

我们想要的是Spring将POST数据视为JSON并使用MappingJackson2HttpMessageConverter将POST主体解析为对象。这可以通过使用curl命令指定“Content-Type”标头来完成:

curl -X POST -H "Content-Type: application/json" -d '{"name":"name1", "due":"2014-DEC-31 01:00:00 PDT", "category":"demo"}' http://localhost:8080/tasks

有关如何使用curl发布JSON数据的信息,请参阅此帖子: How to POST JSON data with Curl from Terminal/Commandline to Test Spring REST?

此外,这是关于MessageConverters的相关Spring文档: http://docs.spring.io/spring/docs/current/spring-framework-reference/html/mvc.html#mvc-ann-requestbody http://docs.spring.io/spring/docs/current/spring-framework-reference/html/remoting.html#rest-message-conversion