Java后台框架篇--Spring之AspectJ AOP

转载请注明出处:http://blog.csdn.net/l1028386804/article/details/49744721

这里我们用一个完整的例子演示spring aspectj aop的使用。

首先新建一个maven项目，在项目的pom.xml中添加spring aop相关的依赖项：

[html]  view plain  copy

1. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
2.     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">  
3.     <modelVersion>4.0.0</modelVersion>  
4.   
5.     <groupId>cn.outofmemory</groupId>  
6.     <artifactId>spring-aop-aspect</artifactId>  
7.     <version>0.0.1-SNAPSHOT</version>  
8.     <packaging>jar</packaging>  
9.   
10.     <name>spring-aop-aspect</name>  
11.     <url>http://maven.apache.org</url>  
12.     <properties>  
13.         <spring.version>3.1.1.RELEASE</spring.version>  
14.     </properties>  
15.     <dependencies>  
16.         <dependency>  
17.             <groupId>org.springframework</groupId>  
18.             <artifactId>spring-core</artifactId>  
19.             <version>${spring.version}</version>  
20.         </dependency>  
21.         <dependency>  
22.             <groupId>org.springframework</groupId>  
23.             <artifactId>spring-context</artifactId>  
24.             <version>${spring.version}</version>  
25.         </dependency>  
26.         <dependency>  
27.             <groupId>org.springframework</groupId>  
28.             <artifactId>spring-aop</artifactId>  
29.             <version>${spring.version}</version>  
30.         </dependency>  
31.         <dependency>  
32.             <groupId>org.aspectj</groupId>  
33.             <artifactId>aspectjrt</artifactId>  
34.             <version>1.6.12</version>  
35.         </dependency>  
36.         <dependency>  
37.             <groupId>org.aspectj</groupId>  
38.             <artifactId>aspectjweaver</artifactId>  
39.             <version>1.6.12</version>  
40.         </dependency>  
41.         <dependency>  
42.             <groupId>cglib</groupId>  
43.             <artifactId>cglib</artifactId>  
44.             <version>2.2</version>  
45.         </dependency>  
46.     </dependencies>  
47. </project>  

在maven中我们引入了spring aop相关的依赖，aspectj相关的包有两个，cglib是必须的。

下面我们在项目中新建一个Service类PersonService，它是业务代码，是我们AOP注入的目标类：

[java]  view plain  copy

1. package cn.outofmemory.spring_aop_aspect;  
2.   
3. import org.springframework.stereotype.Service;  
4.   
5. @Service  
6. public class PersonService {  
7.   
8.     public void addPerson(String personName) {  
9.         System.out.println("add person " + personName);  
10.     }  
11.       
12.     public boolean deletePerson(String personName) {  
13.         System.out.println("delete person " + personName) ;  
14.         return true;  
15.     }  
16.       
17.     public void editPerson(String personName) {  
18.         System.out.println("edit person " + personName);  
19.         throw new RuntimeException("edit person throw exception");  
20.     }  
21.       
22. }  

PersonService类中定义了三个方法，addPerson方法无返回值，而deletePerson方法有返回值，而editPerson方法抛出运行时的异常。

下面我们看Aspect类：

[java]  view plain  copy

1. package cn.outofmemory.spring_aop_aspect;  
2.   
3. import org.aspectj.lang.JoinPoint;  
4. import org.aspectj.lang.ProceedingJoinPoint;  
5. import org.aspectj.lang.annotation.After;  
6. import org.aspectj.lang.annotation.AfterReturning;  
7. import org.aspectj.lang.annotation.AfterThrowing;  
8. import org.aspectj.lang.annotation.Around;  
9. import org.aspectj.lang.annotation.Aspect;  
10. import org.aspectj.lang.annotation.Before;  
11. import org.aspectj.lang.annotation.Pointcut;  
12. import org.springframework.stereotype.Component;  
13.   
14. @Component  
15. @Aspect  
16. public class SimpleAspect {  
17.     @Pointcut("execution(* cn.outofmemory.spring_aop_aspect.*Service*.*(..))")  
18.     public void pointCut() {  
19.     }  
20.   
21.     @After("pointCut()")  
22.     public void after(JoinPoint joinPoint) {  
23.         System.out.println("after aspect executed");  
24.     }  
25.   
26.     @Before("pointCut()")  
27.     public void before(JoinPoint joinPoint) {  
28.         //如果需要这里可以取出参数进行处理  
29.         //Object[] args = joinPoint.getArgs();  
30.         System.out.println("before aspect executing");  
31.     }  
32.   
33.     @AfterReturning(pointcut = "pointCut()", returning = "returnVal")  
34.     public void afterReturning(JoinPoint joinPoint, Object returnVal) {  
35.         System.out.println("afterReturning executed, return result is "  
36.                 + returnVal);  
37.     }  
38.   
39.     @Around("pointCut()")  
40.     public void around(ProceedingJoinPoint pjp) throws Throwable {  
41.         System.out.println("around start..");  
42.         try {  
43.             pjp.proceed();  
44.         } catch (Throwable ex) {  
45.             System.out.println("error in around");  
46.             throw ex;  
47.         }  
48.         System.out.println("around end");  
49.     }  
50.   
51.     @AfterThrowing(pointcut = "pointCut()", throwing = "error")  
52.     public void afterThrowing(JoinPoint jp, Throwable error) {  
53.         System.out.println("error:" + error);  
54.     }  
55. }  

