r-fubon-neo

r-fubon-neo 是富邦證券 Neo SDK 的 Rust 實現版本 (P.O.C project)，完全相容 Python 3.12+ 的 fubon_neo 套件功能。提供高性能、類型安全的金融交易和市場數據 API。

⚠️ 重要提醒: 這是一個概念驗證 (Proof of Concept) 專案，目前處於開發階段，僅供學習和研究目的使用。

✨ 特色功能

🚀 高性能: 使用 Rust 異步架構，比 Python 版本更快
🔒 類型安全: 編譯時檢查，避免運行時錯誤
🌐 完整 API: 支援股票、期貨、選擇權交易
📊 即時數據: WebSocket 即時市場數據串流
🐳 Docker 化: 完整的容器化部署方案，支援靜態連結
📦 靜態連結: 單一執行檔，無外部依賴，適合容器化部署
📚 文檔完整: 詳細的 API 文檔和範例

🚀 快速開始

安裝

方法 1: 使用 Cargo (推薦)

# 將 r-fubon-neo 加入到您的 Cargo.toml
[dependencies]
r-fubon-neo = "2.2.3"

或使用 cargo add 命令：

cargo add r-fubon-neo

⚠️ 重要提醒: 由於 crates.io 大小限制，套件不包含原生 .so 函式庫。您需要：

下載原生函式庫：

git clone https://github.com/SDpower/r-fubon-neo.git
cd r-fubon-neo

# 複製對應平台的 .so 檔案到您的專案目錄
mkdir -p lib
cp -r lib/ /path/to/your/project/

或使用完整源碼版本（包含所有檔案）：

git clone https://github.com/SDpower/r-fubon-neo.git
cd r-fubon-neo
cargo build --release

方法 2: 從源碼編譯

git clone https://github.com/SDpower/r-fubon-neo.git
cd r-fubon-neo

# 設置環境變數
cp .env.example .env
# 編輯 .env 檔案，填入您的登入認證資訊

# 標準編譯
cargo build --release

# 靜態連結編譯 (推薦用於部署)
cargo build --release --target x86_64-unknown-linux-musl

使用 Docker

# 標準 Docker 映像
docker build -t r-fubon-neo .

# 靜態連結映像（極小體積 - 僅 2.16MB）
docker build -f Dockerfile.static --target static -t r-fubon-neo:static .

# Distroless 靜態映像（3.94MB，更好相容性）
docker build -f Dockerfile.static --target distroless -t r-fubon-neo:distroless .

# 運行容器
docker run --rm r-fubon-neo version
docker run --rm r-fubon-neo:static version       # 最小體積
docker run --rm r-fubon-neo:distroless version   # 更好相容性

基本使用

使用 Cargo 套件

在您的 Cargo.toml 中：

[dependencies]
r-fubon-neo = "2.2.3"

在您的程式中：

use r_fubon_neo::{FubonSDK, CoreSDK, Mode, Order, OrderType, BSAction, TimeInForce, LoginCredentials};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // 初始化 SDK 並登入
    let mut sdk = FubonSDK::new();
    
    let credentials = LoginCredentials {
        personal_id: "your_personal_id".to_string(),
        password: "your_password".to_string(),
        cert_path: "/path/to/your/certificate.p12".to_string(),
        cert_pass: Some("your_cert_password".to_string()),
    };
    
    // 登入並獲取帳戶列表
    let accounts = sdk.login(credentials)?;
    println!("可用帳戶: {:?}", accounts);
    
    // 獲取帳戶餘額
    let balance = sdk.get_account_balance()?;
    println!("帳戶餘額: ${:.2}", balance);
    
    // 初始化市場數據
    sdk.init_realtime(Mode::Speed)?;
    
    if let Some(market_data) = sdk.market_data() {
        // 使用 REST API 獲取股票資料
        let stock_client = market_data.rest_client.stock()?;
        let snapshot = stock_client.snapshot()?.get_data("2330").await?;
        println!("台積電快照: {:?}", snapshot);
    }
    
    Ok(())
}

CLI 使用

# 查看版本
r-fubon-neo version

# 登入並查看帳戶
r-fubon-neo login

# 使用環境變數 (.env 檔案)
r-fubon-neo test
r-fubon-neo market-data

