Giters

leadhxyh / transmit

接口数据转换,接口转发工具

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

第三方接口对接/数据转换工具：transmit

功能描述：

当项目中需要使用同一套数据对接多家第三方接口的时候, 比如对接保险公司接口, 对接支付公司接口. 以往的情况是针对每家公司的接口文档开发一套代码, 这样会添加很多不必要的工作量. 针对这种情况, 我开发了这个工具. 这个工具可以做到接口之间参数转换,转发. 节省了对接接口时的开发任务.

优点

  1. 数据转换使用freemarker模板, 无需编写java代码.
  2. 使用vert.x框架编写. 效率高, 代码量小.
  3. 请求数据入库, 数据有迹可循.
  4. 可自己编写插件, 完成其定义签名和自定义freemarker指令.

使用说明

打包命令

git clone https://github.com/hjx601496320/transmit.git
cd transmit/
mvn package
cd target/
//解压
tar -zxvf transmit.tar.gz
//启动
sh bin/start.sh

文件目录

├── bin                         启动脚本
│   ├── restart.sh
│   ├── start.sh
│   └── stop.sh
├── fileTypeConfig                      配置
│   ├── fileTypeConfig.json
│   └── logback.xml
├── lib
│   ├── commons-cli-1.4.jar     依赖
......
│   ├── transmit-1.0-SNAPSHOT.jar
│   ├── vertx-web-client-3.8.0.jar
│   └── vertx-web-common-3.8.0.jar
├── log                         日志
│   ├── debug
│   │   └── debug.2019-09-17.log
│   ├── error
│   │   └── error.2019-09-17.log
│   └── info
│       └── info.2019-09-17.log
└── sout.log

配置说明

配置示例

{

  其他配置
  "fileTypeConfig": {
    
    是否缓存模板文件,默认true. 关闭的话每次请求会重新加载配置.
    重新加载配置是指 除了port, cache, ext, db节点之外, 每次请求都会重新读所有配置文件(目的是为了方便开发, 线上请不要开启).
    "cache": true,
    
    系统端口号
    "port": 9090,
    
    引用其他的配置文件的文件路径
    "import": [
    ],
    
    其他组件加载, 执行CLass.forName, 可以加载自己定义的一些插件, 完成类似数据入库, 接口签名之类的功能
    "ext": [
      "com.hebaibai.ctrt.Driver"
    ],
    
    数据库配置, 用于保存接口请求日志
    "db": {
      "url": "jdbc:mysql://127.0.0.1/dbname?characterEncoding=utf-8&useSSL=true",  
      "username": "root",
      "password": "root"
    }
  },
  
  配置示例
  "fileTypeConfig-demo": {
  
    接受请求
    "request": {
    
      接受请求的地址 127.0.0.1:9090/download
      "path": "/download",
      
      请求的方式
      "method": "GET",
      
      请求参数类型: FORM(表单提交),  JSON(json),  QUERY(?key=value&key2=value),  TEXT(文本),  XML(xml),
      "request-type": "QUERY",
      
      返回参数类型
      "response-type": "TEXT"
    },
    
    转发的接口配置
    "api": {
    
      接口请求地址(缺少节点时直接用'response-ftl'返回)
      "url": "http://127.0.0.1:9003/api/download",
      
      插件编号, 在ext中加载来的
      "extCode": "null",
      
      接口请求地址
      "method": "GET",
      
      请求参数类型
      "request-type": "QUERY",
      
      请求超时设置,默认3000 ms, 单位ms
      "timeout": 1,
      
      返回参数类型
      "response-type": "TEXT",
      
      请求参数转换模板
      "request-ftl": "/home/hjx/work/myProject/transmit/file/download-req.ftl",
      
      响应参数转换模板
      "response-ftl": "/home/hjx/work/myProject/transmit/file/download-res.ftl"
    }
  }
}

日志表sql

CREATE TABLE `api_log`
(
    `id`          varchar(64) NOT NULL,
    `type_code`   varchar(64) DEFAULT NULL COMMENT '类型',
    `send_msg`    text COMMENT '请求内容',
    `receive`     text COMMENT '接口返回数据',
    `end_time`    datetime    DEFAULT NULL COMMENT '请求耗时',
    `create_time` datetime    DEFAULT NULL COMMENT '请求时间',
    `status`      int(11)     DEFAULT NULL COMMENT '状态1:success, 0:error',
    PRIMARY KEY (`id`)
) ENGINE = InnoDB
  DEFAULT CHARSET = utf8 COMMENT ='接口请求日志';

接口转换示例

请求参数:

