前言

很久以前都想寫這篇文章，一直沒有空，但直到現在我對當時的情景還有印象，之是以有印象是因為需求很簡單，業務記錄檔的記錄與查詢的功能，但是具體實作真的很爛，具體的爛法會在反面示例裡細說，上司以及客戶層面很認可，一系列迷之操作，讓我印象深刻。

需求描述與分析

客戶側提出需求很簡單：要對幾個關鍵的業務功能進行記錄檔記錄，即什麼人在什麼時間操作了哪個功能，操作前的資料封包是什麼、操作後的資料封包是什麼，必要的時候可以一鍵回退。

日志在業務系統中是必不可少的一個功能，常見的有系統日志、記錄檔等：

系統日志

這裡的系統日志是指的是程式執行過程中的關鍵步驟，根據實際場景輸出的debug、info、warn、error等不同級别的程式執行記錄資訊，這些一般是給程式員或運維看的，一般在出現異常問題的時候，可以通過系統日志中記錄的關鍵參數資訊和異常提示，快速排除故障。

記錄檔

記錄檔，是使用者實際業務操作行為的記錄，這些資訊一般存儲在資料庫裡，如什麼時間哪個使用者點了某個菜單、修改了哪個配置等這類業務操作行為，這些日志資訊是給普通使用者或系統管理者看到。

通過對需求的分析，客戶想要是一個業務記錄檔管理的功能：

1、記錄使用者的業務操作行為，記錄的字段有：操作人、操作時間、操作功能、日志類型、操作内容描述、操作内容封包、操作前内容封包

2、提供一個可視化的頁面，可以查詢使用者的業務操作行為，對重要操作回溯；

3、提供一定的管理功能，必要的時候可以對使用者的誤操作復原；

反面實作

明确需求後，就是怎麼實作的問題了，這裡先上一個反面的實作案例，也是因為這一個反面案例，才讓我對這個簡單的需求印象深刻。

這裡我以一個人員管理的功能為例還原一下，當時的具體實作：

1、每個接口裡都加一段記錄業務記錄檔的記錄；

2、每個接口裡都要捕獲一下異常，記錄異常業務記錄檔；

下面是僞代碼：

@RestController
@Slf4j
@BusLog(name = "人員管理")
@RequestMapping("/person")
public class PersonController2 {
    @Autowired
    private IPersonService personService;
    @Autowired
    private IBusLogService busLogService;
    //添加人員資訊
    @PostMapping
    public Person add(@RequestBody Person person) {
       try{
           //添加資訊資訊
        Person result = this.personService.registe(person);
        //儲存業務日志
        this.saveLog(person);
        log.info("//增加person執行完成");        
       }catch(Exception e){
           //儲存異常記錄檔
           this.saveExceptionLog(e);       
       }
        return result;
    }
}

這種通過寫死實作的業務記錄檔管理功能，最大的問題就是業務記錄檔收集與業務邏輯耦合嚴重，和代碼重複，新開發的接口在完成業務邏輯後要織入一段業務記錄檔儲存的邏輯，已開發上線的接口，還要重新再修改織入業務記錄檔儲存的邏輯并測試，且每個接口需要織入的業務記錄檔儲存的邏輯是一樣的。

設計思路

如果對AOP有一些印象的話，最好的方法就是使用aop實作：

1、定義業務記錄檔注解，注解内可以定義一些屬性，如操作功能名稱、功能的描述等；

2、把業務記錄檔注解标記在需要進行業務操作記錄的方法上（在實際業務中，一些簡單的業務查詢行為通常沒有必要記錄）；

3、定義切入點，編寫切面：切入點就是标記了業務記錄檔注解的目标方法；切面的主要邏輯就是儲存業務記錄檔資訊；

Spring AOP

AOP （Aspect Orient Programming）,直譯過來就是面向切面程式設計,AOP 是一種程式設計思想，是面向對象程式設計（OOP）的一種補充。面向切面程式設計，實作在不修改源代碼的情況下給程式動态統一添加額外功能的一種技術，AOP可以攔截指定的方法并且對方法增強，而且無需侵入到業務代碼中，使業務與非業務處理邏輯分離；

