使用@ResponseStatus修饰异常类
如果希望程序抛出自定义异常时也能被异常解析器解析成HTTP状态码,从而显示Web服务器提供的错误页面,就像前面DefaultHandlerExceptptionResolver的行为那样,则可使用Spring MVC提供的@ResponseStatus注解。
@ResponseStatus可用于修饰异常类,为该异常类指定对应的状态码和错误原因,这样当控制器的处理方法抛出该异常时,将由ResponseStatusExceptionResolver负责解析成对应的HTTP状态码。
此外,@ResponseStatus还可用于修饰方法,当使用该注解修饰方法时,通常会与@ExceptionHandler注解结合使用。
@ResponseStatus注解支持的属性如表
@ResponseStatus注解其实很简单,通常只需指定value或code属性,指定该异常类对应的HTTP状态码。
需要说明的是,当使用该注解修饰异常类,或者该注解指定了reason属性之后,Spring MVC底层会调用HttpServletResponse的sendError()方法来输出响应消息。
一旦调用了HttpServletResponse的sendError()方法,整个响应就完成了,后面不应该继续输出任何内容。因此,@ResponseStatus注解不适合在RESTful API中使用。注意
避免在RESTful API中使用@ResponseStatus注解。如果希望RESTful API也能生成带HTTP状态码的响应消息,只要让处理方法返回ResponseEntity对象即可,就如第6章所介绍的那样。
下面对上一个示例略做修改,先删除Spring MVC配置文件中关于SimpleMappingExceptionResolver异常解析器的配置,不再使用这种“老旧”的异常处理机制。
接下来定义一个自定义的异常类。
该异常类使用了@ResponseStatus注解修饰,并指定了code和reason属性,这意味着当控制器的处理方法抛出该异常时,该异常就会被解析成HttpStatus.FORBIDDEN状态码,并使用reason指定异常原因。
该示例对BookServiceImpl实现类略做修改,使之能抛出自定义的BookException异常。下面是BookServiceImpl实现类的代码。
从上面的粗体字代码可以看出,当Book的price属性值小于或等于50时,该方法会抛出BookException异常。
由于本示例不再需要argerror.jsp、sqlerror.jsp、error.jsp等错误页面,而是直接使用Web服务器提供的错误页面,因此可删除/WEB-INF/content目录下的argerror.jsp、sqlerror.jsp、error.jsp文件。
部署、运行该应用,请求/bookForm,应用会显示/WEB-INF/content/bookForm.jsp页面,在该页面的price表单域中输入小于50的数值后提交表单,将看到如图
使用@ExceptionHandler修饰异常处理方法
@ExceptionHandler注解修饰的方法被当成异常处理方法,当控制器的处理方法抛出异常时,该方法将会自动执行,对异常进行处理。
@ExceptionHandler注解只支持一个value属性,该属性可通过数组指定一系列的异常类名,表明只有当处理方法抛出对应的异常时,@ExceptionHandler注解修饰的异常处理方法才会自动执行。
@ExceptionHandler注解修饰的异常处理方法可声明如下类型形参。
➢ 任何异常类型:用于访问处理方法抛出的异常。
➢ ServletRequest、ServletResponse、HttpSession等:用于访问Servlet API。
➢ WebRequest或NativeWebRequest:其作用等同于在控制器的处理方法中声明这种类型的形参。
➢ Locale:用于访问客户端的语言区域。
➢ InputStream、Reader、OutputStream或Writer:用于直接访问请求或响应的IO流。
➢ Model:代表模型对象。
@ExceptionHandler注解修饰的异常处理方法可返回如下类型的返回值。
➢ ModelAndView:该返回值同时包含Model和View。
➢ Model或Map:该返回值只有模型数据,Spring MVC会使用RequestToViewNameTranslator隐式获取视图名。
➢ View:该返回值就是视图对象。
➢ String:该返回值代表逻辑视图名。
➢ HttpEntity<?>、ResponseEntity<?>或@ResponseBody修饰的方法:该方法的返回值将直接作为响应消息,通常用于RESTful API开发。
➢ void:当异常处理方法自行通过ServletResponse或HttpServletResponse生成响应消息时,可将该方法的返回值声明为void;否则,如果将异常处理方法的返回值声明为void,Spring MVC会使用RequestToViewNameTranslator隐式获取视图名。
下面示例还是对前面的SimpleMappingExceptionResolver示例略做修改,先删除Spring MVC配置文件中关于SimpleMappingExceptionResolver异常解析器的配置,不再使用这种“老旧”的异常处理机制。