放課後プログラミング

調べたことや考えたことなどを忘れないために書きます。

Spring Framework 4.0によるAOP

Spring Framework 4.0によるDIで書いたコードにSpringのAOP機能を追加する方法を紹介します。
SpringのAOP機能は各メソッドにロガーなどを記述したいが、そのメソッドの本来のロジックとは関係ないからそこには書きたくないってときに役に立つ機能で、特定のメソッドの前や後や例外throwしたときに外部で指定した動作を加えることができる。

pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>test</groupId>
    <artifactId>test</artifactId>
    <version>1.0-SNAPSHOT</version>

    <properties>
        <spring.version>4.0.3.RELEASE</spring.version>
        <aspectj.version>1.7.4</aspectj.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-core</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context</artifactId>
            <version>${spring.version}</version>
        </dependency>

        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-aop</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.aspectj</groupId>
            <artifactId>aspectjrt</artifactId>
            <version>${aspectj.version}</version>
        </dependency>
        <dependency>
            <groupId>org.aspectj</groupId>
            <artifactId>aspectjweaver</artifactId>
            <version>${aspectj.version}</version>
        </dependency>
    </dependencies>

</project>

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: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.xsd
       http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop.xsd">

    <context:component-scan base-package="aopexample"/>
    <context:annotation-config/>
    <aop:aspectj-autoproxy/>
</beans>

AspectOrientedProgrammingExample.java

public class AspectOrientedProgrammingExample {

    public static void main(String[] args) {
        ApplicationContext ctx = new ClassPathXmlApplicationContext("beans.xml");
        HelloWorld helloWorld= ctx.getBean(HelloWorld.class);
        helloWorld.sayHello();
    }
}

HelloWorld.java

@Component
public class HelloWorld {

    @Autowired
    @Qualifier(value = "HelloImpl2")
    private IHello hello;

    public void sayHello() {
        hello.sayHello();
    }
}

IHello.java

public interface Hello {
    public void sayHello();
}

HelloImpl1.java

@Component
@Qualifier(value = "HelloImpl1")
public class HelloImpl1 implements IHello {

    public void sayHello() {
        System.out.println("Hello");
    }
}

HelloImpl2.java

@Component
@Qualifier(value = "HelloImpl2")
public class HelloImpl2 implements IHello {

    public void sayHello() {
        System.out.println("another Hello");
    }
}

Tracer.java

@Aspect
@Component
public class Tracer {

    @Before("execution(* aopexample.HelloWorld.*(..))")
    private void before(JoinPoint joinPoint) {
        System.out.println("before!!");
    }

    @After("execution(* aopexample.HelloWorld.*(..))")
    private void after(JoinPoint joinPoint) {
        System.out.println("after!!");
    }

    @Around("execution(* aopexample.HelloWorld.*(..))")
    private String around(ProceedingJoinPoint pjp) throws Throwable {
        System.out.println("around before !!");
        String s = (String) pjp.proceed();
        System.out.println("around after !!");
        return s;
    }
}

必要なコードは以上。
注目すべきはメソッド前後の動作を記述しているTracer.javaについて、HelloWorld側は一切関知していない事で、@AspectアノテーションをつけたTracerクラス内の@Before@Aroundといったアノテーションで、いつどこで発動させるかを指定するだけで、あとはSpringが検知して全てやってくれる!

AspectOrientedProgrammingExample.main

の実行結果は

around before !!
before!!
another Hello
around after !!
after!!

となる。

AOP機能を使うと、本来のロジックと、ロガーなどの多くのクラスに渡って必要なコードを分離することができて、メンテナンス性や可読性が高まるのが利点です。