如何强制Spring Boot将正确的HTTP状态代码设置为错误响应？

Question

package com.pany.app;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class MyApplication {

    public static void main(String[] args) {
        SpringApplication.run(MyApplication.class, args);
    }

}

package com.pany.app;

import org.springframework.context.annotation.Configuration;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;

@Configuration
public class MySecurityConfig extends WebSecurityConfigurerAdapter {

    protected void configure(HttpSecurity http) throws Exception {
        http.authorizeRequests().antMatchers("/**").anonymous();
    }

}

package com.pany.app;

import org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.HttpClientErrorException;

@RestController
public class MyController {

    @GetMapping(path = "/", produces = { "application/json" })
    public void home() {
        throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "This is my custom 400 Bad Request message");
    }

}

{
  "timestamp": "2020-09-14T07:24:22.061+0000",
  "status": 500,
  "error": "Internal Server Error",
  "message": "400 This is my custom 400 Bad Request message",
  "path": "/"
}

我还用Spring Boot2.3.3.Release测试了这一点...现在它甚至不再像以前那样工作了！！

{
  "timestamp": "2020-09-14T07:34:23.154+00:00",
  "status": 500,
  "error": "Internal Server Error",
  "message": "",
  "path": "/"
}

所有这些都是通过诸如ErrorController、AbstracTerrorController和BasicErrorController等类/接口来处理的（都在ErrorMVCautoConfiguration中设置）。显然，有一个重定向到URL/error的操作，将原始请求/和/或响应包装到其他内容中，例如，我可以将请求调试为符合以下内容：SecurityContextHolderAwareRequestWrapper[FirewalledRequest[org.apache.catalina.core.ApplicationHttpRequest@3751Bea4]]

我发现，我得到的JSON是通过一个名为DefaulTerrorAttributes的bean生成的，该bean从键“javax.servlet.error.status_code”下的请求中提取HTTP状态代码。

我在上面看到:https://github.com/spring-projects/spring-boot/issues/4694#issuecomment-163597864(2015年12月）：

问题实际上是在BasicErrorController中，并且是特定于HTML响应的。错误使用由ErrorPageFilter设置的javax.servlet.error.status_code属性设置响应状态，但BasicErrorController.ErrorHTML不这样做。这将导致文本/HTML错误响应的状态为200 OK。

事实上，在我的例子中，从来没有调用errorpagefilter。

{
  "timestamp": "2020-09-14T07:24:22.061+0000",
  "status": 400,
  "error": "Bad Request",
  "message": "This is my custom 400 Bad Request message",
  "path": "/"
}

多谢了。

Answer 1

@controlleradvice的一个简单替代方案是具有如下所示的自定义异常

@Slf4j
@ResponseStatus(HttpStatus.NOT_FOUND)
public class NotFoundException extends RuntimeException{

  public NotFoundException(String message) {
    super(message);
    log.warn(message);
  }

}

使用带有@responsestatus注释的所需Http代码。

并在需要时抛出此异常

throw new NotFoundException("Your message for not found goes here");