blocks|key|4454297|text|如果您希望完全控制每个控制器中的响应消息，请编写一个ControllerAdvice。例如，该示例将MethodArgumentNotValidException转换为自定义json对象：|type|unstyled|depth|inlineStyleRanges|offset|length|style|CODE|entityRanges|data|4454298|import+org.springframework.core.Ordered;
import+org.springframework.core.annotation.Order;
import+org.springframework.validation.BindingResult;
import+org.springframework.web.bind.MethodArgumentNotValidException;
import+org.springframework.web.bind.annotation.ControllerAdvice;
import+org.springframework.web.bind.annotation.ExceptionHandler;
import+org.springframework.web.bind.annotation.ResponseBody;
import+org.springframework.web.bind.annotation.ResponseStatus;

import+java.util.ArrayList;
import+java.util.List;

import+static+org.springframework.http.HttpStatus.BAD_REQUEST;

/**
+*+Kudos+http://www.petrikainulainen.net/programming/spring-framework/spring-from-the-trenches-adding-validation-to-a-rest-api/
+*
+*/
@Order(Ordered.HIGHEST_PRECEDENCE)
@ControllerAdvice
public+class+MethodArgumentNotValidExceptionHandler+{

++++@ResponseStatus(BAD_REQUEST)
++++@ResponseBody
++++@ExceptionHandler(MethodArgumentNotValidException.class)
++++public+Error+methodArgumentNotValidException(MethodArgumentNotValidException+ex)+{
++++++++BindingResult+result+=+ex.getBindingResult();
++++++++List<org.springframework.validation.FieldError>+fieldErrors+=+result.getFieldErrors();
++++++++return+processFieldErrors(fieldErrors);
++++}

++++private+Error+processFieldErrors(List<org.springframework.validation.FieldError>+fieldErrors)+{
++++++++Error+error+=+new+Error(BAD_REQUEST.value(),+"validation+error");
++++++++for+(org.springframework.validation.FieldError+fieldError:+fieldErrors)+{
++++++++++++error.addFieldError(fieldError.getField(),+fieldError.getDefaultMessage());
++++++++}
++++++++return+error;
++++}

++++static+class+Error+{
++++++++private+final+int+status;
++++++++private+final+String+message;
++++++++private+List<FieldError>+fieldErrors+=+new+ArrayList<>();

++++++++Error(int+status,+String+message)+{
++++++++++++this.status+=+status;
++++++++++++this.message+=+message;
++++++++}

++++++++public+int+getStatus()+{
++++++++++++return+status;
++++++++}

++++++++public+String+getMessage()+{
++++++++++++return+message;
++++++++}

++++++++public+void+addFieldError(String+path,+String+message)+{
++++++++++++FieldError+error+=+new+FieldError(path,+message);
++++++++++++fieldErrors.add(error);
++++++++}

++++++++public+List<FieldError>+getFieldErrors()+{
++++++++++++return+fieldErrors;
++++++++}
++++}
}|code-block|syntax|javascript|4454299|entityMap^0|Q|G|1E|V|0|0^^$0|@$1|2|3|4|5|6|7|M|8|@$9|N|A|O|B|C]|$9|P|A|Q|B|C]]|D|@]|E|$]]|$1|F|3|G|5|H|7|R|8|@]|D|@]|E|$I|J]]|$1|K|3|-4|5|6|7|S|8|@]|D|@]|E|$]]]|L|$]]

If you want full control over the response message in every controller write a <code>ControllerAdvice</code>. For example, that example transform <code>MethodArgumentNotValidException</code> into a custom json object:

<pre><code>import org.springframework.core.Ordered;
import org.springframework.core.annotation.Order;
import org.springframework.validation.BindingResult;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.ResponseStatus;

import java.util.ArrayList;
import java.util.List;

import static org.springframework.http.HttpStatus.BAD_REQUEST;

/**
 * Kudos http://www.petrikainulainen.net/programming/spring-framework/spring-from-the-trenches-adding-validation-to-a-rest-api/
 *
 */
