7. Spring Boot 中使用切片

AOP为Aspect Oriented Programming的缩写,意为:面向切面编程,通过预编译方式和运行期动态代理实现程序功能的统一维护的一种技术。AOP是Spring框架中的一个重要内容,它通过对既有程序定义一个切入点,然后在其前后切入不同的执行内容,比如常见的有:打开数据库连接/关闭数据库连接、打开事务/关闭事务、记录日志等。基于AOP不会破坏原来程序逻辑,因此它可以很好的对业务逻辑的各个部分进行隔离,从而使得业务逻辑各部分之间的耦合度降低,提高程序的可重用性,同时提高了开发的效率。

下面主要讲两个内容,一个是如何在Spring Boot中引入Aop功能,二是如何使用Aop做切面去统一处理Web请求的日志。

1. 添加依赖

在spring boot中通过其starter可以方便的引入aop的依赖,如下实例:

<!--添加切片AOP依赖-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
        </dependency>

2. 创建切面Component类

创建一个基本的日志切面类,需要包含以下的要点:

  1. 添加@Aspect注解,声明是切片
  2. 添加@Component注解,将其作为一个元素注入进去
  3. 使用@Pointcut定义一个切入点,可以是一个规则表达式,比如下例中某个package下的所有函数
  4. 根据需要在需要切片的地方切入内容
  • 使用@Before在切入点开始处切入内容
  • 使用@After在切入点结尾处切入内容
  • 使用@AfterReturning在切入点return内容之后切入内容(可以用来对处理返回值做一些加工处理)
  • 使用@Around在切入点前后切入内容,并自己控制何时执行切入点自身的内容
  • 使用@AfterThrowing用来处理当切入内容部分抛出异常之后的处理逻辑

下面是一个标准的实例:

@Aspect
@Component
public class WebLogAspect {

    private Logger logger = Logger.getLogger(getClass());

    @Pointcut("execution(public * com.didispace.web..*.*(..))")
    public void webLog(){}

    @Before("webLog()")
    public void doBefore(JoinPoint joinPoint) throws Throwable {
        // 接收到请求,记录请求内容
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();

        // 记录下请求内容
        logger.info("URL : " + request.getRequestURL().toString());
        logger.info("HTTP_METHOD : " + 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 = "ret", pointcut = "webLog()")
    public void doAfterReturning(Object ret) throws Throwable {
        // 处理完请求,返回内容
        logger.info("RESPONSE : " + ret);
    }

}

可以看上面的例子,通过@Pointcut定义的切入点为com.didispace.web包下的所有函数(对web层所有请求处理做切入点),然后通过@Before实现,对请求内容的日志记录(本文只是说明过程,可以根据需要调整内容),最后通过@AfterReturning记录请求返回的对象。

通过运行程序并访问:http://localhost:8080/hello?name=didi,可以获得下面的日志输出

2016-05-19 13:42:13,156  INFO WebLogAspect:41 - URL : http://localhost:8080/hello
2016-05-19 13:42:13,156  INFO WebLogAspect:42 - HTTP_METHOD : http://localhost:8080/hello
2016-05-19 13:42:13,157  INFO WebLogAspect:43 - IP : 0:0:0:0:0:0:0:1
2016-05-19 13:42:13,160  INFO WebLogAspect:44 - CLASS_METHOD : com.didispace.web.HelloController.hello
2016-05-19 13:42:13,160  INFO WebLogAspect:45 - ARGS : [didi]
2016-05-19 13:42:13,170  INFO WebLogAspect:52 - RESPONSE:Hello didi

声明
部分内容来自互联网,参考文档

  1. http://blog.didispace.com/springbootaoplog/

扩展:@PointCut详解

1. 匹配包/类型_ within()

  1. 匹配 ProductService 类里头的所有方法
@Pointcut("within(com.zhb.service.ProductService)")
  1. 匹配 com.zhb 包及子包下所有类的方法
@Pointcut("within(com.zhb..*)")

2. 匹配对象

  1. 匹配AOP对象的目标对象为指定类型的方法,即 LogService 的 AOP 代理对象的方法
@Pointcut("this(com.zhb.log.Loggable)")
  1. 匹配实现Loggable接口的目标对象(而不是 AOP 代理后的对象)的方法
@Pointcut("target(com.zhb.log.Loggable)")
  • this 可以拦截 DeclareParents(Introduction)
  • target 不拦截 DeclareParents(Introduction)
  1. 匹配所有以Service结尾的bean里头的方法
@Pointcut("bean(*Service)")

3. 匹配参数 args()

  1. 匹配任何以 find 开头而且只有一个Long 参数的方法
@Pointcut("execution(* ..find(Long))")
  1. 匹配任何以 find 开头的而且第一个参数Long型的方法
@Pointcut("execution(* ..find(Long,..))")
  1. 匹配任何只有一个Long参数的方法
@Pointcut("within(com.zhb..*) && args(Long)")
  1. 匹配第一个参数为Long型的方法
@Pointcut("within(com.zhb..*) && args(Long,..)")

4. 匹配注解

  1. 匹配方法标注有AdminOnly的注解的方法
@Pointcut("@annotation(com.zhb.anno.AdminOnly) && within(com.zhb..*)")
  1. 匹配标注有NeedSecured的类底下的方法 //class级别
@Pointcut("@within(com.zhb.anno.NeedSecured) && within(com.zhb..*)")
  1. 匹配标注有NeedSecured的类及其子类的方法 //runtime级别

在spring context的环境下,二者没有区别

@Pointcut("@target(com.zhb.anno.NeedSecured) && within(com.zhb..*)")
  1. 匹配传入的参数类标注有Repository注解的方法
@Pointcut("@args(com.zhb.anno.NeedSecured) && within(com.zhb..*)")

5. 匹配方法

  1. 匹配任何公共方法
@Pointcut("execution(public * com.zhb.service..(..))")
  1. 匹配com.zhb包及子包下Service类中无参方法
@Pointcut("execution(* com.zhb..Service.())")
  1. 匹配com.zhb包及子包下Service类中的任何只有一个参数的方法
@Pointcut("execution(* com.zhb..Service.(*))")
  1. 匹配com.zhb包及子包下任何类的任何方法
@Pointcut("execution(* com.zhb...(..))")
  1. 匹配com.zhb包及子包下返回值为String的任何方法
@Pointcut("execution(String com.zhb...(..))")

6. 匹配异常

execution(public * com.zhb.service..(..) throws java.lang.IllegalAccessException)
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,053评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,527评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,779评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,685评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,699评论 5 366
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,609评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,989评论 3 396
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,654评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,890评论 1 298
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,634评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,716评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,394评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,976评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,950评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,191评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,849评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,458评论 2 342

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,593评论 18 139
  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 46,732评论 6 342
  • 什么是Spring Spring是一个开源的Java EE开发框架。Spring框架的核心功能可以应用在任何Jav...
    jemmm阅读 16,438评论 1 133
  • logImpl 置顶log实现组件,可选值SLF4J、LOG4J、LOG4J2、JDK_LOGGING、COMMO...
    一路摇到顶阅读 2,036评论 0 0
  • 终于看完罗新璋译本,又是一顿唏嘘,看来看去,感觉美和圆满总是相克的,肉身总想追求圆满,灵魂却总是倾向超脱,多么讽刺...
    沐一林阅读 310评论 0 0