Trong các bài viết trước về giới thiệu lập trình hướng khía cạnh và compile-time weaving trong AspectJ, mình đã giới thiệu với các bạn các annotation @Before và annotation @After để chèn các đoạn code trước và sau khi ứng dụng của chúng ta gọi tới một phương thức của một đối tượng. Đây chính là những Advice đấy các bạn. Ngoài annotation @Before và annotation @After ra, chúng ta còn có các Advice khác như: annotation @AfterReturn, annotation @AfterThrowing và annotation @Around. Trong bài viết này, mình sẽ giới thiệu với các bạn chi tiết hơn về annotation @Before để các bạn hiểu rõ hơn, biết khi nào nên sử dụng nó các bạn nhé!
Đầu tiên, mình cũng sẽ tạo mới một project để làm ví dụ:
AspectJ dependency:
|
1 2 3 4 5 |
<dependency> <groupId>org.aspectj</groupId> <artifactId>aspectjrt</artifactId> <version>1.8.13</version> </dependency> |
Mình sẽ chạy ví dụ sử dụng compile-time weaving nên mình sẽ khai báo thêm plugin aspectj-maven-plugin như sau:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 |
<plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>aspectj-maven-plugin</artifactId> <version>1.10</version> <configuration> <source>1.8</source> <target>1.8</target> </configuration> <executions> <execution> <goals> <goal>compile</goal> </goals> <configuration> <complianceLevel>1.8</complianceLevel> </configuration> </execution> </executions> </plugin> |
Class cần chèn code:
|
1 2 3 4 5 6 7 8 |
package com.huongdanjava.aspectj; public class HelloWorld { public void hello() { System.out.println("Hello"); } } |
Application class:
|
1 2 3 4 5 6 7 8 9 |
package com.huongdanjava.aspectj; public class Application { public static void main(String[] args) { HelloWorld hello = new HelloWorld(); hello.hello(); } } |
Bây giờ, chúng ta sẽ định nghĩa một class để chèn một đoạn code mà chúng ta muốn vào trước method hello() của đối tượng HelloWorld sử dụng annotation @Before của AspectJ các bạn nhé.
Class HelloWorldAspect có nội dung như sau:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
package com.huongdanjava.aspectj; import org.aspectj.lang.annotation.Aspect; import org.aspectj.lang.annotation.Before; @Aspect public class HelloWorldAspect { @Before("execution (* com.huongdanjava.aspectj.HelloWorld.hello(..))") public void allMethods() { System.out.println("Hello"); } } |
Ở đây, mình đã định nghĩa một method trong class HelloWorldAspect tên là allMethods() với annotation @Before. Nội dung của annotation @Before như sau:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 |
/******************************************************************************* * Copyright (c) 2005 Contributors. * All rights reserved. * This program and the accompanying materials are made available * under the terms of the Eclipse Public License v1.0 * which accompanies this distribution and is available at * http://eclipse.org/legal/epl-v10.html * * Contributors: * initial implementation Alexandre Vasseur *******************************************************************************/ package org.aspectj.lang.annotation; import java.lang.annotation.Target; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; /** * Before advice * * @author <a href="mailto:alex AT gnilux DOT com">Alexandre Vasseur</a> */ @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.METHOD) public @interface Before { /** * The pointcut expression where to bind the advice */ String value(); /** * When compiling without debug info, or when interpreting pointcuts at runtime, * the names of any arguments used in the advice declaration are not available. * Under these circumstances only, it is necessary to provide the arg names in * the annotation - these MUST duplicate the names used in the annotated method. * Format is a simple comma-separated list. */ String argNames() default ""; } |
Như các bạn thấy, annotation @Before định nghĩa 2 thuộc tính: value và argNames trong đó thuộc tính argNames là optional. Thuộc tính value là thuộc tính quan trọng nhất, nó định nghĩa một Poincut, giúp chúng ta định nghĩa chính xác vị trí mà chúng ta muốn chèn code.
Chúng ta có thể định nghĩa một Poincut sử dụng một combinator cùng với một Pattern expression.
Một Pattern expression được định nghĩa bởi những thành phần như sau:
|
1 |
[modifiers] [return type] [(packageName)(className)(methodName)](parameters) |
Tất cả các thành phần này đều có thể được khai báo với “*” mang ý nghĩa bất kỳ giá trị nào cũng được.
Trong đó:
- modifiers: định nghĩa access modifier của method mà chúng ta muốn chèn code. Chúng ta có thể để trống nó, lúc đó nó mang ý nghĩa giống như giá trị “*”.
- return type: void hoặc bất kỳ kiểu dữ liệu nào mà method chúng ta cần chèn code return.
- (packageName)(className)(methodName): định nghĩa method mà chúng ta muốn chèn code. Trong ví dụ của mình, vì mình đang muốn chèn code ở phía trước method hello() của đối tượng HelloWorld nên mình đã định nghĩa com.huongdanjava.aspectj.HelloWorld.hello. Các bạn cũng có thể thay thế bằng com.huongdanjava.aspectj.HelloWorld.* để chèn code cho tất cả các method trong đối tượng HelloWorld cũng được.
- parameters: định nghĩa method với parameter mà chúng ta cần chèn code. Chúng ta có thể sử dụng (..) để chỉ định method với parameter bất kỳ.
Trong các thành phần trên, mỗi thành phần sẽ đóng vai trò như một tiêu chí để chỉ định vị trí mà chúng ta muốn chèn code.
Combinator định nghĩa khi nào đoạn code cần chèn của chúng ta sau khi đã thoả mãn Pattern thì được thực thi. AspectJ định nghĩa một danh sách các combinator mà các bạn có thể sử dụng cho mục đích của mình, chi tiết tại đây. Mỗi combinator có thể định nghĩa với nhiều Pattern khác nhau, giúp chúng ta có thể định nghĩa khi nào đoạn code chúng ta cần chèn nên được thực thi.
Như ví dụ ở trên, mình sử dụng combinator “execution” để thực thi đoạn code khi chương trình gọi tới các phương thức trong đối tượng HelloWorld.
Kết quả khi chúng ta chạy ví dụ trên như sau:
Để lấy tất cả các thông tin về method mà chúng ta đang chèn code, các bạn có thể sử dụng đối tượng JoinPoint như là một argument trong phương thức định nghĩa với annotation @Before như sau:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
package com.huongdanjava.aspectj; import org.aspectj.lang.JoinPoint; import org.aspectj.lang.annotation.Aspect; import org.aspectj.lang.annotation.Before; @Aspect public class HelloWorldAspect { @Before("execution (* com.huongdanjava.aspectj.HelloWorld.hello(..))") public void allMethods(JoinPoint joinPoint) { System.out.println("Hello, method name: " + joinPoint.getSignature().getName()); } } |
Trong đoạn code trên, mình đã sử dụng đối tượng JoinPoint để lấy thông tin tên của method đang thực thi.
Kết quả:
Sử dụng đối tượng JoinPoint chúng ta còn có thể làm nhiều điều khác nữa, chúng ta sẽ tìm hiểu thêm về nó khi thảo luận về các Advice khác các bạn nhé!
