點選「 IT碼徒 」， 關註，置頂 公眾號

每日技術幹貨，第一時間送達！

此元件解決的問題是： 「誰」在「什麽時間」對「什麽」做了「什麽事」

本元件目前針對 Spring-boot 做了 Autoconfig，如果是 SpringMVC，也可自己在 xml 初始化 bean

1

使用方式

基本使用

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 {
publicstaticvoidmain(String[] args) {
SpringApplication.run(Main. class, args);
}
}


日誌埋點

1. 普通的記錄日誌

@LogRecordAnnotation(success = "{{#order.purchaseName}}下了一個訂單,購買商品「{{#order.productName}}」,下單結果:{{#_ret}}",
prefix = LogRecordType.ORDER, bizNo = "{{#order.orderNo}}")
publicbooleancreateOrder(Order order){
log.info("【建立訂單】orderNo={}", order.getOrderNo());
// db insert order
returntrue;
}

此時會打印操作日誌 「張三下了一個訂單,購買商品「超值優惠紅燒肉套餐」,下單結果:true」

2. 期望記錄失敗的日誌, 如果丟擲異常則記錄fail的日誌，沒有丟擲記錄 success 的日誌

@LogRecordAnnotation(
fail = "建立訂單失敗，失敗原因：「{{#_errorMsg}}」",
success = "{{#order.purchaseName}}下了一個訂單,購買商品「{{#order.productName}}」,下單結果:{{#_ret}}",
prefix = LogRecordType.ORDER, bizNo = "{{#order.orderNo}}")
publicbooleancreateOrder(Order order){
log.info("【建立訂單】orderNo={}", order.getOrderNo());
// db insert order
returntrue;
}

其中的 #_errorMsg 是取的方法丟擲異常後的異常的 errorMessage。

3. 日誌支持種類

比如一個訂單的操作日誌，有些操作日誌是使用者自己操作的，有些操作是系統營運人員做了修改產生的操作日誌，我們系統不希望把營運的操作日誌暴露給使用者看到， 但是營運期望可以看到使用者的日誌以及營運自己操作的日誌，這些操作日誌的bizNo都是訂單號，所以為了擴充套件添加了型別欄位,主要是為了對日誌做分類，查詢方便，支持更多的業務。

@LogRecordAnnotation(
fail = "建立訂單失敗，失敗原因：「{{#_errorMsg}}」",
category = "MANAGER",
success = "{{#order.purchaseName}}下了一個訂單,購買商品「{{#order.productName}}」,下單結果:{{#_ret}}",
prefix = LogRecordType.ORDER, bizNo = "{{#order.orderNo}}")
publicbooleancreateOrder(Order order){
log.info("【建立訂單】orderNo={}", order.getOrderNo());
// db insert order
returntrue;
}

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}}")
publicbooleancreateOrder(Order order){
log.info("【建立訂單】orderNo={}", order.getOrderNo());
// db insert order
returntrue;
}

5. 如何指定操作日誌的操作人是什麽？框架提供了兩種方法

@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
returntrue;
}

這種方法手工指定，需要方法參數上有 operator 參數，或者透過 SpEL 呼叫靜態方法獲取當前使用者。

@Configuration
public classLogRecordConfiguration{
@Bean
public IOperatorGetService operatorGetService(){
return () -> Optional.of(OrgUserUtils.getCurrentUser())
.map(a -> new OperatorDO(a.getMisId()))
.orElseThrow(() -> new IllegalArgumentException("user is null"));
}
}
//也可以這麽搞：
@Service
public classDefaultOperatorGetServiceImplimplementsIOperatorGetService{
@Override
public OperatorDO getUser(){
OperatorDO operatorDO = new OperatorDO();
operatorDO.setOperatorId("SYSTEM");
return operatorDO;
}
}




6. 日誌文案調整