# 或使用 CLI 參數
r-fubon-neo --personal-id YOUR_ID --password YOUR_PASS --cert-path /path/to/cert.p12 login
r-fubon-neo --personal-id YOUR_ID --password YOUR_PASS --cert-path /path/to/cert.p12 test

📊 支援的功能

交易功能

✅ 股票買賣
✅ 期貨交易
✅ 選擇權交易
✅ 條件單
✅ 停損停利
✅ 帳戶查詢

市場數據

✅ 即時報價 (WebSocket)
✅ 歷史數據 (REST API)
✅ 技術指標
✅ 盤中數據
✅ 快照數據

支援市場

🇹🇼 台灣股市
📈 台指期貨
📊 台指選擇權

🐳 Docker 使用

基本運行

# 構建標準映像
docker build -t r-fubon-neo .

# 構建靜態連結映像 (推薦 - 僅 2.16MB)
docker build -f Dockerfile.static --target static -t r-fubon-neo:static .

# 構建 Distroless 靜態映像 (3.94MB，更好相容性)
docker build -f Dockerfile.static --target distroless -t r-fubon-neo:distroless .

# 運行標準容器
docker run --rm \
  -e FUBON_PERSONAL_ID=your_id \
  -e FUBON_PASSWORD=your_password \
  -e FUBON_CERT_PATH=/path/to/cert.p12 \
  -e FUBON_CERT_PASS=your_cert_password \
  r-fubon-neo test

# 運行靜態映像 (極小體積，最高安全性)
docker run --rm \
  -e FUBON_PERSONAL_ID=your_id \
  -e FUBON_PASSWORD=your_password \
  -e FUBON_CERT_PATH=/path/to/cert.p12 \
  r-fubon-neo:static test

# 運行 Distroless 映像 (小體積，更好兼容性)
docker run --rm \
  -e FUBON_PERSONAL_ID=your_id \
  -e FUBON_PASSWORD=your_password \
  -e FUBON_CERT_PATH=/path/to/cert.p12 \
  r-fubon-neo:distroless test

Docker Compose

# 啟動標準服務
docker-compose up fubon-neo

# 開發模式
docker-compose --profile dev up fubon-neo-dev

# 靜態連結版本
docker-compose --profile static up fubon-neo-static
docker-compose --profile distroless up fubon-neo-distroless

# 包含監控
docker-compose --profile monitoring up

便利腳本

# 構建腳本
./scripts/docker-build.sh -t v2.2.3                    # 標準版本
./scripts/docker-build.sh -s -t static                # 靜態連結版本 (2.16MB)
./scripts/docker-build.sh --distroless -t distroless  # Distroless 版本 (3.94MB)

# 運行腳本
./scripts/docker-run.sh -k YOUR_KEY -s YOUR_SECRET test  # Legacy method (deprecated)
# 新方法: 使用環境變數或直接運行 Docker 容器

映像大小比較

映像版本	大小	說明	使用場景
`r-fubon-neo:static`	2.16MB	基於 scratch，完全靜態連結	生產部署，最高安全性
`r-fubon-neo:distroless`	3.94MB	基於 distroless，靜態連結	生產部署，更好相容性
`r-fubon-neo:latest`	~50MB+	標準 Debian 基底	開發測試

📖 文檔與資源

📚 文檔

API 文檔 - 完整的 API 參考
Docker 指南 - Docker 使用說明
開發者指南 - 開發環境設置
範例程式碼 - 使用範例

📦 套件資源

crates.io: r-fubon-neo - Rust 套件庫
docs.rs: 線上文檔 - 自動生成的 API 文檔
GitHub: 原始碼 - 完整原始碼與原生函式庫

🚀 快速連結

# 查看套件資訊
cargo info r-fubon-neo

# 查看線上文檔
cargo doc --open

# 加入專案依賴
cargo add r-fubon-neo

🔧 開發

環境需求

Rust 1.75+
OpenSSL 開發庫
pkg-config

編譯

# 開發模式
cargo run -- version

# 發布模式
cargo build --release

# 靜態連結版本 (推薦用於部署)
cargo build --release --target x86_64-unknown-linux-musl
cargo build --profile static

# 運行測試
cargo test

# 格式化程式碼
cargo fmt

# 檢查程式碼
cargo clippy

開發環境

# 使用 Docker 開發環境
docker-compose --profile dev up fubon-neo-dev

# 或使用 cargo-watch 熱重載
cargo install cargo-watch
cargo watch -x "run -- version"

