Spring AOP入门Demo分享

在阅读本文之前，大家可先行参阅《简单理解spring之ioc和aop及代码示例》一文，简单了解下ioc和aop的相关内容。下面进入正题。

本文将会一步一步创建一个最简单的例子，来使用spring的aop特性，算是一个spring aop的入门demo。作为一个初学者，运行出这么简单的一个demo也踩了很多的坑。

oop的问题，aop的补充

当我们需要为分散的对象引入公共行为的时候，oop则显得无能为力。也就是说，oop允许你定义从上到下的关系，但并不适合定义从左到右的关系。例如日志功能。日志代码往往水平地散布在所有对象层次中，而与它所散布到的对象的核心功能毫无关系。对于其他类型的代码，如安全性、异常处理和透明的持续性也是如此。这种散布在各处的无关的代码被称为横切（cross-cutting）代码，在oop设计中，它导致了大量代码的重复，而不利于各个模块的重用。

所谓“方面”，简单地说，就是将那些与业务无关，却为业务模块所共同调用的逻辑或责任封装起来，便于减少系统的重复代码，降低模块间的耦合度，并有利于未来的可操作性和可维护性。

spring中对aop的支持

spring中aop代理由spring的ioc容器负责生成、管理，其依赖关系也由ioc容器负责管理。因此，aop代理可以直接使用容器中的其他bean实例作为目标，这种关系可由ioc容器的依赖注入提供。spring默认使用java动态代理来创建aop代理，这样就可以为任何接口实例创建代理了。当需要代理的类不是代理接口的时候，spring自动会切换为使用cglib代理，也可强制使用cglib。

本例子的逻辑如下：有一个car类（业务类），在car类中的go方法运行之前和之后，都会有相应的日志记录，但car类本身并不知道日志的任何逻辑。

创建maven项目并添加依赖

首先，新建一个maven项目，使用 maven‐archetype‐quickstart模板，然后打开pom.xml文件，加入spring aop运行需要的依赖包

<dependency>
  <groupid>org.springframework</groupid>
  <artifactid>spring-core</artifactid>
  <version>4.0.5.release</version>
</dependency>
<dependency>
  <groupid>org.springframework</groupid>
  <artifactid>spring-beans</artifactid>
  <version>4.0.5.release</version>
</dependency>
<dependency>
  <groupid>org.springframework</groupid>
  <artifactid>spring-context</artifactid>
  <version>4.0.5.release</version>
</dependency>
<dependency>
  <groupid>org.springframework</groupid>
  <artifactid>spring-aop</artifactid>
  <version>4.0.5.release</version>
</dependency>
<dependency>
  <groupid>org.aspectj</groupid>
  <artifactid>aspectjweaver</artifactid>
  <version>1.8.1</version>
</dependency>

编写业务代码

新增一个业务类car，包含一个go()方法

package com.wowo.spring_aop_demo1;
public class car {
  public void go(){
    system.out.println("go go go!");
  }
}

编写切面类

日志类会记录下系统的运行情况，但日志的逻辑不会在业务类中写的到处都是，而是作为一个切面类存在。

package com.wowo.spring_aop_demo1;
public class carlogger {
  public void beforerun(){
    system.out.println("car is going to run");
  }
  public void afterrun(){
    system.out.println("car is running");
  }
}

该切面类包含两个方法，他们分别是前置通知和后置通知。

通过bean来配置关联

