【开发必备】Spring AOP的灵活运用

858 阅读4分钟

转载请声明出处!

Spring AOP为我们提供了一种更简洁的代码编写方法。主要用来隔离业务逻辑代码,降低非业务代码的侵入性。比如像日志记录,安全管理,事务管理等,如果直接写到业务代码里,侵入性大,代码阅读性差。

如果你的项目使用了AOP,那么可以给你的类里的方法添加更多功能,让代码更简洁易读。

在这里,James不打算和大家讨论AOP的基础知识。如果没有用过AOP的同学,可以先百度简单看一下AOP的基本概念,我们将主要关注Spring AOP应用程序。

在我们开发的任何应用程序中,以下的这些代码我相信一定是大家都写过的:

//服务层
@Service
public class OrderServiceImpl {
    public Order queryOrder() {
        System.out.println("Reading from collectionA");
        return new Order("1","2019-07-11");
    }

    public int updateOrder() {
        System.out.println("Writing to collectionA");
        return 1;
    }
}
//控制层
@Controller
public class OrderController {
    @Autowired
    OrderServiceImpl orderServiceImpl;

    //订单查询
    @RequestMapping("query")
    public Order queryOrder() {
        return orderServiceImpl.queryOrder();
    }
    //订单修改
    @RequestMapping("update")
    public int updateOrder() {
         return orderServiceImpl.updateOrder();
     }
}

在上面的示例中,我们在控制层中有一个OrderController类和一个OrderServiceImpl业务类。

如果现在有这么一个需求:

在我们的应用程序的第一个版本中,它是没有授权功能,现在的需求是要加一个授权功能。

在上面的示例中,在我们操作订单信息之前(不管是查询还是修改)添加一个检查用户是否为admin的功能。

实现此功能的一种方法是创建Authorization类和isAuthorized方法来检查用户是否被授权。那么我们需要更新OrderServiceImpl的所有方法,并通过调用isAuthorized方法来检查授权。

@Component
public class OrderServiceImpl {
     public Order queryOrder() {
         //判断当前登陆用户是否有权限查询
         if (Authorization.isAuthorised(Session.getUserId())){
             System.out.println("Reading from collectionA");
             return new Order("1","2019-07-11");
         }
     }
    public int updateOrder() {
         //判断当前登陆用户是否有权限修改
         if (Authorization.isAuthorised(Session.getUserId())){
             System.out.println("Writing to collectionA");
             return 1;
         }
     }
}

但是,这种方法存在缺点。我们需要修改OrderServiceImpl类的每个方法,并且在所有方法中重复调用isAuthorized方法的相同代码以检查授权。

如果不更改现有类,能不能完成授权检查功能呢?

当然可以,AOP就可以实现。

现在定义一个AuthorizationCheck类,可以为OrderServiceImpl类创建一个切入点。在建议中,我们检查用户是否是管理员,然后我们继续;否则,我们不操作。

无需在OrderServiceImpl类中进行任何更改。

代码如下:

@Aspect
@Configuration
public class AuthorizationCheck {
     //使用Around切面拦截OrderServiceImpl类的所有方法,在调用OrderServiceImpl方法时自动检查权限
     @Around("execution(**com.enjoy.aop.OrderServiceImpl.*(..))")
     public void check (ProceedingJoinPoint jp) {
          try {
               if(Authorization.isAuthorised(Session.getUserId())) {
                     jp.proceed();//手动执行目标方法,相当于调用OrderServiceImpl的某个方法
               }
               else {
                     System.out.println("User not Authorised");
               }
          } catch (Throwable e) {
                    e.printStackTrace();
          }
     }
}

现在,对于对OrderServiceImpl类的任何方法的任何调用,只有在满足时才会调用订单相关方法。

以上可见,在不更改现有类的情况下,我们完成了授权功能。当然除了这种使用方式外,我们还可以监控性能,比如监控OrderServiceImpl类里方法执行的时间情况,如何操作呢?见下

创建一个名为TurnAroundTime自定义注解,用来检查目标方法执行的性能与时间。

以下是一个例子:首先,我们需要自定义一个注解。

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public@interface TurnAroundTime {
}

我们想检查的对象为方法,所以这里的目标类型是Method,@Target(ElementType.METHOD)。

RetentionPolicy是运行时,因为我们想在运行时应用它们。接下来,我们定义切面。

@Aspect
@Configuration
public class PerformanceCheck {
    //拦截com.enjoy.aop包下的所有方法,当方法声明TurnAroundTime注解时,
    //都需要执行watchPerformance切面方法
     @Around("execution(** com.enjoy.aop.*.*.*(..))&& @annotation(TurnAroundTime)")
     public void watchPerformance(ProceedingJoinPoint jp) {
          Instant start = Instant.now();//调方法前计时
          try {
              jp.proceed();//手动执行目标方法,相当于调用OrderServiceImpl的某个方法
          } catch (Throwable e) {
              e.printStackTrace();
          }
          Instant finish = Instant.now();//调方法结束后计时
          long timeElapsed = Duration.between(start,finish).toMillis();//调用方法耗时多少
          System.out.println("Total Turnaround time:" + timeElapsed);
     }
}

我们使用切入点定义一个切面,用该切面来监听目标方法执行情况。记录目标方法执行前和执行之后的时间差。

因此,若我们想要测量目标方法的性能时,我们需要使用自定义注释@TurnAroundTime来注释该方法。

代码如下:

@Component
public class OrderServiceImpl {
     @TurnAroundTime
     public Order queryOrder() {
          //判断当前登陆用户是否有权限查询
         if (Authorization.isAuthorised(Session.getUserId())){
             System.out.println("Reading from collectionA");
             return new Order("1","2019-07-11");
         }
     }
    @TurnAroundTime
    public int updateOrder() {
         //判断当前登陆用户是否有权限修改
         if (Authorization.isAuthorised(Session.getUserId())){
             System.out.println("Writing to collectionA");
             return 1;
         }
     }
}

大家可以看到,SpringAOP玩熟悉后,可以解决很多代码冗余问题,方便我们开发,自定义注解能让我们更好的美化代码,减少代码的侵入性,本节就写到这里吧。

你的赞和关注是我继续创作的动力~