Spring Boot @ResponseStatus 教程展示了如何在 Spring 应用中使用@ResponseStatus 注解。
Spring 是流行的 Java 应用框架,而 Spring Boot 是 Spring 的演进,可以帮助轻松地创建独立的,生产级的基于 Spring 的应用。
@ResponseStatus
@ResponseStatus
用应返回的状态代码和原因消息标记方法或异常类。 调用处理程序方法时或抛出指定的异常时,状态代码将应用于 HTTP 响应。 它会覆盖通过其他方式设置的状态信息,例如ResponseEntity
或redirect:
。
Spring Boot @ResponseStatus
示例
在以下应用中,我们演示@ResponseStatus
注解的用法。 该应用模拟用于通过其 ID 检索订单的表单。 尝试查找 ID 大于 500 的订单将引发异常。 由于此异常,将显示一个自定义错误页面。
这是 Spring 应用的项目结构。
pom.xml
这是 Maven pom.xml
文件。 spring-boot-starter-freemarker
是 Freemarker 模板引擎的依赖项; spring-boot-maven-plugin
将 Spring 应用打包到可执行的 JAR 或 WAR 归档文件中。
com/zetcode/controller/MyController.java
MyController's
getOrder()
方法响应客户端请求。 它使用@PathVariable
从路径读取顺序 ID。
对于无效订单(id < 0)和大于 500 的订单,我们抛出OrderNotFoundException
异常。 这是订单系统的简单模拟。
对于其他订单 ID,我们返回一条消息,指示已找到并返回了该订单。
com/zetcode/exception/OrderNotFoundException.java
我们有一个自定义OrderNotFoundException
。 它以@ResponseStatus
注解装饰。 该值设置为HttpStatus.NOT_FOUND
,并且原因消息显示“无此顺序”。 此信息将在错误页面中使用。
resources/static/index.html
这是主页。 它包含一个链接,用于查找带有 ID 505 的订单。该文件位于src/main/resources/static
目录中。
resources/templates/error.ftl
error.ftl
是通用错误页面。 这是 Freemarker 模板文件,显示状态,错误和原因消息。 这些值是通过@ResponseStatus
设置的。 它位于src/main/resources/templates
目录中。
com/zetcode/Application.java
Application
是设置 Spring Boot 应用的入口。
Figure: Error page
在本教程中,我们展示了如何在 Spring 应用中使用@ResponseStatus
注解。