而SpringAOP，則是AOP的一種具體實作，Spring内部對SpringAOP的應用最經典的場景就是Spring的事務，通過事務注解的配置，Spring會自動在業務方法中開啟、送出業務，并且在業務處理失敗時，執行相應的復原政策；與過濾器、攔截器相比，更加重要的是其适用範圍不再局限于SpringMVC項目，可以在任意一層定義一個切點，織入相應的操作，并且還可以改變傳回值；

圖檔

Filter和HandlerInterceptor

之是以沒有選擇Filter和HandlerInterceptor，而是AOP來實作業務記錄檔功能，是因為Filter和HandlerInterceptor自身的一些局限性：

過濾器

過濾器（Filter）是與servlet相關聯的一個接口，主要适用于java web項目中，依賴于Servlet容器，是利用java的回調機制來實作過濾攔截來自浏覽器端的http請求，可以攔截到通路URL對應的方法的請求和響應（ServletRequest request, ServletResponse response），但是不能對請求和響應資訊中的值進行修改；一般用于設定字元編碼、鑒權操作等；

如果想要做到更細一點的類和方法或者是在非servlet環境中使用，則是做不到的；是以凡是依賴Servlet容器的環境，過濾器都可以使用，如Struts2、SpringMVC;

圖檔

攔截器

攔截器的（HandlerInterceptor）使用範圍以及功能和過濾器很類似，但是也是有差別的。首先，攔截器（HandlerInterceptor）适用于SpringMVC中，因為HandlerInterceptor接口是SpringMVC相關的一個接口，而實作java Web項目，SpringMVC是目前的首選選項，但不是唯一選項，還有struts2等；是以，如果是非SpingMVC的項目，HandlerInterceptor無法使用的；

其次，和過濾器一樣，攔截器可以攔截到通路URL對應的方法的請求和響應（ServletRequest request, ServletResponse response），但是不能對請求和響應資訊中的值進行修改；一般用于設定字元編碼、鑒權操作等；如果想要做到更細一點的類和方法或者是在非servlet環境中使用，則也是是做不到的；

總之，過濾器和攔截器的功能很類似，但是攔截器的适用範圍比過濾器更小；

圖檔

SpringAOP、過濾器、攔截器對比

在比對中同一目标時，過濾器、攔截器、SpringAOP的執行優先級是：過濾器>攔截器>SpringAOP，執行順序是先進後出，具體的不同則展現在以下幾個方面：

1、作用域不同

過濾器依賴于servlet容器，隻能在 servlet容器，web環境下使用，對請求-響應入口處進行過濾攔截；
攔截器依賴于springMVC，可以在SpringMVC項目中使用，而SpringMVC的核心是DispatcherServlet，而DispatcherServlet又屬于Servlet的子類，是以作用域和過濾器類似；
SpringAOP對作用域沒有限制，隻要定義好切點，可以在請求-響應的入口層（controller層）攔截處理，也可以在請求的業務處理層（service層）攔截處理；

2、顆粒度的不同

過濾器的控制顆粒度比較粗，隻能在doFilter()中對請求和響應進行過慮和攔截處理；
攔截器提供更精細顆粒度的控制，有preHandle()、postHandle()、afterCompletion()，可以在controller對請求處理之前、請求處理後、請求響應完畢織入一些業務操作；
SpringAOP，提供了前置通知、後置通知、傳回後通知、異常通知、環繞通知，比攔截器更加精細化的顆粒度控制，甚至可以修改傳回值；

實作方案

環境配置

jdk版本:1.8開發工具：Intellij iDEA 2020.1
springboot:2.3.9.RELEASE
mybatis-spring-boot-starter：2.1.4

依賴配置

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

表結構設計

create table if not exists bus_log
(
   id bigint auto_increment comment '自增id'
      primary key,
   bus_name varchar(100) null comment '業務名稱',
   bus_descrip varchar(255) null comment '業務操作描述',
   oper_person varchar(100) null comment '操作人',
   oper_time datetime null comment '操作時間',
   ip_from varchar(50) null comment '操作來源ip',
   param_file varchar(255) null comment '操作參數封包檔案'
)
comment '業務記錄檔' default charset ='utf8';

