Spring项目AOP入门案例

た入场券 2024-04-01 10:15 42阅读 0赞

案例设定：测算接口执行效率，在方法执行前输出当前系统时间。

对于SpringAOP的开发有两种方式，XML 和 注解，我们使用哪个呢?

因为现在注解使用的比较多，所以本次课程就采用注解完成AOP的开发。

总结需求为:使用SpringAOP的注解方式完成在方法执行的前打印出当前系统时间。

### 1. 思路分析 ###

需求明确后，具体该如何实现，都有哪些步骤，我们先来分析下:

> 1.导入坐标(pom.xml)
> 
> 2.制作连接点(原始操作，Dao接口与实现类)
> 
> 3.制作共性功能(通知类与通知)
> 
> 4.定义切入点
> 
> 5.绑定切入点与通知关系(切面)

### 2. 环境准备 ###

*  创建一个Maven项目
 *  pom.xml添加Spring依赖
    
        <dependencies>
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-context</artifactId>
                <version>5.2.10.RELEASE</version>
            </dependency>
        </dependencies>
 *  添加BookDao和BookDaoImpl类
    
        public interface BookDao {
              
            public void save();
            public void update();
        }
        
        @Repository
        public class BookDaoImpl implements BookDao {
              
        
            public void save() {
              
                System.out.println(System.currentTimeMillis());
                System.out.println("book dao save ...");
            }
        
            public void update(){
              
                System.out.println("book dao update ...");
            }
        }
 *  创建Spring的配置类
    
        @Configuration
        @ComponentScan("com.itheima")
        public class SpringConfig {
              
        }
 *  编写App运行类
    
        public class App {
              
            public static void main(String[] args) {
              
                ApplicationContext ctx = new AnnotationConfigApplicationContext(SpringConfig.class);
                BookDao bookDao = ctx.getBean(BookDao.class);
                bookDao.save();
            }
        }

最终创建好的项目结构如下:

![在这里插入图片描述][423cb0ae017d480a8fce1a54166883ad.png_pic_center]

**说明:**

*  目前打印save方法的时候，因为方法中有打印系统时间，所以运行的时候是可以看到系统时间
 *  对于update方法来说，就没有该功能
 *  我们要使用SpringAOP的方式在不改变update方法的前提下让其具有打印系统时间的功能。

### 3. AOP实现步骤 ###

#### 步骤1:添加依赖 ####

pom.xml

<dependency>
                <groupId>org.aspectj</groupId>
                <artifactId>aspectjweaver</artifactId>
                <version>1.9.6</version>
            </dependency>

![在这里插入图片描述][94c59fced2564bd2a9bb7b037e685e81.png_pic_center]

*  因为`spring-context`中已经导入了`spring-aop`,所以不需要再单独导入`spring-aop`
 *  导入AspectJ的jar包,AspectJ是AOP思想的一个具体实现，Spring有自己的AOP实现，但是相比于AspectJ来说比较麻烦，所以我们直接采用Spring整合ApsectJ的方式进行AOP开发。

#### 步骤2:定义接口与实现类 ####

环境准备的时候，UserDaoImpl已经准备好，不需要做任何修改

#### 步骤3:定义通知类和通知 ####

通知就是将共性功能抽取出来后形成的方法，共性功能指的就是当前系统时间的打印。

public class MyAdvice {
        
        public void method(){
        
            System.out.println(System.currentTimeMillis());
        }
    }

类名和方法名没有要求，可以任意。

#### 步骤4:定义切入点 ####

UserDaoImpl中有两个方法，分别是select和update，我们要增强的是update方法，该如何定义呢?

public class MyAdvice {
        
    
        @Pointcut("execution(void com.dcxuexi.dao.impl.UserDaoImpl.update())")
        public void pt(){
        }
    
        public void methodBefore(){
        
            System.out.println(System.currentTimeMillis());
        }
    }

**说明:**

*  切入点定义依托一个不具有实际意义的方法进行，即无参数、无返回值、方法体无实际逻辑。
 *  execution及后面编写的内容，后面会有章节专门去学习。

#### 步骤5:制作切面 ####

切面是用来描述通知和切入点之间的关系，如何进行关系的绑定?

