精华内容
下载资源
问答
  • spring中aop的注解实现方式简单实例  上篇中我们讲到spring的xml实现,这里我们讲讲使用注解如何实现aop呢。前面已经讲过aop的简单...在切面类(为切点服务的类)前用@Aspect注释修饰,声明为一个切面类。 ...

    spring中aop的注解实现方式简单实例

     

      上篇中我们讲到spring的xml实现,这里我们讲讲使用注解如何实现aop呢。前面已经讲过aop的简单理解了,这里就不在赘述了。

    注解方式实现aop我们主要分为如下几个步骤(自己整理的,有更好的方法的话,欢迎交流codecjh@163.com):

      1.在切面类(为切点服务的类)前用@Aspect注释修饰,声明为一个切面类。

      2.用@Pointcut注释声明一个切点,目的是为了告诉切面,谁是它的服务对象。(此注释修饰的方法的方法体为空,不需要写功能比如 public void say(){};就可以了,方法名可以被候命的具体服务功能所以引用,它可以被理解为切点对象的一个代理对象方法)

      3.在对应的方法前用对应的通知类型注释修饰,将对应的方法声明称一个切面功能,为了切点而服务

      4.在spring配置文件中开启aop注释自动代理。如:<aop:aspectj-autoproxy/>

    这样讲可能还是很抽象,那么,废话不多说,我们代码说话,代码如下:

    骑士类:(看过上一篇内容的就知道骑士是什么东西了,嘿嘿嘿)

    复制代码
     1 package com.cjh.aop2;
     2 
     3 import org.springframework.stereotype.Component;
     4 
     5 /**
     6  * @author 古斌
     7  *
     9  */
    10 @Component("knight")
    11 public class BraveKnight {
    12     public void saying(){
    13         System.out.println("我是骑士..(切点方法)");
    14     }
    15 }
    复制代码

    切面类:(注释主要在这里体现)

    复制代码
     1 package com.cjh.aop2;
     2 
     3 import org.aspectj.lang.ProceedingJoinPoint;
     4 import org.aspectj.lang.annotation.After;
     5 import org.aspectj.lang.annotation.Around;
     6 import org.aspectj.lang.annotation.Aspect;
     7 import org.aspectj.lang.annotation.Before;
     8 import org.aspectj.lang.annotation.Pointcut;
     9 import org.springframework.stereotype.Component;
    10 
    11 /**
    15  */

    @AspectJ提供不同的通知类型

    ····@Before前置通知,相当于BeforeAdvice

    ····@AfterReturning后置通知,相当于AfterReturningAdvice

    ····@Around环绕通知,相当于MethodInterceptor

    ····@AfterThrowing抛出通知,相当于ThrowAdvice

    ····@After最终final通知,不管是否异常,该通知都会执行

     

    16 /**
    17  * 注解方式声明aop
    18  * 1.用@Aspect注解将类声明为切面(如果用@Component("")注解注释为一个bean对象,那么就要在spring配置文件中开启注解扫描,<context:component-scan base-package="com.cjh.aop2"/>
    19  *      否则要在spring配置文件中声明一个bean对象)
    20  * 2.在切面需要实现相应方法的前面加上相应的注释,也就是通知类型。
    21  * 3.此处有环绕通知,环绕通知方法一定要有ProceedingJoinPoint类型的参数传入,然后执行对应的proceed()方法,环绕才能实现。
    22  */
    23 @Component("annotationTest")
    24 @Aspect
    25 public class AnnotationTest {
    26     //定义切点
    27     @Pointcut("execution(* *.saying(..))")
    28     public void sayings(){}
    29     /**
    30      * 前置通知(注解中的sayings()方法,其实就是上面定义pointcut切点注解所修饰的方法名,那只是个代理对象,不需要写具体方法,
    31      * 相当于xml声明切面的id名,如下,相当于id="embark",用于供其他通知类型引用)
    32      * <aop:config>
    33         <aop:aspect ref="mistrel">
    34             <!-- 定义切点 -->
    35             <aop:pointcut expression="execution(* *.saying(..))" id="embark"/>
    36             <!-- 声明前置通知 (在切点方法被执行前调用) -->
    37             <aop:before method="beforSay" pointcut-ref="embark"/>
    38             <!-- 声明后置通知 (在切点方法被执行后调用) -->
    39             <aop:after method="afterSay" pointcut-ref="embark"/>
    40         </aop:aspect>
    41        </aop:config>
    42      */
    43     @Before("sayings()")
    44     public void sayHello(){
    45         System.out.println("注解类型前置通知");
    46     }
    47     //后置通知
    48     @After("sayings()")
    49     public void sayGoodbey(){
    50         System.out.println("注解类型后置通知");
    51     }
    52     //环绕通知。注意要有ProceedingJoinPoint参数传入。
    53     @Around("sayings()")
    54     public void sayAround(ProceedingJoinPoint pjp) throws Throwable{
    55         System.out.println("注解类型环绕通知..环绕前");
    56         pjp.proceed();//执行方法
    57         System.out.println("注解类型环绕通知..环绕后");
    58     }
    59 }
    复制代码

    spring配置文件:

    复制代码
     1 <?xml version="1.0" encoding="UTF-8"?>
     2 <beans xmlns="http://www.springframework.org/schema/beans"
     3     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     4     xmlns:context="http://www.springframework.org/schema/context"
     5     xmlns:aop="http://www.springframework.org/schema/aop"
     6     xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
     7         http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-4.3.xsd
     8         http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.3.xsd">
     9     <!-- 开启注解扫描 -->
    10     <context:component-scan base-package="com.cjh.aop2"/>
    11     <!-- 开启aop注解方式,此步骤s不能少,这样java类中的aop注解才会生效 -->
    12     <aop:aspectj-autoproxy/>
    13 </beans>
    复制代码

    测试代码:

    复制代码
     1 package com.cjh.aop2;
     2 
     3 import org.springframework.context.ApplicationContext;
     4 import org.springframework.context.support.ClassPathXmlApplicationContext;
     5 
     6 /**
     7  * 
    11  */
    12 public class Test {
    13     public static void main(String[] args) {
    14         ApplicationContext ac = new ClassPathXmlApplicationContext("com/cjh/aop2/beans.xml");
    15         BraveKnight br = (BraveKnight) ac.getBean("knight");
    16         br.saying();
    17     }
    18 }
    复制代码

    运行结果:

    注解类型环绕通知..环绕前
    注解类型前置通知
    我是骑士..(切点方法)
    注解类型环绕通知..环绕后
    注解类型后置通知

    ========================分割线===================================

      因为使用了注解方式,所以配置文件少了很多内容,只需要一句<context:component-scan base-package="com.cjh.aop2"/>声明要扫描的包,框架会自动扫描注释并生成bean对象。有个@Component("knight")这个注释,和<bean id="knight" class="com.cjh.aop2.BraveKnight"/>这个配置时一样的意思,框架会自动识别并创建名为knight的BraveKnight对象。所以有了注释,只需要开启注释扫描配置就好了,无需再做相同的bean配置。

      如果运行过程中出现Spring aop : error at ::0 can't find referenced pointcut sleepPonit的错误,那么很可能是spring的包的版本问题,

      我用的是spring4的版本,然后还需要加aspectjrt-1.7.4.jar和aspectjweaver-1.7.4.jar两个包,云盘地址:链接:http://pan.baidu.com/s/1qXQurO4 密码:nc4i

    工程目录如下:(打码码的类不用管,只是为了不为大家造成误导,所以划掉了)

    通知注解类型如下:

     

    上图:

    XML的配置:

     

     切入点:

    切面:

     

     测试

     

     

    转载于:https://www.cnblogs.com/gu-bin/p/10473417.html

    展开全文
  • SpringBoot项目 Spring AOP切面注解实现

    千次阅读 2019-03-30 01:58:46
    //切面拦截器,拦截订单接口请求中是否能查询到token(类似SpringAOP) @Pointcut("execution(public * com.imooc.controller.Seller*.*(..))" + "&& !execution(public * ...

    这个类对控制层controller中的一些订单请求进行了拦截,并判断这些请求中Cookie中是否查到token(微信用户id) 

    import com.imooc.constant.CookieConstant;
    import com.imooc.constant.RedisConstant;
    import com.imooc.exception.SellerAuthorizeException;
    import com.imooc.utils.CookieUtil;
    import lombok.extern.slf4j.Slf4j;
    import org.aspectj.lang.annotation.Aspect;
    import org.aspectj.lang.annotation.Before;
    import org.aspectj.lang.annotation.Pointcut;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.data.redis.core.StringRedisTemplate;
    import org.springframework.stereotype.Component;
    import org.springframework.util.StringUtils;
    import org.springframework.web.context.request.RequestContextHolder;
    import org.springframework.web.context.request.ServletRequestAttributes;
    
    import javax.servlet.http.Cookie;
    import javax.servlet.http.HttpServletRequest;
    
    /**
     * Created by 廖师兄
     * 2017-07-30 17:31
     */
    
    @Aspect //声明表示这是一个切面类
    @Component
    @Slf4j
    public class SellerAuthorizeAspect {
    
        @Autowired
        private StringRedisTemplate redisTemplate;
    
        //切面拦截器,拦截订单接口请求中是否能查询到token(类似SpringAOP)
        @Pointcut("execution(public * com.imooc.controller.Seller*.*(..))" +
        "&& !execution(public * com.imooc.controller.SellerUserController.*(..))") //切入点
        public void verify() {}
    
        @Before("verify()")  //在请求之前
        public void doVerify() {
            ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
            HttpServletRequest request = attributes.getRequest();
    
            //查询cookie
            Cookie cookie = CookieUtil.get(request, CookieConstant.TOKEN);
            if (cookie == null) {
                log.warn("【登录校验】Cookie中查不到token");
                throw new SellerAuthorizeException();
            }
    
            //去redis里查询
            String tokenValue = redisTemplate.opsForValue().get(String.format(RedisConstant.TOKEN_PREFIX, cookie.getValue()));
            if (StringUtils.isEmpty(tokenValue)) {
                log.warn("【登录校验】Redis中查不到token");
                throw new SellerAuthorizeException();
            }
        }
    }

    三、注解

    2 注解说明

    2.1 @Aspect

    作用是把当前类标识为一个切面供容器读取

    2.2 @Before
    标识一个前置增强方法,相当于BeforeAdvice的功能,相似功能的还有

    2.3 @AfterReturning

    后置增强,相当于AfterReturningAdvice,方法正常退出时执行

    2.4 @AfterThrowing

    异常抛出增强,相当于ThrowsAdvice

    2.5 @After

    final增强,不管是抛出异常或者正常退出都会执行

    2.6 @Around

    环绕增强,相当于MethodInterceptor

    2.7 @DeclareParents

    引介增强,相当于IntroductionInterceptor

    3 execution切点函数

     

    execution函数用于匹配方法执行的连接点,语法为:

    execution(方法修饰符(可选)  返回类型  方法名  参数  异常模式(可选)) 

     

    参数部分允许使用通配符:

    *  匹配任意字符,但只能匹配一个元素

    .. 匹配任意字符,可以匹配任意多个元素,表示类时,必须和*联合使用

    +  必须跟在类名后面,如Horseman+,表示类本身和继承或扩展指定类的所有类

     

    示例中的* chop(..)解读为:

    方法修饰符  无

    返回类型      *匹配任意数量字符,表示返回类型不限

    方法名          chop表示匹配名称为chop的方法

    参数               (..)表示匹配任意数量和类型的输入参数

    异常模式       不限

     

    更多示例:

    void chop(String,int)

    匹配目标类任意修饰符方法、返回void、方法名chop、带有一个String和一个int型参数的方法

    public void chop(*)

    匹配目标类public修饰、返回void、方法名chop、带有一个任意类型参数的方法

    public String *o*(..)

     匹配目标类public修饰、返回String类型、方法名中带有一个o字符、带有任意数量任意类型参数的方法

    public void *o*(String,..)

     匹配目标类public修饰、返回void、方法名中带有一个o字符、带有任意数量任意类型参数,但第一个参数必须有且为String型的方法

    也可以指定类:

    public void examples.chap03.Horseman.*(..)

    匹配Horseman的public修饰、返回void、不限方法名、带有任意数量任意类型参数的方法

    public void examples.chap03.*man.*(..)

    匹配以man结尾的类中public修饰、返回void、不限方法名、带有任意数量任意类型参数的方法

    指定包:

    public void examples.chap03.*.chop(..)

    匹配examples.chap03包下所有类中public修饰、返回void、方法名chop、带有任意数量任意类型参数的方法

    public void examples..*.chop(..)

    匹配examples.包下和所有子包中的类中public修饰、返回void、方法名chop、带有任意数量任意类型参数的方法
    可以用这些表达式替换StorageAdvisor中的代码并观察效果

    4 更多切点函数

    除了execution(),Spring中还支持其他多个函数,这里列出名称和简单介绍,以方便根据需要进行更详细的查询

    4.1 @annotation()

    表示标注了指定注解的目标类方法

    例如 @annotation(org.springframework.transaction.annotation.Transactional) 表示标注了@Transactional的方法

    4.2 args()

    通过目标类方法的参数类型指定切点

    例如 args(String) 表示有且仅有一个String型参数的方法

    4.3 @args()

    通过目标类参数的对象类型是否标注了指定注解指定切点

    如 @args(org.springframework.stereotype.Service) 表示有且仅有一个标注了@Service的类参数的方法

    4.4 within()

    通过类名指定切点

    如 with(examples.chap03.Horseman) 表示Horseman的所有方法

    4.5 target()

    通过类名指定,同时包含所有子类

    如 target(examples.chap03.Horseman)  且Elephantman extends Horseman,则两个类的所有方法都匹配

    4.6 @within()

    匹配标注了指定注解的类及其所有子类

    如 @within(org.springframework.stereotype.Service) 给Horseman加上@Service标注,则Horseman和Elephantman 的所有方法都匹配

    4.7 @target()

    所有标注了指定注解的类

    如 @target(org.springframework.stereotype.Service) 表示所有标注了@Service的类的所有方法

    4.8 this()

    大部分时候和target()相同,区别是this是在运行时生成代理类后,才判断代理类与指定的对象类型是否匹配

    5 逻辑运算符

    表达式可由多个切点函数通过逻辑运算组成

    5.1 &&

    与操作,求交集,也可以写成and

    例如 execution(* chop(..)) && target(Horseman)  表示Horseman及其子类的chop方法

    5.2 ||

    或操作,求并集,也可以写成or

    例如 execution(* chop(..)) || args(String)  表示名称为chop的方法或者有一个String型参数的方法

    5.3 !

    非操作,求反集,也可以写成not

    例如 execution(* chop(..)) and !args(String)  表示名称为chop的方法但是不能是只有一个String型参数的方法

    展开全文
  • package com.wow.AopMessage; public interface AopServiceInterface { public String addInfo(int i,int b,int j); }
  • 何为AOP,AOP的注解详解,AOP的使用详例,以上内容尽在本文


    一键三连运势涨,offer飞来落满筐!喜欢本文的朋友,不要吝啬你们的赞。

    1 理解AOP

    1.1 什么是AOP

    AOP(Aspect Oriented Programming),面向切面思想,是Spring的三大核心思想之一(两外两个:IOC-控制反转、DI-依赖注入)。

    那么AOP为何那么重要呢?在我们的程序中,经常存在一些系统性的需求,比如权限校验、日志记录、统计等,这些代码会散落穿插在各个业务逻辑中,非常冗余且不利于维护。例如下面这个示意图:
    在这里插入图片描述
    有多少业务操作,就要写多少重复的校验和日志记录代码,这显然是无法接受的。当然,用面向对象的思想,我们可以把这些重复的代码抽离出来,写成公共方法,就是下面这样:

    在这里插入图片描述
    这样,代码冗余和可维护性的问题得到了解决,但每个业务方法中依然要依次手动调用这些公共方法,也是略显繁琐。有没有更好的方式呢?有的,那就是AOP,AOP将权限校验、日志记录等非业务代码完全提取出来,与业务代码分离,并寻找节点切入业务代码中:

    在这里插入图片描述

    1.2 AOP体系与概念

    简单地去理解,其实AOP要做三类事:

    • 在哪里切入,也就是权限校验等非业务操作在哪些业务代码中执行。
    • 在什么时候切入,是业务代码执行前还是执行后。
    • 切入后做什么事,比如做权限校验、日志记录等。

    因此,AOP的体系可以梳理为下图:
    在这里插入图片描述
    一些概念详解:

    • Pointcut:切点,决定处理如权限校验、日志记录等在何处切入业务代码中(即织入切面)。切点分为execution方式和annotation方式。前者可以用路径表达式指定哪些类织入切面,后者可以指定被哪些注解修饰的代码织入切面。
    • Advice:处理,包括处理时机和处理内容。处理内容就是要做什么事,比如校验权限和记录日志。处理时机就是在什么时机执行处理内容,分为前置处理(即业务代码执行前)、后置处理(业务代码执行后)等。
    • Aspect:切面,即PointcutAdvice
    • Joint point:连接点,是程序执行的一个点。例如,一个方法的执行或者一个异常的处理。在 Spring AOP 中,一个连接点总是代表一个方法执行。
    • Weaving:织入,就是通过动态代理,在目标对象方法中执行处理内容的过程。

    网络上有张图,我觉得非常传神,贴在这里供大家观详:
    在这里插入图片描述

    2 AOP实例

    实践出真知,接下来我们就撸代码来实现一下AOP。完成项目已上传至:GitHub AOP demo项目

    使用 AOP,首先需要引入 AOP 的依赖

    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-aop</artifactId>
    </dependency>
    

    2.1 第一个实例

    接下来,我们先看一个极简的例子:所有的get请求被调用前在控制台输出一句"get请求的advice触发了"。

    具体实现如下:

    1. 创建一个AOP切面类,只要在类上加个 @Aspect 注解即可。@Aspect 注解用来描述一个切面类,定义切面类的时候需要打上这个注解。@Component 注解将该类交给 Spring 来管理。在这个类里实现advice:
    package com.mu.demo.advice;
    
    import org.aspectj.lang.annotation.Aspect;
    import org.aspectj.lang.annotation.Before;
    import org.aspectj.lang.annotation.Pointcut;
    import org.springframework.stereotype.Component;
    
    @Aspect
    @Component
    public class LogAdvice {
        // 定义一个切点:所有被GetMapping注解修饰的方法会织入advice
        @Pointcut("@annotation(org.springframework.web.bind.annotation.GetMapping)")
        private void logAdvicePointcut() {}
    
    	// Before表示logAdvice将在目标方法执行前执行
        @Before("logAdvicePointcut()")
        public void logAdvice(){
        	// 这里只是一个示例,你可以写任何处理逻辑
            System.out.println("get请求的advice触发了");
        }
    }
    
    1. 创建一个接口类,内部创建一个get请求:
    package com.mu.demo.controller;
    
    import com.alibaba.fastjson.JSON;
    import com.alibaba.fastjson.JSONObject;
    import org.springframework.web.bind.annotation.*;
    
    @RestController
    @RequestMapping(value = "/aop")
    public class AopController {
        @GetMapping(value = "/getTest")
        public JSONObject aopTest() {
            return JSON.parseObject("{\"message\":\"SUCCESS\",\"code\":200}");
        }
        
    	@PostMapping(value = "/postTest")
        public JSONObject aopTest2(@RequestParam("id") String id) {
            return JSON.parseObject("{\"message\":\"SUCCESS\",\"code\":200}");
        }
    }
    

    项目启动后,请求http://localhost:8085/aop/getTest接口:
    在这里插入图片描述
    请求http://localhost:8085/aop/postTest接口,控制台无输出,证明切点确实是只针对被GetMapping修饰的方法。

    2.2 第二个实例

    下面我们将问题复杂化一些,该例的场景是:

    1. 自定义一个注解PermissionsAnnotation
    2. 创建一个切面类,切点设置为拦截所有标注PermissionsAnnotation的方法,截取到接口的参数,进行简单的权限校验
    3. PermissionsAnnotation标注在测试接口类的测试接口test

    具体的实现步骤:

    1. 使用@Target、@Retention、@Documented自定义一个注解(关于这三个注解详情请见:元注解详解):
    @Target(ElementType.METHOD)
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    public @interface PermissionAnnotation{
    }
    
    1. 创建第一个AOP切面类,,只要在类上加个 @Aspect 注解即可。@Aspect 注解用来描述一个切面类,定义切面类的时候需要打上这个注解。@Component 注解将该类交给 Spring 来管理。在这个类里实现第一步权限校验逻辑:
    package com.example.demo;
    
    import com.alibaba.fastjson.JSON;
    import com.alibaba.fastjson.JSONObject;
    import org.aspectj.lang.ProceedingJoinPoint;
    import org.aspectj.lang.annotation.Around;
    import org.aspectj.lang.annotation.Aspect;
    import org.aspectj.lang.annotation.Pointcut;
    import org.springframework.core.annotation.Order;
    import org.springframework.stereotype.Component;
    
    @Aspect
    @Component
    @Order(1)
    public class PermissionFirstAdvice {
    
    	// 定义一个切面,括号内写入第1步中自定义注解的路径
        @Pointcut("@annotation(com.mu.demo.annotation.PermissionAnnotation)")
        private void permissionCheck() {
        }
    
        @Around("permissionCheck()")
        public Object permissionCheckFirst(ProceedingJoinPoint joinPoint) throws Throwable {
            System.out.println("===================第一个切面===================:" + System.currentTimeMillis());
    
            //获取请求参数,详见接口类
            Object[] objects = joinPoint.getArgs();
            Long id = ((JSONObject) objects[0]).getLong("id");
            String name = ((JSONObject) objects[0]).getString("name");
            System.out.println("id1->>>>>>>>>>>>>>>>>>>>>>" + id);
            System.out.println("name1->>>>>>>>>>>>>>>>>>>>>>" + name);
    
            // id小于0则抛出非法id的异常
            if (id < 0) {
                return JSON.parseObject("{\"message\":\"illegal id\",\"code\":403}");
            }
            return joinPoint.proceed();
        }
    }
    
    1. 创建接口类,并在目标方法上标注自定义注解 PermissionsAnnotation
    package com.example.demo;
    
    import com.alibaba.fastjson.JSON;
    import com.alibaba.fastjson.JSONObject;
    import org.springframework.web.bind.annotation.*;
    
    @RestController
    @RequestMapping(value = "/permission")
    public class TestController {
        @RequestMapping(value = "/check", method = RequestMethod.POST)
        // 添加这个注解
        @PermissionsAnnotation()
        public JSONObject getGroupList(@RequestBody JSONObject request) {
            return JSON.parseObject("{\"message\":\"SUCCESS\",\"code\":200}");
        }
    }
    

    在这里,我们先进行一个测试。首先,填好请求地址和header:
    在这里插入图片描述
    其次,构造正常的参数:
    在这里插入图片描述
    可以拿到正常的响应结果:
    在这里插入图片描述
    然后,构造一个异常参数,再次请求:
    在这里插入图片描述
    响应结果显示,切面类进行了判断,并返回相应结果:
    在这里插入图片描述
    有人会问,如果我一个接口想设置多个切面类进行校验怎么办?这些切面的执行顺序如何管理

    很简单,一个自定义的AOP注解可以对应多个切面类,这些切面类执行顺序由@Order注解管理,该注解后的数字越小,所在切面类越先执行。

    下面在实例中进行演示:

    创建第二个AOP切面类,在这个类里实现第二步权限校验:

    package com.example.demo;
    
    import com.alibaba.fastjson.JSON;
    import com.alibaba.fastjson.JSONObject;
    import org.aspectj.lang.ProceedingJoinPoint;
    import org.aspectj.lang.annotation.Around;
    import org.aspectj.lang.annotation.Aspect;
    import org.aspectj.lang.annotation.Pointcut;
    import org.springframework.core.annotation.Order;
    import org.springframework.stereotype.Component;
    
    @Aspect
    @Component
    @Order(0)
    public class PermissionSecondAdvice {
    
       @Pointcut("@annotation(com.mu.demo.annotation.PermissionAnnotation)")
       private void permissionCheck() {
       }
    
       @Around("permissionCheck()")
       public Object permissionCheckSecond(ProceedingJoinPoint joinPoint) throws Throwable {
           System.out.println("===================第二个切面===================:" + System.currentTimeMillis());
    
           //获取请求参数,详见接口类
           Object[] objects = joinPoint.getArgs();
           Long id = ((JSONObject) objects[0]).getLong("id");
           String name = ((JSONObject) objects[0]).getString("name");
           System.out.println("id->>>>>>>>>>>>>>>>>>>>>>" + id);
           System.out.println("name->>>>>>>>>>>>>>>>>>>>>>" + name);
    
           // name不是管理员则抛出异常
           if (!name.equals("admin")) {
               return JSON.parseObject("{\"message\":\"not admin\",\"code\":403}");
           }
           return joinPoint.proceed();
       }
    }
    

    重启项目,继续测试,构造两个参数都异常的情况:
    在这里插入图片描述
    响应结果,表面第二个切面类执行顺序更靠前:
    在这里插入图片描述

    3 AOP相关注解

    上面的案例中,用到了诸多注解,下面针对这些注解进行详解。

    3.1 @Pointcut

    @Pointcut 注解,用来定义一个切点,即上文中所关注的某件事情的入口,切入点定义了事件触发时机。

    @Aspect
    @Component
    public class LogAspectHandler {
    
        /**
         * 定义一个切面,拦截 com.mutest.controller 包和子包下的所有方法
         */
        @Pointcut("execution(* com.mutest.controller..*.*(..))")
        public void pointCut() {}
    }
    

    @Pointcut 注解指定一个切点,定义需要拦截的东西,这里介绍两个常用的表达式:一个是使用 execution(),另一个是使用 annotation()

    execution表达式:

    execution(* com.mutest.controller..*.*(..))) 表达式为例:

    • 第一个 * 号的位置:表示返回值类型,* 表示所有类型。
    • 包名:表示需要拦截的包名,后面的两个句点表示当前包和当前包的所有子包,在本例中指 com.mutest.controller包、子包下所有类的方法。
    • 第二个 * 号的位置:表示类名,* 表示所有类。
    • *(..):这个星号表示方法名,* 表示所有的方法,后面括弧里面表示方法的参数,两个句点表示任何参数。

    annotation() 表达式:

    annotation() 方式是针对某个注解来定义切点,比如我们对具有 @PostMapping 注解的方法做切面,可以如下定义切面:

    @Pointcut("@annotation(org.springframework.web.bind.annotation.PostMapping)")
    public void annotationPointcut() {}
    

    然后使用该切面的话,就会切入注解是 @PostMapping 的所有方法。这种方式很适合处理 @GetMapping、@PostMapping、@DeleteMapping不同注解有各种特定处理逻辑的场景。

    还有就是如上面案例所示,针对自定义注解来定义切面。

    @Pointcut("@annotation(com.example.demo.PermissionsAnnotation)")
    private void permissionCheck() {}
    

    3.2 @Around

    @Around注解用于修饰Around增强处理,Around增强处理非常强大,表现在:

    1. @Around可以自由选择增强动作与目标方法的执行顺序,也就是说可以在增强动作前后,甚至过程中执行目标方法。这个特性的实现在于,调用ProceedingJoinPoint参数的procedd()方法才会执行目标方法。
    2. @Around可以改变执行目标方法的参数值,也可以改变执行目标方法之后的返回值。

    Around增强处理有以下特点:

    1. 当定义一个Around增强处理方法时,该方法的第一个形参必须是 ProceedingJoinPoint 类型(至少一个形参)。在增强处理方法体内,调用ProceedingJoinPointproceed方法才会执行目标方法:这就是@Around增强处理可以完全控制目标方法执行时机、如何执行的关键;如果程序没有调用ProceedingJoinPointproceed方法,则目标方法不会执行。
    2. 调用ProceedingJoinPointproceed方法时,还可以传入一个Object[ ]对象,该数组中的值将被传入目标方法作为实参——这就是Around增强处理方法可以改变目标方法参数值的关键。这就是如果传入的Object[ ]数组长度与目标方法所需要的参数个数不相等,或者Object[ ]数组元素与目标方法所需参数的类型不匹配,程序就会出现异常。

    @Around功能虽然强大,但通常需要在线程安全的环境下使用。因此,如果使用普通的BeforeAfterReturning就能解决的问题,就没有必要使用Around了。如果需要目标方法执行之前和之后共享某种状态数据,则应该考虑使用Around。尤其是需要使用增强处理阻止目标的执行,或需要改变目标方法的返回值时,则只能使用Around增强处理了。

    下面,在前面例子上做一些改造,来观察@Around的特点。

    自定义注解类不变。首先,定义接口类:

    package com.example.demo;
    
    import com.alibaba.fastjson.JSON;
    import com.alibaba.fastjson.JSONObject;
    import org.springframework.web.bind.annotation.*;
    
    @RestController
    @RequestMapping(value = "/permission")
    public class TestController {
        @RequestMapping(value = "/check", method = RequestMethod.POST)
        @PermissionsAnnotation()
        public JSONObject getGroupList(@RequestBody JSONObject request) {
            return JSON.parseObject("{\"message\":\"SUCCESS\",\"code\":200,\"data\":" + request + "}");
        }
    }
    

    唯一切面类(前面案例有两个切面类,这里只需保留一个即可):

    package com.example.demo;
    
    import com.alibaba.fastjson.JSONObject;
    import org.aspectj.lang.ProceedingJoinPoint;
    import org.aspectj.lang.annotation.Around;
    import org.aspectj.lang.annotation.Aspect;
    import org.aspectj.lang.annotation.Pointcut;
    import org.springframework.core.annotation.Order;
    import org.springframework.stereotype.Component;
    
    
    @Aspect
    @Component
    @Order(1)
    public class PermissionAdvice {
    
        @Pointcut("@annotation(com.example.demo.PermissionsAnnotation)")
        private void permissionCheck() {
        }
    
    
        @Around("permissionCheck()")
        public Object permissionCheck(ProceedingJoinPoint joinPoint) throws Throwable {
            System.out.println("===================开始增强处理===================");
    
            //获取请求参数,详见接口类
            Object[] objects = joinPoint.getArgs();
            Long id = ((JSONObject) objects[0]).getLong("id");
            String name = ((JSONObject) objects[0]).getString("name");
            System.out.println("id1->>>>>>>>>>>>>>>>>>>>>>" + id);
            System.out.println("name1->>>>>>>>>>>>>>>>>>>>>>" + name);
    
    		// 修改入参
            JSONObject object = new JSONObject();
            object.put("id", 8);
            object.put("name", "lisi");
            objects[0] = object;
    		
    		// 将修改后的参数传入
            return joinPoint.proceed(objects);
        }
    }
    

    同样使用JMeter调用接口,传入参数:{"id":-5,"name":"admin"},响应结果表明:@Around截取到了接口的入参,并使接口返回了切面类中的结果。
    在这里插入图片描述

    3.3 @Before

    @Before 注解指定的方法在切面切入目标方法之前执行,可以做一些 Log 处理,也可以做一些信息的统计,比如获取用户的请求 URL 以及用户的 IP 地址等等,这个在做个人站点的时候都能用得到,都是常用的方法。例如下面代码:

    @Aspect
    @Component
    @Slf4j
    public class LogAspectHandler {
        /**
         * 在上面定义的切面方法之前执行该方法
         * @param joinPoint jointPoint
         */
        @Before("pointCut()")
        public void doBefore(JoinPoint joinPoint) {
            log.info("====doBefore方法进入了====");
    
            // 获取签名
            Signature signature = joinPoint.getSignature();
            // 获取切入的包名
            String declaringTypeName = signature.getDeclaringTypeName();
            // 获取即将执行的方法名
            String funcName = signature.getName();
            log.info("即将执行方法为: {},属于{}包", funcName, declaringTypeName);
    
            // 也可以用来记录一些信息,比如获取请求的 URL 和 IP
            ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
            HttpServletRequest request = attributes.getRequest();
            // 获取请求 URL
            String url = request.getRequestURL().toString();
            // 获取请求 IP
            String ip = request.getRemoteAddr();
            log.info("用户请求的url为:{},ip地址为:{}", url, ip);
        }
    }
    

    JointPoint 对象很有用,可以用它来获取一个签名,利用签名可以获取请求的包名、方法名,包括参数(通过 joinPoint.getArgs() 获取)等。

    3.4 @After

    @After 注解和 @Before 注解相对应,指定的方法在切面切入目标方法之后执行,也可以做一些完成某方法之后的 Log 处理。

    @Aspect
    @Component
    @Slf4j
    public class LogAspectHandler {
        /**
         * 定义一个切面,拦截 com.mutest.controller 包下的所有方法
         */
        @Pointcut("execution(* com.mutest.controller..*.*(..))")
        public void pointCut() {}
    
        /**
         * 在上面定义的切面方法之后执行该方法
         * @param joinPoint jointPoint
         */
        @After("pointCut()")
        public void doAfter(JoinPoint joinPoint) {
    
            log.info("==== doAfter 方法进入了====");
            Signature signature = joinPoint.getSignature();
            String method = signature.getName();
            log.info("方法{}已经执行完", method);
        }
    }
    

    到这里,我们来写个 Controller 测试一下执行结果,新建一个 AopController 如下:

    @RestController
    @RequestMapping("/aop")
    public class AopController {
    
        @GetMapping("/{name}")
        public String testAop(@PathVariable String name) {
            return "Hello " + name;
        }
    }
    

    启动项目,在浏览器中输入:localhost:8080/aop/csdn,观察一下控制台的输出信息:

    ====doBefore 方法进入了====  
    即将执行方法为: testAop,属于com.itcodai.mutest.AopController包  
    用户请求的 url 为:http://localhost:8080/aop/name,ip地址为:0:0:0:0:0:0:0:1  
    ==== doAfter 方法进入了====  
    方法 testAop 已经执行完
    

    从打印出来的 Log 中可以看出程序执行的逻辑与顺序,可以很直观的掌握 @Before@After 两个注解的实际作用。

    3.5 @AfterReturning

    @AfterReturning 注解和 @After 有些类似,区别在于 @AfterReturning 注解可以用来捕获切入方法执行完之后的返回值,对返回值进行业务逻辑上的增强处理,例如:

    @Aspect
    @Component
    @Slf4j
    public class LogAspectHandler {
        /**
         * 在上面定义的切面方法返回后执行该方法,可以捕获返回对象或者对返回对象进行增强
         * @param joinPoint joinPoint
         * @param result result
         */
        @AfterReturning(pointcut = "pointCut()", returning = "result")
        public void doAfterReturning(JoinPoint joinPoint, Object result) {
    
            Signature signature = joinPoint.getSignature();
            String classMethod = signature.getName();
            log.info("方法{}执行完毕,返回参数为:{}", classMethod, result);
            // 实际项目中可以根据业务做具体的返回值增强
            log.info("对返回参数进行业务上的增强:{}", result + "增强版");
        }
    }
    

    需要注意的是,在 @AfterReturning 注解 中,属性 returning 的值必须要和参数保持一致,否则会检测不到。该方法中的第二个入参就是被切方法的返回值,在 doAfterReturning 方法中可以对返回值进行增强,可以根据业务需要做相应的封装。我们重启一下服务,再测试一下:

    方法 testAop 执行完毕,返回参数为:Hello CSDN  
    对返回参数进行业务上的增强:Hello CSDN 增强版
    

    3.6 @AfterThrowing

    当被切方法执行过程中抛出异常时,会进入 @AfterThrowing 注解的方法中执行,在该方法中可以做一些异常的处理逻辑。要注意的是 throwing 属性的值必须要和参数一致,否则会报错。该方法中的第二个入参即为抛出的异常。

    @Aspect
    @Component
    @Slf4j
    public class LogAspectHandler {
        /**
         * 在上面定义的切面方法执行抛异常时,执行该方法
         * @param joinPoint jointPoint
         * @param ex ex
         */
        @AfterThrowing(pointcut = "pointCut()", throwing = "ex")
        public void afterThrowing(JoinPoint joinPoint, Throwable ex) {
            Signature signature = joinPoint.getSignature();
            String method = signature.getName();
            // 处理异常的逻辑
            log.info("执行方法{}出错,异常为:{}", method, ex);
        }
    }
    

    完整的项目已上传至Gtihub:https://github.com/ThinkMugz/aopDemo,觉得有帮助的顺手点个赞给个star,听说这么做的人2021年都升职加薪了!

    以上就是AOP的全部内容。通过几个例子就可以感受到,AOP的便捷之处。欢迎大家指出文中不足之处,喜欢的朋友来个一键三连,听说这么做的人offer拿到手软( •̀ ω •́ )y

    展开全文
  • 传送门:使用切面注解编程实现redis模糊删除数据之一之前虽然用切面编程实现了redis的模糊查询,但是却没有实现像spring-redis原生的语法一样的spEl表达式,比如#参数名这种形式,然后在网上找了一些资料,实现了和...

    传送门:使用切面注解编程实现redis模糊删除数据之一

    之前虽然用切面编程实现了redis的模糊查询,但是却没有实现像spring-redis原生的语法一样的spEl表达式,比如#参数名这种形式,然后在网上找了一些资料,实现了和spring-redis一样的spEl表达,可以使用#参数名或者#p0这样的方式,下面是代码

    import java.lang.reflect.Method;
    import java.util.ArrayList;
    import java.util.List;
    import java.util.Set;
    import java.util.regex.Matcher;
    import java.util.regex.Pattern;
    
    import javax.annotation.Resource;
    
    import org.aspectj.lang.JoinPoint;
    import org.aspectj.lang.annotation.AfterReturning;
    import org.aspectj.lang.annotation.Aspect;
    import org.aspectj.lang.annotation.Pointcut;
    import org.aspectj.lang.reflect.MethodSignature;
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.core.LocalVariableTableParameterNameDiscoverer;
    import org.springframework.data.redis.core.RedisTemplate;
    import org.springframework.expression.ExpressionParser;
    import org.springframework.expression.spel.standard.SpelExpressionParser;
    import org.springframework.expression.spel.support.StandardEvaluationContext;
    import org.springframework.stereotype.Component;
    
    import com.kq.highnet2.framework.base.common.annotation.CacheRemove;
    
    @Aspect
    @Component
    public class CacheRemoveAspect {
        Logger logger=LoggerFactory.getLogger(this.getClass());
    	@Resource(name = "redisTemplate") 
    	RedisTemplate<String, String> redis;
    	@Pointcut(value = "(execution(* *.*(..)) && "//截获标有@CacheRemove的方法
    			+ "@annotation(com.kq.highnet2.framework.base.common.annotation.CacheRemove))")
        private void pointcut() {}
    	@AfterReturning(value = "pointcut()")//切面在方法返回值之后
    	private void process(JoinPoint joinPoint){
    	    MethodSignature signature = (MethodSignature) joinPoint.getSignature();
    	    Object[] args = joinPoint.getArgs();//切面方法的参数
    	    Method method = signature.getMethod();//切面方法
    	    CacheRemove cacheRemove = method.getAnnotation(CacheRemove.class);//获得注解
    	    if (cacheRemove != null){
    	        String value = cacheRemove.value();//暂时没用
    	        String[] keys = cacheRemove.key(); //需要移除的正则key
    	        for(String key:keys) {
    	        	logger.info(key);
    	        	key = parseKey(key, method, args);
    	        	Set<String> keys2 = redis.keys(key);//获得redis中符合正则的缓存
    	        	redis.delete(keys2);//删除缓存
    	        	logger.info("删除缓存:"+key);
    	        }
    	        
    	    }
    	}
        /** 
         *    获取缓存的key  
         *    key 定义在注解上,支持SPEL表达式 
         * @param pjp 
         * @return 
         */  
        private String parseKey(String key,Method method,Object [] args){           
            //获取被拦截方法参数名列表(使用Spring支持类库)  
            LocalVariableTableParameterNameDiscoverer u =     
                new LocalVariableTableParameterNameDiscoverer();    
            String [] paraNameArr=u.getParameterNames(method);  
              
            //使用SPEL进行key的解析  
            ExpressionParser parser = new SpelExpressionParser();   
            //SPEL上下文  
            StandardEvaluationContext context = new StandardEvaluationContext();  
            //把方法参数放入SPEL上下文中  
            for(int i=0;i<paraNameArr.length;i++){  
                context.setVariable(paraNameArr[i], args[i]);  
            } 
            List<String> pList = descFormat(key);//获取#p0这样的表达式
            //将p0作为参数放入SPEL上下文中
            for(String p:pList) {
            	context.setVariable(p.substring(1), args[Integer.valueOf(p.substring(2))]);
            }
            return parser.parseExpression(key).getValue(context,String.class);  
        } 
        /**
         * 提取出#p[数字]这样的表达式
         * @param desc
         * @return
         */
        private static List<String> descFormat(String desc){  
            List<String> list = new ArrayList<>();  
            Pattern pattern = Pattern.compile("#p[0-9]+");   
            Matcher matcher = pattern.matcher(desc);   
            while(matcher.find()){   
                String t = matcher.group(0);   
                list.add(t);  
            }  
            return list;  
        }
    }
    这样就可以和原来@Cacheable等注解上的用法一样了
    	@Caching(evict= {
    		@CacheEvict(value="baseModulePermissionList",key="'baseModulePermissionList'+#userId"),
    	})
    	@CacheRemove(value="deletePermission",key = {"'baseButtonPermissionList'+#p0+'*'","'baseViewPermissionList'+#userId+'*'"})
    	public void evictPermission(String userId) {
    	}

    亲测可以使用

    展开全文
  • Spring切面实现自定义注解

    千次阅读 2019-06-06 11:23:16
    1.首先写出一个自定义注解。 package com.salong.aspect.test; import java.lang.annotation.*; @Target(ElementType.METHOD) @Documented @Retention(RetentionPolicy.RUNTIME) public @interface Login { ...
  • 什么是基于注解切面实现

    千次阅读 2017-12-05 19:51:06
    什么是基于注解切面实现我们使用切面来非侵入式操作程序方法,常用的场景如日志记录、权限判断等。 下面我实现权限判断的切面。分析: 要实现基于注解切面,我们要定义“注解”,定义切面,定义权限验证,定义...
  • JAVA实现简单的切面注解

    万次阅读 2019-08-22 00:31:07
    背景 今天在分析同事遇到一个springboot的注解和方法锁一起用而导致的问题(@...本文介绍java中其中一种(InvocationHandler)利用动态代理的方式实现的代理的方法,从而类似的机制我们推测出spring的切面...
  • Spring 注解 实现 AOP (切面编程) 实现功能:AOP实现模拟日志 实体类 package top.vkiss.springaop.domain; public class User { private String name; public String getName() { return name; } ...
  • spring AOP切面,注解实现,获取参数

    万次阅读 2017-04-09 04:55:49
    Spring的AOP有两种实现方式,一是通过xml配置,二是通过注解,为减少代码量提高可读性跟代码入侵本,若项目使用了spring的框架,本人首选的都是用注解去开发,方法很简单,只需要三步就可以搞定切面 一:在xml文件中开始...
  • 在面向切面编程时,当需要在任何需要切入的地方实现切面编程时,可以用基于自定义注解的方式实现切面编程,即在需要切入的地方加上自定义注解就可以了。@Aspect注解需要引入aspectjrt.jar和aspectjweaver.jar包。1、...
  • 三、切入AOP流程实现切面逻辑 1.Advice切面处理类 2.Pointcut切面切入点 3.Advisor类 4.Advisor可插拔式通过@Bean注入到Spring工厂 4.1 可插拔式配置类 4.2 可插拔式注解开关 4.3 注入到Spring工厂的实现原理...
  • AOP切面实现

    2019-07-25 16:27:08
    AOP切面的实现 AOP的全称是Aspect Orient Programming,即面向切面编程。是对OOP(Object Orient Programming)的一种补充,战门用于处理一些具有横切性质的服务。常常用于日志输出、...第一步:添加切面注解@Asp...
  • 平时我们在开发过程中,代码出现bug时为了更好的在服务器日志中...实现AOP切面日志一般有两种方式: 拦截所有接口controller,在首尾打印日志 拦截指定注解的接口,为有该注解的接口首尾打印日志 我们尝试用自定义...
  • springboot使用自定义注解实现灵活切面添加依赖添加模块 现在springboot项目使用的大多是自定义注解实现切面,现在就来做一个小demo 添加依赖 <dependency> <groupId>org.springframework.boot</...
  •  最近在做数据权限方面的东西,考虑使用切面对用户访问进行拦截,进而确认用户是否对当前数据有访问权限,而我们的项目是springboot项目,所以花时间研究了下springboot下切面实现。  1、首先加入相关maven依赖...
  • 自定义注解的方式实现自定义切面类 参考 参考文献: 源代码及文章:https://www.cnblogs.com/hhhshct/p/8428045.html 自定义注解参考文章:...
  • 手写Spring注解实现Spring AOP切面动态拦截 1.新建注解类命名为PointCutAddress package com.map.common.annotation; import java.lang.annotation.*; @Target(ElementType.METHOD) @Retention(RetentionPolicy....
  • java通过自定义注解实现切面记录操作日志自定义注解java.lang.annotation为开发者提供的元注解日志自定义注解实例日志切面实现在业务逻辑中使用自定义注解记录操作日志 自定义注解 java.lang.annotation为开发者提供...

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 67,595
精华内容 27,038
关键字:

切面注解怎么实现