使用Flask框架实现resumable.js断点续传后端服务

使用Flask框架实现resumable.js断点续传后端服务

resumable.js 项目地址: https://gitcode.com/gh_mirrors/re/resumable.js

什么是resumable.js

resumable.js是一个强大的JavaScript库，专门用于实现大文件的分块上传和断点续传功能。它通过将大文件分割成小块(chunk)进行上传，即使网络中断也能从中断处继续上传，大大提高了大文件上传的可靠性和用户体验。

Flask后端实现原理

下面我们将详细解析如何使用Python的Flask框架实现resumable.js的后端服务。整个实现主要包含三个关键部分：

1. 前端页面渲染

@app.route("/resumable")
def resumable_example():
    return render_template("resumable_upload.html")

这部分代码负责渲染前端页面，该页面应包含resumable.js的上传组件。虽然示例中没有展示HTML模板内容，但通常它会包含文件选择控件和上传按钮。

2. 分块验证接口(GET请求)

@app.route("/resumable_upload", methods=['GET'])
def resumable():
    # 获取请求参数
    resumableIdentfier = request.args.get('resumableIdentifier', type=str)
    resumableFilename = request.args.get('resumableFilename', type=str)
    resumableChunkNumber = request.args.get('resumableChunkNumber', type=int)
    
    # 参数验证
    if not resumableIdentfier or not resumableFilename or not resumableChunkNumber:
        abort(500, 'Parameter error')
    
    # 构建分块文件路径
    temp_dir = os.path.join(temp_base, resumableIdentfier)
    chunk_file = os.path.join(temp_dir, get_chunk_name(resumableFilename, resumableChunkNumber))
    
    # 检查分块是否存在
    if os.path.isfile(chunk_file):
        return 'OK'
    else:
        abort(404, 'Not found')

这个GET接口用于检查特定分块是否已经上传。resumable.js会在实际上传前先调用此接口，如果分块已存在则跳过上传，实现断点续传功能。

3. 分块上传接口(POST请求)

@app.route("/resumable_upload", methods=['POST'])
def resumable_post():
    # 获取表单数据
    resumableTotalChunks = request.form.get('resumableTotalChunks', type=int)
    resumableChunkNumber = request.form.get('resumableChunkNumber', default=1, type=int)
    resumableFilename = request.form.get('resumableFilename', default='error', type=str)
    resumableIdentfier = request.form.get('resumableIdentifier', default='error', type=str)
    
    # 获取分块数据
    chunk_data = request.files['file']
    
    # 创建临时目录
    temp_dir = os.path.join(temp_base, resumableIdentfier)
    if not os.path.isdir(temp_dir):
        os.makedirs(temp_dir, 0777)
    
    # 保存分块
    chunk_name = get_chunk_name(resumableFilename, resumableChunkNumber)
    chunk_file = os.path.join(temp_dir, chunk_name)
    chunk_data.save(chunk_file)
    
    # 检查是否所有分块都已上传
    chunk_paths = [os.path.join(temp_dir, get_chunk_name(resumableFilename, x)) 
                  for x in range(1, resumableTotalChunks+1)]
    upload_complete = all([os.path.exists(p) for p in chunk_paths])
    
    # 合并分块
    if upload_complete:
        target_file_name = os.path.join(temp_base, resumableFilename)
        with open(target_file_name, "ab") as target_file:
            for p in chunk_paths:
                with open(p, 'rb') as stored_chunk_file:
                    target_file.write(stored_chunk_file.read())
                os.unlink(p)
        os.rmdir(temp_dir)
    
    return 'OK'

这个POST接口处理实际的文件分块上传。它会：

1. 接收上传的文件分块
2. 将分块保存到临时目录
3. 检查是否所有分块都已上传完成
4. 如果全部完成，则合并所有分块为完整文件

关键函数解析

def get_chunk_name(uploaded_filename, chunk_number):
    return uploaded_filename + "_part_%03d" % chunk_number

这个辅助函数用于生成分块文件的命名规则，格式为"原文件名_part_序号"，如"example.zip_part_001"。

实际应用中的注意事项

1. 安全性考虑：

   • 应对上传的文件类型和大小进行限制
   • 对文件名进行安全处理，防止路径遍历攻击
   • 考虑添加身份验证机制

2. 性能优化：

   • 对于大文件，合并操作可能耗时，可以考虑使用后台任务处理
   • 可以添加文件校验机制(MD5/SHA等)

3. 存储管理：

   • 添加定时清理未完成上传的临时文件
   • 考虑分布式存储方案应对大流量场景

4. 错误处理：

   • 增强各种异常情况的处理
   • 添加详细的日志记录

总结

通过这个Flask实现，我们为resumable.js提供了一个完整的后端服务，支持文件分块上传、断点续传和自动合并功能。这种方案特别适合大文件上传场景，能够有效应对网络不稳定等问题，提升用户体验。

开发者可以根据实际需求对这个基础实现进行扩展，添加更多业务逻辑和安全措施，构建出更健壮的文件上传服务。

resumable.js 项目地址: https://gitcode.com/gh_mirrors/re/resumable.js