[Add]增加WebTrader的文档

This commit is contained in:
vn.py 2018-02-15 15:45:06 +08:00
parent 31c3c17596
commit 9c242ed73f
2 changed files with 36 additions and 0 deletions

View File

@ -6,6 +6,8 @@
* OptionMaster: 期权量化交易系统 * OptionMaster: 期权量化交易系统
* WebTrader使用Web前端作为监控的交易系统
* DataRecording全自动行情记录工具无需用户每日定时重启 * DataRecording全自动行情记录工具无需用户每日定时重启
* CtaTrading无图形界面模式的CTA策略交易 * CtaTrading无图形界面模式的CTA策略交易

View File

@ -0,0 +1,34 @@
# WebTrader使用说明
## 使用步骤
1. 修改CTP_connect.json中的账号和服务器地址
2. 修改WEB_setting.json中的网页登录用户名和密码
3. 打开cmd运行python server.py
4. 打开另一个cmd运行python run.py
5. 用浏览器推荐Chrome访问http://localhost:5000/
6. 输入2中的用户名和密码登录后点击左下角的“连接CTP”
7. 网页前端的使用方法和常规版本的VnTrader基本一致
8. 如需运行CTA策略请修改CTA_setting.json中的配置
## 文件功能
* server.py基于vnpy.rpc模块实现的交易服务器包含CTP接口和CTA策略模块
* run.py基于Flask实现的Web服务器内部通过vnpy.rpc客户端来访问交易服务器
## 架构设计
* 基于Flask-Restful实现的主动函数调用功能数据流程
1. 用户点击浏览器中的某个按钮发起Restful功能调用
2. Web服务器收到Restful请求将其转化为RPC功能调用发送给交易服务器
3. 交易服务器收到RPC请求执行具体的功能逻辑并返回结果
4. Web服务器返回Restful请求的结果给浏览器
* 基于Flask-Socketio实现的被动数据推送功能数据流程
1. 交易服务器的事件引擎转发某个事件推送并推送给RPC客户端Web服务器
2. Web服务器收到事件推送后将其转化为json格式并通过Websocket发出
3. 浏览器通过Websocket收到推送的数据并渲染在Web前端界面上
* 将程序分为两个进程的主要原因包括:
1. 交易服务器中的策略运行和数据计算的运算压力较大,需要保证尽可能保证低延时效率
2. Web服务器需要面对互联网访问将交易相关的逻辑剥离能更好保证安全性