前言

很久以前都想寫這篇文章，一直沒有空，但直到現(xiàn)在我對當(dāng)時的情景還有印象，之所以有印象是因?yàn)樾枨蠛芎唵?，業(yè)務(wù)操作日志的記錄與查詢的功能，但是具體實(shí)現(xiàn)真的很爛，具體的爛法會在反面示例里細(xì)說，領(lǐng)導(dǎo)以及客戶層面很認(rèn)可，一系列迷之操作，讓我印象深刻。

(相關(guān)資料圖)

需求描述與分析

客戶側(cè)提出需求很簡單：要對幾個關(guān)鍵的業(yè)務(wù)功能進(jìn)行操作日志記錄，即什么人在什么時間操作了哪個功能，操作前的數(shù)據(jù)報(bào)文是什么、操作后的數(shù)據(jù)報(bào)文是什么，必要的時候可以一鍵回退。

日志在業(yè)務(wù)系統(tǒng)中是必不可少的一個功能，常見的有系統(tǒng)日志、操作日志等：

系統(tǒng)日志

這里的系統(tǒng)日志是指的是程序執(zhí)行過程中的關(guān)鍵步驟，根據(jù)實(shí)際場景輸出的debug、info、warn、error等不同級別的程序執(zhí)行記錄信息，這些一般是給程序員或運(yùn)維看的，一般在出現(xiàn)異常問題的時候，可以通過系統(tǒng)日志中記錄的關(guān)鍵參數(shù)信息和異常提示，快速排除故障。

操作日志

操作日志，是用戶實(shí)際業(yè)務(wù)操作行為的記錄，這些信息一般存儲在數(shù)據(jù)庫里，如什么時間哪個用戶點(diǎn)了某個菜單、修改了哪個配置等這類業(yè)務(wù)操作行為，這些日志信息是給普通用戶或系統(tǒng)管理員看到。

通過對需求的分析，客戶想要是一個業(yè)務(wù)操作日志管理的功能：

1、記錄用戶的業(yè)務(wù)操作行為，記錄的字段有：操作人、操作時間、操作功能、日志類型、操作內(nèi)容描述、操作內(nèi)容報(bào)文、操作前內(nèi)容報(bào)文

2、提供一個可視化的頁面，可以查詢用戶的業(yè)務(wù)操作行為，對重要操作回溯；

3、提供一定的管理功能，必要的時候可以對用戶的誤操作回滾；

反面實(shí)現(xiàn)

明確需求后，就是怎么實(shí)現(xiàn)的問題了，這里先上一個反面的實(shí)現(xiàn)案例，也是因?yàn)檫@一個反面案例，才讓我對這個簡單的需求印象深刻。

這里我以一個人員管理的功能為例還原一下，當(dāng)時的具體實(shí)現(xiàn)：

1、每個接口里都加一段記錄業(yè)務(wù)操作日志的記錄；

2、每個接口里都要捕獲一下異常，記錄異常業(yè)務(wù)操作日志；

下面是偽代碼：

@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);        //保存業(yè)務(wù)日志        this.saveLog(person);        log.info("http://增加person執(zhí)行完成");               }catch(Exception e){           //保存異常操作日志           this.saveExceptionLog(e);              }        return result;    }}

這種通過硬編碼實(shí)現(xiàn)的業(yè)務(wù)操作日志管理功能，最大的問題就是業(yè)務(wù)操作日志收集與業(yè)務(wù)邏輯耦合嚴(yán)重，和代碼重復(fù)，新開發(fā)的接口在完成業(yè)務(wù)邏輯后要織入一段業(yè)務(wù)操作日志保存的邏輯，已開發(fā)上線的接口，還要重新再修改織入業(yè)務(wù)操作日志保存的邏輯并測試，且每個接口需要織入的業(yè)務(wù)操作日志保存的邏輯是一樣的。

推薦一個開源免費(fèi)的 Spring Boot 實(shí)戰(zhàn)項(xiàng)目：

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

