Spring Boot實(shí)際應(yīng)用講解(五):AOP之請(qǐng)求日志

文/ZYRzyr
原文鏈接:http://www.reibang.com/p/93216bf41182

本文提綱
一邑雅、AOP超簡介紹
二定躏、實(shí)例
三痒留、最后

本文運(yùn)行環(huán)境

Ubuntu 16.04 LTS
JDK 8 +
IntelliJ IDEA ULTIMATE 2017.2
Maven 3.5.0
Spring Boot 1.5.8.RELEASE

一贯涎、AOP超簡介紹

首先強(qiáng)調(diào)听哭,AOP并不僅僅是在Java中才有的。

網(wǎng)上有很多對(duì)AOP的詳細(xì)介紹塘雳,也有很多講的很好的陆盘,這里就不再贅述。一句話描述就是:每當(dāng)調(diào)用某些方法的過程中败明,都想做同樣的事A隘马,用一種盡量不重復(fù)代碼的方式把A插入到這些方法中,這就是AOP妻顶,其中被插入的方法的某個(gè)過程(方法執(zhí)行前酸员、執(zhí)行后、返回值時(shí)讳嘱、拋出異常時(shí)等)即為切點(diǎn)幔嗦。

AOP最大的好處就在于:不用修改已有的代碼,即每個(gè)想做A的方法都單獨(dú)把A寫進(jìn)去呢燥,同時(shí)減少了代碼的重復(fù)崭添,降低了與業(yè)務(wù)邏輯無關(guān)的代碼的耦合。

二叛氨、實(shí)例

本文就以在控制臺(tái)輸出每個(gè)客戶端請(qǐng)求的詳細(xì)信息為例展示AOP的便利之處呼渣。

2.1 添加依賴

要使用AOP,需要在pom.xml中添加如下依賴:

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

2.2 橫切類

新建類HttpAspect.java

package com.zyr.demo.aspect;

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.AfterReturning;
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.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import javax.servlet.http.HttpServletRequest;

@Aspect
@Component
public class HttpAspect {

    private static final Logger logger = LoggerFactory.getLogger(HttpAspect.class);

    @Pointcut("execution(public * com.zyr.demo.controller..*.*(..))")
    public void logRequest() {
        //no-op
    }

    @Before("logRequest()")
    public void doBefore(JoinPoint joinPoint) {
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();

        logger.info("-------------------------------Request Log Begin----------------------------------------------");
        logger.info("url={}", request.getRequestURL());
        logger.info("method={}", request.getMethod());
        logger.info("ip={}", request.getRemoteAddr());
        logger.info("class_method={}", joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName());
        logger.info("args={}", joinPoint.getArgs());
        logger.info("-------------------------------Request Log End------------------------------------------------");
    }

