Spring MVC @ExceptionHandler的使用

本文介绍如何使用SpringMVC中的@ExceptionHandler注解实现统一异常处理,通过定义ExceptionController类,并在需要处理异常的Controller类中继承该类,可以将HTTP状态码从500改为200,并返回自定义的异常处理信息。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

Spring MVC 中的@ExceptionHandler可以对web的服务器端运行错误, 做统一的处理,使得http status code 从原本的500改成200, 

并去执行用@ExceptionHandler注解的方法。  前提是实现了这个方法的Class被 那个访问的Controller 继承了。


首先定义这样一个统一异常处理类

ExceptionController.java

package com.foundjet.front.base.controller;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;

import net.sf.json.JSONObject;

public abstract class ExceptionController {
	@ExceptionHandler
	public @ResponseBody String exceptionProcess(HttpServletRequest request, HttpServletResponse
			response, RuntimeException ex) {
		JSONObject json = new JSONObject();
		json.put("isError", true);
		json.put("msg", ex.getMessage());
		return json.toString();
	}
}

在需要进行统一处理的类中extends 这个class

package com.foundjet.front.client.controller;

import javax.annotation.Resource;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

import com.foundjet.back.customer.service.CustomerService;
import com.foundjet.front.base.controller.ExceptionController;
import com.foundjet.front.base.controller.LoginAuth;

import net.sf.json.JSONObject;

@RequestMapping("/auth/customer")
@Controller
@LoginAuth
public class CustomerController extends ExceptionController {
	@Resource
	private CustomerService customerService;
	
	/**
	 * 
	 * @param page 第几页,从1开始
	 * @param rows 每页多少记录的行数
	 * @return JSON String
	 */
	@RequestMapping("/querybypage")
	@ResponseBody
	public String QueryByPage(int page, int rows) {
		//当为缺省值的时候进行赋值
        int currentpage = ( page == 0) ? 1: page;	//第几页
        int pageSize = (rows == 0) ? 5: rows;	//每页显示数量
        int index = (currentpage - 1) * pageSize;	//从第几条开始显示
        JSONObject map = customerService.queryByPage(index, pageSize);
        return map.toString();
	}
	
	@RequestMapping("/test")
	public @ResponseBody Object test() {
		JSONObject json = new JSONObject();
		json.put("status", "success");
		String str = null;
		str.toString();
		return json.toString();
	}
}

其中重要的一行是

public class CustomerController extends ExceptionController

这样CustomController里的方法被访问的时候, 如有异常, 就会被exceptionProces()处理

绕过web.xml中如下配置

web.xml

<!-- 错误跳转页面 -->
	<error-page>
		<!-- 路径不正确 -->
		<error-code>404</error-code>
		<location>/WEB-INF/errorpage/404.jsp</location>
	</error-page>
	<error-page>
		<!-- 没有访问权限,访问被禁止 -->
		<error-code>405</error-code>
		<location>/WEB-INF/errorpage/405.jsp</location>
	</error-page>
	<error-page>
		<!-- 内部错误 -->
		<error-code>500</error-code>
		<location>/WEB-INF/errorpage/500.jsp</location>
	</error-page>




### @ExceptionHandler 注解的使用方法及示例 #### 1. 基本概念 `@ExceptionHandler` 是 Spring 框架中的一个重要注解,主要用于标识一个方法,使其能够处理特定类型的异常。当控制器方法抛出指定类型的异常时,Spring 将自动调用由 `@ExceptionHandler` 标识的方法来处理该异常[^2]。 #### 2. 使用场景 此注解广泛应用于 Spring MVC 应用程序中,用于集中化异常处理机制。它可以用来处理各种类型的异常,例如数据库异常、验证异常以及业务逻辑异常等[^1]。这种设计模式不仅可以减少冗余代码,还可以提升代码的可读性和维护性[^3]。 #### 3. 示例代码 以下是关于如何在实际开发中使用 `@ExceptionHandler` 的具体示例: ```java @Controller public class TestExceptionController { // 正常请求处理方法 @GetMapping("/test") public String testMethod() { throw new IllegalArgumentException("非法参数错误"); } // 处理IllegalArgumentException类型异常 @ExceptionHandler(IllegalArgumentException.class) public ResponseEntity<String> handleIllegalArgument(Exception ex) { return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(ex.getMessage()); } } ``` 在此示例中,如果 `/test` 请求触发了一个 `IllegalArgumentException` 异常,则会被 `handleIllegalArgument` 方法捕获并返回相应的 HTTP 错误响应状态码和消息[^4]。 #### 4. 扩展功能 为了进一步增强全局异常处理能力,通常会将所有的异常处理器集中在基类中,其他具体的 Controller 可以继承这个基类从而共享这些异常处理逻辑。下面是一个扩展的例子: ```java // 定义基础控制器类 public abstract class BaseController { @ExceptionHandler({ RuntimeException.class }) public ResponseEntity<String> handleRuntimeException(RuntimeException e) { return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(e.getMessage()); } } // 继承自BaseController的具体控制类 @Controller public class AnotherTestController extends BaseController { @GetMapping("/another-test") public String anotherTestMethod() { throw new RuntimeException("运行时异常发生!"); } } ``` 在这个例子中,任何从 `BaseController` 派生出来的子类都可以利用其定义好的通用异常处理函数。 --- ###
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值