SpringBoot自定義註解+非同步+觀察者模式實現業務日誌保存

• 2022 年 10 月 28 日
• 筆記
• JAVA, springboot

一、前言

我們在企業級的開發中，必不可少的是對日誌的記錄，實現有很多種方式，常見的就是基於AOP+註解進行保存，但是考慮到程式的流暢和效率，我們可以使用非同步進行保存，小編最近在spring和springboot源碼中看到有很多的監聽處理貫穿前後：這就是著名的觀察者模式！！

二、基礎環境

項目這裡小編就不帶大家創建了，直接開始！！

1. 導入依賴

小編這裡的springboot版本是：2.7.4

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.2</version>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

<!-- Druid -->
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>druid-spring-boot-starter</artifactId>
    <version>1.1.16</version>
</dependency>

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

<!-- mysql -->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
</dependency>
<!-- mybatis-plus -->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.5.1</version>
</dependency>

2. 編寫yml配置

server:
  port: 8088

spring:
  datasource:
    #使用阿里的Druid
    type: com.alibaba.druid.pool.DruidDataSource
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://192.168.239.131:3306/test?serverTimezone=UTC
    username: root
    password: root

三、資料庫設計

資料庫保存日誌表的設計，小編一切從簡，一般日誌多的後期會進行分庫分表，或者搭配ELK進行分析，分庫分表一般採用根據方法類型，這需要開發人員遵循rest風格，不然肯定都是post，純屬個人見解哈！！大家可以根據自己的公司的要求進行補充哈！！

