本教程将指导您如何使用Ruby接入实时行情API,以便从WebSocket获取实时金融交易数据。我们将一步步地讲解如何使用Ruby连接到Infoway API,接收实时数据,并定期发送心跳包保持连接稳定。
前置准备
在开始之前,确保您具备以下条件:
- Ruby环境:确保已经安装了Ruby(建议版本 >= 2.5)。
- 安装所需的Gem :我们将使用
websocket-client-simple
和json
这两个Gem来完成WebSocket连接和JSON数据处理。
安装Gem
python
gem install websocket-client-simple
gem install json
步骤1:连接到WebSocket API
我们用Infoway API的实时行情接口作为演示,接入实时期货数据,查询股票或者外汇的步骤是一样的。
首先构建WebSocket连接 :我们通过WebSocket协议连接到API,以获取实时行情数据。Ruby中有多个库可以帮助我们处理WebSocket连接,这里我们选择websocket-client-simple
。
python
require 'websocket-client-simple'
require 'json'
require 'securerandom'
# WebSocket连接URL
# 申请API Key: www.infoway.io
ws_url = "wss://data.infoway.io/ws?business=commodity&apikey=yourApiKey"
# 建立WebSocket连接
ws = WebSocket::Client::Simple.connect(ws_url)
# 监听连接关闭事件
ws.on :close do |e|
puts "WebSocket连接关闭: #{e}"
end
# 监听错误事件
ws.on :error do |e|
puts "WebSocket发生错误: #{e.message}"
end
在上面的代码中,我们使用WebSocket::Client::Simple.connect
方法连接到API的WebSocket接口。如果连接成功,客户端会保持连接状态,可以发送和接收消息。
步骤2:发送订阅消息
接入WebSocket后,我们需要向服务器发送一个消息,告诉服务器我们希望接收哪些贵金属(例如WTI、BRENT)的实时行情数据。这通常通过向WebSocket发送JSON格式的消息来完成。
python
# 定义消息结构
class Message
attr_accessor :code, :trace, :data
def initialize(code, trace, data)
@code = code
@trace = trace
@data = data
end
def to_json(*_args)
{
code: @code,
trace: @trace,
data: @data
}.to_json
end
end
# 订阅贵金属品种(例如WTI、BRENT)
# 申请API Key: www.infoway.io
trade_data = Message.new(10000, SecureRandom.uuid, { 'codes' => ['WTI', 'BRENT'] })
ws.send(trade_data.to_json)
在这段代码中,我们定义了一个Message
类来构建消息。每个消息包括:
code
:操作类型标识符(这里使用10000
表示订阅行情)。trace
:唯一标识符,用于区分不同的请求。data
:请求的数据内容(这里是贵金属品种代码)。
通过ws.send(trade_data.to_json)
,我们将这个消息发送到WebSocket服务器。
步骤3:接收实时数据
WebSocket的优势之一是它能够在连接保持打开时实时推送数据。因此,我们需要一个机制来接收服务器发送的实时行情数据。
python
# 监听接收到的消息
ws.on :message do |msg|
puts "接收到消息: #{msg.data}"
end
在上述代码中,ws.on :message
事件监听器会在每次接收到消息时触发。我们打印出收到的消息内容(一般是JSON格式的数据)。在实际应用中,您可以对这些数据进行处理,提取出需要的行情信息并用于后续的交易决策。
步骤4:定时发送心跳包
WebSocket连接如果长时间没有数据交互,可能会因为超时而被服务器断开连接。因此,通常会定期发送心跳包(ping消息)以保持连接的活跃状态。
python
# 心跳消息结构
ping_message = Message.new(10010, SecureRandom.uuid, nil)
# 启动一个线程,每30秒发送一次心跳包
Thread.new do
loop do
sleep 30
ws.send(ping_message.to_json)
end
end
我们定义了一个心跳消息,并通过一个独立的线程每30秒发送一次心跳包。这确保了连接不会因超时被关闭。
步骤5:保持连接
WebSocket连接通常会持续运行,我们需要确保程序不断执行,以便持续接收数据。
python
# 程序保持运行
loop do
sleep 1
end
通过一个简单的loop do
结构,我们让程序一直保持运行状态,不会退出。这允许WebSocket连接长期保持活动并持续接收消息。
步骤6:处理连接关闭和错误
在实际使用中,WebSocket连接可能会因网络问题或其他原因关闭,或者在发生错误时抛出异常。我们可以通过监听close
和error
事件来处理这些情况。
python
# 监听连接关闭事件
ws.on :close do |e|
puts "WebSocket连接关闭: #{e}"
end
# 监听错误事件
ws.on :error do |e|
puts "WebSocket发生错误: #{e.message}"
end