如何在Plumber API中实现用户选择的xlsx文件上传作为接口输入
Plumber 实现任意XLSX文件上传接口的实操方案
前置依赖准备
- 核心框架
plumber,用来搭建API服务 - 表格解析包
readxl,用来读取上传的xlsx内容 - 内置的
tools包,用来做文件后缀校验,不需要额外安装
核心接口代码实现
Plumber处理文件上传的核心逻辑是:服务端开启multipart表单解析能力,直接捕获用户上传的文件流,自动存储到系统临时目录,再交给路由逻辑处理,全程不需要用户填写本地文件的绝对路径。
可直接复用的接口代码示例:
# 加载依赖(也可以在启动脚本里统一加载) library(plumber) library(readxl) #* 支持任意xlsx文件上传的接口 #* @post /upload-any-xlsx #* @parser multi # 必须开启multipart解析,这是文件上传场景的核心配置 function(req, res) { # 从请求体里拿到解析后的上传文件信息 form_content <- req$body # 空请求校验 if (length(form_content) == 0) { res$status <- 400 return(list(msg = "未接收到任何上传文件,请选择本地xlsx文件后提交")) } # 取第一个上传的文件(如果需要支持多文件上传,遍历列表即可) target_upload <- form_content[[1]] temp_file_path <- target_upload$datapath original_file_name <- target_upload$filename # 文件格式校验 file_suffix <- tolower(tools::file_ext(original_file_name)) if (file_suffix != "xlsx") { unlink(temp_file_path) # 清理不符合要求的临时文件 res$status <- 400 return(list(msg = paste0("仅支持xlsx格式文件,当前上传文件后缀为:", file_suffix))) } # 任意解析xlsx内容,这里没有硬编码表头/列名限制,支持任意结构的xlsx parse_result <- tryCatch({ read_xlsx(temp_file_path) }, error = function(e) { res$status <- 422 list(msg = paste0("xlsx文件解析失败,文件可能损坏:", e$message)) }) # 清理临时文件,避免磁盘占用 unlink(temp_file_path) # 返回处理结果,可根据业务需求自定义返回内容 return(list( upload_file_name = original_file_name, total_rows = nrow(parse_result), total_cols = ncol(parse_result), content_preview = head(parse_result, 3) )) }
高频踩坑提醒
- 千万不要漏写
#* @parser multi注解:默认的plumber parser只会解析JSON格式的请求体,漏写的话会完全读不到上传的文件内容,这是90%的人第一次做文件上传接口会踩的问题 - 不要让用户在接口参数里传本地文件的绝对路径:一是安全风险极高,二是接口服务跑在服务器上根本读不到用户本地电脑的文件路径,所有文件内容都是通过multipart流上传的
- 临时文件必须主动清理:Plumber把上传文件存到临时目录后不会自动删除,长期运行的服务如果不清理,会快速占满磁盘空间
- 因为要求支持任意xlsx文件,不要在解析逻辑里硬编码固定列名、固定表头的校验规则,不然会把正常上传的非预设结构的文件挡在外面
本地测试方式
- 把上面的代码存为
plumber_api.R,在R控制台执行pr("plumber_api.R") %>% pr_run(port = 8080)就能启动服务 - 测试时构造multipart格式的POST请求即可,比如用curl命令:
curl -F "upload_file=@/你本地电脑的任意测试文件.xlsx" http://localhost:8080/upload-any-xlsx - 如果要做简单的上传页面,只需要写一个带
enctype="multipart/form-data"属性的表单,里面放一个type为file的input框,指定accept=".xlsx"限制用户选文件的格式,提交到上面的接口地址就行,不需要额外的上传逻辑
内容的提问来源于stack exchange,提问作者Sabyasachi Datta
相关产品推荐
相关产品推荐

