标签归档:AOP

Spring 使用@AspectJ实现aop

《Spring参考手册》中定义了以下几个AOP的重要概念:

  • 切面(Aspect) :官方的抽象定义为“一个关注点的模块化,这个关注点可能会横切多个对象”,在本例中,“切面”就是类TestAspect所关注的具体行为,例如,AServiceImpl.barA()的调用就是切面TestAspect所关注的行为之一。“切面”在ApplicationContext中<aop:aspect>来配置。
  • 连接点(Joinpoint) :程序执行过程中的某一行为,例如,AServiceImpl.barA()的调用或者BServiceImpl.barB(String _msg, int _type)抛出异常等行为。
  • 通知(Advice) :“切面”对于某个“连接点”所产生的动作,例如,TestAspect中对com.spring.service包下所有类的方法进行日志记录的动作就是一个Advice。其中,一个“切面”可以包含多个“Advice”,例如TestAspect
  • 切入点(Pointcut) :匹配连接点的断言,在AOP中通知和一个切入点表达式关联。例如,TestAspect中的所有通知所关注的连接点,都由切入点表达式execution(* com.spring.service.*.*(..))来决定
  • 目标对象(Target Object) :被一个或者多个切面所通知的对象。例如,AServcieImpl和BServiceImpl,当然在实际运行时,Spring AOP采用代理实现,实际AOP操作的是TargetObject的代理对象。
  • AOP代理(AOP Proxy) 在Spring AOP中有两种代理方式,JDK动态代理和CGLIB代理。默认情况下,TargetObject实现了接口时,则采用JDK动态代理,例如,AServiceImpl;反之,采用CGLIB代理,例如,BServiceImpl。强制使用CGLIB代理需要将 <aop:config>proxy-target-class 属性设为true

通知(Advice)类型

  • 前置通知(Before advice) :在某连接点(JoinPoint)之前执行的通知,但这个通知不能阻止连接点前的执行。ApplicationContext中在<aop:aspect>里面使用<aop:before>元素进行声明。例如,TestAspect中的doBefore方法
  • 后通知(After advice) :当某连接点退出的时候执行的通知(不论是正常返回还是异常退出)。ApplicationContext中在<aop:aspect>里面使用<aop:after>元素进行声明。例如,TestAspect中的doAfter方法,所以AOPTest中调用BServiceImpl.barB抛出异常时,doAfter方法仍然执行
  • 返回后通知(After return advice) :在某连接点正常完成后执行的通知,不包括抛出异常的情况。ApplicationContext中在<aop:aspect>里面使用<after-returning>元素进行声明。
  • 环绕通知(Around advice) :包围一个连接点的通知,类似Web中Servlet规范中的Filter的doFilter方法。可以在方法的调用前后完成自定义的行为,也可以选择不执行。ApplicationContext中在<aop:aspect>里面使用<aop:around>元素进行声明。例如,TestAspect中的doAround方法。
  • 抛出异常后通知(After throwing advice) : 在方法抛出异常退出时执行的通知。 ApplicationContext中在<aop:aspect>里面使用<aop:after-throwing>元素进行声明。例如,TestAspect中的doThrowing方法。

好,进入主题。原先在项目中,在controller返回的状态码,是写在返回的json体中的,故无论业务逻辑是否成功执行,在返回到客户端时,Response的status都是正常(即http返回码是200)。现要改成根据controller返回的状态码,设置Response的status。由于已经存在很多controller方法,就不想一个个地找到每个方法的返回的地方来增加处理逻辑,所以决定用AOP来实现。

而我使用的@AspectJ的方式来实现。

首先要引入cglib-nodep.jar这个包,因为要使controller也能凑效,需要使用CGLIB代理。我使用的是3.1版本。

1、先定义切点

import java.lang.annotation.*;

@Target({ElementType.PARAMETER, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ResponseStatusPC {

}

2、定义切面,由于这里是controller返回后处理的,所以实现“返回后通知(After return advice)”。

import javax.servlet.http.HttpServletResponse;

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.AfterReturning;
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 com.kainaodong.xsst.common.api.constant.CommConstant;
import com.kainaodong.xsst.common.api.domain.ServiceRes;

@Aspect
@Component
public class HttpResponseStatusAspect {
final static Logger log = LoggerFactory.getLogger(HttpResponseStatusAspect.class);
//Controller层切点
@Pointcut(“@annotation(com.kainaodong.xsst.common.api.util.aop.ResponseStatusPC)”)
public void controllerAspect() {
//System.out.println(“controllerAspect”);
}

//Service层切点
@Pointcut(“@annotation(com.kainaodong.xsst.common.api.util.aop.ResponseStatusPC)”)
public void serviceAspect() {
}

@AfterReturning(pointcut=”controllerAspect()”,returning=”res”)
public void doAfter(JoinPoint jp,ServiceRes res){
int reCode=res.getReCode();
if(reCode!=CommConstant.RECODE_SUCCESS){
log.info(“根据controller的返回值设置HttpServletResponse的status:”+reCode);
setResponseStatus(jp.getArgs(), reCode);

}

}

public void setResponseStatus(Object[] args,int status){
for(Object arg:args){
if(arg instanceof HttpServletResponse){
//System.out.println(“HttpServletResponse”);
HttpServletResponse response=(HttpServletResponse) arg;
response.setStatus(status);
break;
}
}
}
}

ServiceRes是封装controller返回值的类。

3、将切点添加到目标对象中:

@ResponseStatusPC
public ServiceRes getUserInfor(HttpServletRequest request,
HttpServletResponse response,Integer userId,Integer loginUserId)

在controller中需要织入通知的方法上,添加@ResponseStatusPC切点的注解即可。

4、修改配置(一般是在applicationContext.xml中配置):

  • 增加切面的bean定义:<bean class=”com.aop.HttpResponseStatusAspect”></bean>  (我开发时,一开始忘了添加,写好切面,添加了切点,却怎样都没有代理成功)
  • 增加自动代理:<aop:aspectj-autoproxy proxy-target-class=”true”/>,如果是代理service,proxy-target-class=”true”可加可不加,而代理controller,则必须要加。

启动项目,即可发现添加了切点的method每次执行完返回后,都会调用HttpResponseStatusAspect.doAfter()。