Water under Ice 技术文档

2024-12-20 16:30:59作者：冯爽妲Honey

1. 安装指南

客户端要求

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

服务器端要求

HTTP 服务器（例如 Sinatra）
WebSocket 服务器（例如 em-websockets）

安装步骤

将 css 和 js 目录复制到服务器的公共目录中。

在网页的 <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>

在网页的 <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。

使用步骤

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

3. 项目API使用文档

WebSocket 客户端 API

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

主要函数

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

4. 项目安装方式

示例服务器运行

安装 Ruby 和 Rubygems：
```
sudo apt-get install ruby rubygems
```
安装 Bundler：
```
gem install bundler
```

克隆项目并安装依赖：

git clone git://github.com/thirtysixthspan/waterunderice
cd waterunderice
bundle install

运行服务器：
```
ruby server.rb
```
访问服务器端口 8000（例如：http://yourserver:8000）。

注意事项

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

支持的浏览器

Chrome 4
Firefox 4

5. 许可证

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

登录后查看全文

项目优选

收起

kernel

deepin linux kernel

docs

OpenHarmony documentation | OpenHarmony开发者文档

Ascend Extension for PyTorch

🎉 (RuoYi)官方仓库基于SpringBoot，Spring Security，JWT，Vue3 & Vite、Element Plus 的前后端分离权限管理系统

🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端

openEuler内核是openEuler操作系统的核心，既是系统性能与稳定性的基石，也是连接处理器、设备与服务的桥梁。

openJiuwen agent-studio提供零码、低码可视化开发和工作流编排，模型、知识库、插件等各资源管理能力

TSX

986

248