文档章节

Spring AOP 详解

村干部
 村干部
发布于 2013/04/23 14:34
字数 2295
阅读 375
收藏 10

此前对于AOP的使用仅限于声明式事务,除此之外在实际开发中也没有遇到过与之相关的问题。最近项目中遇到了以下几点需求,仔细思考之后,觉得采用AOP 来解决。一方面是为了以更加灵活的方式来解决问题,另一方面是借此机会深入学习Spring AOP相关的内容。本文是权当本人的自己AOP学习笔记,以下需求不用AOP肯定也能解决,至于是否牵强附会,仁者见仁智者见智。

  1. 对部分函数的调用进行日志记录,用于观察特定问题在运行过程中的函数调用情况
  2. 监控部分重要函数,若抛出指定的异常,需要以短信或邮件方式通知相关人员
  3. 金控部分重要函数的执行时间

    事实上,以上需求没有AOP也能搞定,只是在实现过程中比较郁闷摆了。

  1. 需要打印日志的函数分散在各个包中,只能找到所有的函数体,手动添加日志。然而这些日志都是临时的,待问题解决之后应该需要清除打印日志的代码,只能再次手动清除^_^!
  2. 类 似1的情况,需要捕获异常的地方太多,如果手动添加时想到很可能明天又要手动清除,只能再汗。OK,该需求相对比较固定,属于长期监控的范畴,并不需求临 时添加后再清除。然而,客户某天要求,把其中20%的异常改为短信提醒,剩下的80%改用邮件提醒。改之,两天后,客户抱怨短信太多,全部改成邮件提 醒...
  3. 该需求通常用于监控某些函数的执行时间,用以判断系统执行慢的瓶颈所在。瓶颈被解决之后,烦恼同情况1


    终于下定决心,采用AOP来解决!代码如下:

需要aspectjweaver.jar

    切面类TestAspect

package com.spring.aop;

import java.io.IOException;

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;

/**
 * Aspect 切面通知类
 * 1,对部分函数的调用进行日志记录,用于观察特定问题在运行过程中的函数调用情况
 * 2,监控部分重要函数,若抛出指定的异常,需要以短信或邮件方式通知相关人员
 * 3,重要函数的执行时间
 * @author Administrator
 *
 */
public class TestAspect {
	
	private String className=null; //类名+函数名
	
	 /**
	  * 后通知
	  * 在某函数执行完之后(不论是正常返回还是异常退出)调用此函数
	  * @param jp 
	  */
	 public void doAfter(JoinPoint jp) {
	     System.out.println("log Ending method: "+className);  
	  }
	  
	 /**
	  * 包围一个连接点的通知
	  * 类似Web中Servlet规范中的Filter的doFilter方法。
	  * 可以在方法的调用前后完成自定义的行为,也可以选择不执行。
	  * @param pjp
	  * @return
	  * @throws Throwable
	  */
	  public Object doAround(ProceedingJoinPoint pjp) throws Throwable {  
	        long time = System.currentTimeMillis();  
	        Object retVal = pjp.proceed();  
	        time = System.currentTimeMillis() - time;  
	        System.out.println("process time: " + time + " ms");  
	        return retVal;  
	    }  
	    
	    /**
	     * 前置通知
	     * 在某个函数调用前执行此函数
	     * @param jp
	     */
	    public void doBefore(JoinPoint jp) { 
	    	className = jp.getTarget().getClass().getName()+"."+jp.getSignature().getName();
	        System.out.println("log Begining method: "+className);  
	    }  
	  
	    /**
	     * 异常通知
	     * @param jp
	     * @param ex
	     * @throws IOException 
	     */
	    public void doThrowing(JoinPoint jp, Throwable ex) throws IOException {  
	        System.out.println("method " + jp.getTarget().getClass().getName()  
	                + "." + jp.getSignature().getName() + " throw exception");  
	        
	    }  
	  
	    @SuppressWarnings("unused")
		private void sendEx(String ex) {  
	        System.out.println("发送邮件!!");
	    }  
}
AService.java类

package com.spring.service;

public interface AService {
	public void fooA(String _msg);  
	  
    public void barA();  
}
AServiceImpl.java类

package com.spring.service;

public class AServiceImpl implements AService {

