前言

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

需求描述與分析

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

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

系統日志

這里的系統日志是指的是程式執行程序中的關鍵步驟，根據實際場景輸出的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;
    }
}

這種通過硬編碼實作的業務操作日志管理功能，最大的問題就是業務操作日志收集與業務邏輯耦合嚴重，和代碼重復，新開發的介面在完成業務邏輯后要織入一段業務操作日志保存的邏輯，已開發上線的介面，還要重新再修改織入業務操作日志保存的邏輯并測驗，且每個介面需要織入的業務操作日志保存的邏輯是一樣的，

推薦一個開源免費的 Spring Boot 實戰專案：

https://github.com/javastacks/spring-boot-best-practice

設計思路

如果對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 = "https://www.cnblogs.com/javastack/p/@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