Spring アノテーション AOP に基づく Java 例外処理

1. はじめに

プロジェクトが最初に開発されたとき、十分な準備がありませんでした。開発が一定のレベルに達して初めて、未解決の問題がいくつかあることに気づきます。たとえば、今日は例外処理という問題について話したいと思います。プログラムを作成するとき、例外は通常 try...catch...finally によって処理されますが、プログラムを作成するときに考えられるすべての例外を本当に処理できるのでしょうか? そして、例外が発生したときにどのようなロジックが実行されるか、どのようなプロンプト情報が返されるか、どのページにジャンプするか、これらすべてを考慮する必要があります。

2. @ControllerAdvice に基づく例外処理 (拡張コントローラー)

@ControllerAdvice アノテーションは、@ExceptionHandler、@InitBinder、@ModelAttribute アノテーション付きメソッドを内部的に使用して、すべての @RequestMapping アノテーション付きメソッドに適用します。この例では、ExceptionHandler を使用して、発生した例外を処理するために @RequestMapping アノテーションが付けられたすべてのメソッドに適用します。

サンプルコード:

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.util.StringUtils;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;

import com.hjz.exception.ServiceException;
import com.hjz.exception.utils.ExceptionUtils;

@ResponseBody
public class ExceptionAdvice {
 private static final Logger LOGGER = LoggerFactory.getLogger(ExceptionAdvice.class);

 /**
  * 拦截web层异常，记录异常日志，并返回友好信息到前端
  * 目前只拦截Exception，是否要拦截Error需再做考虑
  *
  * @param e 异常对象
  * @return 异常提示
  */
 @ExceptionHandler(Exception.class)
 public ResponseEntity<String> handleException(Exception e) {
  //不需要再记录ServiceException，因为在service异常切面中已经记录过
  if (!(e instanceof ServiceException)) {
   LOGGER.error(ExceptionUtils.getExcTrace(e));
  }

  HttpHeaders headers = new HttpHeaders();
  headers.set("Content-type", "text/plain;charset=UTF-8");
  headers.add("icop-content-type", "exception");
  String message = StringUtils.isEmpty(e.getMessage()) ? "系统异常!!" : e.getMessage();
  return new ResponseEntity<>(message, headers, HttpStatus.OK);
 }
}

動作しない場合は、spring-mvc 設定ファイルをチェックして、ControllerAdvice の次の設定があるかどうかを確認してください

<context:component-scan base-package="com.sishuok.es" use-default-filters="false"> 
  <context:include-filter type="annotation" expression="org.springframework.stereotype.Controller"/> 
  <context:include-filter type="annotation" expression="org.springframework.web.bind.annotation.ControllerAdvice"/> 
 </context:component-scan>

3. AOP-ベースの例外処理

1. コントローラー層で例外を処理します。 Spring Configuration のパブリック設定ファイルに以下を追加します:

import org.aspectj.lang.annotation.AfterThrowing;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import org.springframework.util.StringUtils;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import com.hjz.exception.ServiceException;
import com.hjz.exception.utils.ExceptionUtils;

import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.PrintWriter;

/**
 * web异常切面
 * 默认spring aop不会拦截controller层，使用该类需要在spring公共配置文件中注入改bean，
 * 另外需要配置<aop:aspectj-autoproxy proxy-target-class="true"/>
 */
@Aspect
public class WebExceptionAspect {
 private static final Logger LOGGER = LoggerFactory.getLogger(WebExceptionAspect.class);

 @Pointcut("@annotation(org.springframework.web.bind.annotation.RequestMapping)")
 private void webPointcut() {}

 /**
  * 拦截web层异常，记录异常日志，并返回友好信息到前端
  * 目前只拦截Exception，是否要拦截Error需再做考虑
  *
  * @param e 异常对象
  */
 @AfterThrowing(pointcut = "webPointcut()", throwing = "e")
 public void handleThrowing(Exception e) {
  //不需要再记录ServiceException，因为在service异常切面中已经记录过
  if (!(e instanceof ServiceException)) {
   LOGGER.error(ExceptionUtils.getExcTrace(e));
  }

  String errorMsg = StringUtils.isEmpty(e.getMessage()) ? "系统异常" : e.getMessage();
  writeContent(errorMsg);
 }

 /**
  * 将内容输出到浏览器
  *
  * @param content 输出内容
  */
 private void writeContent(String content) {
  HttpServletResponse response = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getResponse();
  response.reset();
  response.setCharacterEncoding("UTF-8");
  response.setHeader("Content-Type", "text/plain;charset=UTF-8");
  response.setHeader("icop-content-type", "exception");
  PrintWriter writer = null;
  try {
   writer = response.getWriter();
  } catch (IOException e) {
   e.printStackTrace();
  }
  writer.print(content);
  writer.flush();
  writer.close();
 }
}

または、登録クラスをカスタマイズして、 @Component アノテーションを ServiceExceptionAspect.java と WebExceptionAspect.java の両方に追加します

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.AfterThrowing;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import org.springframework.util.StringUtils;

import com.hjz.exception.ServiceException;
import com.hjz.exception.utils.ExceptionUtils;

@Aspect
public class ServiceExceptionAspect {
 private static final Logger LOGGER = LoggerFactory.getLogger(ServiceExceptionAspect.class);

 /**
  * @within(org.springframework.stereotype.Service)，拦截带有 @Service 注解的类的所有方法
  * @annotation(org.springframework.web.bind.annotation.RequestMapping)，拦截带有@RquestMapping的注解方法
  */
 @Pointcut("@within(org.springframework.stereotype.Service) && execution(public * *(..))")
 private void servicePointcut() {}

 /**
  * 拦截service层异常，记录异常日志，并设置对应的异常信息
  * 目前只拦截Exception，是否要拦截Error需再做考虑
  *
  * @param e 异常对象
  */
 @AfterThrowing(pointcut = "servicePointcut()", throwing = "e")
 public void handle(JoinPoint point, Exception e) {
  LOGGER.error(ExceptionUtils.getExcTrace(e));

  String signature = point.getSignature().toString();
  String errorMsg = getMessage(signature) == null ? (StringUtils.isEmpty(e.getMessage()) ? "服务异常" : e.getMessage()) : getMessage(signature);
  throw new ServiceException(errorMsg, e);
 }

 /**
  * 获取方法签名对应的提示消息
  *
  * @param signature 方法签名
  * @return 提示消息
  */
 private String getMessage(String signature) {
  return null;
 }
}

<aop:aspectj-autoproxy proxy-target-class="true" />
<bean class="com.hjz.exception.aspect.ServiceExceptionAspect" />
<bean class="com.hjz.exception.aspect.WebExceptionAspect" />

4. 疑問

@(org.springframework.stereotype.Service)内で、@Service

@annotation(org.springframework.web.bind.annotation.RequestMapping)アノテーションが付けられたクラスのメソッドをすべてインターセプトし、メソッドをインターセプトする@RquestMapping

のアノテーションが付けられています。 5. テスト コントローラー層とサービス層の例外テスト クラスをそれぞれ作成します。これは非常に簡単で、メソッド内で例外をスローするだけです。最後に、例外発生時に @AfterThrowing に対応するメソッドが実行されるかどうかを確認するだけです。

以上がこの記事の全内容です。皆さんの学習に役立つことを願っています。また、皆さんも PHP 中国語 Web サイトをサポートしていただければ幸いです。

Spring アノテーション AOP に基づく Java ベースの例外処理に関する記事については、PHP 中国語 Web サイトに注目してください。