springboot aop 自定義註解方式實現一套完善的日誌記錄（完整原始碼）

阿新 • • 發佈：2018-12-09

一：功能簡介

本文主要記錄如何使用aop切面的方式來實現日誌記錄功能。

主要記錄的資訊有: 操作人，方法名，引數，執行時間，操作型別(增刪改查)，詳細描述，返回值。

二：專案結構圖

三：MAVEM依賴

本專案有兩個pom檔案,父類的pom檔案主要作用是對子類pom檔案依賴的版本號進行統一管理。

1.最外層的pom檔案配置如下

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance 
"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.wwj.springboot</groupId>
    <artifactId>springboot</artifactId>
    <packaging>pom</packaging>
    <version>1.0 
-SNAPSHOT</version>
    <modules>
        <module>springboot-aop</module>
    </modules>

    <!-- Inherit defaults from Spring Boot -->
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0 
.4.RELEASE</version>
    </parent>
    <properties>
        <fastjson.version>1.2.49</fastjson.version>
    </properties>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <!-- Import dependency management from Spring Boot -->
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>2.0.4.RELEASE</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>fastjson</artifactId>
                <version>${fastjson.version}</version>
            </dependency>
        </dependencies>
    </dependencyManagement>
</project>

2.子pom檔案配置如下

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>springboot</artifactId>
        <groupId>com.wwj.springboot</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>springboot-aop</artifactId>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!-- spring-boot aop依賴配置引入 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
        </dependency>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
        </dependency>
    </dependencies>

</project>

四：程式碼實現

1.配置檔案

這裡只有兩個配置：1)server.port=11000，設定專案啟動的埠號,防止被其他服務佔用;2)spring.aop.auto=true，開啟spring的aop配置,簡單明瞭，不需要多配置其他的配置或註解。application.yml檔案

server:
  port: 11000
spring:
  aop:
    auto: true #啟動aop配置

2.AOP切點類

這個是最主要的類,可以使用自定義註解或針對包名實現AOP增強。

1)這裡實現了對自定義註解的環繞增強切點，對使用了自定義註解的方法進行AOP切面處理；

2)對方法執行時間進行監控；

3)對方法名，引數名，引數值，對日誌描述的優化處理；

在方法上增加@Aspect 註解宣告切面,使用@Pointcut 註解定義切點，標記方法。

使用切點增強的時機註解:@Before,@Around,@AfterReturning,@AfterThrowing,@After

package com.wwj.springboot.aop;

import com.alibaba.fastjson.JSON;
import com.wwj.springboot.annotation.OperationLogDetail;
import com.wwj.springboot.model.OperationLog;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.*;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.stereotype.Component;

import java.util.Date;
import java.util.HashMap;
import java.util.Map;
import java.util.UUID;

/**
 * Created by IntelliJ IDEA
 *
 * @author weiwenjun
 * @date 2018/9/12
 */
@Aspect
@Component
public class LogAspect {

    /**
     * 此處的切點是註解的方式，也可以用包名的方式達到相同的效果
     * '@Pointcut("execution(* com.wwj.springboot.service.impl.*.*(..))")'
     */
    @Pointcut("@annotation(com.wwj.springboot.annotation.OperationLogDetail)")
    public void operationLog(){}


    /**
     * 環繞增強，相當於MethodInterceptor
     */
    @Around("operationLog()")
    public Object doAround(ProceedingJoinPoint joinPoint) throws Throwable {
        Object res = null;
        long time = System.currentTimeMillis();
        try {
            res =  joinPoint.proceed();
            time = System.currentTimeMillis() - time;
            return res;
        } finally {
            try {
                //方法執行完成後增加日誌
                addOperationLog(joinPoint,res,time);
            }catch (Exception e){
                System.out.println("LogAspect 操作失敗：" + e.getMessage());
                e.printStackTrace();
            }
        }
    }

