加密货币行情
构建具有 API 密钥认证和 WebSocket 流式传输的实时加密货币行情。本教程演示基于 Token 的安全性、中间件配置和基于进程的 WebSocket 处理。
架构
flowchart TB
subgraph Clients
Browser[浏览器客户端]
API[API 客户端]
end
subgraph "HTTP Layer"
Server[http.server
gateway :8081]
Static[http.static
public/]
subgraph "Public Router"
CORS1[cors middleware]
AuthEndpoint[auth_token
POST /auth/token]
end
subgraph "WS Router /ws"
CORS2[cors middleware]
TokenAuth[token_auth middleware]
WSEndpoint[ws_ticker
GET /ws/ticker]
WSRelay[websocket_relay]
end
end
subgraph "Security Layer"
TokenStore[security.token_store
tokens]
Policy[security.policy
user_policy]
MemStore[store.memory
token_data]
end
subgraph "Storage"
DB[db.sql.sqlite
auth.db]
end
subgraph "Process Layer"
Supervisor[process.supervisor
processes]
WSHandler[ws_handler
每连接]
Ticker[ticker
单例]
end
subgraph "External"
CryptoAPI[加密货币价格 API]
end
%% 客户端连接
Browser -->|"GET /"| Static
API -->|"POST /auth/token"| CORS1
Browser -->|"WS /ws/ticker"| CORS2
%% API 流程
CORS1 --> AuthEndpoint
AuthEndpoint -->|验证| TokenStore
AuthEndpoint -->|"签发 token"| API
%% WS 流程
CORS2 --> TokenAuth
TokenAuth -->|验证| TokenStore
TokenAuth --> WSEndpoint
WSEndpoint -->|生成| Supervisor
Supervisor --> WSHandler
WSEndpoint --> WSRelay
WSRelay <-->|"消息"| WSHandler
%% Token store 依赖
MemStore --> TokenStore
Policy -->|附加到 token| TokenStore
%% Auth 使用 DB 存储 API keys
AuthEndpoint -->|查找 API key| DB
%% 进程通信
WSHandler -->|订阅| Ticker
Ticker -->|广播| WSHandler
WSRelay <-->|"ws 帧"| Browser
%% 外部
Ticker -->|获取价格| CryptoAPI
安全流程
-
API Key 交换:客户端 POST API key 到
/auth/token。处理器根据数据库验证,创建带有user_policy的 actor,并签发 HMAC 签名的 token。 -
Token 认证:WebSocket 连接通过
token_auth中间件,验证 Bearer token 并恢复安全上下文(actor + 策略)。 -
进程生成:WebSocket 端点生成处理器进程。由于 token 包含
user_policy,生成被授权。 -
消息路由:
websocket_relay中间件将 WebSocket 帧作为消息路由到处理器进程。
配置
完整的 _index.yaml:
version: "1.0"
namespace: app
entries:
# API keys 数据库
- name: db
kind: db.sql.sqlite
file: "./data/auth.db"
lifecycle:
auto_start: true
# Token 后备存储
- name: token_data
kind: store.memory
lifecycle:
auto_start: true
# 带 HMAC 签名的 Token 存储
- name: tokens
kind: security.token_store
store: app:token_data
token_length: 32
default_expiration: "1h"
token_key: "demo-secret-key-change-in-production"
# 已认证用户的安全策略
- name: user_policy
kind: security.policy
policy:
actions: "*"
resources: "*"
effect: allow
groups:
- user
# 进程宿主
- name: processes
kind: process.host
lifecycle:
auto_start: true
# 数据库迁移
- name: migrate
kind: process.lua
source: file://migrate.lua
method: main
modules: [sql, logger, crypto]
- name: migrate-service
kind: process.service
process: app:migrate
host: app:processes
lifecycle:
auto_start: true
# 行情广播器
- name: ticker
kind: process.lua
source: file://ticker.lua
method: main
modules: [logger, time, json, crypto]
- name: ticker-service
kind: process.service
process: app:ticker
host: app:processes
lifecycle:
auto_start: true
# WebSocket 处理器(每连接生成)
- name: ws_handler
kind: process.lua
source: file://ws_handler.lua
method: main
modules: [logger, json]
# HTTP 服务器
- name: gateway
kind: http.service
addr: ":8081"
lifecycle:
auto_start: true
# 公开路由器(无认证)
- name: public_router
kind: http.router
meta:
server: app:gateway
middleware:
- cors
options:
cors.allow.origins: "*"
# WebSocket 路由器(带认证)
- name: ws_router
kind: http.router
meta:
server: app:gateway
prefix: /ws
middleware:
- cors
- token_auth
options:
cors.allow.origins: "*"
token_auth.store: "app:tokens"
post_middleware:
- websocket_relay
post_options:
wsrelay.allowed.origins: "*"
# 静态文件
- name: public_fs
kind: fs.directory
directory: ./public
- name: static
kind: http.static
meta:
server: app:gateway
path: /
fs: app:public_fs
static_options:
spa: true
index: index.html
# Auth token 交换
- name: auth_token
kind: function.lua
source: file://auth_token.lua
method: handler
modules: [http, sql, crypto, security, json]
- name: auth_token.endpoint
kind: http.endpoint
meta:
router: app:public_router
method: POST
path: /auth/token
func: app:auth_token
# WebSocket ticker 端点
- name: ws_ticker
kind: function.lua
source: file://ws_ticker.lua
method: handler
modules: [http, json, security, logger]
- name: ws_ticker.endpoint
kind: http.endpoint
meta:
router: app:ws_router
method: GET
path: /ticker
func: app:ws_ticker
生产环境中,使用 token_key_env 从环境变量读取 HMAC 密钥,而不是硬编码。参见环境系统。
Token 交换
auth_token.lua - 验证 API keys 并签发 HMAC 签名的 token:
local http = require("http")
local sql = require("sql")
local security = require("security")
local function handler()
local req = http.request()
local res = http.response()
local body, parse_err = req:body_json()
if parse_err then
res:set_status(http.STATUS.BAD_REQUEST)
res:write_json({error = "invalid JSON"})
return
end
local api_key = body.api_key
if not api_key or #api_key == 0 then
res:set_status(http.STATUS.BAD_REQUEST)
res:write_json({error = "api_key required"})
return
end
local db, db_err = sql.get("app:db")
if db_err then
res:set_status(http.STATUS.INTERNAL_ERROR)
res:write_json({error = "database unavailable"})
return
end
local rows, query_err = db:query(
"SELECT user_id, role FROM api_keys WHERE api_key = ?",
{api_key}
)
db:release()
if query_err or #rows == 0 then
res:set_status(http.STATUS.UNAUTHORIZED)
res:write_json({error = "invalid API key"})
return
end
local user = rows[1]
-- 创建带用户身份的 actor
local actor = security.new_actor("user:" .. user.user_id, {
role = user.role,
user_id = user.user_id
})
-- 将 user_policy 附加到 scope
local policy, _ = security.policy("app:user_policy")
local scope = policy and security.new_scope({policy}) or security.new_scope()
-- 签发 HMAC 签名的 token
local store, store_err = security.token_store("app:tokens")
if store_err then
res:set_status(http.STATUS.INTERNAL_ERROR)
res:write_json({error = "token store unavailable"})
return
end
local token, token_err = store:create(actor, scope, {
expiration = "1h",
meta = {ip = req:remote_addr()}
})
store:close()
if token_err then
res:set_status(http.STATUS.INTERNAL_ERROR)
res:write_json({error = "token creation failed"})
return
end
res:write_json({
token = token,
user_id = user.user_id,
role = user.role,
expires_in = 3600
})
end
return { handler = handler }
WebSocket 端点
ws_ticker.lua - 为每个已认证的连接生成处理器进程:
local http = require("http")
local json = require("json")
local security = require("security")
local logger = require("logger")
local function handler()
local req = http.request()
local res = http.response()
if req:method() ~= http.METHOD.GET then
res:set_status(http.STATUS.METHOD_NOT_ALLOWED)
res:write_json({error = "method not allowed"})
return
end
-- Actor 由 token_auth 中间件设置
local actor = security.actor()
if not actor then
res:set_status(http.STATUS.UNAUTHORIZED)
res:write_json({error = "authentication required"})
return
end
local user_id = actor:id()
-- 生成处理器进程(由 token 中的 user_policy 授权)
local pid, err = process.spawn("app:ws_handler", "app:processes", user_id)
if err then
logger:error("spawn failed", {error = tostring(err)})
res:set_status(http.STATUS.INTERNAL_ERROR)
res:write_json({error = "failed to create handler"})
return
end
-- 配置 websocket_relay 将消息路由到处理器
res:set_header("X-WS-Relay", json.encode({
target_pid = tostring(pid),
metadata = {user_id = user_id, auth_time = os.time()}
}))
end
return { handler = handler }
连接处理器
websocket_relay 中间件自动向处理器进程发送生命周期消息:
ws.join- 连接建立,包含用于发送响应的client_pidws.message- 客户端发送了消息ws.leave- 连接关闭(断开时自动发送)
ws_handler.lua - 处理这些生命周期消息:
local logger = require("logger")
local json = require("json")
local function main(user_id)
local inbox = process.inbox()
local client_pid = nil
local subscribed = false
logger:info("handler started", {user_id = user_id})
while true do
local msg, ok = inbox:receive()
if not ok then break end
local topic = msg:topic()
local data = msg:payload():data()
if topic == "ws.join" then
client_pid = data.client_pid
-- 用我们的 PID 订阅以进行崩溃监控
process.send("ticker", "subscribe", {
client_pid = client_pid,
handler_pid = process.pid()
})
subscribed = true
-- 发送欢迎消息
process.send(client_pid, "ws.send", {
type = "text",
data = json.encode({type = "welcome", user_id = user_id})
})
logger:info("client joined", {user_id = user_id, client_pid = client_pid})
elseif topic == "ws.message" then
local content = json.decode(data.data)
if content and content.type == "ping" then
process.send(client_pid, "ws.send", {
type = "text",
data = json.encode({type = "pong"})
})
end
elseif topic == "ws.leave" then
-- Relay 在断开时自动发送此消息
logger:info("client left", {user_id = user_id, reason = data.reason})
if subscribed then
process.send("ticker", "unsubscribe", {handler_pid = process.pid()})
end
break
end
end
return 0
end
return { main = main }
广播
ticker.lua - 维护订阅并广播价格更新:
local logger = require("logger")
local time = require("time")
local json = require("json")
local crypto = require("crypto")
-- handler_pid -> client_pid 映射
local subscriptions = {}
local prices = {
["BTC-USD"] = 42000.00,
["ETH-USD"] = 2500.00,
["SOL-USD"] = 95.00
}
local function broadcast(message)
local data = json.encode(message)
for _, client_pid in pairs(subscriptions) do
process.send(client_pid, "ws.send", {type = "text", data = data})
end
end
local function update_prices()
for symbol, price in pairs(prices) do
local bytes = crypto.random.bytes(2)
local rand = (bytes:byte(1) * 256 + bytes:byte(2)) / 65535.0
local factor = (rand - 0.5) * 0.002
prices[symbol] = price * (1 + factor)
prices[symbol] = tonumber(string.format("%.2f", prices[symbol]))
end
end
local function get_updates()
local updates = {}
for symbol, price in pairs(prices) do
table.insert(updates, {symbol = symbol, price = price, timestamp = os.time()})
end
return updates
end
local function main()
local inbox = process.inbox()
local events = process.events()
local ticker, ticker_err = time.ticker("10ms")
if ticker_err then
logger:error("failed to create ticker", {error = tostring(ticker_err)})
return 1
end
local tick_ch = ticker:response()
process.registry.register("ticker")
logger:info("ticker started", {pid = process.pid()})
while true do
local r = channel.select {
inbox:case_receive(),
events:case_receive(),
tick_ch:case_receive()
}
if r.channel == tick_ch then
update_prices()
if next(subscriptions) then
broadcast({type = "ticker", data = get_updates()})
end
elseif r.channel == events then
local event = r.value
if event.kind == process.event.EXIT then
-- 处理器退出,移除订阅
if subscriptions[event.from] then
logger:info("handler exited", {handler_pid = event.from})
subscriptions[event.from] = nil
end
end
else
local msg = r.value
local topic = msg:topic()
local data = msg:payload():data()
if topic == "subscribe" then
local handler_pid = data.handler_pid
local client_pid = data.client_pid
subscriptions[handler_pid] = client_pid
process.monitor(handler_pid)
logger:info("subscribed", {handler_pid = handler_pid, client_pid = client_pid})
process.send(client_pid, "ws.send", {
type = "text",
data = json.encode({type = "ticker", data = get_updates()})
})
elseif topic == "unsubscribe" then
subscriptions[data.handler_pid] = nil
logger:info("unsubscribed", {handler_pid = data.handler_pid})
end
end
end
end
return { main = main }
数据库迁移
migrate.lua - 创建 API keys 表并生成演示密钥:
local sql = require("sql")
local logger = require("logger")
local crypto = require("crypto")
local function main()
local db, err = sql.get("app:db")
if err then
logger:error("failed to connect", {error = tostring(err)})
return 1
end
local _, exec_err = db:execute([[
CREATE TABLE IF NOT EXISTS api_keys (
id INTEGER PRIMARY KEY AUTOINCREMENT,
api_key TEXT UNIQUE NOT NULL,
user_id TEXT NOT NULL,
role TEXT NOT NULL DEFAULT 'user',
created_at INTEGER NOT NULL
)
]])
if exec_err then
db:release()
logger:error("migration failed", {error = tostring(exec_err)})
return 1
end
-- 检查演示密钥是否存在
local rows, _ = db:query("SELECT api_key FROM api_keys WHERE user_id = ?", {"demo"})
if #rows == 0 then
local demo_key, key_err = crypto.random.string(32)
if key_err then
db:release()
return 1
end
db:execute(
"INSERT INTO api_keys (api_key, user_id, role, created_at) VALUES (?, ?, ?, ?)",
{demo_key, "demo", "user", os.time()}
)
logger:info("demo API key created", {api_key = demo_key})
else
logger:info("demo API key exists", {api_key = rows[1].api_key})
end
db:release()
return 0
end
return { main = main }
运行
wippy init
wippy run
打开 http://localhost:8081 并输入日志中显示的演示 API key。
要点
| 概念 | 实现 |
|---|---|
| Token 签名 | 带 HMAC 密钥的 security.token_store |
| Token 验证 | 路由器上的 token_auth 中间件 |
| 授权 | 附加到 token scope 的 security.policy |
| WebSocket 生命周期 | websocket_relay 自动发送 ws.join/ws.leave |
| 处理器清理 | process.monitor(handler_pid) 检测崩溃 |
| 订阅映射 | subscriptions[handler_pid] = client_pid |
另请参阅
- WebSocket Relay - 中间件配置
- Security 模块 - Actor、策略、token 存储
- 进程管理 - 生成和消息传递