当前位置:首页 > Java技术 > Java 代码中的全局异常处理

Java 代码中的全局异常处理

最近接手一个新项目,写用例的时候去翻看代码,发现部分代码里缺少基本的异常处理,包括对参数异常以及业务异常的处理。对照之前负责过的异常处理做得比较好的项目,给开发提了几点建议,顺便又去翻看了之前项目的代码,对常用的异常处理方式做了一个梳理。

1 Java异常分类

 

Java 代码中的全局异常处理 _ JavaClub全栈架构师技术笔记


Java把异常当做对象来处理。Throwable是所有错误或异常的超类。Throwable类有两个直接子类:Error类和Exception类。
1、Error是指java运行时系统的内部错误和资源耗尽错误,是程序无法处理的异常,应用程序不会抛出该类对象。
2、Exception是程序本身可以处理的异常,应尽可能去处理这些异常。Exception分两类,一个是运行时异常RuntimeException,一个是检查异常CheckedException。
3、CheckedException一般是外部错误,这种异常都发生在编译阶段,Java编译器会强制程序去捕获此类异常。
4、RuntimeException是那些可能在Java 虚拟机正常运行期间抛出的异常的超类。这种错误是由程序员引起的错误,可以修正代码解决。

2 用@ControllerAdvice+@ExceptionHandler实现全局异常处理

通常在Controller层需要去捕获service层的异常,防止返回一些不友好的错误信息到客户端,但如果Controller层每个方法都用模块化的try-catch代码去捕获异常,会很难看也难维护。
异常处理最好是解耦的,并且都放在一个地方集中管理。Spring能够较好的处理这种问题,核心如下,这里主要关注前两个:
@ExceptionHandler:统一处理某一类异常,从而能够减少代码重复率和复杂度
@ControllerAdvice:异常集中处理,更好的使业务逻辑与异常处理剥离开
@ResponseStatus:可以将某种异常映射为HTTP状态码

单使用@ExceptionHandler,只能在当前Controller中处理异常,与@ControllerAdvice组合使用,则可以实现全局异常处理,不用每个controller都配置。

2.1 全局异常处理类

下面通过一个实际项目代码来看一下@ControllerAdvice+@ExceptionHandler的使用。
@ControllerAdvice定义全局异常处理类GlobalExceptionHandler
@ExceptionHandler声明异常处理方法,使用value指定异常类,value = Exception.class表示处理Controller层抛出的Exception及其子类的异常,这样Controller层代码就不需要进行异常处理了。

GlobalExceptionHandler类中对多个异常进行了处理,这些异常分两类,一类是自定义异常,如AuthenticationException、BadRequestException,一类是非自定义异常,如HttpRequestMethodNotSupportedException、TypeMismatchException等。

 

Java 代码中的全局异常处理 _ JavaClub全栈架构师技术笔记

2.2 自定义异常

一般项目中都会有一些业务相关(非JVM抛出)的异常,可以使用自定义异常继承相关的异常来抛出有用的异常信息,其类名要能体现具体的异常信息,这样根据异常名就可以知道哪里有异常,根据异常提示信息进行程序修改。比如空指针异常NullPointException,可以抛出message为“xxx为空”定位异常位置,而不用输出堆栈信息。

自定义异常通常是定义一个继承自Exception类的子类,一般会直接继承自Exception类,而不会继承某个运行时的异常类。

下面是项目代码中自定义异常的使用。
定义自定义异常类AuthenticationException,继承Exception类:

 

Java 代码中的全局异常处理 _ JavaClub全栈架构师技术笔记


在Service层抛出AuthenticationException:

Java 代码中的全局异常处理 _ JavaClub全栈架构师技术笔记

2.3 数据校验异常处理

代码中可以使用@RequestBody+@Valid进行数据绑定和数据校验。
下面是项目代码中对Post请求表单的处理,通过@RequestBody将请求body中的json与表单对象(CreateOrderRequestVO)绑定,使用@Valid进行表单验证。如果不使用@Valid,CreateOrderRequestVO中的@NotNull等注解不生效。

 

Java 代码中的全局异常处理 _ JavaClub全栈架构师技术笔记

在表单对象CreateOrderRequestVO类的相应字段上添加用于充当校验条件的注解(@NotNull@NotBlank@Min等)。

 

Java 代码中的全局异常处理 _ JavaClub全栈架构师技术笔记

数据校验失败时,Spring MVC 框架会抛出 MethodArgumentNotValidException 异常, 在 GlobalExceptionHandler 中加上对 MethodArgumentNotValidException 异常的声明和处理,就可以全局处理数据校验的异常了。

小结

本文主要是基于项目代码,对其中的全局统一异常处理做了一个梳理和总结。这种异常处理方式将异常处理从业务代码中解耦出来,实现异常信息的统一处理和维护,减少了模板代码,改善了代码的风格。

在日常测试中,有意识地多学习一些开发代码中写得好的地方,为自己以后写代码不断积累经验,还可以适时地对开发的代码提出一些建议。

以上转自:https://testerhome.com/topics/12058

附录我司的全局异常处理类

package api.util;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;

import api.framework.dto.Result;
import api.framework.exception.ServiceException;

/**
 * 全局异常处理器,处理新增的异常,对于有特殊逻辑的返回直接定义个新方法,参考ServiceException
 */
@ControllerAdvice
@Component
@ResponseBody
public class GlobalExceptionHandler {
	
	private final static Logger LOGGER = LoggerFactory.getLogger(GlobalExceptionHandler.class);
	
	@ExceptionHandler(ServiceException.class)
	public Result<String> handlerServiceException(ServiceException e){
        return new Result<String>("error", e.getMessage(), "", "", e.getCode());
	}
	

	@ExceptionHandler(Exception.class)
	public Result<String> handlerException(Exception e){
		LOGGER.error("Oops", e);
        return new Result<String>("error", "网络异常", "", "", "500");
	}
}
package api.framework.exception;

/**
 * <p>
 * 业务异常,这里约定每个业务场景的错误都是有一个错误码的。
 * </p>
 * <p>
 * 这个错误码需要展示给前端。前端需要根据这个码值做一些特殊的判断。如余额不足,
 * 错误码 001,那么前端根据这个码值引导用户去充值页面。
 * <p>
 */
public class ServiceException extends RuntimeException{

	private static final long serialVersionUID = 228211L;
	
	private String code;
	
	/**
	 * 构造一个业务异常类
	 * 
	 * @param code 错误码,注意约定的业务错误码都是大于600的
	 * @param message 错误信息
	 */
	public ServiceException(String code, String message){
		super(message);
		this.code = code;
	}

	/**
	 * 返回错误码
	 * @return 错误码
	 */
	public String getCode() {
		return code;
	}
}

 

作者:水桶前辈
来源链接:https://blog.csdn.net/robinson_911/article/details/90549592

版权声明:
1、JavaClub(https://www.javaclub.cn)以学习交流为目的,由作者投稿、网友推荐和小编整理收藏优秀的IT技术及相关内容,包括但不限于文字、图片、音频、视频、软件、程序等,其均来自互联网,本站不享有版权,版权归原作者所有。

2、本站提供的内容仅用于个人学习、研究或欣赏,以及其他非商业性或非盈利性用途,但同时应遵守著作权法及其他相关法律的规定,不得侵犯相关权利人及本网站的合法权利。
3、本网站内容原作者如不愿意在本网站刊登内容,请及时通知本站(javaclubcn@163.com),我们将第一时间核实后及时予以删除。


本文链接:https://www.javaclub.cn/java/68177.html

分享给朋友: