SpringBoot入門建站全系列（三十六）AspectJ做AOP日志管理

一、概述

Spring的兩大特性，AOP和IOC，AOP面向切面編程，可以對當(dāng)前代碼無侵入的情況下，使用AspectJ對切點(diǎn)數(shù)據(jù)進(jìn)行分析存儲(chǔ)。常常被用來做日志/流水的存儲(chǔ)記錄。

本篇對如何使用spring-boot-starter-aop做簡要說明，并補(bǔ)充常用的表達(dá)式。

首發(fā)地址：SpringBoot入門建站全系列（三十六）AspectJ做AOP日志管理）

如果大家正在尋找一個(gè)java的學(xué)習(xí)環(huán)境，或者在開發(fā)中遇到困難，可以加入我們的java學(xué)習(xí)圈，點(diǎn)擊即可加入，共同學(xué)習(xí)，節(jié)約學(xué)習(xí)時(shí)間，減少很多在學(xué)習(xí)中遇到的難題。

二、配置

本文假設(shè)你已經(jīng)引入spring-boot-starter-web。已經(jīng)是個(gè)SpringBoot項(xiàng)目了,如果不會(huì)搭建，可以打開這篇文章看一看《SpringBoot入門建站全系列（一）項(xiàng)目建立》。

2.1 Maven依賴

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

引入spring-boot-starter-aop即可，不需要額外引入其他jar包。

2.2 配置文件

無需額外的配置。

三、SpringBoot應(yīng)用

3.1 Service層（被切面的業(yè)務(wù)邏輯層）

這里簡單寫一個(gè)業(yè)務(wù)邏輯，內(nèi)容不是重點(diǎn)，重點(diǎn)是怎么切面。

BusinessService：

package com.cff.springbootwork.aspectj.service;

import javax.servlet.http.HttpServletRequest;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Service;

import com.cff.springbootwork.aspectj.util.IPUtil;
import com.cff.springbootwork.dto.IpModel;

@Service
public class BusinessService {
    private final Logger logger = LoggerFactory.getLogger(this.getClass());

    /**
     * 獲取ip地址
     * 
     * @param request
     * @return
     */
    public IpModel getIpInfo(HttpServletRequest request, int type) {
        logger.info("進(jìn)入getIpInfo方法。");
        IpModel ipModel = new IpModel();
        ipModel.setClientIpAddress(IPUtil.getIpAddr(request));
        ipModel.setServerIpAddress(IPUtil.localIp());
        return ipModel;
    }

    /**
     * 測試
     * 
     * @param type
     * @return
     */
    public Integer getTestInfo(int type) {
        logger.info("進(jìn)入getTestInfo方法。");
        return type;
    }
}

3.2 Aspect切面

有了上面的Service，可以直接使用@Component@Aspect來寫切面邏輯。

OperateLogAspect:

package com.cff.springbootwork.aspectj;

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.After;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.Around;
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;

@Component
@Aspect
public class OperateLogAspect {
    private final Logger logger = LoggerFactory.getLogger(this.getClass());

    @Pointcut("execution(* com.cff.springbootwork.aspectj.service.BusinessService.*(..)) && !execution(* com.cff.springbootwork.aspectj.service.BusinessService.getTest*(..)) ")
    private void log() {
    }

    @Before("log()")
    public void beforeMethod(JoinPoint joinPoint) {
        String methodName = joinPoint.getSignature().getName();
        joinPoint.getArgs();
        logger.info("方法為:" + methodName + ", 這是一個(gè)前置測試 ");
    }

    @After("execution(* com.cff.springbootwork.aspectj.service.BusinessService.*(..))")
    public void afterMethod(JoinPoint joinPoint) {
        String methodName = joinPoint.getSignature().getName();
        logger.info("方法為:" + methodName + ", 這是一個(gè)后置測試 ");
    }
    
    @Around("execution(* com.cff.springbootwork.aspectj.service.BusinessService.getTestInfo(..))")
    public void test(JoinPoint joinPoint) {
        String methodName = joinPoint.getSignature().getName();
        logger.info("方法為:" + methodName + ", 測水水水水水水水水水水 ");
    }

    @AfterReturning(value = "log()", returning = "result")
    public void afterReturning(JoinPoint point, Object result) {
        String methodName = point.getSignature().getName();
        logger.info("方法為：" + methodName + "，目標(biāo)方法執(zhí)行結(jié)果為：" + result);
    }