SimpleAspect类中的第一个方法是pointCut()方法，此方法无任何执行内容，只有一个@Pointcut的注解，其他方法都会引用这个注解中指定的pointcut表达式。

其他几个方法是各种Advice类型的方法实现，在这些方法中都可以通过JoinPoint实例来获得方法执行的上下文信息，参数信息。需要注意AfterReturning和AfterThrowing，After三种不同Advice的执行顺序。

有了spring框架和aspectj以及cglib的支持，我们只需要实现上面两个类就可以使用spring aop的功能了，下面我们看下如何在spring的配置文件中配置spring aop。

[html]  view plain  copy

1. <?xml version="1.0" encoding="UTF-8"?>  
2. <beans xmlns="http://www.springframework.org/schema/beans"  
3.        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
4.        xmlns:aop="http://www.springframework.org/schema/aop"  
5.        xmlns:context="http://www.springframework.org/schema/context"  
6.        xsi:schemaLocation="http://www.springframework.org/schema/beans  
7.                            http://www.springframework.org/schema/beans/spring-beans-3.0.xsd  
8.                            http://www.springframework.org/schema/aop  
9.                            http://www.springframework.org/schema/aop/spring-aop-3.0.xsd  
10.                            http://www.springframework.org/schema/context  
11.                            http://www.springframework.org/schema/context/spring-context-3.1.xsd">  
12.     <aop:aspectj-autoproxy />  
13.     <context:component-scan base-package="cn.outofmemory" />   
14. </beans>  

注意在beans节点中需要指定aop命名空间，一家chemaLocation地址，启用aop只需要添加<aop:aspectj-autoproxy/>就可以了。<context:component-scan/>节点用来指定自动扫描bean的命名空间。

最后我们要测试下aop的效果，需要新建一个App类作为程序的入口类。

[java]  view plain  copy

1. package cn.outofmemory.spring_aop_aspect;  
2.   
3. import org.springframework.context.ApplicationContext;  
4. import org.springframework.context.support.ClassPathXmlApplicationContext;  
5.   
6.   
7. /** 
8.  * Hello world! 
9.  * 
10.  */  
11. public class App   
12. {  
13.     public static void main( String[] args )  
14.     {  
15.       ApplicationContext appContext = new ClassPathXmlApplicationContext("/appContext.xml");  
16.       PersonService personService = appContext.getBean(PersonService.class);  
17.       String personName = "Jim";  
18.       personService.addPerson(personName);  
19.       personService.deletePerson(personName);  
20.       personService.editPerson(personName);  
21.       ((ClassPathXmlApplicationContext)appContext).close();  
22.     }  
23. }  

这个类中我们初始化了ApplicationContext，然后从中得到PersonService的实例，并执行其addPerson,deletePerson,editPerson方法，最后关闭ApplicationContext。

其执行结果如下：

[java]  view plain  copy

1. before aspect executing  
2. around start..  
3. add person Jim  
4. after aspect executed  
5. around end  
6. afterReturning executed, return result is null  
7. -------------------------------------  
8. before aspect executing  
9. around start..  
10. delete person Jim  
11. after aspect executed  
12. around end  
13. afterReturning executed, return result is null  
14. ----------------------------------------  
15. before aspect executing  
16. around start..  
17. edit person Jim  
18. after aspect executed  
19. error in around  
20. error:java.lang.RuntimeException: edit person throw exception  
21. Exception in thread ...  

从上面执行结果可以看到我们要执行的Before，around，after以及around，afterReturning，afterThrowing都正常的执行了