此組件解決的問題是：「誰」在「什麼時間」對「什麼」做了「什麼事」
本組件目前針對 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 記錄在日誌的內容中
@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;
}
@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. 支持記錄操作的詳情或者額外信息
@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;
}
@Configuration
public class LogRecordConfiguration {
@Bean
public IOperatorGetService operatorGetService() {
return () -> Optional.of(OrgUserUtils.getCurrentUser())
.map(a -> new OperatorDO(a.getMisId()))
.orElseThrow(() -> new IllegalArgumentException("user is null"));
}
}
//也可以這麼搞：
@Service
public class DefaultOperatorGetServiceImpl implements IOperatorGetService {
@Override
public OperatorDO getUser() {
OperatorDO operatorDO = new OperatorDO();
operatorDO.setOperatorId("SYSTEM");
return operatorDO;
}
}
6. 日誌文案調整
-
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;
}
框架的擴展點
重寫OperatorGetServiceImpl通過上下文獲取用戶的擴展，例子如下
@Service
public 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 保存/查詢日誌的例子,使用者可以根據數據量保存到合適的存儲介質上，比如保存在數據庫/或者ES。自己實現保存和刪除就可以了
也可以只實現查詢的接口，畢竟已經保存在業務的存儲上了，查詢業務可以自己實現，不走 ILogRecordService 這個接口，畢竟產品經理會提一些千奇百怪的查詢需求。
@Service
public 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);
}
}
-
IParseFunction 自定義轉換函數的接口，可以實現IParseFunction 實現對LogRecord註解中使用的函數擴展 例子：
@Component
public 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
Author
![]()
如有文章對你有幫助，
“在看”和轉發是對我最大的支持！
推薦
，
GitHub
書籍倉庫
https://github.com/ebooklist/awesome-ebooks-list
整理了大部分常用 技術書籍PDF，持續更新中... 你需要的技術書籍，這裏可能都有...
點擊文末“閱讀原文”可直達
整理不易，麻煩各位小夥伴在GitHub中來個Star支持一下
本文分享自微信公衆號 - Java專欄（finishbug）。
如有侵權，請聯繫 [email protected] 刪除。
本文參與“OSC源創計劃”，歡迎正在閱讀的你也加入，一起分享。