    private void addOperationLog(JoinPoint joinPoint, Object res, long time){
        MethodSignature signature = (MethodSignature)joinPoint.getSignature();
        OperationLog operationLog = new OperationLog();
        operationLog.setRunTime(time);
        operationLog.setReturnValue(JSON.toJSONString(res));
        operationLog.setId(UUID.randomUUID().toString());
        operationLog.setArgs(JSON.toJSONString(joinPoint.getArgs()));
        operationLog.setCreateTime(new Date());
        operationLog.setMethod(signature.getDeclaringTypeName() + "." + signature.getName());
        operationLog.setUserId("#{currentUserId}");
        operationLog.setUserName("#{currentUserName}");
        OperationLogDetail annotation = signature.getMethod().getAnnotation(OperationLogDetail.class);
        if(annotation != null){
            operationLog.setLevel(annotation.level());
            operationLog.setDescribe(getDetail(((MethodSignature)joinPoint.getSignature()).getParameterNames(),joinPoint.getArgs(),annotation));
            operationLog.setOperationType(annotation.operationType().getValue());
            operationLog.setOperationUnit(annotation.operationUnit().getValue());
        }
        //TODO 這裡儲存日誌
        System.out.println("記錄日誌:" + operationLog.toString());
//        operationLogService.insert(operationLog);
    }

    /**
     * 對當前登入使用者和佔位符處理
     * @param argNames 方法引數名稱陣列
     * @param args 方法引數陣列
     * @param annotation 註解資訊
     * @return 返回處理後的描述
     */
    private String getDetail(String[] argNames, Object[] args, OperationLogDetail annotation){

        Map<Object, Object> map = new HashMap<>(4);
        for(int i = 0;i < argNames.length;i++){
            map.put(argNames[i],args[i]);
        }

        String detail = annotation.detail();
        try {
            detail = "'" + "#{currentUserName}" + "'=》" + annotation.detail();
            for (Map.Entry<Object, Object> entry : map.entrySet()) {
                Object k = entry.getKey();
                Object v = entry.getValue();
                detail = detail.replace("{{" + k + "}}", JSON.toJSONString(v));
            }
        }catch (Exception e){
            e.printStackTrace();
        }
        return detail;
    }

    @Before("operationLog()")
    public void doBeforeAdvice(JoinPoint joinPoint){
        System.out.println("進入方法前執行.....");

    }

    /**
     * 處理完請求，返回內容
     * @param ret
     */
    @AfterReturning(returning = "ret", pointcut = "operationLog()")
    public void doAfterReturning(Object ret) {
        System.out.println("方法的返回值 : " + ret);
    }

    /**
     * 後置異常通知
     */
    @AfterThrowing("operationLog()")
    public void throwss(JoinPoint jp){
        System.out.println("方法異常時執行.....");
    }


    /**
     * 後置最終通知,final增強，不管是丟擲異常或者正常退出都會執行
     */
    @After("operationLog()")
    public void after(JoinPoint jp){
        System.out.println("方法最後執行.....");
    }

}

3.自定義註解

package com.wwj.springboot.annotation;

import com.wwj.springboot.enums.OperationType;
import com.wwj.springboot.enums.OperationUnit;

import java.lang.annotation.*;

/**
 * Created by IntelliJ IDEA
 *
 * @author weiwenjun
 * @date 2018/9/12
 */
//@OperationLogDetail(detail = "通過手機號[{{tel}}]獲取使用者名稱",level = 3,operationUnit = OperationUnit.USER,operationType = OperationType.SELECT)
@Documented
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface OperationLogDetail {

    /**
     * 方法描述,可使用佔位符獲取引數:{{tel}}
     */
    String detail() default "";

    /**
     * 日誌等級:自己定，此處分為1-9
     */
    int level() default 0;

    /**
     * 操作型別(enum):主要是select,insert,update,delete
     */
    OperationType operationType() default OperationType.UNKNOWN;

    /**
     * 被操作的物件(此處使用enum):可以是任何物件，如表名(user)，或者是工具(redis)
     */
    OperationUnit operationUnit() default OperationUnit.UNKNOWN;
}

4.註解用到的列舉型別

package com.wwj.springboot.enums;

/**
 * Created by IntelliJ IDEA
 *
 * @author weiwenjun
 * @date 2018/9/12
 */
public enum OperationType {
    /**
     * 操作型別
     */
    UNKNOWN("unknown"),
    DELETE("delete"),
    SELECT("select"),
    UPDATE("update"),
    INSERT("insert");

    private String value;

    public String getValue() {
        return value;
    }

    public void setValue(String value) {
        this.value = value;
    }

    OperationType(String s) {
        this.value = s;
    }
}

package com.wwj.springboot.enums;

/**
 * Created by IntelliJ IDEA
 * 被操作的單元
 * @author weiwenjun
 * @date 2018/9/12
 */
public enum OperationUnit {
    /**
     * 被操作的單元
     */
    UNKNOWN("unknown"),
    USER("user"),
    EMPLOYEE("employee"),
    Redis("redis");

    private String value;

    OperationUnit(String value) {
        this.value = value;
    }

    public String getValue() {
        return value;
    }

    public void setValue(String value) {
        this.value = value;
    }
}

5.日誌記錄物件

package com.wwj.springboot.model;

import java.util.Date;

/**
 * Created by IntelliJ IDEA
 *
 * @author weiwenjun
 * @date 2018/9/12
 */
public class OperationLog {

    private String id;
    private Date createTime;
    /**
     * 日誌等級
     */
    private Integer level;
    /**
     * 被操作的物件
     */
    private String operationUnit;
    /**
     * 方法名
     */
    private String method;
    /**
     * 引數
     */
    private String args;
    /**
     * 操作人id
     */
    private String userId;
    /**
     * 操作人
     */
    private String userName;
    /**
     * 日誌描述
     */
    private String describe;
    /**
     * 操作型別
     */
    private String operationType;
    /**
     * 方法執行時間
     */
    private Long runTime;
    /**
     * 方法返回值
     */
    private String returnValue;

    @Override
    public String toString() {
        return "OperationLog{" +
                "id='" + id + '\'' +
                ", createTime=" + createTime +
                ", level=" + level +
                ", operationUnit='" + operationUnit + '\'' +
                ", method='" + method + '\'' +
                ", args='" + args + '\'' +
                ", userId='" + userId + '\'' +
                ", userName='" + userName + '\'' +
                ", describe='" + describe + '\'' +
                ", operationType='" + operationType + '\'' +
                ", runTime=" + runTime +
                ", returnValue='" + returnValue + '\'' +
                '}';
    }

    public Long getRunTime() {
        return runTime;
    }

    public void setRunTime(Long runTime) {
        this.runTime = runTime;
    }

    public String getReturnValue() {
        return returnValue;
    }

    public void setReturnValue(String returnValue) {
        this.returnValue = returnValue;
    }

    public String getId() {
        return id;
    }

    public void setId(String id) {
        this.id = id;
    }

    public Date getCreateTime() {
        return createTime;
    }

    public void setCreateTime(Date createTime) {
        this.createTime = createTime;
    }

    public Integer getLevel() {
        return level;
    }

    public void setLevel(Integer level) {
        this.level = level;
    }

    public String getOperationUnit() {
        return operationUnit;
    }

    public void setOperationUnit(String operationUnit) {
        this.operationUnit = operationUnit;
    }

    public String getMethod() {
        return method;
    }

    public void setMethod(String method) {
        this.method = method;
    }

    public String getArgs() {
        return args;
    }

    public void setArgs(String args) {
        this.args = args;
    }

    public String getUserId() {
        return userId;
    }

    public void setUserId(String userId) {
        this.userId = userId;
    }

    public String getUserName() {
        return userName;
    }

    public void setUserName(String userName) {
        this.userName = userName;
    }

    public String getDescribe() {
        return describe;
    }

    public void setDescribe(String describe) {
        this.describe = describe;
    }

    public String getOperationType() {
        return operationType;
    }

    public void setOperationType(String operationType) {
        this.operationType = operationType;
    }
}

6.springboot啟動類

package com.wwj.springboot;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

/**
 * Created by IntelliJ IDEA
 *
 * @author weiwenjun
 * @date 2018/9/12
 */
@SpringBootApplication
public class AopApplication {

    public static void main(String[] args) {
        SpringApplication.run(AopApplication.class);
    }
}

7.controller類

package com.wwj.springboot.controller;

import com.wwj.springboot.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseBody;

/**
 * Created by IntelliJ IDEA
 *
 * @author weiwenjun
 * @date 2018/9/12
 */
@Controller
@RequestMapping("user")
public class UserController {

    @Autowired
    private UserService userService;

    /**
     * 訪問路徑 http://localhost:11000/user/findUserNameByTel?tel=1234567
     * @param tel 手機號
     * @return userName
     */
    @ResponseBody
    @RequestMapping("/findUserNameByTel")
    public String findUserNameByTel(@RequestParam("tel") String tel){
        return userService.findUserName(tel);
    }
}

8.Service類

package com.wwj.springboot.service;

/**
 * Created by IntelliJ IDEA
 *
 * @author weiwenjun
 * @date 2018/9/13
 */
public interface UserService {

    /**
     * 獲取使用者資訊
     * @return
     * @param tel
     */
    String findUserName(String tel);
}

9.ServiceImpl類

package com.wwj.springboot.service.impl;

import com.wwj.springboot.annotation.OperationLogDetail;
import com.wwj.springboot.enums.OperationType;
import com.wwj.springboot.enums.OperationUnit;
import com.wwj.springboot.service.UserService;
import org.springframework.stereotype.Service;

/**
 * Created by IntelliJ IDEA
 *
 * @author weiwenjun
 * @date 2018/9/13
 */
@Service
public class UserServiceImpl implements UserService {

    @OperationLogDetail(detail = "通過手機號[{{tel}}]獲取使用者名稱",level = 3,operationUnit = OperationUnit.USER,operationType = OperationType.SELECT)
    @Override
    public String findUserName(String tel) {
        System.out.println("tel:" + tel);
        return "zhangsan";
    }
}

專案原始碼github地址:

springboot aop 自定義註解方式實現一套完善的日誌記錄（完整原始碼）

一：功能簡介本文主要記錄如何使用aop切面的方式來實現日誌記錄功能。主要記錄的資訊有: 操作人，方法名，引數，執行時間，操作型別(增刪改查)，詳細描述，返回值。二：專案結構圖三：MAVEM依賴本專案有兩個pom檔案,父類的pom檔案主要作用是對子類pom檔案依賴的版本號進行統一管理。 1.最外層

使用Spring AOP自定義註解方式實現使用者操作日誌記錄

1，開發環境作業系統：Windows 7 JDK：1.8.0_161 Eclipse：Mars.2 Release (4.5.2) 2，自定義註解類UserLog @Target({ElementType.PARAMETER, ElementType.METHOD}) @R

Spring/Springboot AOP 自定義註解記錄日誌操作

本文采用的方法是使用註解記錄日誌，廢話不多說直接上乾貨。建立一個自定義@Log日誌標籤 package com.insurance.dao; import java.lang.annotation.Documented; import java.lang.ann

SpringBoot 通過自定義註解實現AOP切面程式設計例項

一直心心念的想寫一篇關於AOP切面例項的博文，拖更了許久之後，今天終於著手下筆將其完成。基礎概念 1、切面(Aspect) 首先要理解‘切’字，需要把物件想象成一個立方體，傳統的面向物件變成思維，類定義完成之後（封裝）。每次例項化一個物件，對類定義中的成員變數賦值，就相當於對這個立方體進行了一個定義，

spring-AOP+自定義註解實現日誌管理（註解方式實現）

一、場景後臺管理系統中，管理員作業系統時生成日誌儲存在資料庫中。二、實現 1、jar包依賴  <dependency&

基於springboot通過自定義註解和AOP實現許可權驗證

這篇文章主要介紹自定義註解配合AOP的使用來完成一個簡單的許可權驗證的功能。一、移入依賴 <parent> <groupId>org.springframework.boot</groupId> <artifactId>sprin

《SpringBoot學習篇》（5）AOP+自定義註解實現日誌管理

用到的AOP註解：@Aspect @Pointcut @After 首先看一下如何呼叫自定義註解： @MyLog(module="老師模組", method="查詢全部") @RequestMapping("/all") public List

使用SpringBoot通過自定義註解+AOP+全域性異常處理實現引數統一非空校驗