設(shè)計(jì)思路

如果對AOP有一些印象的話，最好的方法就是使用aop實(shí)現(xiàn)：

1、定義業(yè)務(wù)操作日志注解，注解內(nèi)可以定義一些屬性，如操作功能名稱、功能的描述等；

2、把業(yè)務(wù)操作日志注解標(biāo)記在需要進(jìn)行業(yè)務(wù)操作記錄的方法上（在實(shí)際業(yè)務(wù)中，一些簡單的業(yè)務(wù)查詢行為通常沒有必要記錄）；

3、定義切入點(diǎn)，編寫切面：切入點(diǎn)就是標(biāo)記了業(yè)務(wù)操作日志注解的目標(biāo)方法；切面的主要邏輯就是保存業(yè)務(wù)操作日志信息；

Spring AOP

AOP （Aspect Orient Programming）,直譯過來就是 面向切面編程,AOP 是一種編程思想，是面向?qū)ο缶幊蹋∣OP）的一種補(bǔ)充。面向切面編程，實(shí)現(xiàn)在不修改源代碼的情況下給程序動態(tài)統(tǒng)一添加額外功能的一種技術(shù)，AOP可以攔截指定的方法并且對方法增強(qiáng)，而且無需侵入到業(yè)務(wù)代碼中，使業(yè)務(wù)與非業(yè)務(wù)處理邏輯分離；

而SpringAOP，則是AOP的一種具體實(shí)現(xiàn)，Spring內(nèi)部對SpringAOP的應(yīng)用最經(jīng)典的場景就是Spring的事務(wù)，通過事務(wù)注解的配置，Spring會自動在業(yè)務(wù)方法中開啟、提交業(yè)務(wù)，并且在業(yè)務(wù)處理失敗時，執(zhí)行相應(yīng)的回滾策略；與過濾器、攔截器相比，更加重要的是其適用范圍不再局限于SpringMVC項(xiàng)目，可以在任意一層定義一個切點(diǎn)，織入相應(yīng)的操作，并且還可以改變返回值；

Filter和HandlerInterceptor

之所以沒有選擇Filter和HandlerInterceptor，而是AOP來實(shí)現(xiàn)業(yè)務(wù)操作日志功能，是因?yàn)镕ilter和HandlerInterceptor自身的一些局限性：

過濾器

過濾器（Filter）是與servlet相關(guān)聯(lián)的一個接口，主要適用于java web項(xiàng)目中，依賴于Servlet容器，是利用java的回調(diào)機(jī)制來實(shí)現(xiàn)過濾攔截來自瀏覽器端的http請求，可以攔截到訪問URL對應(yīng)的方法的請求和響應(yīng)（ServletRequest request, ServletResponse response），但是不能對請求和響應(yīng)信息中的值進(jìn)行修改；一般用于設(shè)置字符編碼、鑒權(quán)操作等；

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

攔截器

攔截器的（HandlerInterceptor）使用范圍以及功能和過濾器很類似，但是也是有區(qū)別的。首先，攔截器（HandlerInterceptor）適用于SpringMVC中，因?yàn)镠andlerInterceptor接口是SpringMVC相關(guān)的一個接口，而實(shí)現(xiàn)java Web項(xiàng)目，SpringMVC是目前的首選選項(xiàng)，但不是唯一選項(xiàng)，還有struts2等；因此，如果是非SpingMVC的項(xiàng)目，HandlerInterceptor無法使用的；

其次，和過濾器一樣，攔截器可以攔截到訪問URL對應(yīng)的方法的請求和響應(yīng)（ServletRequest request, ServletResponse response），但是不能對請求和響應(yīng)信息中的值進(jìn)行修改；一般用于設(shè)置字符編碼、鑒權(quán)操作等；如果想要做到更細(xì)一點(diǎn)的類和方法或者是在非servlet環(huán)境中使用，則也是是做不到的；

