建站购物网站,万能本地视频播放器,推荐个2021能看的网站,保山市建设局网站文章目录 一、AspectJ介绍二、简单使用步骤1、引入依赖2、定义一个Aspect3、开启AOP支持 三、AOP 核心概念四、切点#xff08;Pointcut#xff09;1. execution2. within3. this target4. args args5. within target annotation 五、通知#xff0… 文章目录 一、AspectJ介绍二、简单使用步骤1、引入依赖2、定义一个Aspect3、开启AOP支持 三、AOP 核心概念四、切点Pointcut1. execution2. within3. this target4. args args5. within target annotation 五、通知Advice1. Before 示例日志记录2. AfterReturning 示例处理返回值3. AfterThrowing 示例异常处理4. After 示例资源释放5. Around 示例方法执行前后处理6. 参数相关 Advice 示例验证参数7. 注解相关 Advice 示例基于注解的日志记录8. AfterThrowing 异常示例特定异常处理9. Pointcut 单独定义切点其他Advice直接引用 参考 一、AspectJ介绍
AspectJ是一个面向切面的框架它扩展了Java语言并定义了AOP面向切面编程语法。
AspectJ支持数据埋点、日志记录、性能统计、安全控制、事务处理、异常处理等多种横切关注点。通过AspectJ开发者可以更加直观地定义和理解代码的行为减少对业务逻辑的干扰。
特点
模块化AspectJ允许开发者将横切关注点以模块化的方式进行管理和重用提高了代码的可维护性和可读性。声明式编程AspectJ使用注解或XML配置的方式来声明横切关注点减少了重复的样板代码。细粒度控制AspectJ提供了丰富的切点表达式语言可以精确地选择需要横切的连接点实现对代码的细粒度控制。跨模块切面AspectJ可以在不同的模块之间进行切面的织入使得横切关注点可以跨越多个模块进行统一管理。与Java语言的兼容性AspectJ是基于Java语言的扩展与Java语法完全兼容可以无缝地与现有的Java代码进行集成和使用。
二、简单使用步骤
1、引入依赖
dependency groupIdorg.springframework.boot/groupId artifactIdspring-boot-starter-aop/artifactId
/dependency2、定义一个Aspect
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.springframework.stereotype.Component; Aspect
Component
public class MyAspect { // 定义切点表示对哪些类的哪些方法进行拦截 // execution表达式指定了方法签名 // 第一个*表示任意返回类型第二个*表示类中的任意方法 // ..表示任意参数 // 这里的例子表示拦截UserService中的所有方法 Before(execution(* com.example.service.UserService.*(..))) public void beforeAdvice() { System.out.println(Before method: Do something before.); }
}3、开启AOP支持
在Spring Boot应用中通常通过SpringBootApplication注解启动应用该注解包含了EnableAspectJAutoProxy因此默认情况下Spring Boot应用是支持AOP的。
如果你的应用配置较为特殊确保你的配置类上通常是主类添加了EnableAspectJAutoProxy注解以开启对AspectJ自动代理的支持。
三、AOP 核心概念 切面AspectAOP 的模块单元封装了切点、通知以及类型间声明。在Spring AOP中切面通过使用常规类或使用Aspect注解的常规类AspectJ风格来实现。 连接点Join point程序流中指定的一点如方法调用、方法执行、字段访问等。 通知Advice切面在特定连接点上采取的动作。通知包括“环绕”、“前置”和“后置”通知。许多AOP框架包括Spring都将通知建模为拦截器并在连接点周围维护一个拦截器链。 切点Pointcut匹配连接点的谓词。通知与切点表达式相关联。Spring默认使用AspectJ切点表达式语言。 引入Introduction代表一个类型声明额外的方法或字段。Spring AOP允许您向任何被通知的对象引入新接口以及相应的实现。例如您可以使用引入来使bean实现IsModified接口以简化缓存。 目标对象Target object被一个或多个切面通知的对象。也称为“被通知对象”。由于Spring AOP是通过使用运行时代理实现的因此这个对象总是一个代理对象。 AOP代理AOP proxy由AOP框架创建的对象用于实现切面契约如通知方法的执行等。在Spring框架中AOP代理是JDK动态代理或CGLIB代理。 织入Weaving将切面与其他应用类型或对象链接起来以创建被通知对象。这可以在编译时例如使用AspectJ编译器、加载时或运行时完成。Spring AOP像其他纯Java AOP框架一样在运行时执行织入。
Spring AOP包括以下类型的通知
前置通知Before advice在连接点之前运行的通知但它没有能力阻止执行程序执行除非它抛出异常。后置返回通知After returning advice在连接点正常完成后运行的通知例如如果方法返回而没有抛出异常。后置异常通知After throwing advice如果方法通过抛出异常退出时运行的通知。后置最终通知After (finally) advice无论连接点以何种方式退出正常或异常返回都要运行的通知。环绕通知Around advice围绕连接点如方法调用的通知。这是最强大的通知类型。环绕通知可以在方法调用之前和之后执行自定义行为。它还负责选择是否继续到连接点或者通过返回自己的返回值或抛出异常来短路被通知方法的执行。
环绕通知是最通用的通知类型。由于Spring AOP像AspectJ一样提供了全范围的通知类型因此建议您使用能够实现所需行为的最不强大的通知类型。例如如果您只需要使用方法的返回值更新缓存那么实现后置返回通知比实现环绕通知更好尽管环绕通知也可以完成同样的事情。使用最具体的通知类型提供了更简单的编程模型并且减少了出错的可能性。例如您不需要在用于环绕通知的JoinPoint上调用proceed()方法因此您不会忘记调用它。
所有通知参数都是静态类型的因此您可以使用适当类型的通知参数例如方法执行的返回值的类型而不是Object数组。
四、切点Pointcut
Spring AOP支持使用AspectJ切入点表达式来指定切点。这些表达式可以非常灵活地定义需要拦截的方法集合。以下是一些常用的切点指示符和示例
1. execution
execution是最常用的切入点指示符用于匹配方法执行的连接点。其语法结构如下
execution(modifiers-pattern? ret-type-pattern declaring-type-pattern? name-pattern(param-pattern) throws-pattern?)modifiers-pattern可选方法的修饰符如public、private等。ret-type-pattern方法的返回类型*表示任意类型。declaring-type-pattern可选声明方法的类支持使用..来表示包及其子包下的所有类。name-pattern方法的名称。param-pattern方法的参数列表..表示任意数量和类型的参数*表示任意类型的一个参数(*, String)表示第一个参数是任意类型第二个参数是String类型。throws-pattern可选方法抛出的异常类型。
示例
匹配任意类的任意方法execution(* *(..))匹配com.example.service包下所有类的所有方法execution(* com.example.service..*.*(..))匹配MyService类中的doSomething方法execution(* com.example.service.MyService.doSomething(..))匹配任意类的save方法且方法参数为java.lang.String类型execution(* *.save(java.lang.String))
2. within
within用于匹配指定类型内的方法执行包括指定的接口、类或包。
示例
匹配com.example.dao包下的所有类的所有方法within(com.example.dao.*)匹配com.example.dao包及其子包中所有类中的所有方法within(com.example.dao..*)匹配实现了UserService接口的类的所有方法within(com.example.service.UserService)
3. this target
this用于匹配当前AOP代理对象类型的执行方法注意是AOP代理对象的类型匹配。target用于匹配当前目标对象类型的执行方法注意是目标对象的类型匹配。
示例
匹配当前AOP代理对象类型为MyService的所有方法执行this(com.example.service.MyService)匹配当前目标对象类型为MyService的所有方法执行target(com.example.service.MyService)
4. args args
args用于匹配当前执行的方法传入的参数为指定类型的执行方法参数类型列表中的参数必须是类型全限定名通配符不支持。args匹配方法传入的参数所属类上拥有指定的注解的情况。
示例
匹配方法参数为String类型的方法args(java.lang.String)匹配方法参数类型上拥有MyAnnotation注解的方法调用args(com.example.MyAnnotation)
5. within target annotation
within匹配类级别上应用了特定注解的类中的所有方法。target匹配运行时目标对象代理对象的类型上应用了特定注解的方法在Spring AOP中常用于代理对象的切点定义。annotation匹配方法级别上应用了特定注解的方法。
示例
匹配所有类上具体指定了MyAnnotation注解的类内的所有方法within(com.example.MyAnnotation)匹配当前目标对象类型持有MyAnnotation注解的方法target(com.example.MyAnnotation)匹配所有拥有MyAnnotation注解的外部调用方法annotation(com.example.MyAnnotation)
五、通知Advice
Spring AOP提供了多种类型的Advice包括
Before在目标方法执行之前执行。AfterReturning在目标方法正常执行完成后执行。AfterThrowing在目标方法抛出异常时执行。After无论目标方法执行结果如何最终都会执行。Around在目标方法执行前后执行并可以控制目标方法的执行。
每种类型的Advice都需要与切入点表达式结合使用以确定其应用的范围。
1. Before 示例日志记录
在方法执行之前记录日志常用于跟踪方法的调用。
Aspect
Component
public class LoggingAspect {// 定义切点表示对哪些类的哪些方法进行拦截// execution表达式指定了方法签名// 第一个*表示任意返回类型第二个*表示类中的任意方法// ..表示任意参数// 这里的例子表示拦截UserService中的所有方法Before(execution(* com.example.service.UserService.*(..)))public void logBeforeMethodExecution(JoinPoint joinPoint) {System.out.println(Before executing method: joinPoint.getSignature().getName());}// 定义切点表示对哪些类的哪些方法进行拦截// execution表达式指定了方法签名// 第一个*表示任意返回类型第二个*表示类中的任意方法// 第一次..表示包及其子包下的所有类// 第二次..表示任意参数Before(execution(* com.example..*(..)))public void logBeforeMethodExecutionAll(JoinPoint joinPoint) {System.out.println(Before executing method all: joinPoint.getSignature().getName());}
}2. AfterReturning 示例处理返回值
在方法成功执行并返回后对返回值进行处理或记录。
Aspect
Component
public class ReturnValueAspect {AfterReturning(pointcut execution(* com.example.service.UserService.getUserById(..)), returning result)public void logReturnValue(Object result) {System.out.println(Method returned: result);}
}3. AfterThrowing 示例异常处理
在方法抛出异常时捕获异常并进行相应的处理或记录。
Aspect
Component
public class ExceptionHandlingAspect {AfterThrowing(pointcut execution(* com.example.service.*.*(..)), throwing ex)public void handleException(Exception ex) {System.err.println(An exception occurred: ex.getMessage());}
}4. After 示例资源释放
无论方法执行结果如何都会在方法执行后执行常用于资源释放。
Aspect
Component
public class ResourceReleaseAspect {After(execution(* com.example.service.*.*(..)))public void releaseResources() {System.out.println(Resources are released after method execution);}
}5. Around 示例方法执行前后处理
在方法执行前后都进行处理可以控制方法的执行或添加额外的逻辑。
Aspect
Component
public class AroundAdviceAspect {Around(execution(* com.example.service.UserService.*(..)))public Object logAroundMethodExecution(ProceedingJoinPoint joinPoint) throws Throwable {System.out.println(Before executing method: joinPoint.getSignature().getName());Object result joinPoint.proceed(); // 执行目标方法System.out.println(After executing method: joinPoint.getSignature().getName());return result;}
}6. 参数相关 Advice 示例验证参数
在方法执行之前验证参数的有效性。
Aspect
Component
public class ParameterValidationAspect {Before(execution(* com.example.service.UserService.addUser(com.example.model.User)) args(user))public void validateUserParameter(User user) {if (user null || user.getName() null || user.getName().isEmpty()) {throw new IllegalArgumentException(User parameter is invalid);}}
}7. 注解相关 Advice 示例基于注解的日志记录
根据方法上的注解来决定是否进行日志记录。可以使用注解全限定名或使用参数中的注解参数名。
Retention(RetentionPolicy.RUNTIME)
Target(ElementType.METHOD)
public interface Loggable {
}Aspect
Component
public class AnnotationDrivenLoggingAspect {Before(annotation(com.example.aspect.Loggable))public void logMethodWithAnnotation(JoinPoint joinPoint) {System.out.println(Executing loggable method: joinPoint.getSignature().getName());}// 使用参数中的注解Before(annotation(loggable))public void logMethodWithAnnotationArg(JoinPoint joinPoint, Loggable loggable) {System.out.println(Executing loggable method: joinPoint.getSignature().getName());}
}// 在需要日志记录的方法上使用Loggable注解
Service
public class MyService {Loggablepublic void myLoggableMethod() {// ...}
}8. AfterThrowing 异常示例特定异常处理
仅当方法抛出特定类型的异常时进行处理。
Aspect
Component
public class SpecificExceptionHandlingAspect {AfterThrowing(pointcut execution(* com.example.service.*.*(..)), throwing ex)public void handleSpecificException(CustomException ex) {System.err.println(A CustomException occurred: ex.getMessage());}
}// 自定义异常类
public class CustomException extends RuntimeException {public CustomException(String message) {super(message);}
}9. Pointcut 单独定义切点其他Advice直接引用
Aspect
Component
public class LoggingAspect {// 定义切点表示对哪些类的哪些方法进行拦截// execution表达式指定了方法签名// 第一个*表示任意返回类型第二个*表示类中的任意方法// ..表示任意参数// 这里的例子表示拦截UserService中的所有方法Pointcut(execution(* com.example.service.UserService.*(..)))private void service() {}Before(service())public void logBeforeMethodExecution(JoinPoint joinPoint) {System.out.println(Before executing method: joinPoint.getSignature().getName());}}参考
https://docs.spring.io/spring-framework/reference/core/aop.html
