# ti-thrift

**Repository Path**: Timtance/ti-thrift

## Basic Information

- **Project Name**: ti-thrift
- **Description**: 基于thrift实现前端htmlJs与后端nodeJs之间的兼容本地域解决方案
- **Primary Language**: JavaScript
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-04-24
- **Last Updated**: 2024-04-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Thrift架构本地域解决方案
- 基于thrift实现前端htmlJs与后端nodeJs之间的兼容本地域解决方案
- Example of a compatible local domain solution between frontend htmlJs and backend nodeJs based on Thrift
- 后方有方案概要以及排摸出Thrift流转所涉及到的底层文件

# Thrift
你可以使用thrift库来实现在前端使用Thrift协议与后端的Node.js进行通信的解决方案。

Thrift是一种跨语言的服务定义和通信协议，它允许你定义数据类型和服务接口，并生成相应语言的代码。在你的情况下，你可以使用Thrift来定义前后端之间的数据类型和接口，并生成对应的JavaScript代码。

在前端，你可以使用ti-thrift库来处理Thrift协议的通信。它提供了一些工具和函数，可以帮助你在前端使用Thrift协议与后端进行通信。

在后端，你可以使用Node.js的thrift库来处理Thrift协议的通信。它提供了一些函数和类，可以帮助你在Node.js中实现Thrift服务端。

通过使用ti-thrift和Node.js的thrift库，你可以实现前后端之间基于Thrift协议的通信，并在本地域中进行数据交互。

# 环境
- install node 16.0.0
- npm install thrift

# 协议文件编译
## 执行包
- download thrift http://www.apache.org/dyn/closer.cgi?path=/thrift/0.20.0/thrift-0.20.0.exe
- thrift-0.20.0.exe -> thrift.exe
## 协议文件
- https://github.com/apache/thrift/blob/master/tutorial/tutorial.thrift
- https://github.com/apache/thrift/blob/master/tutorial/shared.thrift
## Node端 编译命令
- npm run nodeClientThrift
## JS端 编译命令
- nodeHtmlThrift

# NODE-NODE
## 启动 后端服务
- node nodeClientServer.js
## 启动 前端服务
- node nodeClient.js

# HTML-NODE
## 启动 后端服务
- node nodeHtmlServer.js
## 启动 前端服务
- node nodeHtml.js
## 涉及的文件
- json_protocol.js
- framed_transport.js
- thrift.js

# Thrift JS
## Version: '0.21.0'
https://github.com/apache/thrift/blob/master/lib/js/src/thrift.js

# 指令
- thrift -r --gen js:node -protocol json -transport xhr tutorial.thrift
## 这些参数的含义如下：
- -r: 表示递归处理，可以生成依赖的所有文件。
- --gen js:node: 指定生成的语言为 JavaScript，使用 Node.js 环境。
- -protocol json: 指定使用 JSON 协议进行数据传输。
- -transport xhr: 指定使用 XMLHttpRequest (XHR) 进行数据传输，适用于浏览器环境。
- 因此，运行此命令将根据提供的 tutorial.thrift 文件生成适用于 Node.js 环境的 JavaScript 文件，其中包含使用 JSON 协议和 XMLHttpRequest 进行数据传输的客户端和服务器端代码。
## 注意
-protocol json -transport xhr 不能作为参数， 但可以在thrift主文件 文件头加上
```
/*
* protocol: json
* transport: xhr
*/
```

# 补充：
- Nodejs:  thrift -r --gen js:node tutorial.thrift
- Python：thrift -r --gen py tutorial.thrift
- htmlJs：thrift -r --gen js:jquery tutorial.thrift

## thrift数据请求Head设置
- 通过 jquery发送数据请求， Content-Type类型是 application/vnd.apache.thrift.json; charset=utf-8
服务器处理：可通过中间件来解析Thrift格式的JSON数据，

## 数据请求流程
- 前端请求(Thrift处理封装) ----JSON数据---->服务端（Thrift解析处理）-----业务逻辑(Thrift处理封装)----->接口返回

## Thrift处理封装的数据
- JSON格式示例：JSON.stringify([1, "add", 1, 0, { "1": { "i32": 10 }, "2": { "i32": 5 } }])
- 备注：add是协议定义的方法， 10 和 5 是参数

## 重点
- 在于服务端的解析，对HTMLJscript请求，由Thrift按协议文件封装传输数据。
- 由于Thrift 是RPC架构 主要解决的服务与服务之间的通讯， HtmlJavascript传输是JSON数据并由特定的类型，所以服务端解析处理不一样，不能直接采用Thrift提供的监听处理。
## 解决方案概要
- 采用express实现可处理本地域的数据，通过解析层对数据进行提取在data层进行叠加后抛给回调函数。回调函数接收到数据后，交给Thrift解析，由手动模式提取Input参数数据，并借助Thrift原有的流转机制，设定Output回调处理封装成Thrift协议数据, 通过express的res输出进行接口响应。
### 备注
- 上面有提到的涉及文件就是Thrift内部流转所打点的文件