@Order(Ordered.HIGHEST_PRECEDENCE)
@ControllerAdvice
public class MethodArgumentNotValidExceptionHandler {

 @ResponseStatus(BAD_REQUEST)
 @ResponseBody
 @ExceptionHandler(MethodArgumentNotValidException.class)
 public Error methodArgumentNotValidException(MethodArgumentNotValidException ex) {
 BindingResult result = ex.getBindingResult();
 List&lt;org.springframework.validation.FieldError&gt; fieldErrors = result.getFieldErrors();
 return processFieldErrors(fieldErrors);
 }

 private Error processFieldErrors(List&lt;org.springframework.validation.FieldError&gt; fieldErrors) {
 Error error = new Error(BAD_REQUEST.value(), "validation error");
 for (org.springframework.validation.FieldError fieldError: fieldErrors) {
 error.addFieldError(fieldError.getField(), fieldError.getDefaultMessage());
 }
 return error;
 }

 static class Error {
 private final int status;
 private final String message;
 private List&lt;FieldError&gt; fieldErrors = new ArrayList&lt;&gt;();

 Error(int status, String message) {
 this.status = status;
 this.message = message;
 }

 public int getStatus() {
 return status;
 }

 public String getMessage() {
 return message;
 }

 public void addFieldError(String path, String message) {
 FieldError error = new FieldError(path, message);
 fieldErrors.add(error);
 }

 public List&lt;FieldError&gt; getFieldErrors() {
 return fieldErrors;
 }
 }
}
</code></pre>

blocks|key|4454158|text|我知道这是个老问题，|type|unstyled|depth|inlineStyleRanges|entityRanges|data|4454159|但我只是偶然发现了一些很好的article，它在github中也有一个完美的例子。|offset|length|4454160|基本上，它使用@ControllerAdvice，正如Spring文档所建议的那样。|style|CODE|4454161|例如，捕获400错误将通过覆盖一个函数来实现：|4454162|@ControllerAdvice
public+class+CustomRestExceptionHandler+extends+ResponseEntityExceptionHandler+{

++++@Override
++++protected+ResponseEntity<Object>+handleMethodArgumentNotValid(final+MethodArgumentNotValidException+ex,+final+HttpHeaders+headers,+final+HttpStatus+status,+final+WebRequest+request)+{
++++++++logger.info(ex.getClass().getName());
++++++++//
++++++++final+List<String>+errors+=+new+ArrayList<String>();
++++++++for+(final+FieldError+error+:+ex.getBindingResult().getFieldErrors())+{
++++++++++++errors.add(error.getField()+%2B+":+"+%2B+error.getDefaultMessage());
++++++++}
++++++++for+(final+ObjectError+error+:+ex.getBindingResult().getGlobalErrors())+{
++++++++++++errors.add(error.getObjectName()+%2B+":+"+%2B+error.getDefaultMessage());
++++++++}
++++++++final+ApiError+apiError+=+new+ApiError(HttpStatus.BAD_REQUEST,+ex.getLocalizedMessage(),+errors);
++++++++return+handleExceptionInternal(ex,+apiError,+headers,+apiError.getStatus(),+request);
++++}
}|code-block|syntax|javascript|4454163|(ApiError类是一个简单的对象，用于保存状态、消息和错误)|4454164|entityMap|0|LINK|mutability|MUTABLE|url|http://www.baeldung.com/global-error-handler-in-a-spring-rest-api|1|https://github.com/eugenp/tutorials/tree/master/spring-security-rest^0|0|E|7|0|O|6|1|0|7|H|0|0|0|0^^$0|@$1|2|3|4|5|6|7|12|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|13|8|@]|9|@$D|14|E|15|1|16]|$D|17|E|18|1|19]]|A|$]]|$1|F|3|G|5|6|7|1A|8|@$D|1B|E|1C|H|I]]|9|@]|A|$]]|$1|J|3|K|5|6|7|1D|8|@]|9|@]|A|$]]|$1|L|3|M|5|N|7|1E|8|@]|9|@]|A|$O|P]]|$1|Q|3|R|5|6|7|1F|8|@]|9|@]|A|$]]|$1|S|3|-4|5|6|7|1G|8|@]|9|@]|A|$]]]|T|$U|$5|V|W|X|A|$Y|Z]]|10|$5|V|W|X|A|$Y|11]]]]