總之，過濾器和攔截器的功能很類似，但是攔截器的適用范圍比過濾器更?。?/p>

SpringAOP、過濾器、攔截器對比

在匹配中同一目標(biāo)時，過濾器、攔截器、SpringAOP的執(zhí)行優(yōu)先級是：過濾器>攔截器>SpringAOP，執(zhí)行順序是先進(jìn)后出，具體的不同則體現(xiàn)在以下幾個方面：

1、作用域不同

• 過濾器依賴于servlet容器，只能在 servlet容器，web環(huán)境下使用，對請求-響應(yīng)入口處進(jìn)行過濾攔截；
• 攔截器依賴于springMVC，可以在SpringMVC項(xiàng)目中使用，而SpringMVC的核心是DispatcherServlet，而DispatcherServlet又屬于Servlet的子類，因此作用域和過濾器類似；
• SpringAOP對作用域沒有限制，只要定義好切點(diǎn)，可以在請求-響應(yīng)的入口層（controller層）攔截處理，也可以在請求的業(yè)務(wù)處理層（service層）攔截處理；

2、顆粒度的不同

• 過濾器的控制顆粒度比較粗，只能在doFilter()中對請求和響應(yīng)進(jìn)行過慮和攔截處理；
• 攔截器提供更精細(xì)顆粒度的控制，有preHandle()、postHandle()、afterCompletion()，可以在controller對請求處理之前、請求處理后、請求響應(yīng)完畢織入一些業(yè)務(wù)操作；
• SpringAOP，提供了前置通知、后置通知、返回后通知、異常通知、環(huán)繞通知，比攔截器更加精細(xì)化的顆粒度控制，甚至可以修改返回值；

實(shí)現(xiàn)方案

環(huán)境配置

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

依賴配置

    org.springframework.boot    spring-boot-starter-aop

表結(jié)構(gòu)設(shè)計(jì)

create table if not exists bus_log(   id bigint auto_increment comment "自增id"      primary key,   bus_name varchar(100) null comment "業(yè)務(wù)名稱",   bus_descrip varchar(255) null comment "業(yè)務(wù)操作描述",   oper_person varchar(100) null comment "操作人",   oper_time datetime null comment "操作時間",   ip_from varchar(50) null comment "操作來源ip",   param_file varchar(255) null comment "操作參數(shù)報(bào)文文件")comment "業(yè)務(wù)操作日志" default charset ="utf8";

代碼實(shí)現(xiàn)

1、定義業(yè)務(wù)日志注解@BusLog，可以作用在控制器或其他業(yè)務(wù)類上，用于描述當(dāng)前類的功能；也可以用于方法上，用于描述當(dāng)前方法的作用；

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

2、把業(yè)務(wù)操作日志注解BusLog標(biāo)記在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("http://增加person執(zhí)行完成");        return result;    }    @PostMapping("/batch")    @BusLog(descrip = "批量添加人員信息")    public String addBatch(@RequestBody List personList){        this.personService.addBatch(personList);        return String.valueOf(System.currentTimeMillis());    }     @GetMapping    @NeedDecrypt    @BusLog(descrip = "人員信息列表查詢")    public PageInfo list(Integer page, Integer limit, String searchValue) {       PageInfo pageInfo = this.personService.getPersonList(page,limit,searchValue);        log.info("http://查詢person列表執(zhí)行完成");        return pageInfo;    }    @GetMapping("/{loginNo}")    @NeedDecrypt    @BusLog(descrip = "人員信息詳情查詢")    public Person info(@PathVariable String loginNo,String phoneVal) {        Person person= this.personService.get(loginNo);        log.info("http://查詢person詳情執(zhí)行完成");        return person;    }    @PutMapping    @NeedEncrypt    @BusLog(descrip = "修改人員信息")    public String edit(@RequestBody Person person) {         this.personService.update(person);        log.info("http://查詢person詳情執(zhí)行完成");        return String.valueOf(System.currentTimeMillis());    }    @DeleteMapping    @BusLog(descrip = "刪除人員信息")    public String edit(@PathVariable(name = "id") Integer id) {         this.personService.delete(id);        log.info("http://查詢person詳情執(zhí)行完成");        return String.valueOf(System.currentTimeMillis());    }}

