HKbitEX 开发文档

🌙 主题

部署文档 ​

版本号修改修改时间备注
v1.0.0王小琱2024.12.20首版

1. 项目简介 ​

exchange-market-service-backend 是一个基于 Go 语言开发的微服务，主要用于交易所市场相关的业务处理。该服务负责市场行情、撮合、订单管理等核心功能，支持高并发、低延迟的业务场景，适用于数字资产交易所、金融科技等领域。

2. 环境要求 ​

  • Go 版本：1.21 及以上
  • Docker：20.10 及以上

3. 部署方式 ​

3.1 本地部署 ​

3.1.1 下载代码 ​

bash
git clone https://gitlab.atom8.io/hkbitex/exchange-market-backend.git
cd exchange-market-backend

3.1.2 安装依赖 ​

bash
# 安装 protoc 工具
make init

# 更新依赖
make tidy

3.1.3 编译代码 ​

bash
make build

3.1.4 配置说明 ​

环境变量类型是否必填说明
APP_LOG_LEVELstring可选，默认info日志级别（trace、debug、info、warn、error、fatal）
SERVER_HOSTstring必填服务监听地址（如 0.0.0.0:8080）
METRICS_SWITCHstring必填metrics 开关，on：启用，off：关闭
METRICS_HOSTstring必填metrics 服务监听地址（如 0.0.0.0:18080）
GRPC_MARKET_AGGstring必填行情服务地址（如 127.0.0.1:8080）

3.1.5 启动服务 ​

创建 Systemd 文件 /etc/systemd/system/market.service：

bash
[Unit]
Description=exchange-market-service-backend
After=network.target

[Service]
WorkingDirectory=/app/market-service
Type=simple
User=root
ExecStart=/app/market-service/market-service
StandardOutput=append:/app/market-service/logs/output.log
StandardError=append:/app/market-service/logs/error.log
Restart=on-failure
EnvironmentFile=/app/market-service/.env

[Install]
WantedBy=multi-user.target

重载并启动服务：

bash
# 创建必要的目录
mkdir -p /app/market-service/logs

# 复制配置文件
cp .env.default /app/market-service/.env
cp market-service /app/market-service/

# 启动服务
systemctl daemon-reload
systemctl start market-service
systemctl enable market-service

# 检查服务状态
systemctl status market-service

3.2 Docker部署（推荐生产环境） ​

3.2.1 下载代码 ​

bash
git clone https://gitlab.atom8.io/hkbitex/exchange-market-backend.git
cd exchange-market-backend

3.2.2 编译代码 ​

bash
make docker

3.2.3 环境变量 ​

在项目根目录创建 .env 文件（内容同上），或直接通过 Docker -e 方式传入。

3.2.4 启动服务 ​

bash
docker run -d \
  --name exchange-market-service-backend \
  --env-file .env \
  -p 8080:8080 \
  registry.example.com/exchange-market-service-backend:latest

4. 数据库配置 ​

无

5. 日志配置 ​

5.1 日志位置 ​

  • 默认日志输出：/app/market-service/logs/
  • 日志文件：
    • output.log：标准输出日志
    • error.log：错误日志

5.2 日志级别 ​

  • 可通过 .env 配置（如 info、debug、error等）
  • 建议生产环境使用 info 级别

6. 监控配置 ​

7. 其他说明 ​

  • 相关第三方服务（如行情源、撮合引擎等）需根据实际业务对接

  • 如有问题，请联系项目负责人

🚀 构建现代化数字资产交易平台

Copyright © 2025 HKbitEX Development Team