Files
rakuten-api/.env.example
T
q792602257andClaude Opus 5 63c41b61e7 自动登录接口 + 有状态端容器化部署 + 三服务合并 openapi 导出
自动登录(此前只能人工跑 scripts/login.py 再 /api/auth/reload):
- 新增 POST /api/auth/login:动作顺序与下单前的 require_logged_in 一致(探测 →
  未登录则按 account.yaml 登一次 → 再探测),已登录直接跳过不白起浏览器。
  刻意**不抛 5001**:失败以 logged_in=false + 各站 detail 正常返回,调用方自己
  决定是人工接管还是换账号。
- 新增 RAKUTEN_AUTO_LOGIN_ON_START(默认 false):启动即准备登录态,为容器部署
  而存在(镜像里没有落盘的 storage_state)。做成后台任务而非启动阻塞——登录最长
  等 relogin_timeout_seconds(默认 300s,撞验证码时在等人工),阻塞会让 /health
  在这段时间里连端口都不通;关服务时 cancel 掉在途的那次。
- 自动登录不绕过站点校验:凭据是用户自己配在 account.yaml 里的,代填进站点自己的
  登录表单,撞 reCAPTCHA / 设备验证会停在有头浏览器等人工,等不到就超时失败。

容器化部署(新增 Dockerfile.trading + docker-compose.yml):
- 有状态端单独出镜像不是为了整洁:下单/结算必须用**有头** Chromium(headless 会让
  结算 SPA 失灵),镜像要带 Xvfb + 日文字体 + 给人工接管用的可选 x11vnc,抓取镜像
  没有这些。网关复用同一镜像只换 command。
- Jenkinsfile 一条流水线产出两个镜像,BUILD_SCRAPING / BUILD_TRADING 两个开关控制。
- .dockerignore 补上 account.yaml / .auth/ / .browser-data/ / data/:明文密码+卡号、
  可直接冒充账号的 cookie、带登录态的浏览器 profile、含真实 PII 的证据快照,都不该
  进镜像也不该进 build context,运行时一律走挂载。
- .env.example 里 RAKUTEN_AUTO_LOGIN_ON_START 刻意留成注释:compose 的变量插值与
  env_file 读的是同一个 ./.env,这里写成显式值会让 compose 的 `${...:-true}` 失效,
  按 compose 文件头「cp .env.example .env」走反而不会自动登录。

openapi 导出(scripts/export_openapi.py):三服务合并成一份可直接导入 Apifox /
Postman 的文档,每条接口带 operation 级 servers(不必手动切端口)。鉴权标注是遍历
FastAPI 依赖树认出真的挂了 require_bearer_token 的接口,不按路径猜。

openapi.json 本身仍是 gitignore 的本地生成物,因此 tests/test_openapi_export.py
只在内存里校验合并逻辑(三服务覆盖、operation 级 servers、除 /health 外全部标鉴权、
operationId 唯一、$ref 可解析),不断言「文件内容 == 当前导出结果」——CI 的全新
clone 里没有这个文件,那种断言必然失败。代价是「改了接口忘了重新导出」没有自动
兜底,得手动跑 --check,已在 README 里点明。

398 测试全绿;另单独验证过缺 openapi.json 时该文件 5 个用例仍通过(CI 场景)。
compose 的变量插值行为只按文档核对,本机没有 docker 未能实测。

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-08-14 14:27:38 +08:00

127 lines
6.7 KiB
Bash

