WebDAV（Web Distributed Authoring and Versioning）是对HTTP协议的扩展，它允许客户端以标准化的方式对远程服务器上的文件进行创建、修改、移动和锁定等操作。在Ruby生态中，虽然存在一些现成的WebDAV库，但在某些定制化场景下，直接使用HTTP库结合XML解析器来手动实现WebDAV客户端，能够提供更细粒度的控制和更高的灵活性。本文将详细探讨如何在Ruby中实现WebDAV客户端的核心功能，包括获取资源属性的PROPFIND请求、创建目录的MKCOL操作，以及处理并发冲突的文件锁定机制。
WebDAV协议基础与Ruby环境准备
WebDAV在HTTP的基础上增加了一系列新的方法，如PROPFIND用于获取属性，MKCOL用于创建集合（目录），LOCK和UNLOCK用于资源锁定。要实现一个功能完备的WebDAV客户端，首先需要理解这些方法的具体语义和对应的请求头要求。例如，PROPFIND请求通常需要设置Depth头部，其值可以是0、1或infinity，分别表示只查询资源本身、查询当前层级以及递归查询所有子层级。
在Ruby中，我们可以使用标准库net/http来发送自定义的HTTP请求，同时利用nokogiri宝石来解析WebDAV服务器返回的XML格式的多重状态响应。首先，确保你的项目中安装了必要的依赖。可以通过以下命令安装nokogiri，它是一个强大的HTML和XML解析器，能够帮助我们轻松提取WebDAV响应中的文件名、大小、修改时间等元数据。
gem install nokogiri
在编写客户端代码之前，我们需要定义一个基础的WebDAV客户端类，用于封装服务器的连接信息和认证逻辑。由于WebDAV通常基于HTTP基本认证或摘要认证，我们可以直接在Net::HTTP请求中添加Authorization头部。为了方便后续操作，我们将初始化一个WebDAVClient类，接收服务器地址、用户名和密码作为参数，并维护一个HTTP连接实例。
使用PROPFIND获取资源属性与目录列表
PROPFIND是WebDAV中最常用的方法之一，它允许客户端查询服务器上某个资源或集合的属性。当需要列出远程目录下的所有文件时，我们会向目录的URL发送一个PROPFIND请求，并设置Depth头部为1。请求体通常是一个XML文档，指明我们需要获取哪些属性，例如显示名、内容长度、最后修改时间等。如果请求体为空，服务器通常会返回默认的属性集。
在Ruby中实现PROPFIND请求，需要构建一个Net::HTTP::Propfind对象（由于标准库没有直接提供这个类，我们可以通过Net::HTTPGenericRequest来动态创建自定义方法）。服务器返回的响应状态码通常是207 Multi-Status，这意味着响应体是一个包含多个资源状态的XML文档。我们需要使用Nokogiri::XML来解析这个文档，提取出每个文件的href和对应的属性。
require 'net/http'
require 'nokogiri'
class WebDAVClient
def initialize(base_url, username, password)
@base_url = URI.parse(base_url)
@username = username
@password = password
@http = Net::HTTP.new(@base_url.host, @base_url.port)
@http.use_ssl = (@base_url.scheme == 'https')
end
def propfind(path, depth = 1)
request = Net::HTTP::Propfind.new(path)
request['Depth'] = depth.to_s
request['Content-Type'] = 'application/xml; charset=utf-8'
request.basic_auth(@username, @password)
# 设置请求体，请求获取所有属性
request.body = '<?xml version="1.0" encoding="utf-8"?><propfind xmlns="DAV:"><allprop/></propfind>'
response = @http.request(request)
if response.code == '207'
parse_multi_status(response.body)
else
raise "PROPFIND failed: #{response.code} #{response.message}"
end
end
private
def parse_multi_status(xml_body)
doc = Nokogiri::XML(xml_body)
# 移除命名空间以简化XPath查询
doc.remove_namespaces!
entries = []
doc.xpath('//response').each do |node|
href = node.at_xpath('href').content
# 提取文件大小
size_node = node.at_xpath('//getcontentlength')
size = size_node ? size_node.content.to_i : 0
entries << { href: href, size: size }
end
entries
end
end
# 动态创建Net::HTTP::Propfind类
module Net
class HTTPPropfind < HTTPGenericRequest
METHOD = 'PROPFIND'
REQUEST_HAS_BODY = true
RESPONSE_HAS_BODY = true
end
end上述代码展示了如何动态扩展Net::HTTP来支持PROPFIND方法。在parse_multi_status方法中，我们使用了remove_namespaces!方法，这在处理复杂的WebDAV命名空间时非常有用，可以让我们直接使用简单的XPath表达式来查询节点。解析完成后，我们将得到一个包含文件路径和大小的哈希数组，客户端可以据此构建本地文件列表视图。
使用MKCOL创建集合与目录结构
MKCOL方法用于在WebDAV服务器上创建一个新的集合，也就是我们常说的目录。与FTP的MKD命令类似，MKCOL请求发送到服务器后，如果目标路径不存在且父级集合存在，服务器将创建该目录。如果目录已经存在，服务器会返回405 Method Not Allowed状态码。因此，在执行MKCOL操作前，通常需要先通过PROPFIND检查目录是否存在，或者在代码中捕获异常以进行容错处理。
实现MKCOL相对简单，因为它不需要请求体。我们只需要向目标URL发送一个空的MKCOL请求即可。如果创建成功，服务器会返回201 Created状态码。在Ruby中，我们可以通过继承Net::HTTPGenericRequest来定义Net::HTTP::Mkcol类。为了提高目录创建的健壮性，我们可以封装一个递归创建目录的方法，类似于本地文件系统中的mkdir -p命令。
module Net
class HTTPMkcol < HTTPGenericRequest
METHOD = 'MKCOL'
REQUEST_HAS_BODY = false
RESPONSE_HAS_BODY = true
end
end
class WebDAVClient
# ... 之前的初始化代码 ...
def mkcol(path)
request = Net::HTTP::Mkcol.new(path)
request.basic_auth(@username, @password)
response = @http.request(request)
case response.code.to_i
when 201
puts "Directory created successfully at #{path}"
true
when 405
puts "Directory already exists or method not allowed: #{path}"
false
else
raise "MKCOL failed: #{response.code} #{response.message}"
end
end
def mkdir_p(path)
# 将路径拆分为各个层级
segments = path.split('/').reject(&:empty?)
current_path = '/'
segments.each do |segment|
current_path = File.join(current_path, segment)
# 尝试创建每一级目录，忽略已存在的错误
begin
mkcol(current_path)
rescue
# 忽略已存在导致的异常
end
end
end
end在这个实现中，mkdir_p方法通过分割路径并逐级发送MKCOL请求，实现了递归创建目录的功能。这种方法在处理多层嵌套目录时非常有效，即使中间某些目录已经存在，也能继续向下创建，确保最终目标目录结构被正确建立。需要注意的是，频繁的HTTP请求可能会带来网络延迟，在实际应用中可以考虑结合PROPFIND先检查整个路径结构，以减少不必要的网络往返。
实现文件锁定与解锁机制
在多用户或多进程同时访问和编辑WebDAV服务器上的同一文件时，如果不加控制，很容易发生写入冲突和数据覆盖。WebDAV协议通过LOCK和UNLOCK方法提供了原生的并发控制机制。当一个客户端获取了文件的写锁后，其他客户端将无法覆盖该文件，直到锁被释放或超时。实现文件锁定功能对于构建可靠的协作编辑系统至关重要。
LOCK请求通常包含一个XML请求体，指明锁的范围（可以是独占锁或共享锁）和超时时间。服务器在成功授予锁后，会返回一个Lock-Token，客户端在后续的PUT请求修改文件时，必须通过If头部携带这个Token来证明自己拥有修改权限。当修改完成后，客户端需要发送UNLOCK请求，并在Lock-Token头部中提供该令牌以释放锁。在Ruby中，我们可以通过自定义HTTP请求类来实现这两个操作。
module Net
class HTTPLock < HTTPGenericRequest
METHOD = 'LOCK'
REQUEST_HAS_BODY = true
RESPONSE_HAS_BODY = true
end
class HTTPUnlock < HTTPGenericRequest
METHOD = 'UNLOCK'
REQUEST_HAS_BODY = false
RESPONSE_HAS_BODY = true
end
end
class WebDAVClient
# ... 之前的初始化代码 ...
def lock(path, timeout = 3600)
request = Net::HTTP::Lock.new(path)
request['Content-Type'] = 'application/xml; charset=utf-8'
request['Timeout'] = "Second-#{timeout}"
request.basic_auth(@username, @password)
request.body = <<-XML
<?xml version="1.0" encoding="utf-8"?>
<lockinfo xmlns="DAV:">
<lockscope><exclusive/></lockscope>
<locktype><write/></locktype>
<owner>
<href>mailto:admin@ipipp.com</href>
</owner>
</lockinfo>
XML
response = @http.request(request)
if response.code == '200'
# 从响应头中提取Lock-Token
token = response['Lock-Token']
puts "Successfully locked #{path}. Token: #{token}"
token
else
raise "LOCK failed: #{response.code} #{response.message}"
end
end
def unlock(path, token)
request = Net::HTTP::Unlock.new(path)
request['Lock-Token'] = token
request.basic_auth(@username, @password)
response = @http.request(request)
if response.code == '204'
puts "Successfully unlocked #{path}"
true
else
raise "UNLOCK failed: #{response.code} #{response.message}"
end
end
def safe_write(path, content, token)
request = Net::HTTP::Put.new(path)
request['If'] = "(#{token})"
request.basic_auth(@username, @password)
request.body = content
response = @http.request(request)
if response.code == '204' || response.code == '201'
puts "File written successfully with lock token"
true
else
raise "Write failed: #{response.code} #{response.message}"
end
end
end上述代码完整展示了WebDAV的锁定与解锁流程。在lock方法中，我们请求一个独占写锁，并从响应头中获取Lock-Token。在safe_write方法中，我们将获取到的Token放入If头部，确保只有持有锁的客户端才能修改文件。操作完成后，调用unlock方法释放资源。这种机制有效避免了并发写入导致的数据损坏问题，是WebDAV协议在文件管理领域的重要优势之一。通过合理运用这些核心方法，Ruby开发者可以轻松构建出功能强大且安全可靠的远程文件管理系统。