對於更新等方法，方法的參數上大部份都是訂單ID、或者產品ID等， 比如下面的例子：日誌記錄的success內容是：「更新了訂單{{#orderId}},更新內容為…」，這種對於營運或者產品來說難以理解，所以引入了自訂函式的功能。使用方法是在原來的變量的兩個大括弧之間加一個函式名稱 例如 「{ORDER{#orderId}}」 其中 ORDER 是一個函式名稱。只有一個函式名稱是不夠的,需要添加這個函式的定義和實作。可以看下面例子 自訂的函式需要實作框架裏面的IParseFunction的介面，需要實作兩個方法：

這裏有個問題：加了自訂函式後，框架怎麽能呼叫到呢？答：對於Spring boot套用很簡單，只需要把它暴露在Spring的上下文中就可以了，可以加上Spring的 @Component 或者 @Service 很方便。Spring mvc 套用需要自己裝配 Bean。

// 沒有使用自訂函式
@LogRecordAnnotation(success = "更新了訂單{{#orderId}},更新內容為....",
prefix = LogRecordType.ORDER, bizNo = "{{#order.orderNo}}",
detail = "{{#order.toString()}}")
publicbooleanupdate(Long orderId, Order order){
returnfalse;
}
//使用了自訂函式，主要是在 {{#orderId}} 的大括弧中間加了 functionName
@LogRecordAnnotation(success = "更新了訂單ORDER{#orderId}},更新內容為...",
prefix = LogRecordType.ORDER, bizNo = "{{#order.orderNo}}",
detail = "{{#order.toString()}}")
publicbooleanupdate(Long orderId, Order order){
returnfalse;
}
// 還需要加上函式的實作
@Component
public classOrderParseFunctionimplementsIParseFunction{
@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;
}

8. 日誌文案調整 模版中使用方法參數之外的變量

可以在方法中透過 LogRecordContext.putVariable(variableName, Object) 的方法添加變量，第一個物件為變量名稱，後面為變量的物件，然後我們就可以使用 SpEL 使用這個變量了。

例如：例子中的 {{#innerOrder.productName}} 是在方法中設定的變量

@Override
@LogRecordAnnotation(
success = "{{#order.purchaseName}}下了一個訂單,購買商品「{{#order.productName}}」,測試變量「{{#innerOrder.productName}}」,下單結果:{{#_ret}}",
prefix = LogRecordType.ORDER, bizNo = "{{#order.orderNo}}")
publicbooleancreateOrder(Order order){
log.info("【建立訂單】orderNo={}", order.getOrderNo());
// db insert order
Order order1 = new Order();
order1.setProductName("內部變量測試");
LogRecordContext.putVariable("innerOrder", order1);
returntrue;
}

9. 函式中使用LogRecordContext的變量

使用 LogRecordContext.putVariable(variableName, Object) 添加的變量除了可以在註解的 SpEL 運算式上使用，還可以在自訂函式中使用,這種方式比較復雜，下面例子中示意了列表的變化，比如從[A,B,C] 改到 [B,D] 那麽日誌顯示：「刪除了A，增加了D」

@LogRecord(success = "{DIFF_LIST{'文件地址'}}", bizNo = "{{#id}}", prefix = REQUIREMENT)
publicvoid updateRequirementDocLink(String currentMisId, Long id, List<String> docLinks) {
RequirementDO requirementDO = getRequirementDOById(id);
LogRecordContext.putVariable("oldList", requirementDO.getDocLinks());
LogRecordContext.putVariable("newList", docLinks);
requirementModule.updateById("docLinks", RequirementUpdateDO.builder()
.id(id)
.docLinks(docLinks)
.updater(currentMisId)
.updateTime(newDate())
.build());
}
@Component
public class DiffListParseFunction implements IParseFunction {
@Override
publicStringfunctionName() {
return"DIFF_LIST";
}
@SuppressWarnings("unchecked")
@Override
publicString apply(String value) {
if (StringUtils.isBlank(value)) {
return value;
}
List<String> oldList = (List<String>) LogRecordContext.getVariable("oldList");
List<String> newList = (List<String>) LogRecordContext.getVariable("newList");
oldList = oldList == null ? Lists.newArrayList() : oldList;
newList = newList == null ? Lists.newArrayList() : newList;
Set<String> deletedSets = Sets.difference(Sets.newHashSet(oldList), Sets.newHashSet(newList));
Set<String> addSets = Sets.difference(Sets.newHashSet(newList), Sets.newHashSet(oldList));
StringBuilder stringBuilder = new StringBuilder();
if (CollectionUtils.isNotEmpty(addSets)) {
stringBuilder.append("新增了 <b>").append(value).append("</b>：");
for (String item : addSets) {
stringBuilder.append(item).append("，");
}
}
if (CollectionUtils.isNotEmpty(deletedSets)) {
stringBuilder.append("刪除了 <b>").append(value).append("</b>：");
for (String item : deletedSets) {
stringBuilder.append(item).append("，");
}
}
return StringUtils.isBlank(stringBuilder) ? null : stringBuilder.substring(0, stringBuilder.length() - 1);
}
}





框架的擴充套件點

@Service
public classDefaultOperatorGetServiceImplimplementsIOperatorGetService{
@Override
public Operator getUser(){
return Optional.ofNullable(UserUtils.getUser())
.map(a -> new Operator(a.getName(), a.getLogin()))
.orElseThrow(()->new IllegalArgumentException("user is null"));
}
}



也可以只實作查詢的介面，畢竟已經保存在業務的儲存上了，查詢業務可以自己實作，不走 ILogRecordService 這個介面，畢竟產品經理會提一些千奇百怪的查詢需求。

@Service
public classDbLogRecordServiceImplimplementsILogRecordService{
@Resource
private LogRecordMapper logRecordMapper;
@Override
@Transactional(propagation = Propagation.REQUIRES_NEW)
publicvoidrecord(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);
}
}





@Component
public class UserParseFunction implements IParseFunction {
private final Splitter splitter = Splitter.on(",").trimResults();
@Resource
@Lazy
private UserQueryService userQueryService;
@Override
publicStringfunctionName() {
return"USER";
}
@Override
// 11,12 返回 11(小明)，12(張三)
publicString 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 方式呼叫靜態方法噢

2

Change Log & TODO

註意點：

整體日誌攔截是在方法執行之後記錄的，所以對於方法內部修改了方法參數之後，LogRecordAnnotation 的註解上的 SpEL 對變量的取值是修改後的值哦～

3

最後

感興趣的小夥伴，可以添加到自己的計畫裏面測試一下哦！

來源：blog.csdn.net/weixin_43954303/article/details/113781801

— END —

PS：防止找不到本篇文章，可以收藏點贊，方便翻閱尋找哦。

往期推薦