R Academy · 课时

将 Plumber API 部署到生产环境

使用 Docker 和云平台容器化并部署 Plumber API

将 Plumber API 部署到生产环境 是 CoddyKit 上的免费 R Academy 课时。这是第 4 节课，共 4 节。你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。这是 R Academy 学习路径的一部分，你的进度在网页和 CoddyKit 应用中同步。 R Academy 课程共包含 4 节课。

生产部署选项

Plumber API 可以通过多种方式部署：

Docker 容器——可移植、可重复，并且可以在任何地方运行
Posit Connect——一键部署并支持调度
Digital Ocean / EC2——运行 R 的普通 Linux VM

Docker 是可移植性最高的选项，也是生产环境 R API 的行业标准。

Plumber API 入口点

创建顶层文件 api.R 以启动 Plumber 服务器。使用 Sys.getenv('PORT', unset='8000')，这样容器编排器无需修改代码即可设置端口。

# api.R
# library(plumber)
#
# pr <- plumb('routes.R')
# port <- as.integer(Sys.getenv('PORT', unset = '8000'))
# pr$run(host = '0.0.0.0', port = port)
#
# Listening on 0.0.0.0 is required inside Docker
# (127.0.0.1 is only reachable inside the container)

基础 Docker 镜像——rocker/r-ver

rocker/r-ver 镜像提供了精简且固定版本的 R 环境。请始终固定具体的 R 版本（例如 rocker/r-ver:4.3.2），以确保构建结果可重复。在生产环境中避免使用 :latest。

# Dockerfile
# FROM rocker/r-ver:4.3.2
#
# Alternatively use rocker/plumber which pre-installs plumber:
# FROM rstudio/plumber:latest
#
# rocker/r-ver is more minimal and gives you full control
# over which packages are installed.

在 Dockerfile 中安装 R 包

使用 RUN Rscript -e "install.packages(...)" 在镜像构建期间安装包。请先使用 apt-get 安装系统依赖（例如 httr2 所需的 libssl-dev）。

# FROM rocker/r-ver:4.3.2
#
# RUN apt-get update && apt-get install -y \
#     libssl-dev \
#     libcurl4-openssl-dev \
#  && rm -rf /var/lib/apt/lists/*
#
# RUN Rscript -e "install.packages(c('plumber', 'jsonlite', 'httr2'), repos='https://cloud.r-project.org')"

复制文件并设置端口

使用 COPY 将 R 源文件复制到容器中。使用 EXPOSE 声明端口，让 Docker 知道容器监听哪个端口。这仅用于文档说明，不会发布端口。

# FROM rocker/r-ver:4.3.2
# ...
# WORKDIR /app
# COPY routes.R .
# COPY api.R .
#
# EXPOSE 8000
#
# CMD ["Rscript", "api.R"]

构建并运行 Docker 镜像

使用 docker build 构建镜像，然后运行一个将主机端口映射到容器端口的容器。-e 标志用于注入机密信息所需的环境变量。

# Build the image:
# docker build -t my-r-api:1.0 .
#
# Run a container:
# docker run -d \
#   -p 8000:8000 \
#   -e API_SECRET_KEY='my_secret' \
#   -e DATABASE_URL='postgres://...' \
#   --name r-api \
#   my-r-api:1.0
#
# Test:
# curl http://localhost:8000/ping

使用 Sys.getenv() 读取机密信息

在生产环境中，绝不要将机密信息放入 Dockerfile 或源代码中。请在运行时使用 Sys.getenv() 读取它们。通过 Docker 的 -e 标志、Kubernetes 机密信息或 AWS Secrets Manager 等环境变量管理系统传入这些信息。

