如何在spring mvc @Controller中返回错误消息

Question

我正在使用这样的方法

@RequestMapping(method = RequestMethod.GET)
public ResponseEntity<UserWithPhoto> getUser(@RequestHeader(value="Access-key") String accessKey,
                                     @RequestHeader(value="Secret-key") String secretKey){
    try{
        return new ResponseEntity<UserWithPhoto>((UserWithPhoto)this.userService.chkCredentials(accessKey, secretKey, timestamp),
                new HttpHeaders(),
                HttpStatus.CREATED);
    }
    catch(ChekingCredentialsFailedException e){
        e.printStackTrace();
        return new ResponseEntity<UserWithPhoto>(null,new HttpHeaders(),HttpStatus.FORBIDDEN);
    }
}

并且我想在发生异常时返回一些文本消息，但现在我只返回状态和空对象。有可能吗？

Answer 1

正在评估来自另一个调用的服务的错误响应...

这是我评估错误的解决方案：

try {
        return authenticationFeign.signIn(userDto, dataRequest);
    }catch(FeignException ex){

        //ex.status();

        if(ex.status() == HttpStatus.UNAUTHORIZED.value()){
            System.out.println("is a error 401");
            return new ResponseEntity<>(HttpStatus.UNAUTHORIZED);
        }
        return new ResponseEntity<>(HttpStatus.OK);

    }

Answer 2

return new ResponseEntity<>(GenericResponseBean.newGenericError("Error during the calling the service", -1L), HttpStatus.EXPECTATION_FAILED);

Answer 3

这是另一种选择。创建一个接受状态代码和消息的通用异常。然后创建一个异常处理程序。使用异常处理程序从异常中检索信息并返回给服务的调用者。

http://javaninja.net/2016/06/throwing-exceptions-messages-spring-mvc-controller/

public class ResourceException extends RuntimeException {

    private HttpStatus httpStatus = HttpStatus.INTERNAL_SERVER_ERROR;

    public HttpStatus getHttpStatus() {
        return httpStatus;
    }

    /**
     * Constructs a new runtime exception with the specified detail message.
     * The cause is not initialized, and may subsequently be initialized by a
     * call to {@link #initCause}.
     * @param message the detail message. The detail message is saved for later retrieval by the {@link #getMessage()}
     *                method.
     */
    public ResourceException(HttpStatus httpStatus, String message) {
        super(message);
        this.httpStatus = httpStatus;
    }
}

然后使用异常处理程序检索信息并将其返回给服务调用者。

@ControllerAdvice
public class ExceptionHandlerAdvice { 

    @ExceptionHandler(ResourceException.class)
    public ResponseEntity handleException(ResourceException e) {
        // log exception 
        return ResponseEntity.status(e.getHttpStatus()).body(e.getMessage());
    }         
} 

然后在需要时创建一个异常。

throw new ResourceException(HttpStatus.NOT_FOUND, "We were unable to find the specified resource.");

Answer 4

正如 Sotirios Delimanolis 已经在 cmets 中指出的那样，有两种选择：

返回 ResponseEntity 和错误信息

像这样改变你的方法：

@RequestMapping(method = RequestMethod.GET)
public ResponseEntity getUser(@RequestHeader(value="Access-key") String accessKey,
                              @RequestHeader(value="Secret-key") String secretKey) {
    try {
        // see note 1
        return ResponseEntity
            .status(HttpStatus.CREATED)                 
            .body(this.userService.chkCredentials(accessKey, secretKey, timestamp));
    }
    catch(ChekingCredentialsFailedException e) {
        e.printStackTrace(); // see note 2
        return ResponseEntity
            .status(HttpStatus.FORBIDDEN)
            .body("Error Message");
    }
}

注意 1：您不必使用 ResponseEntity 构建器，但我发现它有助于保持代码的可读性。它还有助于记住特定 HTTP 状态代码的响应应包含哪些数据。例如，状态码为 201 的响应应在 Location 标头中包含指向新创建资源的链接（请参阅 Status Code Definitions）。这就是 Spring 提供方便的构建方法ResponseEntity.created(URI) 的原因。

注意 2：不要使用 printStackTrace()，而是使用记录器。

提供@ExceptionHandler

从您的方法中删除 try-catch 块并让它抛出异常。然后在使用@ControllerAdvice 注释的类中创建另一个方法，如下所示：

@ControllerAdvice
public class ExceptionHandlerAdvice {

    @ExceptionHandler(ChekingCredentialsFailedException.class)
    public ResponseEntity handleException(ChekingCredentialsFailedException e) {
        // log exception
        return ResponseEntity
                .status(HttpStatus.FORBIDDEN)
                .body("Error Message");
    }        
}

请注意，使用@ExceptionHandler 注释的方法允许具有非常灵活的签名。详情请参阅Javadoc。