• 【AOP系列】8.API统一处理


    在Java中,我们可以使用Spring AOP(面向切面编程)和自定义注解来做API接口的统一返回格式处理。以下是一个简单的示例:

    首先,我们创建一个自定义注解,用于标记需要进行统一返回格式处理的方法:

    1. import java.lang.annotation.ElementType;
    2. import java.lang.annotation.Retention;
    3. import java.lang.annotation.RetentionPolicy;
    4. import java.lang.annotation.Target;
    5. @Target(ElementType.METHOD) //注解放置的目标位置,METHOD是可放在方法级别
    6. @Retention(RetentionPolicy.RUNTIME) //注解在哪个阶段执行
    7. public @interface ApiResponseFormat {
    8. // 可以定义注解的一些属性
    9. }

    然后,我们创建一个切面,用于处理标记了@ApiResponseFormat的方法:

    1. import org.aspectj.lang.ProceedingJoinPoint;
    2. import org.aspectj.lang.annotation.Around;
    3. import org.aspectj.lang.annotation.Aspect;
    4. import org.aspectj.lang.annotation.Pointcut;
    5. import org.springframework.stereotype.Component;
    6. @Aspect
    7. @Component
    8. public class ApiResponseFormatAspect {
    9. @Pointcut("@annotation(com.yourpackage.ApiResponseFormat)") //指定自定义注解的路径
    10. public void pointcut() {}
    11. @Around("pointcut()")
    12. public Object around(ProceedingJoinPoint joinPoint) {
    13. Object result = null;
    14. try {
    15. result = joinPoint.proceed(); //执行方法
    16. } catch (Throwable e) {
    17. // 异常处理,返回错误信息
    18. return new ApiResponse(false, "服务器内部错误");
    19. }
    20. // 正常处理,包装返回结果
    21. return new ApiResponse(true, result);
    22. }
    23. }

    在这里,ApiResponse是一个自定义的类,用于包装API接口的返回结果:

    1. public class ApiResponse {
    2. private boolean success;
    3. private Object data;
    4. public ApiResponse(boolean success, Object data) {
    5. this.success = success;
    6. this.data = data;
    7. }
    8. // getter和setter方法...
    9. }

    最后,我们在需要进行统一返回格式处理的方法上添加@ApiResponseFormat注解:

    1. public class SomeController {
    2. @ApiResponseFormat
    3. public Object someApi(SomeData data) {
    4. //...
    5. }
    6. }

    这样,当someApi方法被调用时,ApiResponseFormatAspect中的around方法会被触发,从而实现API接口的统一返回格式处理。

    注意:这只是一个简单的示例,实际使用时,你可能需要处理更多的细节,例如根据不同的异常返回不同的错误信息等。而且,Spring已经提供了强大的异常处理和响应体包装的支持,通常我们不需要自己实现这样的功能。

  • 相关阅读:
    设计模式-享元模式Flyweight(结构型)
    linux ioctl 理解
    训练深度学习神经网络的常用5个损失函数
    LLVM技术在GaussDB等数据库中的应用
    Flink运行时架构 完整使用 (第四章)
    SpringAMQP简介及简单使用
    嵌入模型和大型语言模型的区别
    大数据-kafka学习笔记
    CV&NLP基础11之ResNet(深度残差网络)学习
    Sql知识总结-MySql存储过程
  • 原文地址:https://blog.csdn.net/Yooneep/article/details/133858236