# In routes.R:
# db_url   <- Sys.getenv('DATABASE_URL', unset = '')
# api_key  <- Sys.getenv('API_SECRET_KEY', unset = '')
#
# if (nchar(db_url) == 0)  stop('DATABASE_URL is required')
# if (nchar(api_key) == 0) stop('API_SECRET_KEY is required')
#
# Fail fast at startup rather than failing silently at request time
cat('Validate all required env vars at startup with stop()
')

运行状况检查端点

/ping 或 /health 端点可以让负载均衡器和编排器（Kubernetes、ECS）确认 API 正在运行。它应在无需身份验证的情况下快速返回 200，并且可以选择检查数据库连接。

# #* Health check
# #* @preempt auth
# #* @get /ping
# function() {
#   list(
#     status  = 'ok',
#     version = '1.0.0',
#     time    = format(Sys.time(), '%Y-%m-%dT%H:%M:%SZ')
#   )
# }
#
# Docker HEALTHCHECK:
# HEALTHCHECK CMD curl -f http://localhost:8000/ping || exit 1

完整 Dockerfile 示例

将所有内容组合起来——下面是一个适用于生产环境的 Plumber API Dockerfile：

# FROM rocker/r-ver:4.3.2
# RUN apt-get update && apt-get install -y libssl-dev libcurl4-openssl-dev \
#  && rm -rf /var/lib/apt/lists/*
# RUN Rscript -e "install.packages(c('plumber','jsonlite'), repos='https://cloud.r-project.org')"
# WORKDIR /app
# COPY routes.R api.R ./
# EXPOSE 8000
# HEALTHCHECK CMD curl -f http://localhost:8000/ping || exit 1
# CMD ["Rscript", "api.R"]

生产环境中的日志记录

结构化日志记录有助于诊断生产环境中的问题。使用 cat() 或 logger 包将带时间戳的日志写入标准输出——Docker 和大多数平台会自动捕获标准输出，并将其转发到日志聚合器。

# Log format: ISO timestamp + level + message
log_info <- function(msg) {
  cat(format(Sys.time(), '%Y-%m-%dT%H:%M:%S'), '[INFO]', msg, '
')
}

log_info('API starting up')
log_info(paste('Port:', Sys.getenv('PORT', '8000')))

使用 Nginx 作为反向代理

在生产环境中，应在 Plumber 前面放置 Nginx 反向代理，以处理 TLS 终止、速率限制和请求缓冲。Nginx 将请求传递到本地主机上的 Plumber，而外部世界则通过 443 端口连接到 Nginx。

# Nginx config snippet (nginx.conf):
# server {
#   listen 443 ssl;
#   ssl_certificate     /etc/letsencrypt/.../fullchain.pem;
#   ssl_certificate_key /etc/letsencrypt/.../privkey.pem;
#
#   location /api/ {
#     proxy_pass         http://127.0.0.1:8000/;
#     proxy_set_header   Host $host;
#     proxy_set_header   X-Real-IP $remote_addr;
#   }
# }

快速检查：Docker EXPOSE

Dockerfile 中的 EXPOSE 8000 指令实际上会执行什么操作？

Plumber API 部署回顾

生产环境部署 Plumber 的关键步骤：

监听 0.0.0.0，并从环境中读取 PORT
使用固定版本的 rocker/r-ver:X.Y.Z 作为基础镜像
在 Dockerfile 中安装包；只复制源文件
通过 -e 环境变量注入机密信息——绝不要将其放在源代码或 Dockerfile 中
添加 /ping 运行状况检查端点（使用 #* @preempt auth）
使用 Nginx 作为反向代理来处理 TLS 和速率限制

常见问题解答

「将 Plumber API 部署到生产环境」课时是免费的吗？

是的 — 「将 Plumber API 部署到生产环境」的完整文本可在网页上免费阅读。要进行交互式练习（内置代码编辑器和全天候 AI 导师）并解锁 R Academy 课程的其余内容，请升级到 CoddyKit PRO。 R Academy 课程共包含 4 节课。

「将 Plumber API 部署到生产环境」这节课中我会学到什么？

使用 Docker 和云平台容器化并部署 Plumber API 你通过在浏览器中直接运行的动手代码来练习 R Academy，全天候 AI 导师会在你学习这节课的过程中回答你的问题。

学习 R Academy 需要有经验吗？

无需任何先前经验。CoddyKit 上的 R Academy 课程适合初学者到高级学习者，你可以从这里开始或从头开始，按照自己的节奏学习。这是第 4 节课，共 4 节。

「将 Plumber API 部署到生产环境」课时需要多长时间？

大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动，所以你能稳步进步，并在网页和应用中从离开的地方继续。

我能在这节 R Academy 课中编写并运行代码吗？

能。每节 R Academy 课都包含内置代码编辑器，你可以在浏览器中直接编写并运行真实代码，并获得即时 AI 反馈 — 无需本地设置。

此课程中的所有课时

← 返回 R Academy