新增一个配置文件，本例命名为bean.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:p="http://www.springframework.org/schema/p"
  xmlns:context="http://www.springframework.org/schema/context"
  xmlns:aop="http://www.springframework.org/schema/aop"
  xsi:schemalocation="
      http://www.springframework.org/schema/beans 
      http://www.springframework.org/schema/beans/spring-beans-2.5.xsd
      http://www.springframework.org/schema/context 
      http://www.springframework.org/schema/context/spring-context-2.5.xsd
      http://www.springframework.org/schema/aop
      http://www.springframework.org/schema/aop/spring-aop.xsd"
  >
  <bean id="car" class="com.wowo.spring_aop_demo1.car"/>
  <bean id="logger" class="com.wowo.spring_aop_demo1.carlogger" />
  <aop:config>
    <aop:aspect ref="logger">
      <aop:pointcut expression="execution(* com.wowo.spring_aop_demo1.car.go(..))" id="go"/>

      <aop:before pointcut-ref="go" method="beforerun" />
      <aop:after pointcut-ref="go" method="afterrun" />
    </aop:aspect>
  </aop:config>
</beans>

注意：这个配置文件中，aop的命名空间，以及xsi:schemalocation中包含的几个地址都是必须的。
execution(* com.wowo.spring_aop_demo1.car.go(..))是一个aspectj切点表达式，execution表示在执行时触发，后面的*表示任意类型的返回值，com.wowo.spring_aop_demo1.car指的是切点所在的类，go(..)是方法名，..表示任意参数。

spring切面可以应用5种类型的通知：

·before——在方法被调用之前调用通知
·after——在方法完成之后调用通知，无论方法是否执行成功
·after-returning——在方法成功执行之后调用通知
·after-throwing——在方法抛出异常后调用通知
·around——通知包裹了被通知的方法，在被通知的方法调用之前和调用之后都执行自定义的行为

运行业务代码

下面创建一个包含main()方法的类，来运行业务代码

package com.wowo.spring_aop_demo1;
import org.springframework.context.applicationcontext;
import org.springframework.context.support.classpathxmlapplicationcontext;
public class app 
{
  public static void main( string[] args )
  {
    applicationcontext context = new classpathxmlapplicationcontext("bean.xml");
    car car=(car) context.getbean("car");
    car.go();
  }
}

在上面的代码中，由spring创建了一个car对象。spring在创建该对象时，发现它的一个方法被配置成了切点（pointcut），所以，在实例化该对象时，会创建一个代理对象，当切点方法go()执行时，会被spring创建的代理对象所拦截，运行go方法之前，会调用所对应的切面类carlogger的前置方法beforerun()，然后调用car.go()方法，再然后就调用切面类carlogger的后置方法afterrun()。

注意：必须使用spring创建包含切点的对象，如果自己创建的话，spring是监测不到的，它的运行也不会被应用任何通知。

项目输出结果为

car is going to run
go go go!
car is running

使用环绕通知

如果想使用环绕通知，我们需要修改切面类中的通知方法以及配置文件，业务类无需做任何修改，因为他们是完全解耦的。首先修改切面类carlogger

import org.aspectj.lang.proceedingjoinpoint;
public class carlogger {

  public void aroundrun(proceedingjoinpoint joinpoint){
    system.out.println("car is going to run");
    try {
      //调用被代理的对象的目标方法，本例中指向car.go()方法
      joinpoint.proceed();
    } catch (throwable e) {
      e.printstacktrace();
    }
    system.out.println("car is running");
  }
}

环绕通知的方法，需要接受proceedingjoinpoint类型的参数，其proceed()方法将会调用被代理对象的目标方法，所以，正常情况下，这个方法一定要调用。我们也可以通过不调用该方法来组织被代理对象的运行。

接下来将配置文件的aop:config部分修改为如下所示

<aop:config>
    <aop:aspect ref="logger">
      <aop:pointcut expression="execution(* com.wowo.spring_aop_demo1.car.go(..))" id="go"/>
      <aop:around method="aroundrun" pointcut-ref="go"/>
    </aop:aspect>
  </aop:config>

注意：环绕通知不能和前置/后置通知同时存在。运行代码后，输出结果不变。

总结

以上就是本文关于spring aop入门demo分享的全部内容，希望对大家有所帮助。感兴趣的朋友可以继续参阅本站其他相关专题，如有不足之处，欢迎留言指出。感谢朋友们对本站的支持！