使用aop切面方式实现流水日志输出,并且代码无侵入,满足开闭原则

场景模拟

1. 基础场景搭建

@Data
public class UpdateOrder {  
    private Long orderId;
}
@Data  
public class SaveOrder {
    private Long id;  
}
@Service 
public class OrderService {  
    public Boolean saveOrder(SaveOrder saveOrder) {  
        System.out.println("保存订单, orderId: " + saveOrder.getId());  
        return true;  
    }  
  
    public Boolean updateOrder(UpdateOrder updateOrder) {  
        System.out.println("更新订单, orderId: " + updateOrder.getOrderId());  
        return true;  
    }  
}

测试

@SpringBootApplication  
public class Application implements CommandLineRunner {  
    public static void main(String[] args) {  
        new SpringApplication(Application.class).run(args);  
    }  
  
    @Autowired  
    private OrderService orderService;  
  
    @Override  
    public void run(String... args) throws Exception {  
  
        SaveOrder saveOrder = new SaveOrder();  
        saveOrder.setId(1L);  
        orderService.saveOrder(saveOrder);  
  
        UpdateOrder updateOrder = new UpdateOrder();  
        updateOrder.setOrderId(2L);  
        orderService.updateOrder(updateOrder);  
    }  
}

2. AOP 实现

2.1 自定义注解

public @interface RecordOperate {  
    String desc() default "";  
}

2.2 在需要增强的方法上加上注解

2.3 定义切面

@Component  
@Aspect  
public class OperateAspect {  
  
    @Pointcut("@annotation(RecordOperate)")  
    public void pointcut(){}  
      
  
    @Around("pointcut()")  
    public Object around(ProceedingJoinPoint point) throws Throwable {  
        Object result = point.proceed();
            
        // 待填写
        return result;  
    }  
}

不同的入参
private Long orderId;
private Long id;

在统一的切面中,如何根据不同的入参,获取到想要的参数

难道要一个一个判断吗?

解决方法

定义一个接口,根据指定方法进行转换,根据不同的入参,拿到标准模型

实现

定义统一返回

@Data  
public class OperateLogDO {  
    private Long orderId;  
    private String desc;  
    private String result;  
}

定义接口

public interface Convert <PARAM>{  
    OperateLogDO convert(PARAM param);  
}

修改注解

public @interface RecordOperate {  
    String desc() default "";  
    Class<? extends Convert> convert();  
}

定义一个类去实现Convert 接口 完成对数据的处理

public class SaveOrderConvert implements Convert<SaveOrder>{  
    @Override  
    public OperateLogDO convert(SaveOrder saveOrder) {  
        OperateLogDO operateLogDO = new OperateLogDO();  
        operateLogDO.setOrderId(saveOrder.getId());  
        return operateLogDO;  
    }  
}

完善切面OperateAspect

MethodSignature methodSignature = (MethodSignature) point.getSignature();  
RecordOperate annotation = methodSignature.getMethod().getAnnotation(RecordOperate.class);  
  
Class<? extends Convert> convert = annotation.convert();  
Convert logConvert = convert.newInstance();  
OperateLogDO operateLogDO = logConvert.convert(point.getArgs()[0]);  
  
operateLogDO.setDesc(annotation.desc());  
operateLogDO.setResult(result.toString());  
  
System.out.println("新增日志  " + JSON.toJSONString(operateLogDO));

完善增强方法上的注解

@RecordOperate(desc = "保存订单", convert = SaveOrderConvert.class)  
public Boolean saveOrder(SaveOrder saveOrder) {  
    System.out.println("保存订单, orderId: " + saveOrder.getId());  
    return true;  
}

结尾

这样以后来的新的方法只需要实现 Convert 接口,就不需要去改老的代码啦!

  • 15
    点赞
  • 14
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
好的,下面是一个简单的示例,演示如何使用 AOP 实现切面存储操作日志: ```java @Aspect @Component public class LogAspect { private static final Logger logger = LoggerFactory.getLogger(LogAspect.class); @Autowired private HttpServletRequest request; @Pointcut("execution(public * com.example.controller.*.*(..))") public void controllerLog() {} @Before("controllerLog()") public void doBefore(JoinPoint joinPoint) { logger.info("Request URL : {} {}", request.getRequestURL().toString(), request.getMethod()); logger.info("IP : {}", request.getRemoteAddr()); logger.info("Class Method : {}.{}", joinPoint.getSignature().getDeclaringTypeName(), joinPoint.getSignature().getName()); logger.info("Args : {}", Arrays.toString(joinPoint.getArgs())); } @AfterReturning(returning = "result", pointcut = "controllerLog()") public void doAfterReturning(Object result) { logger.info("Response : {}", result); } } ``` 代码解释: - `@Aspect` 注解表示这是一个切面类。 - `@Component` 注解表示让 Spring 自动扫描并注册该组件。 - `private static final Logger logger = LoggerFactory.getLogger(LogAspect.class);` 声明一个日志记录器。 - `@Autowired private HttpServletRequest request;` 注入 HttpServletRequest 对象,以便获取请求信息。 - `@Pointcut("execution(public * com.example.controller.*.*(..))")` 定义切点,表示匹配 com.example.controller 包下的所有公共方法。 - `@Before("controllerLog()")` 定义前置通知,表示在切点方法执行前执行该方法。 - `JoinPoint` 是 Spring AOP 提供的用于获取连接点信息的类,可以获取方法名、参数等信息。 - `@AfterReturning(returning = "result", pointcut = "controllerLog()")` 定义后置通知,表示在切点方法执行后执行该方法。 - `returning = "result"` 表示将方法的返回值赋值给 result 参数。 - `logger.info()` 是日志记录器的方法,用于记录日志信息。 以上代码实现了一个简单的 AOP 切面,用于记录 controller 的操作日志。在具体的业务场景中,可以根据实际需要进行扩展和定制。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值