代碼實作

1、定義業務日志注解@BusLog，可以作用在控制器或其他業務類上，用于描述目前類的功能；也可以用于方法上，用于描述目前方法的作用；

/**
 * 業務日志注解
 * 可以作用在控制器或其他業務類上，用于描述目前類的功能；
 * 也可以用于方法上，用于描述目前方法的作用；
 */
@Target({ElementType.METHOD,ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface BusLog {
 
 
    /**
     * 功能名稱
     * @return
     */
    String name() default "";
 
    /**
     * 功能描述
     * @return
     */
    String descrip() default "";
 
}

2、把業務記錄檔注解BusLog标記在PersonController類和方法上；

@RestController
@Slf4j
@BusLog(name = "人員管理")
@RequestMapping("/person")
public class PersonController {
    @Autowired
    private IPersonService personService;
    private Integer maxCount=100;
 
    @PostMapping
    @NeedEncrypt
    @BusLog(descrip = "添加單條人員資訊")
    public Person add(@RequestBody Person person) {
        Person result = this.personService.registe(person);
        log.info("//增加person執行完成");
        return result;
    }
    @PostMapping("/batch")
    @BusLog(descrip = "批量添加人員資訊")
    public String addBatch(@RequestBody List<Person> personList){
        this.personService.addBatch(personList);
        return String.valueOf(System.currentTimeMillis());
    }
 
    @GetMapping
    @NeedDecrypt
    @BusLog(descrip = "人員資訊清單查詢")
    public PageInfo<Person> list(Integer page, Integer limit, String searchValue) {
       PageInfo<Person> pageInfo = this.personService.getPersonList(page,limit,searchValue);
        log.info("//查詢person清單執行完成");
        return pageInfo;
    }
    @GetMapping("/{loginNo}")
    @NeedDecrypt
    @BusLog(descrip = "人員資訊詳情查詢")
    public Person info(@PathVariable String loginNo,String phoneVal) {
        Person person= this.personService.get(loginNo);
        log.info("//查詢person詳情執行完成");
        return person;
    }
    @PutMapping
    @NeedEncrypt
    @BusLog(descrip = "修改人員資訊")
    public String edit(@RequestBody Person person) {
         this.personService.update(person);
        log.info("//查詢person詳情執行完成");
        return String.valueOf(System.currentTimeMillis());
    }
    @DeleteMapping
    @BusLog(descrip = "删除人員資訊")
    public String edit(@PathVariable(name = "id") Integer id) {
         this.personService.delete(id);
        log.info("//查詢person詳情執行完成");
        return String.valueOf(System.currentTimeMillis());
    }
}

3、編寫切面類BusLogAop，并使用@BusLog定義切入點，在環繞通知内執行過目标方法後，擷取目标類、目标方法上的業務日志注解上的功能名稱和功能描述，把方法的參數封包寫入到檔案中，最後儲存業務記錄檔資訊；

@Component
@Aspect
@Slf4j
public class BusLogAop implements Ordered {
    @Autowired
    private BusLogDao busLogDao;
 
    /**
     * 定義BusLogAop的切入點為标記@BusLog注解的方法
     */
    @Pointcut(value = "@annotation(com.fanfu.anno.BusLog)")
    public void pointcut() {
    }
 
    /**
     * 業務操作環繞通知
     *
     * @param proceedingJoinPoint
     * @retur
     */
    @Around("pointcut()")
    public Object around(ProceedingJoinPoint proceedingJoinPoint) {
        log.info("----BusAop 環繞通知 start");
        //執行目标方法
        Object result = null;
        try {
            result = proceedingJoinPoint.proceed();
        } catch (Throwable throwable) {
            throwable.printStackTrace();
        }
        //目标方法執行完成後，擷取目标類、目标方法上的業務日志注解上的功能名稱和功能描述
        Object target = proceedingJoinPoint.getTarget();
        Object[] args = proceedingJoinPoint.getArgs();
        MethodSignature signature = (MethodSignature) proceedingJoinPoint.getSignature();
        BusLog anno1 = target.getClass().getAnnotation(BusLog.class);
        BusLog anno2 = signature.getMethod().getAnnotation(BusLog.class);
        BusLogBean busLogBean = new BusLogBean();
        String logName = anno1.name();
        String logDescrip = anno2.descrip();
        busLogBean.setBusName(logName);
        busLogBean.setBusDescrip(logDescrip);
        busLogBean.setOperPerson("fanfu");
        busLogBean.setOperTime(new Date());
        JsonMapper jsonMapper = new JsonMapper();
        String json = null;
        try {
            json = jsonMapper.writeValueAsString(args);
        } catch (JsonProcessingException e) {
            e.printStackTrace();
        }
        //把參數封包寫入到檔案中
        OutputStream outputStream = null;
        try {
            String paramFilePath = System.getProperty("user.dir") + File.separator + DateUtil.format(new Date(), DatePattern.PURE_DATETIME_MS_PATTERN) + ".log";
            outputStream = new FileOutputStream(paramFilePath);
            outputStream.write(json.getBytes(StandardCharsets.UTF_8));
            busLogBean.setParamFile(paramFilePath);
        } catch (FileNotFoundException e) {
            e.printStackTrace();
        } catch (IOException e) {
            e.printStackTrace();
        } finally {
            if (outputStream != null) {
                try {
                    outputStream.flush();
                    outputStream.close();
                } catch (IOException e) {
                    e.printStackTrace();
                }
 
            }
        }
        //儲存業務記錄檔資訊
        this.busLogDao.insert(busLogBean);
        log.info("----BusAop 環繞通知 end");
        return result;
    }
 
    @Override
    public int getOrder() {
        return 1;
    }
}

測試

調試方法

平時後端調試接口，一般都是使用postman，這裡給大家安利一款工具，即Intellij IDEA的Test RESTful web service，功能和使用和postman差不多，唯一的好處就是不用在電腦上再額外裝個postman，功能入口：工具欄的Tools-->http client-->Test RESTful web

圖檔

另外還有一種用法，我比較喜歡用這種，簡單幾句就可以發起一個http請求，還可以一次批量執行；

圖檔

驗證結果

圖檔

總結

業務記錄檔記錄中包含了使用者操作的功能名稱、功能描述、操作人、操作時間和操作的參數封包，參數封包之是以選擇存儲在檔案中，是因為正常情況下，是不需要知道具體的參數封包，隻有在復原操作的時候才會用到，可以根據上一次的參數封包逆向操作。

原文連結：https://mp.weixin.qq.com/s/wXMF5oCmXa2MnIXZQMvoPg

SpringBoot怎麼設計業務記錄檔功能？

前言

需求描述與分析

系統日志

記錄檔

設計思路

Spring AOP

Filter和HandlerInterceptor

過濾器

攔截器

SpringAOP、過濾器、攔截器對比

實作方案

環境配置

依賴配置

表結構設計

代碼實作

測試

調試方法

驗證結果

總結

繼續閱讀

MyBatis-Plus 之AR模式

馴服爛代碼_馴服Tomcat：Tomcat 5的過濾技巧

基于Springboot+VUE+Mysql的大學生校園疫情防控管理系統

Using MessageConverter

馴服爛代碼_C＃中的馴服配置

Spring Cloud整合Sleuth，當請求完成後，Zipkin沒有鍊路資訊

JAVA自學之路——馬士兵

Rabbitmq指令行手動建立隊列

整合 Spring 開發架構及服務端技術

SSM整合02---Spring-SpringMVC層一、添加web架構支援二、web.xml三、spring-mvc.xml

SSM架構（二）------------表現層的SpringMVC

Intellij idea基于Maven 的SSM 架構整合

Spring資料和Redis

SpringMVC的啟動過程源碼分析1 SpringMVC 配置XML的方式啟動2 SpringMVC純注解模式啟動

Java Spring 架構

SpringCloud微服務（四）之ribbon筆記ribbon是什麼？入門案例自定義均衡負載算法