public class MyAdvice {
        
    
        @Pointcut("execution(void com.dcxuexi.dao.impl.UserDaoImpl.update())")
        public void pt(){
        }
    
        @Before("pt()")
        public void methodBefore(){
        
            System.out.println(System.currentTimeMillis());
        }
    }

绑定切入点与通知关系，并指定通知添加到原始连接点的具体执行位置

![在这里插入图片描述][94766338159b421fb90dab60fb8129ca.png_pic_center]

**说明:**@Before翻译过来是之前，也就是说通知会在切入点方法执行之前执行，除此之前还有其他四种类型，后面会讲。

#### 步骤6:将通知类配给容器并标识其为切面类 ####

@Component
    @Aspect
    public class MyAdvice {
        
    
        @Pointcut("execution(void com.dcxuexi.dao.impl.UserDaoImpl.update())")
        public void pt(){
        }
    
        @Before("pt()")
        public void methodBefore(){
        
            System.out.println(System.currentTimeMillis());
        }
    }

#### 步骤7:开启注解格式AOP功能 ####

@Configuration
    @ComponentScan("com.dcxuexi")
    @EnableAspectJAutoProxy
    public class SpringConfig {
        
    }

#### 步骤8:运行程序 ####

public class SpringAopFrist {
        
        public static void main(String[] args) {
        
            ApplicationContext context = new AnnotationConfigApplicationContext(SpringConfig.class);
            UserDao userDao = context.getBean(UserDao.class);
            //userDao.select();
            userDao.update();
        }
    }

看到在执行update方法之前打印了系统时间戳，说明对原始方法进行了增强，AOP编程成功。

![在这里插入图片描述][da399739f4f44bf4af572c9b5f69185b.png_pic_center]

### 知识点1：@EnableAspectJAutoProxy ###

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>@EnableAspectJAutoProxy</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>类型</td> 
   <td>配置类注解</td> 
  </tr> 
  <tr> 
   <td>位置</td> 
   <td>配置类定义上方</td> 
  </tr> 
  <tr> 
   <td>作用</td> 
   <td>开启注解格式AOP功能</td> 
  </tr> 
 </tbody> 
</table>

### 知识点2：@Aspect ###

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>@Aspect</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>类型</td> 
   <td>类注解</td> 
  </tr> 
  <tr> 
   <td>位置</td> 
   <td>切面类定义上方</td> 
  </tr> 
  <tr> 
   <td>作用</td> 
   <td>设置当前类为AOP切面类</td> 
  </tr> 
 </tbody> 
</table>

### 知识点3：@Pointcut ###

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>@Pointcut</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>类型</td> 
   <td>方法注解</td> 
  </tr> 
  <tr> 
   <td>位置</td> 
   <td>切入点方法定义上方</td> 
  </tr> 
  <tr> 
   <td>作用</td> 
   <td>设置切入点方法</td> 
  </tr> 
  <tr> 
   <td>属性</td> 
   <td>value（默认）：切入点表达式</td> 
  </tr> 
 </tbody> 
</table>

### 知识点4：@Before ###

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>@Before</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>类型</td> 
   <td>方法注解</td> 
  </tr> 
  <tr> 
   <td>位置</td> 
   <td>通知方法定义上方</td> 
  </tr> 
  <tr> 
   <td>作用</td> 
   <td>设置当前通知方法与切入点之间的绑定关系，<br>当前通知方法在原始切入点方法前运行</td> 
  </tr> 
 </tbody> 
</table>

### 项目代码 ###

*  [gitee 代码下载][gitee]
 *  [github 代码代码][github]

[423cb0ae017d480a8fce1a54166883ad.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/26de9a20c9a342039fbb30a969faee2f.png
[94c59fced2564bd2a9bb7b037e685e81.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/66e63ac1b2c94b49a2a84ced2bbbdd92.png
[94766338159b421fb90dab60fb8129ca.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/860cdddae5c2429abd36ac9706313a8c.png
[da399739f4f44bf4af572c9b5f69185b.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/6d7e5f742733476f82446f479b80bb78.png
[gitee]: https://gitee.com/DchuangDB/sping-projeck
[github]: https://github.com/dcbut/spring