I know this is kind of old question,

But I just run into it and I found some pretty good <a href="http://www.baeldung.com/global-error-handler-in-a-spring-rest-api" rel="noreferrer">article</a> which has also a perfect example in <a href="https://github.com/eugenp/tutorials/tree/master/spring-security-rest" rel="noreferrer">github</a>.

Basically it uses <code>@ControllerAdvice</code> as Spring documentation suggests.

So for example catching 400 error will be achieved by overriding one function:

<pre><code>@ControllerAdvice
public class CustomRestExceptionHandler extends ResponseEntityExceptionHandler {

 @Override
 protected ResponseEntity&lt;Object&gt; handleMethodArgumentNotValid(final MethodArgumentNotValidException ex, final HttpHeaders headers, final HttpStatus status, final WebRequest request) {
 logger.info(ex.getClass().getName());
 //
 final List&lt;String&gt; errors = new ArrayList&lt;String&gt;();
 for (final FieldError error : ex.getBindingResult().getFieldErrors()) {
 errors.add(error.getField() + ": " + error.getDefaultMessage());
 }
 for (final ObjectError error : ex.getBindingResult().getGlobalErrors()) {
 errors.add(error.getObjectName() + ": " + error.getDefaultMessage());
 }
 final ApiError apiError = new ApiError(HttpStatus.BAD_REQUEST, ex.getLocalizedMessage(), errors);
 return handleExceptionInternal(ex, apiError, headers, apiError.getStatus(), request);
 }
}
</code></pre>

(ApiError class is a simple object to hold status, message, errors)

blocks|key|4454433|text|一种方法是在实体属性的@NotNull注释中添加消息。并在控制器请求体中添加@Valid注释。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|4454434|DTO：|4454435|public+class+User+{
+++
++++@NotNull(message+=+"User+name+cannot+be+empty")
++++private+String+name;

++++@NotNull(message+=+"Password+cannot+be+empty")
++++private+String+password;

++++//..
}|code-block|syntax|javascript|4454436|控制器：|4454437|@RequestMapping(value+=+"/user",+method+=+RequestMethod.POST)
public+ResponseEntity<String>+saveUser(@Valid+@RequestBody+User+user)+{
++++//..
++++return+new+ResponseEntity<>(HttpStatus.OK);
}
//+Add+one+
@ExceptionHandler(MethodArgumentNotValidException.class)
public+ResponseEntity<List<YourErrorResponse>>+handleException(MethodArgumentNotValidException+ex)+{
//+Loop+through+FieldErrors+in+ex.getBindingResult();
//+return+*YourErrorReponse*+filled+using+*fieldErrors*
}|4454438|entityMap^0|0|0|0|0|0^^$0|@$1|2|3|4|5|6|7|O|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|P|8|@]|9|@]|A|$]]|$1|D|3|E|5|F|7|Q|8|@]|9|@]|A|$G|H]]|$1|I|3|J|5|6|7|R|8|@]|9|@]|A|$]]|$1|K|3|L|5|F|7|S|8|@]|9|@]|A|$G|H]]|$1|M|3|-4|5|6|7|T|8|@]|9|@]|A|$]]]|N|$]]

