注册账号登录
keepcleargas
积墨开源 核心成员
关注

实现 `Spring-boot` 的接口调试捕捉 - Jimoos-api-tracer(开源分享)

技术Java创建于3月24日257次阅读1人收藏

实现 Spring-boot mvc 的接口 request/response 的捕捉应用。

前言(造个轮子的理由)

公司是技术外包服务公司,经常会涉及和不同团队(远程)合作,包括前端,APP 端,接口的请求分析使用频率非常高,以前一般都是 fiddler 或 charles
或 服务端打日志解决,所以需要一个小侵入、可视化 、不需要 proxy ,就能进行测试线的接口调试的。

Jimoos-api-tracer简介

Spring-boot http接口请求 捕捉
测试线接口/客户端调试 必备

定位为: Http接口调试利器

  • 接口查询
  • 详细的 Request/Response 查询
  • 慢查询,eg. >1000ms
  • HttpStatus 查询,快速查出 500/400的请求
  • 指定路径Path查询

开源项目地址: https://github.com/jimoos-cn/jimoos-api-tracer

Build Status

欢迎 Star/Fork

Demo 演示(良心云小水管 大家轻拍)

演示地址: http://150.158.189.200:4000/develop/traces

密码:123456

测试 Http 请求 http://150.158.189.200:4000/v1/pings?q=xiaoduyu.

//img.xiaoduyu.com/32bab791fe7243dbb812025695bcff87.png

快速上手

1. 初始化 数据库

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 '系统',
    `correlation` varchar(128) COLLATE utf8mb4_unicode_ci  DEFAULT NULL COMMENT 'correlation',
    `status`      varchar(50) COLLATE utf8mb4_unicode_ci   DEFAULT NULL COMMENT '返回状态',
    `duration`    int(11)                                  DEFAULT NULL COMMENT '请求时间',
    `create_at`   bigint(20)                               DEFAULT NULL COMMENT '创建事件',
    PRIMARY KEY (`id`)
) ENGINE = InnoDB
  DEFAULT CHARSET = utf8mb4
  COLLATE = utf8mb4_unicode_ci COMMENT ='api 接口的 request 和 response 跟踪';

2. 在接口模块(监听端)增加 依赖

<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>

现在启动 你的spring-boot 应用,你的 表中JM_API_TRACE应该有 request/response 捕捉了。

注意 在启动命令里 须增加 -Dlogbook.servlet.form-request=parameter,
解决 application/x-www-form-urlencoded 捕捉body为空的问题。

idea 调试如下

//img.xiaoduyu.com/c650aab5ed2341d49ab810136fac6341.png

启动 api-trace-manager web 服务

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

配置数据库连接,需要和 你的应用 数据库连接一致。

  • 4 打开应用 http://127.0.0.1:4000

输入密码 : 123456

即可查看预览

//img.xiaoduyu.com/a72b8bc34503491891b4b7e1a5fc2bc2.png

使用 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 的 路径下。

开源版权声明

Lgpl-3.0

B站新UP,求关注

新技术up,欢迎大家 关注 一键三连。

https://www.bilibili.com/video/BV1H5411K7e7

1条评论 / 2条回复
666666
是是是
5月25日
回复
是是是
5月25日
回复
keepcleargas
积墨开源 核心成员
关注私信
1
关注
2
粉丝
1
帖子