實現(xiàn) Spring-boot mvc 的接口 request/response 的捕捉應(yīng)用。
前言(造個輪子的理由)
公司是技術(shù)外包服務(wù)公司，經(jīng)常會涉及和不同團隊(遠(yuǎn)程)合作，包括前端，APP 端，接口的請求分析使用頻率非常高，以前一般都是 fiddler 或 charles
或 服務(wù)端打日志解決，所以需要一個小侵入、可視化 、不需要 proxy ，就能進行測試線的接口調(diào)試的。
Jimoos-api-tracer簡介
Spring-boot http接口請求 捕捉
測試線接口/客戶端調(diào)試 必備
定位為: Http接口調(diào)試?yán)?/p>
- 接口查詢
- 詳細(xì)的
Request/Response查詢 - 慢查詢，
eg. >1000ms -
HttpStatus查詢，快速查出 500/400的請求 - 指定路徑
Path查詢
開源項目地址: https://github.com/jimoos-cn/jimoos-api-tracer
[站外圖片上傳中...(image-d4df23-1616551181175)]
歡迎 Star/Fork
Demo 演示（良心云小水管 大家輕拍）
演示地址: http://150.158.189.200:4000/develop/traces
密碼:123456
測試 Http 請求 http://150.158.189.200:4000/v1/pings?q=簡書
快速上手
1. 初始化 數(shù)據(jù)庫
CREATE TABLE `JM_API_TRACE`
(
`id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
`request` text COLLATE utf8mb4_unicode_ci COMMENT '請求',
`response` longtext COLLATE utf8mb4_unicode_ci COMMENT '返回值',
`tenant_id` varchar(128) COLLATE utf8mb4_unicode_ci DEFAULT NULL COMMENT '租戶ID',
`uri` varchar(1024) COLLATE utf8mb4_unicode_ci DEFAULT NULL COMMENT 'path',
`domain` varchar(1023) COLLATE utf8mb4_unicode_ci DEFAULT NULL COMMENT '域名',
`method` varchar(50) COLLATE utf8mb4_unicode_ci DEFAULT NULL COMMENT 'http method,eg. POST',
`path` varchar(255) COLLATE utf8mb4_unicode_ci DEFAULT NULL COMMENT '路徑',
`ip` varchar(255) COLLATE utf8mb4_unicode_ci DEFAULT NULL COMMENT '請求IP',
`user_agent` varchar(255) COLLATE utf8mb4_unicode_ci DEFAULT NULL COMMENT 'user-agent',
`os_family` varchar(50) COLLATE utf8mb4_unicode_ci DEFAULT NULL COMMENT '系統(tǒng)',
`correlation` varchar(128) COLLATE utf8mb4_unicode_ci DEFAULT NULL COMMENT 'correlation',
`status` varchar(50) COLLATE utf8mb4_unicode_ci DEFAULT NULL COMMENT '返回狀態(tài)',
`duration` int(11) DEFAULT NULL COMMENT '請求時間',
`create_at` bigint(20) DEFAULT NULL COMMENT '創(chuàng)建事件',
PRIMARY KEY (`id`)
) ENGINE = InnoDB
DEFAULT CHARSET = utf8mb4
COLLATE = utf8mb4_unicode_ci COMMENT ='api 接口的 request 和 response 跟蹤';
2. 在接口模塊(監(jiān)聽端)增加 依賴
<dependencies>
<dependency>
<groupId>cn.jimoos</groupId>
<artifactId>jm-api-tracer</artifactId>
<version>0.0.1</version>
</dependency>
<dependency>
<groupId>org.zalando</groupId>
<artifactId>logbook-spring-boot-starter</artifactId>
<version>2.4.1</version>
</dependency>
<!-- ua 解析 -->
<dependency>
<groupId>com.github.ua-parser</groupId>
<artifactId>uap-java</artifactId>
<version>1.5.1</version>
</dependency>
</dependencies>
現(xiàn)在啟動 你的spring-boot 應(yīng)用，你的 表中
JM_API_TRACE應(yīng)該有 request/response 捕捉了。
注意 在啟動命令里 須增加
-Dlogbook.servlet.form-request=parameter,
解決application/x-www-form-urlencoded捕捉body為空的問題。
idea 調(diào)試如下
啟動 api-trace-manager web 服務(wù)
1 下載
manager jar
,Manager-Jar 下載地址2 初始化 application.yml
spring:
application:
name: jimoos-api-tracer-manager
datasource:
url: jdbc:mysql://localhost:3306/jimoos?useUnicode=true&characterEncoding=utf-8
username: root
password: 123456
type: com.alibaba.druid.pool.DruidDataSource
driver-class-name: com.mysql.jdbc.Driver
mybatis:
mapper-locations: classpath*:mapper/**/*.xml
type-aliases-package: cn.jimoos.model
server:
port: 4000
- 3 啟動 manager.jar
java -Djava.security.egd=file:/dev/./urandom -jar jm-api-tracer-manager-0.0.1.jar --spring.config.location=file:application.yml
配置數(shù)據(jù)庫連接，需要和 你的應(yīng)用 數(shù)據(jù)庫連接一致。
- 4 打開應(yīng)用 http://127.0.0.1:4000
輸入密碼 : 123456
即可查看預(yù)覽
使用 Docker鏡像
docker run -d -p 4000:4000 -v /Users/keepcleargas/tmp/api-trace:/config --name jimoos-api-trace-manager -e TZ=Asia/Shanghai --entrypoint '/bin/sh' keepcleargas/jm-api-tracer-manager -c 'java -Djava.security.egd=file:/dev/./urandom -jar /app.jar --spring.config.location=file:/config/application.yml'
注意 修改 config 的映射文件地址 到 application.yml 的 路徑下。
開源版權(quán)聲明
B站新UP，求關(guān)注
分享一些 Spring-boot 開發(fā)，Ansible &docker 部署，項目管理等一些知識。
新技術(shù) up，歡迎大家 關(guān)注 一鍵三連。
五分鐘接入 API 調(diào)試?yán)鳎珹PI 調(diào)試不再難: https://www.bilibili.com/video/BV1H5411K7e7