    @Around("log()")
    public Object around(ProceedingJoinPoint joinPoint) throws Throwable {
        logger.info("請求參數(shù)：{}", joinPoint.getArgs());
        Object[] arr = joinPoint.getArgs();
        Integer type = (Integer) arr[1];
        logger.info("請求類型：{}", type);
        long startTime = System.currentTimeMillis();
        Object obj = joinPoint.proceed();
        long timeTaken = System.currentTimeMillis() - startTime;
        logger.info("執(zhí)行時(shí)間：{}", timeTaken);
        return obj;
    }
}

這里，

1. @Pointcut可以定義切點(diǎn)，定義之后，其他地方使用同樣的切點(diǎn)就不需要再寫execution，直接寫切點(diǎn)的方法名即可。
2. @Before是在被切方法調(diào)用前執(zhí)行，可以獲取到被切方法的參數(shù)。
3. @After是在被切方法執(zhí)行后執(zhí)行，無法獲取到被切方法的返回值。
4. @AfterReturning是被被切方法執(zhí)行后執(zhí)行，可以獲取到被切方法的返回值。
5. @Around是環(huán)繞被切方法，記住需要調(diào)用joinPoint.proceed()執(zhí)行被切方法，如果有返回值，注意return返回值。
6. @AfterThrowing: 異常通知, 在方法拋出異常之后執(zhí)行。
7. 如果切面方法外有事務(wù)，切面執(zhí)行的方法也是會(huì)回滾的。

四、運(yùn)行結(jié)果

測試中，我調(diào)用BusinessService的getIpInfo方法。

切面測試結(jié)果:

2020-09-02 15:36:59,755 [http-nio-8086-exec-1][IP:|USER:][INFO  com.cff.springbootwork.aspectj.OperateLogAspect] 請求參數(shù)：org.apache.catalina.connector.RequestFacade@71138566
2020-09-02 15:36:59,755 [http-nio-8086-exec-1][IP:|USER:][INFO  com.cff.springbootwork.aspectj.OperateLogAspect] 請求類型：1
2020-09-02 15:36:59,757 [http-nio-8086-exec-1][IP:|USER:][INFO  com.cff.springbootwork.aspectj.OperateLogAspect] 方法為:getIpInfo, 這是一個(gè)前置測試 
2020-09-02 15:36:59,761 [http-nio-8086-exec-1][IP:|USER:][INFO  com.cff.springbootwork.aspectj.service.BusinessService] 進(jìn)入getIpInfo方法。
2020-09-02 15:36:59,765 [http-nio-8086-exec-1][IP:|USER:][INFO  com.cff.springbootwork.aspectj.OperateLogAspect] 執(zhí)行時(shí)間：10
2020-09-02 15:36:59,766 [http-nio-8086-exec-1][IP:|USER:][INFO  com.cff.springbootwork.aspectj.OperateLogAspect] 方法為:getIpInfo, 這是一個(gè)后置測試 
2020-09-02 15:36:59,766 [http-nio-8086-exec-1][IP:|USER:][INFO  com.cff.springbootwork.aspectj.OperateLogAspect] 方法為：getIpInfo，目標(biāo)方法執(zhí)行結(jié)果為：IpModel [clientIpAddress=10.4.45.120, serverIpAddress=10.4.45.120]

五、切面表達(dá)式淺談

execution(<修飾符模式>? <返回類型模式> <方法名模式>(<參數(shù)模式>) <異常模式>?) 除了返回類型模式、方法名模式和參數(shù)模式外，其它項(xiàng)都是可選的。

？表示可省略，

修飾符模式如public、protected等；

返回類型模式表示方法返回類型；

方法名模式表示類+方法；

參數(shù)模式表示參數(shù)；

異常模式表示拋出的異常；

表達(dá)式中，可以使用*來代表任意字符，用..來表示任意個(gè)參數(shù)。

示例：

execution(* com.cff.springbootwork.aspectj.service.BusinessService.*(..))

1. 切面表達(dá)式是從execution開始的，()內(nèi)是表達(dá)式主體。
2. 第一個(gè)號(hào)：表示返回類型，號(hào)表示所有的類型。
3. com.cff.springbootwork.aspectj.service.BusinessService.*表示匹配該類的所有方法。
4. (..)表示參數(shù)個(gè)數(shù)任意。
5. 多個(gè)execution可以合并，可以使用||、&&等進(jìn)行連接。

六、測試用的其他類

AspectJTestServerRest:

package com.cff.springbootwork.aspectj.web;

import javax.servlet.http.HttpServletRequest;

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;

import com.cff.springbootwork.aspectj.service.BusinessService;
import com.cff.springbootwork.dto.IpModel;
import com.cff.springbootwork.dto.ResultModel;