DROP TABLE IF EXISTS `sys_log`;
CREATE TABLE `sys_log`  (
  `id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT '日誌主鍵',
  `title` varchar(50) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT '' COMMENT '模組標題',
  `business_type` int(2) NULL DEFAULT 0 COMMENT '業務類型（0其它 1新增 2修改 3刪除）',
  `method` varchar(100) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT '' COMMENT '方法名稱',
  `request_method` varchar(10) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT '' COMMENT '請求方式',
  `oper_name` varchar(50) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT '' COMMENT '操作人員',
  `oper_url` varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT '' COMMENT '請求URL',
  `oper_ip` varchar(128) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT '' COMMENT '主機地址',
  `oper_time` datetime(0) NULL DEFAULT NULL COMMENT '操作時間',
  PRIMARY KEY (`id`) USING BTREE
) ENGINE = InnoDB AUTO_INCREMENT = 1585197503834284034 CHARACTER SET = utf8 COLLATE = utf8_general_ci COMMENT = '操作日誌記錄' ROW_FORMAT = Dynamic;

SET FOREIGN_KEY_CHECKS = 1;

實體類：

import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import com.fasterxml.jackson.annotation.JsonFormat;
import lombok.Data;

import java.time.LocalDateTime;

/**
 * 操作日誌記錄表 sys_log
 *
 */
@Data
@TableName("sys_log")
public class SysLog {
    private static final long serialVersionUID = 1L;

    /**
     * 日誌主鍵
     */
    @TableId
    private Long id;

    /**
     * 操作模組
     */
    private String title;

    /**
     * 業務類型（0其它 1新增 2修改 3刪除）
     */
    private Integer businessType;

    /**
     * 請求方式
     */
    private String requestMethod;

    /**
     * 操作人員
     */
    private String operName;

    /**
     * 請求url
     */
    private String operUrl;

    /**
     * 操作地址
     */
    private String operIp;

    /**
     * 操作時間
     */
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private LocalDateTime operTime;

}

四、主要功能

大體思路：
先手寫一個註解—>切面來進行獲取要保存的數據—>一個發布者來發布要保存的數據—>一個監聽者監聽後保存（非同步）

完整項目架構圖如下：

1. 編寫註解

import com.example.demo.constant.BusinessTypeEnum;

import java.lang.annotation.*;

/**
 * 自定義操作日誌記錄註解
 * @author wangzhenjun
 * @date 2022/10/26 15:37
 */
@Target(ElementType.METHOD) // 註解只能用於方法
@Retention(RetentionPolicy.RUNTIME) // 修飾註解的生命周期
@Documented
public @interface Log {

    String value() default "";
    /**
     * 模組
     */
    String title() default "測試模組";

    /**
     * 功能
     */
    BusinessTypeEnum businessType() default BusinessTypeEnum.OTHER;
}

2. 業務類型枚舉

/**
 * @author wangzhenjun
 * @date 2022/10/26 11:22
 */
public enum BusinessTypeEnum {

    /**
     * 其它
     */
    OTHER(0,"其它"),

    /**
     * 新增
     */
    INSERT(1,"新增"),

    /**
     * 修改
     */
    UPDATE(2,"修改"),

    /**
     * 刪除
     */
    DELETE(3,"刪除");

    private Integer code;

    private String message;

    BusinessTypeEnum(Integer code, String message) {
        this.code = code;
        this.message = message;
    }

    public Integer getCode() {
        return code;
    }

    public String getMessage() {
        return message;
    }
}

3. 編寫切片

這裡小編是以切片後進行發起的，當然規範流程是要加異常後的切片，這裡以最簡單的進行測試哈，大家按需進行添加！！

import com.example.demo.annotation.Log;
import com.example.demo.entity.SysLog;
import com.example.demo.listener.EventPubListener;
import com.example.demo.utils.IpUtils;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.After;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import javax.servlet.http.HttpServletRequest;
import java.time.LocalDateTime;

/**
 * @author wangzhenjun
 * @date 2022/10/26 15:39
 */
@Aspect
@Component
public class SysLogAspect {

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

    @Autowired
    private EventPubListener eventPubListener;

    /**
     * 以註解所標註的方法作為切入點
     */
    @Pointcut("@annotation(com.example.demo.annotation.Log)")
    public void sysLog() {}


    /**
     * 在切點之後織入
     * @throws Throwable
     */
    @After("sysLog()")
    public void doAfter(JoinPoint joinPoint) {
        Log log = ((MethodSignature) joinPoint.getSignature()).getMethod()
                .getAnnotation(Log.class);
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder
                .getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();
        String method = request.getMethod();
        String url = request.getRequestURL().toString();
        String ip = IpUtils.getIpAddr(request);
        SysLog sysLog = new SysLog();
        sysLog.setBusinessType(log.businessType().getCode());
        sysLog.setTitle(log.title());
        sysLog.setRequestMethod(method);
        sysLog.setOperIp(ip);
        sysLog.setOperUrl(url);
        // 從登錄中token獲取登錄人員資訊即可
        sysLog.setOperName("我是測試人員");
        sysLog.setOperTime(LocalDateTime.now());
        // 發布消息
        eventPubListener.pushListener(sysLog);
        logger.info("=======日誌發送成功，內容：{}",sysLog);
    }
}

4. ip工具類

import com.baomidou.mybatisplus.core.toolkit.StringUtils;

import javax.servlet.http.HttpServletRequest;

/**
 * @author wangzhenjun
 * @date 2022/10/26 16:27
 * 獲取IP方法
 *
 * @author jw
 */
public class IpUtils {
    /**
     * 獲取客戶端IP
     *
     * @param request 請求對象
     * @return IP地址
     */
    public static String getIpAddr(HttpServletRequest request) {
        if (request == null) {
            return "unknown";
        }
        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("X-Forwarded-For");
        }
        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.getHeader("X-Real-IP");
        }

        if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
            ip = request.getRemoteAddr();
        }

        return "0:0:0:0:0:0:0:1".equals(ip) ? "127.0.0.1" : getMultistageReverseProxyIp(ip);
    }


    /**
     * 從多級反向代理中獲得第一個非unknown IP地址
     *
     * @param ip 獲得的IP地址
     * @return 第一個非unknown IP地址
     */
    public static String getMultistageReverseProxyIp(String ip) {
        // 多級反向代理檢測
        if (ip != null && ip.indexOf(",") > 0) {
            final String[] ips = ip.trim().split(",");
            for (String subIp : ips) {
                if (false == isUnknown(subIp)) {
                    ip = subIp;
                    break;
                }
            }
        }
        return ip;
    }

    /**
     * 檢測給定字元串是否為未知，多用於檢測HTTP請求相關
     *
     * @param checkString 被檢測的字元串
     * @return 是否未知
     */
    public static boolean isUnknown(String checkString) {
        return StringUtils.isBlank(checkString) || "unknown".equalsIgnoreCase(checkString);
    }
}

5. 事件發布

事件發布是由ApplicationContext對象進行發布的，直接注入使用即可！
使用觀察者模式的目的：為了業務邏輯之間的解耦，提高可擴展性。
這種模式在spring和springboot底層是經常出現的，大家可以去看看。
發布者只需要關注發布消息，監聽者只需要監聽自己需要的，不管誰發的，符合自己監聽條件即可。

import com.example.demo.entity.SysLog;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationContext;
import org.springframework.stereotype.Component;

/**
 * @author wangzhenjun
 * @date 2022/10/26 16:38
 */
@Component
public class EventPubListener {
    @Autowired
    private ApplicationContext applicationContext;

    // 事件發布方法
    public void pushListener(SysLog sysLogEvent) {
        applicationContext.publishEvent(sysLogEvent);
    }
}

6. 監聽者

@Async：單獨開啟一個新執行緒去保存，提高效率！
@EventListener：監聽

/**
 * @author wangzhenjun
 * @date 2022/10/25 15:22
 */
@Slf4j
@Component
public class MyEventListener {

    @Autowired
    private TestService testService;
	
	// 開啟非同步
    @Async
    // 開啟監聽
    @EventListener(SysLog.class)
    public void saveSysLog(SysLog event) {
        log.info("=====即將非同步保存到資料庫======");
        testService.saveLog(event);
    }

}

五、測試

1. controller

/**
 * @author wangzhenjun
 * @date 2022/10/26 16:51
 */
@Slf4j
@RestController
@RequestMapping("/test")
public class TestController {

    @Log(title = "測試呢",businessType = BusinessTypeEnum.INSERT)
    @GetMapping("/saveLog")
    public void saveLog(){
        log.info("我就是來測試一下是否成功！");
    }
}

2. service

/**
 * @author wangzhenjun
 * @date 2022/10/26 16:55
 */
public interface TestService {

    int saveLog(SysLog sysLog);
}

/**
 * @author wangzhenjun
 * @date 2022/10/26 16:56
 */
@Service
public class TestServiceImpl implements TestService {

    @Autowired
    private TestMapper testMapper;

    @Override
    public int saveLog(SysLog sysLog) {

        return testMapper.insert(sysLog);
    }
}

3. mapper

這裡使用mybatis-plus進行保存

/**
 * @author wangzhenjun
 * @date 2022/10/26 17:07
 */
public interface TestMapper extends BaseMapper<SysLog> {
}

4. 測試

5. 資料庫

六、總結

鐺鐺鐺，終於完成了！這個實戰在企業級必不可少的，每個項目搭建人不同，但是結果都是一樣的，保存日誌到數據，這樣可以進行按鈕的點擊進行統計，分析那個功能是否經常使用，那些東西需要優化。只要是有數據的東西，分析一下總會有收穫的！後面日誌多了就行分庫分表，ELK搭建。知道的越多不知道的就越多，這一次下來，知道下面要學什麼了嘛！！

可以看下一小編的微信公眾號，和網站文章首發看，歡迎關注，一起交流哈！！

點擊訪問！小編自己的網站，裡面也是有很多好的文章哦！