此元件解決的問題是：「誰」在「什麼時間」對「什麼」做了「什麼事」
本元件目前針對 Spring-boot 做了 Autoconfig，如果是 SpringMVC，也可自己在 xml 初始化 bean
使用方式基本使用
maven依賴新增SDK依賴
<dependency> <groupId>io.github.mouzt</groupId> <artifactId>bizlog-sdk</artifactId> <version>1.0.1</version> </dependency>SpringBoot入口開啟開關,新增 @EnableLogRecord 註解
tenant是代表租戶的標識，一般一個服務或者一個業務下的多個服務都寫死一個 tenant 就可以
@SpringBootApplication(exclude = DataSourceAutoConfiguration.class)@EnableTransactionManagement@EnableLogRecord(tenant = "com.mzt.test")public class Main { public static void main(String[] args) { SpringApplication.run(Main.class, args); }}1. 普通的記錄日誌
pefix：是拼接在 bizNo 上作為 log 的一個標識。避免 bizNo 都為整數 ID 的時候和其他的業務中的 ID 重複。比如訂單 ID、使用者 ID 等bizNo：就是業務的 ID，比如訂單ID，我們查詢的時候可以根據 bizNo 查詢和它相關的操作日誌success：方法呼叫成功後把 success 記錄在日誌的內容中SpEL 表示式：其中用雙大括號包圍起來的（例如：{{#order.purchaseName}}）#order.purchaseName 是 SpEL表示式。Spring中支援的它都支援的。比如呼叫靜態方法，三目表示式。SpEL 可以使用方法中的任何引數 @LogRecordAnnotation(success = "{{#order.purchaseName}}下了一個訂單,購買商品「{{#order.productName}}」,下單結果:{{#_ret}}", prefix = LogRecordType.ORDER, bizNo = "{{#order.orderNo}}") public boolean createOrder(Order order) { log.info("【建立訂單】orderNo={}", order.getOrderNo()); // db insert order return true; }此時會列印操作日誌 “張三下了一個訂單,購買商品「超值優惠紅燒肉套餐」,下單結果:true”
2. 期望記錄失敗的日誌, 如果丟擲異常則記錄fail的日誌，沒有丟擲記錄 success 的日誌
@LogRecordAnnotation( fail = "建立訂單失敗，失敗原因：「{{#_errorMsg}}」", success = "{{#order.purchaseName}}下了一個訂單,購買商品「{{#order.productName}}」,下單結果:{{#_ret}}", prefix = LogRecordType.ORDER, bizNo = "{{#order.orderNo}}") public boolean createOrder(Order order) { log.info("【建立訂單】orderNo={}", order.getOrderNo()); // db insert order return true; }其中的 #_errorMsg 是取的方法丟擲異常後的異常的 errorMessage。
3. 日誌支援種類
比如一個訂單的操作日誌，有些操作日誌是使用者自己操作的，有些操作是系統運營人員做了修改產生的操作日誌，我們系統不希望把運營的操作日誌暴露給使用者看到， 但是運營期望可以看到使用者的日誌以及運營自己操作的日誌，這些操作日誌的bizNo都是訂單號，所以為了擴充套件添加了型別欄位,主要是為了對日誌做分類，查詢方便，支援更多的業務。
@LogRecordAnnotation( fail = "建立訂單失敗，失敗原因：「{{#_errorMsg}}」", category = "MANAGER", success = "{{#order.purchaseName}}下了一個訂單,購買商品「{{#order.productName}}」,下單結果:{{#_ret}}", prefix = LogRecordType.ORDER, bizNo = "{{#order.orderNo}}") public boolean createOrder(Order order) { log.info("【建立訂單】orderNo={}", order.getOrderNo()); // db insert order return true; }4. 支援記錄操作的詳情或者額外資訊
如果一個操作修改了很多欄位，但是success的日誌模版裡面防止過長不能把修改詳情全部展示出來，這時候需要把修改的詳情儲存到 detail 欄位， detail 是一個 String ，需要自己序列化。這裡的 #order.toString() 是呼叫了 Order 的 toString() 方法。如果儲存 JSON，自己重寫一下 Order 的 toString() 方法就可以。
@LogRecordAnnotation( fail = "建立訂單失敗，失敗原因：「{{#_errorMsg}}」", category = "MANAGER_VIEW", detail = "{{#order.toString()}}", success = "{{#order.purchaseName}}下了一個訂單,購買商品「{{#order.productName}}」,下單結果:{{#_ret}}", prefix = LogRecordType.ORDER, bizNo = "{{#order.orderNo}}") public boolean createOrder(Order order) { log.info("【建立訂單】orderNo={}", order.getOrderNo()); // db insert order return true; }5. 如何指定操作日誌的操作人是什麼？框架提供了兩種方法
第一種：手工在LogRecord的註解上指定。這種需要方法引數上有operator @LogRecordAnnotation( fail = "建立訂單失敗，失敗原因：「{{#_errorMsg}}」", category = "MANAGER_VIEW", detail = "{{#order.toString()}}", operator = "{{#currentUser}}", success = "{{#order.purchaseName}}下了一個訂單,購買商品「{{#order.productName}}」,下單結果:{{#_ret}}", prefix = LogRecordType.ORDER, bizNo = "{{#order.orderNo}}") public boolean createOrder(Order order, String currentUser) { log.info("【建立訂單】orderNo={}", order.getOrderNo()); // db insert order return true; }這種方法手工指定，需要方法引數上有 operator 引數，或者透過 SpEL 呼叫靜態方法獲取當前使用者。
第二種：透過預設實現類來自動的獲取操作人，由於在大部分web應用中當前的使用者都是儲存在一個執行緒上下文中的，所以每個註解都加一個operator獲取操作人顯得有些重複勞動，所以提供了一個擴充套件介面來獲取操作人 框架提供了一個擴充套件介面，使用框架的業務可以 implements 這個介面自己實現獲取當前使用者的邏輯， 對於使用 Springboot 的只需要實現 IOperatorGetService 介面，然後把這個 Service 作為一個單例放到 Spring 的上下文中。使用 Spring Mvc 的就需要自己手工裝配這些 bean 了。@Configurationpublic class LogRecordConfiguration { @Bean public IOperatorGetService operatorGetService() { return () -> Optional.of(OrgUserUtils.getCurrentUser()) .map(a -> new OperatorDO(a.getMisId())) .orElseThrow(() -> new IllegalArgumentException("user is null")); }}//也可以這麼搞：@Servicepublic class DefaultOperatorGetServiceImpl implements IOperatorGetService { @Override public OperatorDO getUser() { OperatorDO operatorDO = new OperatorDO(); operatorDO.setOperatorId("SYSTEM"); return operatorDO; }}6. 日誌文案調整
對於更新等方法，方法的引數上大部分都是訂單ID、或者產品ID等， 比如下面的例子：日誌記錄的success內容是：“更新了訂單{{#orderId}},更新內容為…”，這種對於運營或者產品來說難以理解，所以引入了自定義函式的功能。使用方法是在原來的變數的兩個大括號之間加一個函式名稱 例如 “{ORDER{#orderId}}” 其中 ORDER 是一個函式名稱。只有一個函式名稱是不夠的,需要新增這個函式的定義和實現。可以看下面例子 自定義的函式需要實現框架裡面的IParseFunction的介面，需要實現兩個方法：
functionName() 方法就返回註解上面的函式名；apply()函式引數是 "{ORDER{#orderId}}"中SpEL解析的#orderId的值，這裡是一個數字1223110，接下來只需要在實現的類中把 ID 轉換為可讀懂的字串就可以了， 一般為了方便排查問題需要把名稱和ID都展示出來，例如："訂單名稱（ID）"的形式。這裡有個問題：加了自定義函式後，框架怎麼能呼叫到呢？答：對於Spring boot應用很簡單，只需要把它暴露在Spring的上下文中就可以了，可以加上Spring的 @Component 或者 @Service 很方便。Spring mvc 應用需要自己裝配 Bean。
// 沒有使用自定義函式 @LogRecordAnnotation(success = "更新了訂單{{#orderId}},更新內容為....", prefix = LogRecordType.ORDER, bizNo = "{{#order.orderNo}}", detail = "{{#order.toString()}}") public boolean update(Long orderId, Order order) { return false; } //使用了自定義函式，主要是在 {{#orderId}} 的大括號中間加了 functionName @LogRecordAnnotation(success = "更新了訂單ORDER{#orderId}},更新內容為...", prefix = LogRecordType.ORDER, bizNo = "{{#order.orderNo}}", detail = "{{#order.toString()}}") public boolean update(Long orderId, Order order) { return false; } // 還需要加上函式的實現 @Component public class OrderParseFunction implements IParseFunction { @Resource @Lazy //為了避免類載入順序的問題 最好為Lazy，沒有問題也可以不加 private OrderQueryService orderQueryService; @Override public String functionName() { // 函式名稱為 ORDER return "ORDER"; } @Override //這裡的 value 可以吧 Order 的JSON物件的傳遞過來，然後反解析拼接一個定製的操作日誌內容 public String apply(String value) { if(StringUtils.isEmpty(value)){ return value; } Order order = orderQueryService.queryOrder(Long.parseLong(value)); //把訂單產品名稱加上便於理解，加上 ID 便於查問題 return order.getProductName().concat("(").concat(value).concat(")"); } }7. 日誌文案調整 使用 SpEL 三目表示式
@LogRecordAnnotation(prefix = LogRecordTypeConstant.CUSTOM_ATTRIBUTE, bizNo = "{{#businessLineId}}", success = "{{#disable ? '停用' : '啟用'}}了自定義屬性{ATTRIBUTE{#attributeId}}") public CustomAttributeVO disableAttribute(Long businessLineId, Long attributeId, boolean disable) { return xxx; }@Servicepublic class DefaultOperatorGetServiceImpl implements IOperatorGetService { @Override public Operator getUser() { return Optional.ofNullable(UserUtils.getUser()) .map(a -> new Operator(a.getName(), a.getLogin())) .orElseThrow(()->new IllegalArgumentException("user is null")); }}也可以只實現查詢的介面，畢竟已經儲存在業務的儲存上了，查詢業務可以自己實現，不走 ILogRecordService 這個介面，畢竟產品經理會提一些千奇百怪的查詢需求。
@Servicepublic class DbLogRecordServiceImpl implements ILogRecordService { @Resource private LogRecordMapper logRecordMapper; @Override @Transactional(propagation = Propagation.REQUIRES_NEW) public void record(LogRecord logRecord) { log.info("【logRecord】log={}", logRecord); LogRecordPO logRecordPO = LogRecordPO.toPo(logRecord); logRecordMapper.insert(logRecordPO); } @Override public List<LogRecord> queryLog(String bizKey, Collection<String> types) { return Lists.newArrayList(); } @Override public PageDO<LogRecord> queryLogByBizNo(String bizNo, Collection<String> types, PageRequestDO pageRequestDO) { return logRecordMapper.selectByBizNoAndCategory(bizNo, types, pageRequestDO); }}@Componentpublic class UserParseFunction implements IParseFunction { private final Splitter splitter = Splitter.on(",").trimResults(); @Resource @Lazy private UserQueryService userQueryService; @Override public String functionName() { return "USER"; } @Override // 11,12 返回 11(小明)，12(張三) public String apply(String value) { if (StringUtils.isEmpty(value)) { return value; } List<String> userIds = Lists.newArrayList(splitter.split(value)); List<User> misDOList = userQueryService.getUserList(userIds); Map<String, User> userMap = StreamUtil.extractMap(misDOList, User::getId); StringBuilder stringBuilder = new StringBuilder(); for (String userId : userIds) { stringBuilder.append(userId); if (userMap.get(userId) != null) { stringBuilder.append("(").append(userMap.get(userId).getUsername()).append(")"); } stringBuilder.append(","); } return stringBuilder.toString().replaceAll(",$", ""); }}LogRecordAnnotation 可以使用的變量出了引數也可以使用返回值#_ret變數，以及異常的錯誤資訊#_errorMsg，也可以透過SpEL的 T 方式呼叫靜態方法噢
待擴充套件實現一個 Log的 Context，可以解決方法引數中沒有的變數但是想使用的問題，初步想法是可以透過在方法中 add 變數的形式實現，很快就可以實現了
注意點：整體日誌攔截是在方法執行之後記錄的，所以對於方法內部修改了方法引數之後，LogRecordAnnotation 的註解上的 SpEL 對變數的取值是修改後的值哦～
原始碼https://github.com/mouzt/mzt-biz-log
連結：https://mp.weixin.qq.com/s/qGqamCIDJeoze-1GezPDRA
最新評論