Java中實現(xiàn)日志記錄的方案總結
在平時使用到一些軟件中,比如某寶或者某書,通過記錄用戶的行為來構建和分析用戶的行為數(shù)據(jù),同時也能更好優(yōu)化產(chǎn)品設計和提升用戶體驗。比如在一個訂單系統(tǒng)中,需要確定追蹤用戶的行為,比如:
- 登錄/登出
- 瀏覽商品
- 加購商品
- 搜索商品關鍵字
- 下單
上述行為就需要使用到日志系統(tǒng)來存儲或者記錄數(shù)據(jù),Java 有幾種日志方案,簡單介紹幾種實現(xiàn)方案,以及需要注意的點。
日志添加需要注意問題
根據(jù)業(yè)務的不同,需要使用匹配到合適的日志方案。也需要注意幾個問題:
- 不能影響原來的業(yè)務邏輯。
- 不能報錯,即使報錯,不能影響原有的業(yè)務代碼。
- 對于耗時的日志代碼,使用異步方法
- 侵入性低,盡量少改動原始代碼
Spring AOP
Spring AOP 通過切面編程實現(xiàn)不修改原有代碼,而動態(tài)添加功能的能力。這種方式有以下幾個好處:
- 侵入性低
- 可重用性強
本文使用基于注解的 AOP,首先定義一個切面注解 AopTest:
/** * 切面注解 */ @Target({ElementType.TYPE, ElementType.METHOD}) @Retention(RetentionPolicy.RUNTIME) public @interface AopTest { }
再創(chuàng)建通知 @Around :
@Around("@annotation(com.test.annotation.AopTest)") public Object annotationTest(ProceedingJoinPoint joinPoint) throws Throwable { log.info("執(zhí)行前"); Object result = joinPoint.proceed(); // 執(zhí)行目標方法 Object[] args = joinPoint.getArgs(); log.info("執(zhí)行后"); return result; }
一般都會在執(zhí)行后
添加日志即可,想要在那個方法或者接口加日志,只需要在方法上添加注解即可,比如在接口添加注解:
@GetMapping @AopTest public String first(String param) { log.info("執(zhí)行first方法"); return "result " + param; }
請求接口后,就有如下的輸出:
執(zhí)行前
執(zhí)行first方法
執(zhí)行后
但是切面有一個問題,執(zhí)行切面報錯,方法也無法執(zhí)行,就需要捕獲異常,保證業(yè)務代碼正常執(zhí)行,改造一下上面的通知:
@Around("@annotation(com.test.annotation.AopTest)") public Object annotationTest(ProceedingJoinPoint joinPoint) throws Throwable {log.info("執(zhí)行前"); log.info("執(zhí)行前"); Object result = joinPoint.proceed(); // 執(zhí)行目標方法 try { Object[] args = joinPoint.getArgs(); // 添加日志 log.info("執(zhí)行后"); int a = 1/0; } catch (Exception e) { log.error(e.getMessage()); } return result; }
改造后,即使切面報錯,也不會影響業(yè)務代碼的執(zhí)行了。
AOP 是同步執(zhí)行的,如果日志添加是一個比較耗時的操作,也會影響接口的響應速度,此時可以使用異步的方式,比如消息隊列。
總結一下,Spring AOP 有以下幾個優(yōu)點和缺點。
優(yōu)點:
- 侵入性低
- 可重用性強
缺點及解決方案:
1、切面報錯可能會影響業(yè)務代碼
問題:在切面的異常如果沒有正確處理,可能會影響業(yè)務代碼的正常執(zhí)行。
解決方案:
- 捕獲異常,確保業(yè)務代碼正常執(zhí)行
- 一般使用try catch 捕獲異常,防止向上傳播
2、同步執(zhí)行會影響接口響應速度
問題:如果切面中存在耗時的操作,同步操作會導致接口的響應速度變慢。
解決方案:
- 通過消息隊列將耗時操作異步執(zhí)行
- 使用 @Async 將方法異步執(zhí)行,將任務從主線程脫離出來,交給其他線程池執(zhí)行
事件監(jiān)聽 + 異步
Spring 事件監(jiān)聽機制是一種發(fā)布-訂閱
模式,將事件的發(fā)布和監(jiān)聽解耦開來。通過這種機制,事件的發(fā)布者無需關注監(jiān)聽的邏輯,監(jiān)聽者也無需直接依賴發(fā)布者。
Spring 事件監(jiān)聽有三個部分組成:
1.事件
自定義一個事件,繼承 ApplicationEvent:
@Getter @Setter public class DemoEvent extends ApplicationEvent { private String name; public DemoEvent(Object source) { super(source); } }
2.事件監(jiān)聽
基于 @EventListener 注解監(jiān)聽事件:
@Component @Slf4j public class DemoEventListener { @EventListener public void handleEvent(DemoEvent event){ log.info(event.getName()); log.info("事件監(jiān)聽"); } }
3.事件發(fā)布
使用 applicationEventPublisher.publishEvent 方法發(fā)布事件,
@Autowired private ApplicationEventPublisher applicationEventPublisher; @Override public void publish() { // 執(zhí)行業(yè)務代碼 log.info("執(zhí)行登錄,當前時間 {}",LocalTime.now()); DemoEvent event = new DemoEvent(this); event.setName("hello"); applicationEventPublisher.publishEvent(event); log.info("完成登錄,當前時間 {}",LocalTime.now()); log.info("執(zhí)行 service"); }
配置好事件的發(fā)布和監(jiān)聽之后,在業(yè)務代碼添加事件的發(fā)布,監(jiān)聽方法內(nèi)添加日志的記錄。
Spring 事件監(jiān)聽雖然解耦了發(fā)布和監(jiān)聽,只是解耦邏輯代碼,兩者還是同步執(zhí)行
,并且都是在同一個線程執(zhí)行的,所以事件監(jiān)聽也無法解決添加日志報錯,以及耗時的問題。
4.驗證監(jiān)聽方法是否同步
在事件監(jiān)聽添加延遲:
@EventListener public void handleEvent(DemoEvent event){ try { Thread.sleep(2000); } catch (InterruptedException e) { e.printStackTrace(); } log.info(event.getName()); log.info("事件監(jiān)聽"); }
控制臺輸出:
執(zhí)行登錄,當前時間 16:52:30.799
hello
事件監(jiān)聽
完成登錄,當前時間 16:52:33.799
執(zhí)行 service
接口執(zhí)行了 3 秒多,并且 publish 方法要等待監(jiān)聽方法執(zhí)行完畢之后才能執(zhí)行,說明事件監(jiān)聽是同步的
。
5.驗證監(jiān)聽方法報錯是否會影響主流程
在監(jiān)聽方法添加錯誤代碼:
@EventListener public void handleEvent(DemoEvent event){ int a = 1/0; log.info(event.getName()); log.info("事件監(jiān)聽"); }
控制臺輸出:
執(zhí)行登錄,當前時間 17:10:08.396
java.lang.ArithmeticException: / by zero
監(jiān)聽方法報錯,接口也報錯,業(yè)務代碼無法執(zhí)行,說明監(jiān)聽方法報錯會影響事件發(fā)布方法
。
解決報錯的問題,使用異常捕獲即可。而延遲的問題,就需要使用到異步
的操作,異步就是另啟一個線程執(zhí)行監(jiān)聽方法
,異步除了能解決延遲的問題,也順便解決了報錯的問題。
實現(xiàn)異步在監(jiān)聽方法上添加 @Async 異步注解,監(jiān)聽方法添加延遲和錯誤代碼:
執(zhí)行登錄,當前時間 17:21:50.971
完成登錄,當前時間 17:21:50.974
執(zhí)行 service
publish 方法既不會延遲,也不會因為監(jiān)聽報錯影響執(zhí)行,異步完美解決耗時和報錯的問題
消息隊列
海量日志場景,消息隊列是一個很好的選擇,它也是解耦了發(fā)布者和訂閱者,如果訂閱者開啟了手動確認,消費者也需要使用 try catch 捕獲異常信息,確保消息能正常消費。
總結
本文介紹幾種日志記錄的實現(xiàn)方案:
Spring AOP
:- 優(yōu)點: 侵入性低,代碼可重復性強
- 問題以及解決方案:
- 切面中可能會報錯,報錯會影響業(yè)務代碼的正常執(zhí)行,解決方法是使用 try catch 捕獲異常。
- 日志記錄會影響業(yè)務代碼執(zhí)行效率,可以使用消息隊列異步執(zhí)行日志操作
事件監(jiān)聽 + 異步
:- 優(yōu)點: 解耦業(yè)務邏輯和日志記錄,提升代碼的內(nèi)聚性。
- 缺點以及解決方案:
- AOP 存在的問題,事件監(jiān)聽同樣存在,報錯和耗時都會影響業(yè)務代碼。報錯可以使用異常捕獲,延遲問題可以使用異步方式解決,而異步另起線程也順便解決了報錯影響業(yè)務代碼的問題。
消息隊列
:- 優(yōu)點: 使用于高并發(fā)日記記錄場景
- 問題: 增加系統(tǒng)的復雜性和穩(wěn)定性,還需要考慮消息的丟失和重復消費問題。
到此這篇關于Java中實現(xiàn)日志記錄的方案總結的文章就介紹到這了,更多相關Java日志記錄內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家!
相關文章
spring-boot-starter-parent的作用詳解
這篇文章主要介紹了spring-boot-starter-parent的作用詳解,本文給大家介紹的非常詳細,對大家的學習或工作具有一定的參考借鑒價值,需要的朋友可以參考下2022-08-08springboot+vue實現(xiàn)阿里云oss上傳的示例代碼
文件上傳是常用的功能,本文主要介紹了springboot+vue實現(xiàn)阿里云oss上傳的示例代碼,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧2024-06-06如何通過Java實現(xiàn)PDF轉高質(zhì)量圖片
在Java中,將PDF文件轉換為高質(zhì)量的圖片可以使用不同的庫,其中最常用的庫之一是?Apache?PDFBox,下面我們就來看看這個庫的具體使用吧2024-10-10詳解Java的內(nèi)置異常以及創(chuàng)建自定義異常子類的方法
這篇文章主要介紹了詳解Java的內(nèi)置異常以及創(chuàng)建自定義異常子類的方法,是Java入門學習中的基礎知識,需要的朋友可以參考下2015-09-09Java Synchronize下的volatile關鍵字詳解
這篇文章主要介紹了Java Synchronize下的volatile關鍵字詳解,本文給大家介紹的非常詳細,對大家的學習或工作具有一定的參考借鑒價值,需要的朋友可以參考下2021-03-03win10操作系統(tǒng)下重啟電腦java環(huán)境變量失效
這篇文章主要介紹了win10操作系統(tǒng)下重啟電腦java環(huán)境變量失效,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧2020-09-09