One way to do it is adding message in @NotNull annotation on entity properties. And adding @Valid annotation in controller request body.
DTO:
<pre><code>public class User {
 
 @NotNull(message = &quot;User name cannot be empty&quot;)
 private String name;

 @NotNull(message = &quot;Password cannot be empty&quot;)
 private String password;

 //..
}
</code></pre>
Controller:
<pre><code>@RequestMapping(value = &quot;/user&quot;, method = RequestMethod.POST)
public ResponseEntity&lt;String&gt; saveUser(@Valid @RequestBody User user) {
 //..
 return new ResponseEntity&lt;&gt;(HttpStatus.OK);
}
// Add one 
@ExceptionHandler(MethodArgumentNotValidException.class)
public ResponseEntity&lt;List&lt;YourErrorResponse&gt;&gt; handleException(MethodArgumentNotValidException ex) {
// Loop through FieldErrors in ex.getBindingResult();
// return *YourErrorReponse* filled using *fieldErrors*
}
</code></pre>

blocks|key|4454444|text|@ControllerAdvice(annotations+=+RestController.class)
public+class+GlobalExceptionHandler+implements+ApplicationContextAware+{

++++@ExceptionHandler(MethodArgumentNotValidException.class)
++++@ResponseStatus(HttpStatus.OK)
++++@ResponseBody
++++public+ApplicationError+validationException(MethodArgumentNotValidException+e)+{

++++++++e.printStackTrace();
++++++++return+new+ApplicationError(SysMessageEnum.MSG_005,+e.getBindingResult().getAllErrors().get(0).getDefaultMessage());

++++}

}|type|code-block|depth|inlineStyleRanges|entityRanges|data|syntax|javascript|4454445|unstyled|entityMap^0|0^^$0|@$1|2|3|4|5|6|7|G|8|@]|9|@]|A|$B|C]]|$1|D|3|-4|5|E|7|H|8|@]|9|@]|A|$]]]|F|$]]

<pre><code>@ControllerAdvice(annotations = RestController.class)
public class GlobalExceptionHandler implements ApplicationContextAware {

 @ExceptionHandler(MethodArgumentNotValidException.class)
 @ResponseStatus(HttpStatus.OK)
 @ResponseBody
 public ApplicationError validationException(MethodArgumentNotValidException e) {

 e.printStackTrace();
 return new ApplicationError(SysMessageEnum.MSG_005, e.getBindingResult().getAllErrors().get(0).getDefaultMessage());

 }

}
</code></pre>

blocks|key|4454469|text|你可以这样做|type|unstyled|depth|inlineStyleRanges|entityRanges|data|4454470|@ExceptionHandler(value+=+MethodArgumentNotValidException.class)
++++++protected+ResponseEntity<Error>+handleGlobalExceptions(MethodArgumentNotValidException+ex,
++++++++++WebRequest+request)+{
++++++++log.catching(ex);
++++++++return+new+ResponseEntity<>(createErrorResp(HttpStatus.BAD_REQUEST,
++++++++++++ex.getBindingResult().getFieldErrors().stream().map(err+->+err.getDefaultMessage())
++++++++++++++++.collect(java.util.stream.Collectors.joining(",+"))),
++++++++++++HttpStatus.BAD_REQUEST);
++++++}|code-block|syntax|javascript|4454471|entityMap^0|0|0^^$0|@$1|2|3|4|5|6|7|I|8|@]|9|@]|A|$]]|$1|B|3|C|5|D|7|J|8|@]|9|@]|A|$E|F]]|$1|G|3|-4|5|6|7|K|8|@]|9|@]|A|$]]]|H|$]]

You can do something like this 

<pre><code>@ExceptionHandler(value = MethodArgumentNotValidException.class)
 protected ResponseEntity&lt;Error&gt; handleGlobalExceptions(MethodArgumentNotValidException ex,
 WebRequest request) {
 log.catching(ex);
 return new ResponseEntity&lt;&gt;(createErrorResp(HttpStatus.BAD_REQUEST,
 ex.getBindingResult().getFieldErrors().stream().map(err -&gt; err.getDefaultMessage())
 .collect(java.util.stream.Collectors.joining(", "))),
 HttpStatus.BAD_REQUEST);
 }
</code></pre>

