电脑知识|欧美黑人一区二区三区|软件|欧美黑人一级爽快片淫片高清|系统|欧美黑人狂野猛交老妇|数据库|服务器|编程开发|网络运营|知识问答|技术教程文章 - 好吧啦网

您的位置:首頁技術文章
文章詳情頁

Springboot-注解-操作日志的實現方式

瀏覽:6日期:2023-03-23 14:07:09

此組件解決的問題是:

「誰」在「什么時間」對「什么」做了「什么事」

本組件目前針對 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; }框架的擴展點

重寫OperatorGetServiceImpl通過上下文獲取用戶的擴展,例子如下

@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 保存/查詢日志的例子,使用者可以根據數據量保存到合適的存儲介質上,比如保存在數據庫/或者ES。自己實現保存和刪除就可以了

也可以只實現查詢的接口,畢竟已經保存在業務的存儲上了,查詢業務可以自己實現,不走 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); }}

IParseFunction 自定義轉換函數的接口,可以實現IParseFunction 實現對LogRecord注解中使用的函數擴展

例子:

@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

以上為個人經驗,希望能給大家一個參考,也希望大家多多支持好吧啦網。如有錯誤或未考慮完全的地方,望不吝賜教。

標簽: Spring
相關文章:
主站蜘蛛池模板: 机构创新组合设计实验台_液压实验台_气动实训台-戴育教仪厂 | TMT观察网_独特视角观察TMT行业 派财经_聚焦数字经济内容服务平台 | QQ房产导航-免费收录优秀房地产网站_房地产信息网 | 两头忙,井下装载机,伸缩臂装载机,30装载机/铲车,50装载机/铲车厂家_价格-莱州巨浪机械有限公司 | 螺杆泵_中成泵业| 有机肥设备生产制造厂家,BB掺混肥搅拌机、复合肥设备生产线,有机肥料全部加工设备多少钱,对辊挤压造粒机,有机肥造粒设备 -- 郑州程翔重工机械有限公司 | ISO9001认证咨询_iso9001企业认证代理机构_14001|18001|16949|50430认证-艾世欧认证网 | KBX-220倾斜开关|KBW-220P/L跑偏开关|拉绳开关|DHJY-I隔爆打滑开关|溜槽堵塞开关|欠速开关|声光报警器-山东卓信有限公司 | 卓能JOINTLEAN端子连接器厂家-专业提供PCB接线端子|轨道式端子|重载连接器|欧式连接器等电气连接产品和服务 | 济南律师,济南法律咨询,山东法律顾问-山东沃德律师事务所 | 新型锤式破碎机_新型圆锥式_新型颚式破碎机_反击式打沙机_锤式制砂机_青州建源机械 | 江西高职单独招生-江西单招考试-江西高职单招网 | 回转支承-转盘轴承-回转驱动生产厂家-洛阳隆达轴承有限公司 | 新疆十佳旅行社_新疆旅游报价_新疆自驾跟团游-新疆中西部国际旅行社 | atcc网站,sigma试剂价格,肿瘤细胞现货,人结肠癌细胞株购买-南京科佰生物 | 安规_综合测试仪,电器安全性能综合测试仪,低压母线槽安规综合测试仪-青岛合众电子有限公司 | 专业深孔加工_东莞深孔钻加工_东莞深孔钻_东莞深孔加工_模具深孔钻加工厂-东莞市超耀实业有限公司 | 飞歌臭氧发生器厂家_水处理臭氧发生器_十大臭氧消毒机品牌 | 学生作文网_中小学生作文大全与写作指导| 罗茨真空机组,立式无油往复真空泵,2BV水环真空泵-力侨真空科技 | 数控专用机床,专用机床,自动线,组合机床,动力头,自动化加工生产线,江苏海鑫机床有限公司 | 杜康白酒加盟_杜康酒代理_杜康酒招商加盟官网_杜康酒厂加盟总代理—杜康酒神全国运营中心 | 成都软件开发_OA|ERP|CRM|管理系统定制开发_成都码邻蜀科技 | 郑州水质检测中心_井水检测_河南废气检测_河南中环嘉创检测 | 机器视觉检测系统-视觉检测系统-机器视觉系统-ccd检测系统-视觉控制器-视控一体机 -海克易邦 | 原色会计-合肥注册公司_合肥代理记账公司_营业执照代办 | 智能汉显全自动量热仪_微机全自动胶质层指数测定仪-鹤壁市科达仪器仪表有限公司 | 耳模扫描仪-定制耳机设计软件-DLP打印机-asiga打印机-fitshape「飞特西普」 | 企业微信营销_企业微信服务商_私域流量运营_艾客SCRM官网 | 早报网| 滑板场地施工_极限运动场地设计_滑板公园建造_盐城天人极限运动场地建设有限公司 | 船用锚链|专业锚链生产厂家|安徽亚太锚链制造有限公司 | 众品地板网-地板品牌招商_地板装修设计_地板门户的首选网络媒体。 | 氟氨基酮、氯硝柳胺、2-氟苯甲酸、异香兰素-新晨化工 | 警用|治安|保安|不锈钢岗亭-售货亭价格-垃圾分类亭-移动厕所厂家-苏州灿宇建材 | 山东钢格板|栅格板生产厂家供应商-日照森亿钢格板有限公司 | 圣才学习网-考研考证学习平台,提供万种考研考证电子书、题库、视频课程等考试资料 | 范秘书_懂你的范文小秘书| 全屋整木定制-橱柜,家具定制-四川峨眉山龙马木业有限公司 | 热工多功能信号校验仪-热电阻热电偶校验仿真仪-金湖虹润仪表 | 流变仪-热分析联用仪-热膨胀仪厂家-耐驰科学仪器商贸 |