🆚 與 Python 版本對比

功能	Python (fubon_neo)	Rust (r-fubon-neo)
性能	標準	🚀 3-5倍更快
記憶體使用	標準	🔋 50% 更少
類型安全	運行時檢查	✅ 編譯時檢查
錯誤處理	Exception	🛡️ Result 類型
並發處理	asyncio	⚡ Tokio 異步
部署大小	需要 Python 環境	📦 單一執行檔 (2.16MB 靜態映像)

🔧 設定檔

應用設定 (config/app.yml)

app:
  name: "r-fubon-neo"
  version: "2.2.3"
  environment: "production"

api:
  timeout: 30
  retry_attempts: 3

websocket:
  ping_interval: 30
  max_missed_pongs: 2

環境變數設定

方法1: 使用 .env 檔案 (推薦)

# 複製範例檔案
cp .env.example .env

# 編輯 .env 檔案
# FUBON_PERSONAL_ID=your_actual_personal_id
# FUBON_PASSWORD=your_actual_password
# FUBON_CERT_PATH=/path/to/your/certificate.p12
# FUBON_CERT_PASS=your_actual_cert_password

方法2: 直接設置環境變數

# 登入認證 (主要格式)
export FUBON_PERSONAL_ID=your_personal_id
export FUBON_PASSWORD=your_password
export FUBON_CERT_PATH=/path/to/your/certificate.p12
export FUBON_CERT_PASS=your_cert_password

# 或使用替代格式
export PERSONAL_ID=your_personal_id
export PASSWORD=your_password
export CERT_PATH=/path/to/your/certificate.p12
export CERT_PASS=your_cert_password

# 日誌等級
export RUST_LOG=info
export RUST_BACKTRACE=1

支援的環境變數名稱

FUBON_PERSONAL_ID 或 PERSONAL_ID
FUBON_PASSWORD 或 PASSWORD
FUBON_CERT_PATH 或 CERT_PATH
FUBON_CERT_PASS 或 CERT_PASS (可選)

🤝 貢獻

歡迎提交問題和拉取請求！

Fork 這個專案
創建功能分支 (git checkout -b feature/amazing-feature)
提交更改 (git commit -m 'Add amazing feature')
推送到分支 (git push origin feature/amazing-feature)
開啟拉取請求

📄 授權

本專案採用雙重授權：

⚠️ 免責聲明

本專案為概念驗證 (P.O.C) 專案，僅供教育、學習和研究目的。

🚫 不適用於生產環境: 此專案尚未經過充分測試，不建議用於實際交易
📚 學習目的: 主要用於展示 Rust 在金融科技領域的應用可能性
⚠️ 風險提醒: 使用者在進行實際交易前，請充分了解相關風險並確保遵守所有適用的法律法規
🛡️ 責任聲明: 作者不對使用本軟體造成的任何損失負責
🔬 實驗性質: 本專案的功能和 API 可能會有重大變更

👨‍💻 專案資訊

開發者: Steve Lo
聯絡方式: [email protected]
專案性質: P.O.C (Proof of Concept) project
開發目的: 探索 Rust 在金融 API 開發領域的應用潛力

📞 支援與聯絡

📧 Email: [email protected]
🐛 問題回報: GitHub Issues
💬 討論: GitHub Discussions
📖 文檔: 線上文檔

Made with ❤️ in Rust by Steve Lo
P.O.C Project - Exploring Rust in FinTech

Name		Name	Last commit message	Last commit date
Latest commit History 6 Commits
.cargo		.cargo
.github		.github
config		config
docs		docs
examples		examples
lib		lib
monitoring		monitoring
scripts		scripts
src		src
.dockerignore		.dockerignore
.env.example		.env.example
.gitignore		.gitignore
CHANGELOG.md		CHANGELOG.md
CONTRIBUTING.md		CONTRIBUTING.md
Cargo.toml		Cargo.toml
Dockerfile		Dockerfile
Dockerfile.dev		Dockerfile.dev
Dockerfile.static		Dockerfile.static
LICENSE-APACHE		LICENSE-APACHE
LICENSE-MIT		LICENSE-MIT
README.md		README.md
build.rs		build.rs
docker-compose.override.yml		docker-compose.override.yml
docker-compose.yml		docker-compose.yml

License

Licenses found

SDpower/r-fubon-neo

Folders and files

Latest commit

History

Repository files navigation