blocks|key|4454284|text|@ControllerAdvice
@RestController
public+class+CustomizedResponseEntityExceptionHandler+extends+ResponseEntityExceptionHandler+{

++++++++@Override
++++++++protected+ResponseEntity<Object>+handleMethodArgumentNotValid(
++++++++++++++++MethodArgumentNotValidException+ex,+HttpHeaders+headers,+HttpStatus+status,+WebRequest+request)+{

+++++++++++//+ex.getBindingResult():+extract+the+bind+result+for+default+message.+
++++++++++++++String+errorResult+=+ex.getBindingResult().toString();
+++++++++++++CustomizedExceptionHandlerResponse+exceptionResponse+=+new+CustomizedExceptionHandlerResponse(
++++++++++++++++++++errorResult,+new+Date(),+request.getDescription(false));

++++++++++++return+new+ResponseEntity<>(exceptionResponse,+HttpStatus.BAD_REQUEST);
++++++++}


}

class+CustomizedExceptionHandlerResponse+{

+++private+String+message;
+++private+String+status;
+++private+Date+timestamp;

+++//+constuctor,+setters,+getters...
}|type|code-block|depth|inlineStyleRanges|entityRanges|data|syntax|javascript|4454285|unstyled|entityMap^0|0^^$0|@$1|2|3|4|5|6|7|G|8|@]|9|@]|A|$B|C]]|$1|D|3|-4|5|E|7|H|8|@]|9|@]|A|$]]]|F|$]]

<pre><code>@ControllerAdvice
@RestController
public class CustomizedResponseEntityExceptionHandler extends ResponseEntityExceptionHandler {

 @Override
 protected ResponseEntity&lt;Object&gt; handleMethodArgumentNotValid(
 MethodArgumentNotValidException ex, HttpHeaders headers, HttpStatus status, WebRequest request) {

 // ex.getBindingResult(): extract the bind result for default message. 
 String errorResult = ex.getBindingResult().toString();
 CustomizedExceptionHandlerResponse exceptionResponse = new CustomizedExceptionHandlerResponse(
 errorResult, new Date(), request.getDescription(false));

 return new ResponseEntity&lt;&gt;(exceptionResponse, HttpStatus.BAD_REQUEST);
 }


}

class CustomizedExceptionHandlerResponse {

 private String message;
 private String status;
 private Date timestamp;

 // constuctor, setters, getters...
}
</code></pre>

DTO:

<pre><code>public class User {

 @NotNull
 private String name;

 @NotNull
 private String password;

 //..
}
</code></pre>

Controller:

<pre><code>@RequestMapping(value = "/user", method = RequestMethod.POST)
public ResponseEntity&lt;String&gt; saveUser(@Valid @RequestBody User user) {
 //..
 return new ResponseEntity&lt;&gt;(HttpStatus.OK);
}
</code></pre>

Default json error:

<pre><code>{"timestamp":1417379464584,"status":400,"error":"Bad Request","exception":"org.springframework.web.bind.MethodArgumentNotValidException","message":"Validation failed for argument at index 0 in method: public org.springframework.http.ResponseEntity&lt;demo.User&gt; demo.UserController.saveUser(demo.User), with 2 error(s): [Field error in object 'user' on field 'name': rejected value [null]; codes [NotNull.user.name,NotNull.name,NotNull.java.lang.String,NotNull]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [user.name,name]; arguments []; default message [name]]; default message [may not be null]],"path":"/user"}
</code></pre>

I would like to have my custom json for each error occured. How do I accomplish that?

How do I customize default error message from spring @Valid validation?

DTO：public class User {    @NotNull    private String name;    @NotNull    private String password;    //..}控制器：@RequestMapping(value = "/user", method = Reques...

问如何定制spring @Valid validation中的默认错误消息？
EN

社区

活动

资源

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问如何定制spring @Valid validation中的默认错误消息？EN

社区

活动

资源

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问如何定制spring @Valid validation中的默认错误消息？
EN