	@Override
	public void barA() {
		System.out.println("AServiceImpl.barA()");
	}

	@Override
	public void fooA(String _msg) {
		System.out.println("AServiceImpl.fooA(msg:"+_msg+")");

	}

}
BServiceImpl.java类

package com.spring.service;

public class BServiceImpl {
	public void barB(String _msg, int _type) throws Exception {  
		int s = Integer.parseInt(_msg);
		System.out.println("BServiceImpl.barB(msg:"+_msg+" type:"+_type+")"+s);
          
            
    }  
  
    public void fooB() {  
        System.out.println("BServiceImpl.fooB()");  
    }  
}
AOPTest.java测试类

package com.spring.aop;

import org.springframework.test.AbstractDependencyInjectionSpringContextTests;

import com.spring.service.AService;
import com.spring.service.BServiceImpl;

public class AOPTest extends AbstractDependencyInjectionSpringContextTests{

	private AService aService;  
    
    private BServiceImpl bService;  
    
    protected String[] getConfigLocations() {  
        String[] configs = new String[] { "classpath*:context/applicationContext-aop.xml"};  
        return configs;  
    }
    
    /** 
     * 测试正常调用 
     */  
    public void testCall()  
    {  
        aService.fooA("JUnit test fooA");  
        aService.barA();  
        bService.fooB();  
        try {
			bService.barB("1",1);
		} catch (Exception e) {
		}  
    }  
    
    /** 
     * 测试After-Throwing 
     * 异常调用
     */  
    public void testThrow()  
    {  
        try {  
            bService.barB("p",1);  
        } catch (Exception e) {  
              
        }  
    }
    
    public void setAService(AService service) {  
        aService = service;  
    }  
      
    public void setBService(BServiceImpl service) {  
        bService = service;  
    }  
}
applicationContext.xml 配置

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:aop="http://www.springframework.org/schema/aop"
	xmlns:tx="http://www.springframework.org/schema/tx"
	xsi:schemaLocation="http://www.springframework.org/schema/beans 
	http://www.springframework.org/schema/beans/spring-beans-2.0.xsd 
	http://www.springframework.org/schema/tx 
	http://www.springframework.org/schema/tx/spring-tx-2.0.xsd 
	http://www.springframework.org/schema/aop 
	http://www.springframework.org/schema/aop/spring-aop-2.0.xsd">
    
    <!-- 
    1,对部分函数的调用进行日志记录,用于观察特定问题在运行过程中的函数调用情况
	2,监控部分重要函数,若抛出指定的异常,需要以短信或邮件方式通知相关人员
	3,金控部分重要函数的执行时间 -->
	<aop:config>
		<aop:aspect id="TestAspect" ref="aspectBean">  
            <!--配置com.spring.service包下所有类或接口的所有方法-->  
            <aop:pointcut id="businessServices"  
                expression="execution(* com.spring.service.*.*(..))" />  
            <aop:before pointcut-ref="businessServices" method="doBefore"/>  
            <aop:after pointcut-ref="businessServices" method="doAfter"/>  
            <aop:around pointcut-ref="businessServices" method="doAround"/>  
            <aop:after-throwing pointcut-ref="businessServices" method="doThrowing" throwing="ex"/>  
        </aop:aspect>  
	</aop:config>

	<bean id="aspectBean" class="com.spring.aop.TestAspect" />  
    <bean id="aService" class="com.spring.service.AServiceImpl"></bean>  
    <bean id="bService" class="com.spring.service.BServiceImpl"></bean>
    
</beans>

 《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方法。

       切入点表达式

  • 通常情况下,表达式中使用”execution“就可以满足大部分的要求。表达式格式如下:
execution(modifiers-pattern? ret-type-pattern declaring-type-pattern? name-pattern(param-pattern) throws-pattern?)

modifiers-pattern:方法的操作权限

ret-type-pattern:返回值

declaring-type-pattern:方法所在的包

name-pattern:方法名

parm-pattern:参数名

throws-pattern:异常

其中,除ret-type-pattern和name-pattern之外,其他都是可选的。上例中,execution(* com.spring.service.*.*(..))表示com.spring.service包下,返回值为任意类型;方法名任意;参数不作限制的所有方法。

  • 通知参数

可以通过args来绑定参数,这样就可以在通知(Advice)中访问具体参数了。例如,<aop:aspect>配置如下

