首页
/ Water under Ice 技术文档

Water under Ice 技术文档

2024-12-16 10:23:02作者:冯爽妲Honey

1. 安装指南

客户端要求

  • HTML 5 兼容的浏览器
  • jQuery >= 1.4.3
  • jQuery UI >= 1.8.4

服务器端要求

  • HTTP 服务器(例如 Sinatra)
  • WebSocket 服务器(例如 em-websockets)

安装步骤

  1. cssjs 目录复制到服务器的公共目录中。
  2. 在网页的 <head> 部分添加以下代码:
    <link href="css/web_socket_file_uploader.css" media="screen" rel="StyleSheet" type="text/css">
    <script language="javascript" src="js/web_socket_client.js" type="text/javascript"></script>
    <script language="javascript" src="js/web_socket_file_uploader.js" type="text/javascript"></script>
    <script language="javascript" src="js/application.js" type="text/javascript"></script>
    
  3. 在网页的 <body> 部分添加以下代码块:
    <div class="file_uploader">
      <h2>File Upload</h2>
      <div class="file_progress_bar">
        <span class="file_information" name="file_information"></span>
        <input class="file_browse_button" type="button" value="Browse">
        <input class="file_upload_button" type="button" value="Upload">
        <input class="file_reupload_button" type="button" value="Reupload">
        <input class="file_pause_button" type="button" value="Pause">
        <input class="file_resume_button" type="button" value="Resume">
        <input class="file_cancel_button" type="button" value="Cancel">
        <span class="file_progress" name="file_progress"></span>
        <input class="file_name_input" name="file_name_input" type="file">
      </div>
    </div>
    

2. 项目的使用说明

功能特点

  • 支持非常大的文件上传。
  • 上传过程中不会阻塞网页。
  • 可以随时暂停和恢复上传,即使在不同的会话或机器上。
  • 使用 WebSocket 协议进行传输。
  • 不使用 Flash、Java、iframe 或 XHR。

使用步骤

  1. 用户点击“浏览”按钮选择文件。
  2. 点击“上传”按钮开始上传文件。
  3. 上传过程中,用户可以点击“暂停”按钮暂停上传,或点击“恢复”按钮继续上传。
  4. 如果需要取消上传,可以点击“取消”按钮。

3. 项目API使用文档

WebSocket 客户端 API

  • web_socket_client.js:负责与服务器建立 WebSocket 连接,并处理文件分段传输。
  • web_socket_file_uploader.js:负责文件的读取、分段、上传和暂停/恢复功能。

主要函数

  • initWebSocket(url):初始化 WebSocket 连接。
  • sendFileSegment(segment):发送文件分段到服务器。
  • pauseUpload():暂停上传。
  • resumeUpload():恢复上传。
  • cancelUpload():取消上传。

4. 项目安装方式

示例服务器运行

  1. 安装 Ruby 和 Rubygems:
    sudo apt-get install ruby rubygems
    
  2. 安装 Bundler:
    gem install bundler
    
  3. 克隆项目并安装依赖:
    git clone git://github.com/thirtysixthspan/waterunderice
    cd waterunderice
    bundle install
    
  4. 运行服务器:
    ruby server.rb
    
  5. 访问服务器端口 8000(例如:http://yourserver:8000)。

注意事项

  • 浏览器必须支持 HTML 5 和 WebSockets。
  • 当前 WebSockets 仅支持 ASCII 传输,因此文件在上传前需要进行 Base64 编码,这会增加总传输字节数的三分之一,并可能增加 CPU 负载。

支持的浏览器

  • Chrome 4
  • Firefox 4

5. 许可证

本项目采用 MIT 许可证,详细信息请参阅项目根目录下的 LICENSE 文件。

登录后查看全文

项目优选

收起
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
295
998
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
499
396
leetcodeleetcode
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
51
15
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
114
199
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
61
144
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
97
251
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
357
342
CangjieMagicCangjieMagic
基于仓颉编程语言构建的 LLM Agent 开发框架,其主要特点包括:Agent DSL、支持 MCP 协议,支持模块化调用,支持任务智能规划。
Cangjie
580
41
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
374
37
杨帆测试平台杨帆测试平台
扬帆测试平台是一款高效、可靠的自动化测试平台,旨在帮助团队提升测试效率、降低测试成本。该平台包括用例管理、定时任务、执行记录等功能模块,支持多种类型的测试用例,目前支持API(http和grpc协议)、性能、CI调用等功能,并且可定制化,灵活满足不同场景的需求。 其中,支持批量执行、并发执行等高级功能。通过用例设置,可以设置用例的基本信息、运行配置、环境变量等,灵活控制用例的执行。
JavaScript
21
2