# 本仓库出三个服务,共用这一份配置:
# 抓取服务 python -m app.scraping.main —— 匿名、无状态、可多开实例
# 交易服务 python -m app.trading.main —— 带账号登录态、有状态,只能单实例
# 下单任务网关 python -m app.gateway.main —— 任务队列 + 状态镜像,只能单实例
# 各自只读自己那部分,下面按用途分组标注。
# ---- 抓取服务监听地址,通常本地用 127.0.0.1,容器/服务器用 0.0.0.0 ----
RAKUTEN_APP_HOST=0.0.0.0
RAKUTEN_APP_PORT=31107
# ---- 交易服务监听地址(同机部署时端口必须与上面错开)----
RAKUTEN_TRADING_HOST=0.0.0.0
RAKUTEN_TRADING_PORT=31108
# ---- 下单任务网关监听地址(部署在服务器侧;本地 worker 出站长轮询取任务)----
RAKUTEN_GATEWAY_HOST=0.0.0.0
RAKUTEN_GATEWAY_PORT=31109
# 运行环境:dev / prod / test
RAKUTEN_APP_ENV=dev
# 日志级别:DEBUG / INFO / WARNING / ERROR
RAKUTEN_LOG_LEVEL=INFO
# 是否将日志写入文件(dev 默认 false,prod 默认 true;可显式覆盖)
RAKUTEN_LOG_TO_FILE=
# 日志目录(相对项目根目录)
RAKUTEN_LOG_DIR=logs
# 日志切割策略(Loguru 语法):例如 100 MB / 1 day / 00:00
RAKUTEN_LOG_ROTATION=100 MB
# 日志清理策略(Loguru 语法):例如 14 days / 30 days
RAKUTEN_LOG_RETENTION=14 days
# 日志压缩格式:zip / gz / tar.gz;留空表示不压缩
RAKUTEN_LOG_COMPRESSION=zip
# Bearer Token 鉴权密钥:请求需携带 Authorization: Bearer <token>
RAKUTEN_BEARER_TOKEN=REPLACE_WITH_TOKEN_32CHARS
# 单次抓取超时(秒)
RAKUTEN_REQUEST_TIMEOUT_SECONDS=30
# 对乐天站点的最大并发请求数
RAKUTEN_MAX_SITE_CONCURRENCY=8
# 单次抓取的最大尝试次数(含首次):1 次直发,2 次换 cookie 重试,3 次起动用浏览器兜底
RAKUTEN_HTTP_MAX_ATTEMPTS=3
# Akamai cookie 最长复用时长(秒),超时后重新预热
RAKUTEN_SESSION_TTL_SECONDS=1800
# 浏览器兜底:纯 HTTP 被反爬拦截时用 Playwright 取回 cookie 再回灌重试。
# 日常流量不会触发;未安装 playwright 时自动降级为不兜底(主链路不受影响)。
RAKUTEN_BROWSER_FALLBACK_ENABLED=true
# 浏览器无头模式(留空表示 dev 有头、其他环境无头)
RAKUTEN_BROWSER_HEADLESS=
# 使用的浏览器通道(Windows 可填 chrome;留空使用 bundled chromium)
RAKUTEN_BROWSER_CHANNEL=
# 代理地址(需要日本 IP 时配置,例如 http://127.0.0.1:7890)
# 建议两个服务各配各的:抓取被限速换 IP 即可,交易带账号,出口 IP 频繁漂移
# 反而会触发风控。
RAKUTEN_PROXY_SERVER=
# 代理用户名(如代理需要认证则填写)
RAKUTEN_PROXY_USERNAME=
# 代理密码(如代理需要认证则填写)
RAKUTEN_PROXY_PASSWORD=
# ---- OpenTelemetry traces(可选;默认关闭)----
# 启用后把抓取-解析链路以 span 导出到 OTLP/HTTP endpoint,
# 用于排查"抓到的内容为什么解析不出预期字段"。
# 解析失败时会把页面 HTML 作为 span event 上报(上限可配),便于事后复现。
RAKUTEN_OTEL_ENABLED=false
RAKUTEN_OTEL_ENDPOINT=https://oltp.jerryyan.top/v1/traces
# 服务名按服务覆盖;不设时两侧 main.py 分别按 rakuten-scraping / rakuten-trading 落地
RAKUTEN_OTEL_SERVICE_NAME=
# OTLP 鉴权头(形如 key=val,key=val);当前 endpoint 裸跑,留空
RAKUTEN_OTEL_HEADERS=
# 失败 HTML 快照上限字节(默认 2MB,超出截断并标注 truncated=true)
RAKUTEN_OTEL_SNAPSHOT_MAX_BYTES=2000000
# ---- 以下仅交易服务使用 ----
# 人工登录后落盘的 cookie 目录(相对项目根目录)。
# 里面是可直接冒充账号的凭据,已在 .gitignore 排除,不要提交、不要外传。
RAKUTEN_AUTH_STATE_DIR=.auth
# 下单金额上限(日元):实际应付超过该值直接拒绝提交,防止解析出错或页面改版
# 导致买到远超预期的订单。设为 0 表示不设上限(不建议)。
RAKUTEN_ORDER_MAX_TOTAL_YEN=30000
# 付款后监控(订单列表页轮询)间隔(秒)与最大轮询次数。间隔不宜太短——同一账号
# 频繁访问订单页有被风控盯上的风险。默认 3 小时一次,最多 80 次(约 10 天)。
RAKUTEN_ORDER_MONITOR_POLL_INTERVAL_SECONDS=10800
RAKUTEN_ORDER_MONITOR_MAX_CHECKS=80
# 登录态失效时是否自动重登(需要项目根有 account.yaml,含明文密码)。
# 关闭时登录态一掉就抛 5001 / 转 needs_human,需要人工跑 scripts/login.py。
RAKUTEN_RELOGIN_ENABLED=true
# 自动登录(含撞验证码时等人工接管)的最长总耗时(秒)。无人值守的机器可以调小
# (如 60)以尽快失败转 needs_human。
RAKUTEN_RELOGIN_TIMEOUT_SECONDS=300
# 启动时是否自动登录一次:起服务即按 account.yaml 把登录态准备好,不必先在宿主机跑
# scripts/login.py。后台执行不阻塞端口,失败只记日志。
# **刻意留成注释**:裸机跑不开(代码默认 false,别在开发机上一启动就弹浏览器),
# 容器部署由 docker-compose.yml 给 true。这里一旦写成显式值,compose 里的
# `${RAKUTEN_AUTO_LOGIN_ON_START:-true}` 就会读到 .env 的值而失效——compose 的变量
# 插值和 env_file 读的是同一个 ./.env。要手动覆盖时才取消注释。
# RAKUTEN_AUTO_LOGIN_ON_START=false
# ---- 以下仅下单任务网关使用 ----
# 任务队列 SQLite 文件路径(相对项目根目录)。务必放在持久化卷上,丢了等于
# 丢了一批下单任务。详见 docs/order-gateway.md。
RAKUTEN_GATEWAY_DB_PATH=data/gateway.db
# 任务租约 TTL(秒)。worker 领取后必须在此时间内首次 report 或 renew,否则
# 任务被置为 stale(**绝不自动重投**,需要人工 reclaim)。
RAKUTEN_LEASE_TTL_SECONDS=300
# 长轮询单次最长挂起秒数。worker 端 wait 参数会被夹到这个上限。
RAKUTEN_LEASE_MAX_WAIT_SECONDS=60
# worker 心跳超时阈值(秒)。超过即视为失联,/health 报 degraded。
RAKUTEN_WORKER_OFFLINE_ALERT_SECONDS=300
# ---- 以下仅交易服务内的下单 worker 使用 ----
# 网关 URL。**留空则不启动 worker**,交易服务只跑登录态接口。
# 部署形态:本地机(NAT 后无公网入口)通过出站长轮询从这里领任务。
RAKUTEN_ORDER_GATEWAY_URL=
# worker 标识。同一时间只能有一个 worker 持有 lease,留空时取主机名。
RAKUTEN_WORKER_ID=
# 本地订单 SQLite 文件路径(执行事实的权威记录)。
RAKUTEN_TRADING_DB_PATH=data/trading.db
# 页面证据目录(HTML 快照 + 截图 + meta.json,按 task_id 分子目录)。
RAKUTEN_EVIDENCE_DIR=data/evidence
# 抓取服务基地址。worker 需要商品数据(加购用 purchase 块)时出站请求这里。
RAKUTEN_SCRAPER_BASE_URL=