Spring Aop实现日志收集和重复属性赋值
简介
AOP(Aspect-Oriented Programming),即面向切面编程,用人话说就是把公共的逻辑抽出来,让开发者可以更专注于业务逻辑开发。
和IOC一样,AOP也指的是一种思想。AOP思想是OOP(Object-Oriented Programming)的补充。OOP是面向类和对象的,但是AOP则是面向不同切面的。一个切面可以横跨多个类和对象去操作,极大的丰富了开发者的使用方式,提高了开发效率。
譬如,一个订单的创建,可能需要以下步骤:
-
权限校验
-
事务管理
-
创建订单
-
日志打印
如果使用AOP思想,我们就可以把这四步当成四个“切面”,让业务人员专注开发第三个切面,其他三个切面则是基础的通用逻辑,统一交给AOP封装和管理。
Spring AOP有如下概念:
术语 | 翻译 | 释义 |
---|---|---|
Aspect | 切面 | 切面由切入点和通知组成,它既包含了横切逻辑的定义,也包括了切入点的定义。切面是一个横切关注点的模块化,一个切面能够包含同一个类型的不同增强方法,比如说事务处理和日志处理可以理解为两个切面。 |
PointCut | 切入点 | 切入点是对连接点进行拦截的条件定义,决定通知应该作用于截哪些方法。(充当where角色,即在哪里做) |
Advice | 通知 | 通知定义了通过切入点拦截后,应该在连接点做什么,是切面的具体行为。(充当what角色,即做什么) |
Target | 目标对象 | 目标对象指将要被增强的对象,即包含主业务逻辑的类对象。或者说是被一个或者多个切面所通知的对象。 |
JoinPoint | 连接点 | 连接点是程序在运行时的执行点,这个点可以是正在执行的方法,或者是正在抛出的异常。因为Spring只支持方法类型的连接点,所以在Spring中连接点就是运行时刻被拦截到的方法。连接点由两个信息确定:+ 方法(表示程序执行点,即在哪个目标方法)+ 相对点(表示方位,即目标方法的什么位置,比如调用前,后等) |
Weaving | 织入 | 织入是将切面和业务逻辑对象连接起来, 并创建通知代理的过程。织入可以在编译时,类加载时和运行时完成。在编译时进行织入就是静态代理,而在运行时进行织入则是动态代理。 |
对于通知类型来说:
Before Advice | 连接点执行前执行的逻辑 |
---|---|
After returning advice | 连接点正常执行(未抛出异常)后执行的逻辑 |
After throwing advice | 连接点抛出异常后执行的逻辑 |
After finally advice | 无论连接点是正常执行还是抛出异常,在连接点执行完毕后执行的逻辑 |
Around advice | 该通知可以非常灵活的在方法调用前后执行特定的逻辑 |
代码实现
1、创建注解
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Log {String value() default "";
}
2、切面类
@Aspect
@Slf4j
@Component
public class LogAspect {/*** 切入点*/@Pointcut("execution(* com.zh.cn.*.*.*(..)) && @annotation(com.zh.cn.annotation.Log)")public void LogAspect(){}@Before("LogAspect()")public void before(JoinPoint joinPoint){//收集日志系统log.info("日志收集---前置通知");//获取日志收集中的实体类log.info("参数:{}",joinPoint);//获取basePojo实体类Object[] args = joinPoint.getArgs();Object entity = args[0];try {Method setUpdateTime = entity.getClass().getDeclaredMethod("setUpdateTime", Date.class);Method setUpdateName = entity.getClass().getDeclaredMethod("setUpdateName", String.class);//通过反射为对象赋值setUpdateTime.invoke(entity,new Date());setUpdateName.invoke(entity,"zh");} catch (NoSuchMethodException | IllegalAccessException | InvocationTargetException e) {throw new RuntimeException(e);}//收集日志//~~~~log.info("日志收集---后置通知");}
}
3、controller层
/*** @Description:* @author:<a href="2358853434@qq.com"></a> zh* @Create : 2024/10/5**/
@RestController
@RequestMapping("/order/v1")
public class OrderController {@Resourceprivate OrderService orderService;@GetMapping("/update")public Result update() {Order order = new Order();order.setId(1292071939041697792L);order.setName("测试商品");order.setNum(128L);return orderService.update(order);}@GetMapping("/insert")public Result insert(){return Result.success();}
}
4、service层
@Service
@Slf4j
public class OrderServiceimpl implements OrderService {@ResourceRedisTemplate<String,String> redisTemplate;@ResourceRedisDistributedLock redisDistributedLock;/*** 更新订单接口* @param order* @return*/@Logpublic Result update(Order order) {log.info("update开始,订单号:{}",order.getId()+"order:"+order);//加锁成功while(redisDistributedLock.tryLock("order:"+order.getId()+":"+Thread.currentThread().getId(), "requestId", 10)) {//执行订单减减log.info("加锁成功"+Thread.currentThread().getId());redisTemplate.opsForValue().set("order:"+order.getId(), order.toString());break;}if (redisDistributedLock.unlock("order:"+order.getId()+":"+Thread.currentThread().getId(),"requestId")) {log.info("update结束,订单号:{}",order.getId());return Result.success();}return Result.error("下单失败");}
}
5、测试
测试用例
由于项目中加了spring-security的相关依赖,需要配置Authorization,不需要的友友请自行删除
GET http://localhost:19002/order/v1/update
Authorization: Basic cm9vdDpyb290
结果
测试用例
由于项目中加了spring-security的相关依赖,需要配置Authorization,不需要的友友请自行删除
GET http://localhost:19002/order/v1/update
Authorization: Basic cm9vdDpyb290