快捷導(dǎo)航

詳解使用Spring Boot的AOP處理自定義注解

更新時(shí)間：2018年01月12日 10:00:02 作者：crane-yuan

本篇文章主要介紹了詳解使用Spring Boot的AOP處理自定義注解，小編覺得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過來看看吧

上一篇文章Java 注解介紹講解了下Java注解的基本使用方式，并且通過自定義注解實(shí)現(xiàn)了一個(gè)簡(jiǎn)單的測(cè)試工具；本篇文章將介紹如何使用Spring Boot的AOP來簡(jiǎn)化處理自定義注解，并將通過實(shí)現(xiàn)一個(gè)簡(jiǎn)單的方法執(zhí)行時(shí)間統(tǒng)計(jì)工具為樣例來講解這些內(nèi)容。

AOP概念

面向側(cè)面的程序設(shè)計(jì)（aspect-oriented programming，AOP，又譯作面向方面的程序設(shè)計(jì)、觀點(diǎn)導(dǎo)向編程、剖面導(dǎo)向程序設(shè)計(jì)）是計(jì)算機(jī)科學(xué)中的一個(gè)術(shù)語，指一種程序設(shè)計(jì)范型。該范型以一種稱為側(cè)面（aspect，又譯作方面）的語言構(gòu)造為基礎(chǔ)，側(cè)面是一種新的模塊化機(jī)制，用來描述分散在對(duì)象、類或函數(shù)中的橫切關(guān)注點(diǎn)（crosscutting concern）。

側(cè)面的概念源于對(duì)面向?qū)ο蟮某绦蛟O(shè)計(jì)的改進(jìn)，但并不只限于此，它還可以用來改進(jìn)傳統(tǒng)的函數(shù)。與側(cè)面相關(guān)的編程概念還包括元對(duì)象協(xié)議、主題（subject）、混入（mixin）和委托。

注釋：以上定義源自中文維基百科（如果訪問不了，可以通過修改系統(tǒng)的hosts文件訪問， 198.35.26.96 zh.wikipedia.org #中文維基百科，只能幫到這了，如果還是上不了，那就麻煩上網(wǎng)搜索下怎么修改系統(tǒng)的hosts文件，不同系統(tǒng)下hosts文件位置不一樣，如果是Linux或者M(jìn)ac系統(tǒng)，我就直接告訴你吧，一般文件路徑是 /etc/hosts ），AOP這個(gè)詞的翻譯有點(diǎn)和國(guó)內(nèi)主流叫法不一致，國(guó)內(nèi)主流都把AOP譯做「面向切面編程」，大家不要拘泥于叫法，知道指的是同一個(gè)東西即可。

估計(jì)，你看了這個(gè)定義也是懵的，如果想深入了解可以去知乎看看大佬們是如何掰扯的什么是面向切面編程AOP？。我這邊還是就直接上例子了吧。

Spring Boot的AOP環(huán)境準(zhǔn)備

在 pom.xml 中引入相應(yīng)的依賴模塊

<!-- Spring Boot依賴包 -->
<parent>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-parent</artifactId>
  <version>1.5.1.RELEASE</version>
</parent>
<dependencies>
  <!-- AOP依賴模塊 -->
  <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
  </dependency>
  <!-- Web依賴模塊 -->
  <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
  </dependency>
</dependencies>

先實(shí)現(xiàn)一個(gè)簡(jiǎn)單的Web請(qǐng)求處理

一個(gè)簡(jiǎn)單的處理Web請(qǐng)求的Controller。

package com.craneyuan.controller;

import com.craneyuan.service.IHelloWorldService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloWorldController {
  @Autowired
  private IHelloWorldService helloWorldService;

  @RequestMapping(value = "/hello", method = RequestMethod.GET)
  public String hello(String name) {
    return helloWorldService.getHelloMessage(name);
  }
}

一個(gè)簡(jiǎn)單的HelloWorld服務(wù)實(shí)現(xiàn)類，接口的定義我就不展示代碼了。

package com.craneyuan.service.impl;

import com.craneyuan.annotation.AnalysisActuator;
import com.craneyuan.service.IHelloWorldService;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Service;

import java.util.Optional;

@Service
public class HelloWorldServiceImpl implements IHelloWorldService {

  public String getHelloMessage(String name) {
    return "Hello " + Optional.ofNullable(name).orElse("World!");
  }

}

這樣一個(gè)簡(jiǎn)單的Web服務(wù)就弄好了，你可以啟動(dòng)項(xiàng)目用 curl 命令調(diào)用試下，例如： curl -XGET -i "http://127.0.0.1:8080/hello?name=Java" ，如果一切順利的話，你將會(huì)得到類似下面這樣的響應(yīng)：

HTTP/1.1 200
Content-Type: text/plain;charset=UTF-8
Content-Length: 11
Date: Thu, 11 Jan 2018 09:45:38 GMT

Hello Java

使用自定義注解來統(tǒng)計(jì)方法的執(zhí)行時(shí)間

先定義一個(gè)用來統(tǒng)計(jì)方法執(zhí)行時(shí)間的注解。

package com.craneyuan.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface AnalysisActuator {
  String note() default "";
}

然后定義一個(gè)切面，來處理剛剛定義的注解。

package com.craneyuan.aspect;

import com.craneyuan.annotation.AnalysisActuator;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.After;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;

@Aspect
@Component
public class AnalysisActuatorAspect {
  final static Logger log = LoggerFactory.getLogger(AnalysisActuatorAspect.class);

  ThreadLocal<Long> beginTime = new ThreadLocal<>();

  @Pointcut("@annotation(analysisActuator)")
  public void serviceStatistics(AnalysisActuator analysisActuator) {
  }

  @Before("serviceStatistics(analysisActuator)")
  public void doBefore(JoinPoint joinPoint, AnalysisActuator analysisActuator) {
    // 記錄請(qǐng)求到達(dá)時(shí)間
    beginTime.set(System.currentTimeMillis());
    log.info("cy666 note:{}", analysisActuator.note());
  }

  @After("serviceStatistics(analysisActuator)")
  public void doAfter(AnalysisActuator analysisActuator) {
    log.info("cy666 statistic time:{}, note:{}", System.currentTimeMillis() - beginTime.get(), analysisActuator.note());
  }

}

最后，只要在需要統(tǒng)計(jì)執(zhí)行時(shí)間的方法上加上 @AnalysisActuator 注解就行了。

package com.craneyuan.service.impl;

import com.craneyuan.annotation.AnalysisActuator;
import com.craneyuan.service.IHelloWorldService;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Service;

import java.util.Optional;

@Service
public class HelloWorldServiceImpl implements IHelloWorldService {

  @AnalysisActuator(note = "獲取聊天信息方法")
  public String getHelloMessage(String name) {
    return "Hello " + Optional.ofNullable(name).orElse("World!");
  }

}

啟動(dòng)項(xiàng)目，用 curl 命令隨便調(diào)用一下，如果順利的話就可以觀察到切面打印的日志了。

...
cy666 statistic time:4, note:獲取聊天信息方法

以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章:

欧美bbbwbbbw肥妇,免费乱码人妻系列日韩,一级黄片

詳解使用Spring Boot的AOP處理自定義注解

相關(guān)文章

最新評(píng)論

大家感興趣的內(nèi)容

最近更新的內(nèi)容

常用在線小工具