    @AfterReturning(returning = "object", pointcut = "logRequest()")
    public void doAfterReturning(Object object) {
        if (object != null) {
            logger.info("response={}", object.toString());
        }
    }
}
  1. @Aspect:表示該類是一個(gè)橫切類寞埠;

  2. @Component:表示將該類放入Spring容器中屁置;

  3. @Pointcut:表示切入的地方,括號(hào)內(nèi)execution的括號(hào)中表示com.zyr.demo.controller包中的所有public方法仁连;

  4. logRequest():由@Pointcut表示該方法即為上文提到的事A蓝角,方法名自定義,方法體內(nèi)為空饭冬,表示該方法單純指定切入點(diǎn)使鹅,具體內(nèi)容在引用它的地方寫,如下面的doBeforedoAfterReturning昌抠;

  5. @Before:括號(hào)中引用了上面的logRequest()患朱,表示該方法的切入點(diǎn)與它相同,@Before表示在被切入的方法開始執(zhí)行前炊苫,需要先執(zhí)行該方法體內(nèi)的代碼裁厅,此處即為打印請(qǐng)求信息冰沙,方法名自定義;

  6. @AfterReturning:括號(hào)中的object必須與方法的參數(shù)名相同执虹,表示被切入的方法的返回值拓挥。pointcut即同上,表示切入點(diǎn)與logRequest()的切入點(diǎn)相同袋励,@AfterReturning表示在被切入的方法返回值時(shí)侥啤,執(zhí)行該方法中的內(nèi)容;

  7. 除了@Before@AfterReturning插龄,還有@After愿棋、AfterThrowing科展、@Around`等切入方式均牢。

2.3 測試

運(yùn)行項(xiàng)目,打開REST Client才睹,測試上一節(jié)中的localhost:8080/user/register徘跪,提交成功后,可以看到控制臺(tái)輸出以下信息琅攘,說明切入成功垮庐,相應(yīng)的可以測試其它方法:

2017-11-22 16:46:23.591 INFO 10526 --- [nio-8080-exec-1] com.zyr.demo.aspect.HttpAspect : -------------------------------Request Log Begin----------------------------------------------
2017-11-22 16:46:23.591 INFO 10526 --- [nio-8080-exec-1] com.zyr.demo.aspect.HttpAspect : url=http://localhost:8080/user/register
2017-11-22 16:46:23.592 INFO 10526 --- [nio-8080-exec-1] com.zyr.demo.aspect.HttpAspect : method=POST
2017-11-22 16:46:23.592 INFO 10526 --- [nio-8080-exec-1] com.zyr.demo.aspect.HttpAspect : ip=127.0.0.1
2017-11-22 16:46:23.592 INFO 10526 --- [nio-8080-exec-1] com.zyr.demo.aspect.HttpAspect : class_method=com.zyr.demo.controller.UserController.register
2017-11-22 16:46:23.592 INFO 10526 --- [nio-8080-exec-1] com.zyr.demo.aspect.HttpAspect : args=User{name='bob', age=22, password='123456'}
2017-11-22 16:46:23.592 INFO 10526 --- [nio-8080-exec-1] com.zyr.demo.aspect.HttpAspect : -------------------------------Request Log End------------------------------------------------
2017-11-22 16:46:23.595 INFO 10526 --- [nio-8080-exec-1] com.zyr.demo.aspect.HttpAspect : response=<200 OK,success,{}>

三、最后

本文介紹了Spring Boot中使用AOP的一個(gè)簡單例子坞琴,可以看見哨查,在Spring Boot中很輕松就能使用AOP

本文代碼已上傳至我的GitHub倉庫剧辐,進(jìn)入以后將branches切換為5-AOP即可看見寒亥。

前篇:
Spring Boot實(shí)際應(yīng)用講解(一):Hello World
Spring Boot實(shí)際應(yīng)用講解(二):配置詳解
Spring Boot實(shí)際應(yīng)用講解(三):表單驗(yàn)證
Spring Boot實(shí)際應(yīng)用講解(四):RESTful API

后續(xù)將推出以下文章,敬請(qǐng)關(guān)注荧关!

Spring Boot實(shí)際應(yīng)用講解(六):MySQL + Spring-data-jpa(Hibernate)
Spring Boot實(shí)際應(yīng)用講解(七):統(tǒng)一異常處理
Spring Boot實(shí)際應(yīng)用講解(八):MySQL + Mybatis
Spring Boot實(shí)際應(yīng)用講解(九):MySQL + Mybatis + Redis

文中若有錯(cuò)之處溉奕,還請(qǐng)各位批評(píng)指正,謝謝忍啤!

原文作者/ZYRzyr
原文鏈接:http://www.reibang.com/p/93216bf41182

請(qǐng)進(jìn)入這里獲取授權(quán):https://101709080007647.bqy.mobi

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末加勤,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子同波,更是在濱河造成了極大的恐慌鳄梅,老刑警劉巖,帶你破解...
    沈念sama閱讀 206,968評(píng)論 6 482
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件未檩,死亡現(xiàn)場離奇詭異戴尸,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)讹挎,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,601評(píng)論 2 382
  • 文/潘曉璐 我一進(jìn)店門校赤,熙熙樓的掌柜王于貴愁眉苦臉地迎上來吆玖,“玉大人,你說我怎么就攤上這事马篮≌闯耍” “怎么了?”我有些...
    開封第一講書人閱讀 153,220評(píng)論 0 344
  • 文/不壞的土叔 我叫張陵浑测,是天一觀的道長翅阵。 經(jīng)常有香客問我,道長迁央,這世上最難降的妖魔是什么掷匠? 我笑而不...
    開封第一講書人閱讀 55,416評(píng)論 1 279
  • 正文 為了忘掉前任,我火速辦了婚禮岖圈,結(jié)果婚禮上讹语,老公的妹妹穿的比我還像新娘。我一直安慰自己蜂科,他們只是感情好顽决,可當(dāng)我...
    茶點(diǎn)故事閱讀 64,425評(píng)論 5 374
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著导匣,像睡著了一般才菠。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上贡定,一...
    開封第一講書人閱讀 49,144評(píng)論 1 285
  • 那天赋访,我揣著相機(jī)與錄音,去河邊找鬼缓待。 笑死蚓耽,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的命斧。 我是一名探鬼主播田晚,決...
    沈念sama閱讀 38,432評(píng)論 3 401
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼国葬!你這毒婦竟也來了贤徒?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 37,088評(píng)論 0 261
  • 序言:老撾萬榮一對(duì)情侶失蹤汇四,失蹤者是張志新(化名)和其女友劉穎接奈,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體通孽,經(jīng)...
    沈念sama閱讀 43,586評(píng)論 1 300
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡序宦,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,028評(píng)論 2 325
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了背苦。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片互捌。...
    茶點(diǎn)故事閱讀 38,137評(píng)論 1 334
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡潘明,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出秕噪,到底是詐尸還是另有隱情钳降,我是刑警寧澤,帶...
    沈念sama閱讀 33,783評(píng)論 4 324
  • 正文 年R本政府宣布腌巾,位于F島的核電站遂填,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏澈蝙。R本人自食惡果不足惜吓坚,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,343評(píng)論 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望灯荧。 院中可真熱鬧礁击,春花似錦、人聲如沸漏麦。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,333評(píng)論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽撕贞。三九已至,卻和暖如春测垛,著一層夾襖步出監(jiān)牢的瞬間捏膨,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,559評(píng)論 1 262
  • 我被黑心中介騙來泰國打工食侮, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留号涯,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 45,595評(píng)論 2 355
  • 正文 我出身青樓锯七,卻偏偏與公主長得像链快,于是被迫代替她去往敵國和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子眉尸,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 42,901評(píng)論 2 345