3、編寫切面類BusLogAop，并使用@BusLog定義切入點(diǎn)，在環(huán)繞通知內(nèi)執(zhí)行過目標(biāo)方法后，獲取目標(biāo)類、目標(biāo)方法上的業(yè)務(wù)日志注解上的功能名稱和功能描述， 把方法的參數(shù)報(bào)文寫入到文件中，最后保存業(yè)務(wù)操作日志信息；

@Component@Aspect@Slf4jpublic class BusLogAop implements Ordered {    @Autowired    private BusLogDao busLogDao;     /**     * 定義BusLogAop的切入點(diǎn)為標(biāo)記@BusLog注解的方法     */    @Pointcut(value = "@annotation(com.fanfu.anno.BusLog)")    public void pointcut() {    }     /**     * 業(yè)務(wù)操作環(huán)繞通知     *     * @param proceedingJoinPoint     * @retur     */    @Around("pointcut()")    public Object around(ProceedingJoinPoint proceedingJoinPoint) {        log.info("----BusAop 環(huán)繞通知 start");        //執(zhí)行目標(biāo)方法        Object result = null;        try {            result = proceedingJoinPoint.proceed();        } catch (Throwable throwable) {            throwable.printStackTrace();        }        //目標(biāo)方法執(zhí)行完成后，獲取目標(biāo)類、目標(biāo)方法上的業(yè)務(wù)日志注解上的功能名稱和功能描述        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();        }        //把參數(shù)報(bào)文寫入到文件中        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();                }             }        }        //保存業(yè)務(wù)操作日志信息        this.busLogDao.insert(busLogBean);        log.info("----BusAop 環(huán)繞通知 end");        return result;    }     @Override    public int getOrder() {        return 1;    }}

測試

調(diào)試方法

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

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

驗(yàn)證結(jié)果

總結(jié)

業(yè)務(wù)操作日志記錄中包含了用戶操作的功能名稱、功能描述、操作人、操作時間和操作的參數(shù)報(bào)文，參數(shù)報(bào)文之所以選擇存儲在文件中，是因?yàn)檎Ｇ闆r下，是不需要知道具體的參數(shù)報(bào)文，只有在回滾操作的時候才會用到，可以根據(jù)上一次的參數(shù)報(bào)文逆向操作。

版權(quán)聲明：本文為CSDN博主「凡夫販夫」的原創(chuàng)文章，遵循CC 4.0 BY-SA版權(quán)協(xié)議，轉(zhuǎn)載請附上原文出處鏈接及本聲明。原文鏈接：https://blog.csdn.net/fox9916/article/details/130175379

近期熱文推薦：

1.1,000+ 道 Java面試題及答案整理(2022最新版)

2.勁爆！Java 協(xié)程要來了。。。

3.Spring Boot 2.x 教程，太全了！

4.別再寫滿屏的爆爆爆炸類了，試試裝飾器模式，這才是優(yōu)雅的方式?。?/p>

5.《Java開發(fā)手冊（嵩山版）》最新發(fā)布，速速下載！

覺得不錯，別忘了隨手點(diǎn)贊+轉(zhuǎn)發(fā)哦！

免責(zé)聲明：以上內(nèi)容為本網(wǎng)站轉(zhuǎn)自其它媒體，相關(guān)信息僅為傳遞更多信息之目的，不代表本網(wǎng)觀點(diǎn)，亦不代表本網(wǎng)站贊同其觀點(diǎn)或證實(shí)其內(nèi)容的真實(shí)性。如稿件版權(quán)單位或個人不想在本網(wǎng)發(fā)布，可與本網(wǎng)聯(lián)系，本網(wǎng)視情況可立即將其撤除。