@RestController
@RequestMapping("/asp")
public class AspectJTestServerRest {
    @Autowired
    private BusinessService businessService;

    @RequestMapping(value = "/ip", method = { RequestMethod.GET })
    public ResultModel welCome(HttpServletRequest request) {
        IpModel ipModel = businessService.getIpInfo(request, 1);
        return ResultModel.ok(ipModel);
    }

    @RequestMapping(value = "/test", method = { RequestMethod.GET })
    public ResultModel test(HttpServletRequest request) {
        Integer ipModel = businessService.getTestInfo(1);
        return ResultModel.ok(ipModel);
    }
}

IpModel:

package com.cff.springbootwork.dto;

public class IpModel {
    private String clientIpAddress;
    private String serverIpAddress;

    public String getClientIpAddress() {
        return clientIpAddress;
    }

    public void setClientIpAddress(String clientIpAddress) {
        this.clientIpAddress = clientIpAddress;
    }

    public String getServerIpAddress() {
        return serverIpAddress;
    }

    public void setServerIpAddress(String serverIpAddress) {
        this.serverIpAddress = serverIpAddress;
    }

    @Override
    public String toString() {
        return "IpModel [clientIpAddress=" + clientIpAddress + ", serverIpAddress=" + serverIpAddress + "]";
    }
}

IPUtil:

package com.cff.springbootwork.aspectj.util;

import java.net.InetAddress;
import java.net.UnknownHostException;

import javax.servlet.http.HttpServletRequest;

public class IPUtil {
    /**
     * @Description: 獲取客戶端IP地址
     */
    public static String getIpAddr(HttpServletRequest request) {
        String ip = request.getHeader("x-forwarded-for");
        if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
            ip = request.getHeader("Proxy-Client-IP");
        }
        if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
            ip = request.getHeader("WL-Proxy-Client-IP");
        }
        if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
            ip = request.getRemoteAddr();
            if (ip.equals("127.0.0.1")) {
                // 根據(jù)網(wǎng)卡取本機(jī)配置的IP
                InetAddress inet = null;
                try {
                    inet = InetAddress.getLocalHost();
                } catch (Exception e) {
                    e.printStackTrace();
                }
                ip = inet.getHostAddress();
            }
        }
        // 多個(gè)代理的情況，第一個(gè)IP為客戶端真實(shí)IP,多個(gè)IP按照','分割
        if (ip != null && ip.length() > 15) {
            if (ip.indexOf(",") > 0) {
                ip = ip.substring(0, ip.indexOf(","));
            }
        }
        return ip;
    }

    /**
     * 獲取的是本地的IP地址
     * 
     * @return
     */
    public static String localIp() {
        String result = "";
        try {
            InetAddress address = InetAddress.getLocalHost();
            result = address.getHostAddress();
        } catch (UnknownHostException e) {
            e.printStackTrace();
        }
        return result;
    }
}

ResultModel:

package com.cff.springbootwork.dto;

/**
 * @author cff
 */
public class ResultModel {

    private String errorCode;
    private String message;
    private Object data;

    public ResultModel() {

    }

    public ResultModel(String errorCode, String message) {
        this.errorCode = errorCode;
        this.message = message;
    }

    public ResultModel(String errorCode, String message, Object data) {
        this.errorCode = errorCode;
        this.message = message;
        this.data = data;
    }

    public String geterrorCode() {
        return errorCode;
    }

    public void seterrorCode(String errorCode) {
        this.errorCode = errorCode;
    }

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }

    public Object getData() {
        return data;
    }

    public void setData(Object data) {
        this.data = data;
    }

    public static ResultModel ok(Object data) {
        return new ResultModel("0000", "成功", data);
    }

    public static ResultModel error(String msg) {
        return new ResultModel("1111", msg);
    }

    public static ResultModel error(String msg, Object data) {
        return new ResultModel("1111", msg, data);
    }
}

品茗IT-博客專題:https://www.pomit.cn/lecture.html匯總了Spring專題、Springboot專題、SpringCloud專題、web基礎(chǔ)配置專題。

快速構(gòu)建項(xiàng)目

Spring項(xiàng)目快速開發(fā)工具：

一鍵快速構(gòu)建Spring項(xiàng)目工具

一鍵快速構(gòu)建SpringBoot項(xiàng)目工具

一鍵快速構(gòu)建SpringCloud項(xiàng)目工具

一站式Springboot項(xiàng)目生成

Mysql一鍵生成Mybatis注解Mapper

Spring組件化構(gòu)建

SpringBoot組件化構(gòu)建

SpringCloud服務(wù)化構(gòu)建