<aop:config>
		<aop:aspect id="TestAspect" ref="aspectBean">
			<aop:pointcut id="businessService"
				expression="execution(* com.spring.service.*.*(String,..)) and args(msg,..)" />
				<aop:after pointcut-ref="businessService" method="doAfter"/>
		</aop:aspect>
	</aop:config>

TestAspect的doAfter方法中就可以访问msg参数,但这样以来AService中的barA()和BServiceImpl中的barB()就不再是连接点,因为execution(* com.spring.service.*.*(String,..))只配置第一个参数为String类型的方法。其中,doAfter方法定义如下:

public void doAfter(JoinPoint jp,String msg)
  •   访问当前的连接点

任何通知(Advice)方法可以将第一个参数定义为 org.aspectj.lang.JoinPoint 类型。JoinPoint 接口提供了一系列有用的方法, 比如 getArgs() (返回方法参数)、getThis() (返回代理对象)、getTarget() (返回目标)、getSignature() (返回正在被通知的方法相关信息)和 toString()(打印出正在被通知的方法的有用信息。

© 著作权归作者所有

村干部
粉丝 5
博文 15
码字总数 11243
作品 0
其他
程序员
私信 提问
加载中

评论(0)

Spring AOP 创建代理的源码解析

相关文章 Spring AOP 注解方式源码解析 Spring AOP 功能使用详解 Spring 的 getBean 方法源码解析 Spring bean 创建过程源码解 Spring 中 bean 注册的源码解析 前言 在上篇文章 Spring AOP 注...

TSMYK
2019/01/01
265
0
Spring AOP 功能使用详解

相关文章 Spring 中 bean 注册的源码解析 Spring bean 创建过程源码解析 Spring 的 getBean 方法源码解析 前言 AOP 既熟悉又陌生,了解过 Spring 人的都知道 AOP 的概念,即面向切面编程,可...

TSMYK
2018/12/25
762
2
spring框架 AOP核心详解

AOP称为面向切面编程,在程序开发中主要用来解决一些系统层面上的问题,比如日志,事务,权限等待,Struts2的拦截器设计就是基于AOP的思想,是个比较经典的例子。 一 AOP的基本概念 (1)Aspec...

自古一人
2018/08/02
0
0
详解spring 每个jar的作用

spring.jar 是包含有完整发布模块的单个jar 包。但是不包括mock.jar, aspects.jar, spring-portlet.jar, and spring-hibernate2.jar。 spring-src.zip就是所有的源代码压缩包。 除了spring....

mosaic101
2015/03/06
74
0
spring boot 源码解析

spring boot 源码解析58-总结 spring boot 源码解析57-actuator组件:info背后的密码(全网独家) spring boot 源码解析56-actuator请求处理流程(以EnvironmentEndpoint为例) spring boot 源码解...

chenssy
01/10
0
0

没有更多内容

加载失败,请刷新页面

加载更多

SpringBoot和SpringCloud的区别

一、SpringBoot和SpringCloud简介 1、SpringBoot:是一个快速开发框架,通过用Maven依赖的继承方式,帮助我们快速整合第三方常用框架,完全采用注解化(使用注解方式启动SpringMVC),简化X...

安然_oschina
38分钟前
19
0
IMX6ULL开发板-虚拟机安装Ubuntu系统

安装好了 VMware 虚拟机以后,我们就可以在 VMware 上安装 Ubuntu 系统了,首先我们去 Ubuntu 的 官网获取系统镜像,下载地址为:https://www.ubuntu.com/download/desktop,如下图所示: 从...

书白
46分钟前
17
0
MyBatis Plus自定义SQL使用条件构造器QueryWrapper

1.注解的方式: @Select("select * from user_collection uc left join post p on uc.post_id = p.id ${ew.customSqlSegment}")IPage<Post> selectPosts(Page page, @Param(Constants.WRAP......

code-ortaerc
50分钟前
13
0
DNS负载均衡

DNS是什么? DNS(Domain Name System)是域名和IP地址相互映射的一个分布式数据库。在DNS系统中有一个比较重要的的资源类型叫做主机记录也称为A记录。A记录是用于名称解析的重要记录,它将...

简到珍
51分钟前
14
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部