一、前言在我們寫後臺介面時，難免對引數進行非空校驗，如果一兩個還好，但如果需要寫大量的介面，及必填引數太多的時候，會給我們開發帶來大量的重複工作，及很多相似程式碼。而sping自帶的@RequestParam註解並不能完全滿足我們的需求，因為

Spring AOP 自定義註解實現日誌管理

目錄一、配置檔案二、新建一個日誌實體類Log 三、編寫 service 層四、編寫 service 層的實現 serviceimpl 五、自定義註解類六、編寫切面類七、spring + aop 需要的 jar 包部落格的程式碼是基於 SSM 環境編寫的

springboot-監聽器，過濾器，攔截器，aop,自定義註解

springboot基礎-監聽器，過濾器，攔截器，aop,自定義註解文章目錄 springboot基礎-監聽器，過濾器，攔截器，aop,自定義註解 1.監聽器 2.過濾器 3.攔截器 4.aop 5.自定義註解

自定義註解使用實現登入AOP

分散式商城redis應用,實現單點登入和購物車功能單點登入+自定義註解+AOP 技術點: redis+jsonp+cookie實現分散式系統內部的單點登入抽取公共的js $(function () { $.ajax({ //url進行遠端訪

使用Spring Aop自定義註解實現自動記錄日誌

百度加自己琢磨，以下親測有效，所以寫下來記錄，也方便自己回顧瀏覽加深印象之類，有什麼問題可以評論一起解決，不完整之處也請大佬指正，一起進步哈哈（1）首先配置檔案：  <aop:

Spring AOP自定義註解實現許可權控制

1.建立註解類，controller控制層使用該註解進行許可權控制使用 import java.lang.annotation.Documented; import java.lang.annotation.ElementType; import java.lang.annotation.R

SpringBoot 整合AOP 自定義註解

SpringBoot 整合Aop 完成自定義註解功能前提是需要掌握一定的Spring Aop知識第一步：引入jar <dependency> <groupId>org.springframewo

Spring AOP自定義註解實現系統日誌記錄管理

package com.kilomob.powernetwork.managerweb.annotation; import java.lang.reflect.Method; import java.net.InetAddress; import java.util.Arrays; import java

Spring+SpringMVC+Mybatis 利用AOP自定義註解實現可配置日

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 5

ratelimit+aop自定義註解實現應用限流

1、基於springboot專案pom.xml新增如下依賴： <dependency> <groupId>org.springframework.boot</groupId> <artifactId>sprin

SpringBoot使用自定義註解實現簡單引數加密解密(註解+HandlerMethodArgumentResolver)

# 前言 > 我黃漢三又回來了，快半年沒更新部落格了，這半年來的經歷實屬不易， > 疫情當頭，本人實習的公司沒有跟員工共患難，直接辭掉了很多人。 > 作為一個實習生，本人也被無情開除了。所以本人又得重新準備找工作了。 > 算了，感慨一下，本來想昨天發的，但昨天是清明，哀悼時期，就留到了今天發。話不多說，

SpringBoot系列（十三）統一日誌處理，logback+slf4j AOP+自定義註解，走起！

**往期精彩推薦** [SpringBoot系列（一）idea新建Springboot專案](https://www.cnblogs.com/swzx-1213/p/12345330.html) [SpringBoot系列（二）入門知識](https://www.cnblogs.com/swzx-1213

【Spring】—AOP之AspectJ註解方式實現聲明式事務管理

source xml配置 blog org 僅支持選擇 imp 獨立 col 前言這回來說下註解方式的聲明式事務管理。正文 Demo 1、引入相關的jar包這裏寫圖片描述 2、引入AOP約束<beans xmlns:xsi="http://www.w3

springboot aop 自定義註解方式實現一套完善的日誌記錄（完整原始碼）

一：功能簡介

二：專案結構圖

三：MAVEM依賴

四：程式碼實現

1.配置檔案

2.AOP切點類

3.自定義註解

4.註解用到的列舉型別

5.日誌記錄物件

6.springboot啟動類

7.controller類

8.Service類

9.ServiceImpl類

相關推薦