返回上一章节:第一章:面向切面编程-AOP概念和相关术语
作者: 潘勇
2019/3/24 10:14:45
@all 本文为原创,转载请注明出处
上一章节我们说到了Aop的概念和一些相关的术语,这一章节我们将基于以上的概念进行一个小案例的实战。我们如果想要熟练的掌握,就需要多加练习。
案例的git地址:https://github.com/pydlove/study/tree/master/aop-demo-beyond
如果有相关问题可以添加QQ群:801340005,可以一起讨论学习技术。
1、准备阶段
我们本章基于AspectJ来完成的,AspectJ是一个优秀个AOP框架,当Spring Aop 不能满足需求时,我们可以转向更加的强大的AspectJ。
废话不多说,我们直接准备案例需要的 jar 包,我这里创建的并不是Maven项目,当然你也可以创建Maven项目。并且我使用的是Spring4,
我这里只对jar包做个简单点介绍,毕竟不是我们的主线,不应该占据过多的内容。主要分为两部分,第一部分是Spring自带的,可以参考下面的帖子:
第一部分包含22个jar包。
第二部分:包含6个jar包
AspectJ:aspectjrt-1.6.9.jar、aspectjweaver-1.7.4.jar
数据处理:fastjson-1.2.56.jar (这个东西一旦你使用就会发现它的好处,非常强大,我到哪个项目都忘不了带上它)(本章节用不到,后面使用)
Lombok:lombok-1.16.18.jar(它封装很多注解能让我们POJO类重复的东西简化,例如:@Data,@Builder等)(本章节用不到,后面使用)
日志:slf4j-api-1.7.26.jar、slf4j-simple-1.7.26.jar (本章节用不到,后面使用)
既然jar包准备好了,我们就开始第一个案例吧。
2、案例
这个案例我想实现的是:
某个投资方由于特别喜欢Beyond想举办一个晚会,请beyond上场表演,演出之前都有主持人报幕,这个是他的诉求。(这部分是投资方安排好的,列进投资方的计划书里了)
Beyond得知这个消息之后,决定在晚会上和大家好好互动下。(这部分是投资方为安排的,没有列进投资方的计划书里)
我们开始基于这个案例实现吧!
我们设计下需要哪些类:
投资方:也就是测试类
晚会:接口,提供表演这个方法,这个方法就是连接点
主持人:切面类,在表演之前之后都需要报幕
Beyond:晚会的主角,晚会接口的实现类,需要实现晚会的抽象方法
互动:互动是附加内容,并未在计划书里,互动应该具备一个接口,有一个互动方法,再具备一个实现类,实现互动的内容。再基于其他形式引入到晚会中。
(注:引入是上一章节提到的概念)
AopConfig:这个类主要是开始AspectJ的自动代理,并且还可以在这个类声明我们切面的bean
晚会接口:
Beyond:
实现了晚会接口,实现了sing()方法,并且需要被@Component注解标注,因为需要创建SingerBeyond 这个bean。
主持人:
主持人使我们整个案例的重点,支持人我们的切面类,负责在Beyond表演之前、之后、整个表演过程中(环绕)、表演异常这些情况下提供支持。
1、主持人类Compere 首先得声明bean,之后被Spring容器管理,我们才能将自动将主持人注入到晚会的每一个过程,所以得使用@Component标注
2、主持人类Compere是切面,所以得用@Aspect注解标注,声明该类是切面。声明之后,该类不是普通的POJO类了,它是一个切面,定义了切面的具体行为。@Aspect是引用自org.aspectj.lang.annotation包下。上一章节我们说了切面主要包括:通知和切点,通知表明了what、when,切点表名了where。
3、该类中声明了四个通知,分别是前置通知(Before)、环绕通知(Around)、返回通知(AfterReturning)、异常通知(AfterThrowing)
我们观察四个通知都有相似处,@Before、@AfterReturning都有 execution(* com.study.pany.bean.aopDemo1.IEvening.sing(String, String)) && args(singer, song),@Around都有 execution(* com.study.pany.bean.aopDemo1.IEvening.sing(..)),@AfterThrowing有pointcut ="execution(* com.study.pany.bean.aopDemo1.IEvening.*(..))", throwing ="throwable"
这个是什么呢?我们下面介绍。
4、我这里只简单分析下@Before注解,我们点开@Before注解。(详细分析注解的活并不是本章应该干的,本章只需要了解这些注解到底干了些什么。所以本章就不演示自定义注解,包括一些一些属性介绍,放在其他章节,请留意以后内容的更新)
@Target({ElementType.METHOD}) 表示注解方法级别的
@Retention(RetentionPolicy.RUNTIME) 表示运行时加载
String value(); 重点,@Before("execution(* com.study.pany.bean.aopDemo1.IEvening.sing(String, String)) && args(singer, song)") 也可以写成@Before(value ="execution(* com.study.pany.bean.aopDemo1.IEvening.sing(String, String)) && args(singer, song)");
@Before本身表明是的切面的when,而这个value的内容表明的是where,所以它是切点,被@Before标注的方法表明的是what。
所以我们现在知道了execution(* com.study.pany.bean.aopDemo1.IEvening.sing(String, String)) && args(singer, song)这个是切点。
String argNames()default ""; 参数名称,字符串类型,默认是""
5、对比@Before和@Around的value
execution(* com.study.pany.bean.aopDemo1.IEvening.sing(String, String)) && args(singer, song)
execution(* com.study.pany.bean.aopDemo1.IEvening.sing(..))
一张图告诉你。
注:winthin() 和 execution() 类似,都是指定哪些连接点是切点的,但execution更强大一点,大可以作用到包,小可以作用到方法;而within 最小作用范围是类
AopConfig:
通过@EnableAspectJAutoProxy开启自动代理
投资方:
投资方就是我们的测试类,利用Junit启动Spring的容器。当然也可以使用ClassPathXmlApplicationContext这个方式去启动,这里就不对ClassPathXmlApplicationContext启动做介绍。毕竟我们的主题是基于注解的,这样尽量都用注解的方式。
注意类上的@RunWith和@ContextConfiguration
@RunWith 是基于SpringJunit4ClassRunner这个类,当然我们也可以自定义自己的类去是继承这个类,加入我们自己想要加入的逻辑,RunWith这里用我们自己的类启动。(这里不做介绍,可以自行了解)
@ContextConfiguration 指定读取的配置文件,我们这里配置文件很简单,只是设定哪个包下开启自动扫描。
@Autowired 自动装配,所以之前IEvening的实现类SingerBeyond上,我们需要使用@Component,否则这里没办法注入。
我们启动看下结果:
我只在Before和AfterReturning 这里加入逻辑去,@Around这里没有加入逻辑,这个我们后面做日志管理案例的时候会着重介绍到。
如果我们需要测试异常之后切面会做出响应,我们需要改造下现有的类。这部分代码我直接截图出来。
执行结果如下:
3、案例一的扩充(实现引入)
我们上面代码都是实现的是投资方安排好的内容,已经列进计划书的内容,而我接下来要做的就是投资方计划之外的,也就是Beyond的和大家互动。这部分没办法写到计划书里面,因为Beyond没有计划书的原稿,没有办法修改,如何加入到环节中呢?
其实这也就是在我们日常开发中,可能有些核心的内容已经封装好了,是以jar的形式提供给我们的,我们是没办法直接修改的,因为我们压根就没有源码,这时候我们如何将我们的内容引入呢?就由这个案例来揭晓吧。
我们上面说到引入互动,需要一个接口,一个实现类,然后通过某种形式引入到晚会上。但是晚会原来的接口是不会修改的。
首先创建接口:
IInteraction (互动)
InteractionImpl(互动实现类)
互动形式:
Game,互动是以游戏的形式加入到晚会中。我们来介绍下Game。
1、我们的Game类同样得声明并创建bean,交给Spring容器来处理。
2、这个引入的类必须是以切面的形式引入。所以要使用@Aspect注解。
3、基于@DeclareParents这个注解引入到目标类里。com.study.pany.bean.aopDemo1.IEvening 指的是目标类,我们需要将互动引入到晚会,晚会就是我们的目标类,“+”表示该类和它所有的子类。defaultImpl 表示选择哪个类引入到目标类中,也就是具体互动什么内容。
@DeclareParents(value ="com.study.pany.bean.aopDemo1.IEvening+", defaultImpl = InteractionImpl.class)
(本章节先只是讲使用,后面章节再介绍,它是如何基于代理模式去实现的)
接下来我们使用投资方的类来调用试试,如下:
运行结果如下:
可见我们已经引入成功了。