<Demo>
  <Info>
    <Code>XXX-1</Code>
    <UUID>d83a011a-958d-4310-a51b-0fb3a4228ef5</UUID>
	<Time>2017-11-15 16:57:36</Time>
  </Info>
  <XXX>
    <Order>
      <SerialNo>0</SerialNo>
      <OrderNo>123123123</OrderNo>
	  <OrderCode>asdasdasd</OrderCode>
	  <Result>1</Result>
    </Order>
  </XXX>
</Demo>

转发接口需要的数据:

格式 JSON(POST)

{
    "header": {
        "code": "${ROOT.Info.Code}",
        "date": "${ROOT.Info.Time}"
    },
    "body": {
        "orderCode": "${ROOT.XXX.Order.OrderCode}"
    }
}

格式 FORM(POST)

code=${ROOT.Info.Code}
date=${ROOT.Info.Time}
orderCode=${ROOT.XXX.Order.OrderCode}

格式 QUERY(GET)

code=${ROOT.Info.Code}&date=${ROOT.Info.Time}&orderCode=${ROOT.XXX.Order.OrderCode}

格式 XML(POST)

<xml>
    <header>
        <code>${ROOT.Info.Code}</code>
        <date>${ROOT.Info.Time}</date>
    </header>
    <body>
        <orderCode>${ROOT.XXX.Order.OrderCode}</orderCode>
    </body>
</xml>

参数节点说明

转换参数使用freemarker模板将参数转换为适应api接口的参数

放入模板中的参数顶级有两个节点:

ROOT :在转换响应/请求报文时, 参数节点.

REQUEST :在转换响应报文时, 请求参数的节点

返回页面实例

配置示例

{
  "fileTypeConfig": {
    "port": 8080,
    "cache": false
  },
  "text-page": {
    "doc": "测试页面",
    "request": {
      设置请求路径
      "path": "/index",
      设置请求参数
      "method": "GET",
      请求参数类型
      "request-type": "QUERY",
      设置响应格式(这里是html, 也可以是 xml, json)
      "response-type": "HTML"
    },
    "api": {
      对应的页面文件
      "response-ftl": "result.ftl"
    }
  }
}
页面文件: result.ftl
<html>
<head>
    <title>index</title>
</head>
<body>
    <h1>${REQUEST.uuid}</h1>
</body>
</html>

对应请求地址

http://127.0.0.1:8080/index?uuid=12

使用数据库配置

当配置节点太多的时候管理起来不好管理, 现在可以将配置存放在数据库中.

sql

CREATE TABLE `api_config`
(
    `code`              varchar(100) NOT NULL COMMENT '配置编号',
    `doc`               varchar(100) DEFAULT NULL COMMENT '配置说明',
    `method`            varchar(10)  NOT NULL COMMENT '请求方式(GET/POST)',
    `path`              varchar(200) NOT NULL COMMENT '请求地址',
    `request_type`      varchar(10)  NOT NULL COMMENT '请求参数类型(QUERY/FORM/JSON/TEXT)',
    `response_type`     varchar(10)  NOT NULL COMMENT '响应参数类型(QUERY/FORM/JSON/TEXT)',
    `timeout`           int(11)      DEFAULT '3000' COMMENT 'api请求超时时间单位ms,默认3000',
    `ext_code`          varchar(50)  DEFAULT NULL COMMENT '应用插件编号',
    `api_url`           varchar(200) DEFAULT NULL COMMENT 'api请求地址',
    `api_method`        varchar(10)  DEFAULT NULL COMMENT 'api请求方式(GET/POST)',
    `api_request_type`  varchar(10)  DEFAULT NULL COMMENT 'api请求参数类型(QUERY/FORM/JSON/TEXT)',
    `api_response_type` varchar(10)  DEFAULT NULL COMMENT 'api响应参数类型(QUERY/FORM/JSON/TEXT)',
    `request_ftl`       text COMMENT 'api请求参数转换模板',
    `response_ftl`      text         NOT NULL COMMENT 'api响应参数转换模板',
    `property`          text COMMENT '用户自定义的额外配置,json格式',
    `status`            int(11)      DEFAULT '1' COMMENT '状态1:可用/0:不可用',
    PRIMARY KEY (`code`),
    UNIQUE KEY `api_config_un` (`path`, `method`),
    KEY `api_config_method_IDX` (`method`, `path`) USING HASH
) ENGINE = InnoDB
  DEFAULT CHARSET = utf8;

修改配置

配置文件只有这些配置生效,"dbConfig"=ture表示开始数据库配置. 每次请求时向数据库查询转换配置

{
  "config": {
    "port": 9527,
    "dbConfig": true,
    "ext": [
    ],
    "db": {
      "url": "jdbc:mysql://127.0.0.1/dbname?characterEncoding=utf-8&useSSL=true",
      "username": "root",
      "password": "root"
    }
  }
}

About

接口数据转换,接口转发工具

Languages

Language:Java 98.9%Language:Shell 1.0%Language:FreeMarker 0.0%