.NET (PowerShell) 并发文件使用（锁定，同时仍允许读取访问）

Question

我有一个需要同时访问的 XML 文件。我不需要并发写入，但我确实需要并发读取。读取/修改此 XML 文件的规定方法是使用 PowerShell 脚本，该脚本使用 Linq to XML (XElement) 来处理 XML 文件。

理想的场景是：

1. 团队中的所有用户都将在工作日开始时运行此 PowerShell 脚本，并将一直运行到工作日结束。
2. 在整个工作日期间，团队中的任何用户都将输入预定义的命令，这些命令将查询 XML 文件以收集数据。每次用户运行其中一个查询时，它都会打开 XML 文件，执行查询，关闭 XML 文件，然后显示结果。
3. 有时，这些用户中的任何一个都需要修改 XML 文件。用户将输入一个预定义的命令，指定他们想要修改的节点，然后他们将输入他们想要添加/修改的所有数据。然后脚本将打开文件（锁定它，因此其他用户无法以读/写方式打开它），将 XML 文件读入XElement 对象，执行所需的操作，然后将XElement 保存回文件，然后释放锁。
4. 在任何时候，当用户修改文件时（某些操作可能很长），任何其他尝试进行修改的用户不得能够打开文件（我会发现异常，并显示“请稍等”类型的消息）。但是，他们必须能够以只读方式打开文件才能执行查询。

我见过this related post, 'Concurrent file usage in C#'，并尝试使用以下代码来实现这一点。在 PowerShell ISE 的一个实例中，我执行读写函数，然后在“输入项目名称”循环中，我在另一个 PowerShell ISE 实例中执行只读函数。尝试以只读方式打开文档时，我收到一条异常声明 The process cannot access the file 'C:\Path\To\file.xml' because it is being used by another process.

using namespace System.Linq.Xml
using namespace System.IO
Add-Type -AssemblyName 'System.Xml.Linq (rest of Assembly's Full Name)'

$filename = "C:\Path\To\file.xml"

function Read-Only()
{
    $filestream = [FileStream]::new($filename, [FileMode]::Open, [FileAccess]::Read)
    $database = [XElement]::Load($filestream)
    foreach($item in $database.Element("Items").Elements("Item"))
    {
        Write-Host "Item name $($item.Attribute("Name").Value)"
    }
    $filestream.Close()
    $filestream.Dispose()
}
function Read-Write()
{
    $filestream = [FileStream]::new($filename, [FileMode]::Open, [FileAccess]::ReadWrite, [FileShare]::Read)
    $database = [XElement]::Load($filestream)

    $itemname = Read-Host "Enter an item name ('quit' to quit)"
    while($itemname -ne 'quit')
    {
        $database.Element("Items").Add([XElement]::new([XName]"Item", [XAttribute]::new([XName]"Name", $itemname)))
        $itemname = Read-Host "Enter an item name ('quit' to quit)"
    }

    $filestream.Seek(0, [SeekOrigin]::Begin)
    $database.Save($filestream)

    $filestream.Close()
    $filestream.Dispose()
}

如何锁定文件以进行独占编辑，同时仍允许对任何其他客户端进行只读访问？

编辑：我已经通过使用 mklement0 建议的解决方案解决了这个问题 - 使用单独的文件作为锁定文件。代码贴在这里：https://pastebin.com/ytzGE7se

Answer 1

如果您使用[FileAccess]::Read 而不明确指定文件共享模式，那么如果文件已经打开，则只有在最初使用文件共享模式[FileShare]::ReadWrite 打开文件时，再次打开它才会成功（即使您'仅要求 read 访问，该方法 defaults 也请求 write 访问）-而您的 Read-Write 函数（明智地）仅使用 @ 987654326@.

如果您使用文件共享模式[FileShare]::ReadWrite显式打开只读文件流，您的直接问题就会消失：

[System.IO.FileStream]::new(
  $path, 
  [System.IO.FileMode]::Open, 
  [System.IO.FileAccess]::Read, 
  [System.IO.FileShare]::ReadWrite  # !! required
)

这允许其他读取器同时访问以及唯一的（读取+）写入器（可能首先打开文件）。

但是，文件在被其他人读取的同时被重写可能会出现问题，因此为了稳健和可预测的操作我建议不同的方法：

注意：This answer 对相关问题显示了以下解决方案的更简单的替代方法，但是，更新需要更长的时间文件。

---

在文件的临时副本中进行修改，然后替换原始文件。

这需要显式同步来协调潜在的更新程序，以便序列化更新，以便防止更新相互覆盖。
您可以使用一个单独的锁定文件（哨兵文件）来实现这一点，例如，updating，它可以作为其他潜在编写者正在进行更新的指示器。

Mike Christiansen（OP 本人）最终还将锁定用户的用户名存储在该文件中，以向其他潜在的储物柜提供反馈。

当修改请求时：

• 循环尝试直到创建锁定文件updating成功，如果文件已经存在则失败。

  • （重新）创建updating 文件向其他潜在的编写者发出修改已开始的信号。相比之下，此时读者可以继续阅读。

• 创建当前 XML 文件的（临时）副本并在那里执行修改。

  • Mike 自己最终只是修改了文件的内存中副本，这简化了事情（如果您有足够的内存来读取整个文件）。

• 用修改后的副本替换原始文件 - 使用重试循环直到复制/重写原始文件成功，因为其他阅读器可能会暂时阻止删除（重新创建）/重写原始文件。

• 删除文件updating，向其他可能的修改器发出更新已完成的信号。

  • 确保始终清理文件 (try .. finally)，因为让它逗留会阻止未来的更新；您可能还需要一个基于超时的机制，在等待删除预先存在的文件时，最终强制删除，前提是可以假设之前的更新程序已经崩溃。

至于读取权限：

• 虽然没有进行任何修改，但并发读取访问应该可以正常工作。

• 当 XML 文件被替换为临时副本/重写时，打开文件进行读取将失败在文件复制操作期间/写操作，所以你'那里也需要一个重试循环。

---

Mike 最终使用的代码可以在here找到。

Answer 2

我可以建议一种稍微不同的方法。您可以使用 PowerShell 执行以下操作，从而避免读取问题。我的 XML 导航可能有点偏离，但它会按照here 的描述工作。

function Read-Only()
{
    $database = [xml](Get-Content $filename)
    foreach($item in $database.Items)
    {
        Write-Host "Item name $item.Name"
    }
 }

现在您可以保留相同的写入功能，也可以使用 PowerShell 完成所有操作。如果你想用 PowerShell 来做，你可以这样做。

function Read-Write()
{
    $database = [xml](Get-Content $filename)

    $itemname = Read-Host "Enter an item name ('quit' to quit)"
    while($itemname -ne 'quit')
    {
        $newItem = $database.CreateElement("item")
        $newItem.SetAttribute("Name", $itemname)
        $database.Items.AppendChild($newItem)
        # You can also save all the changes up and write once.
        $database.Save($filename)
        $itemname = Read-Host "Enter an item name ('quit' to quit)"
    }
}

Answer 3

也许这会有所帮助。创建文件流时，有一个 FileShare 选项。如果设置为ReadWrite，多个进程可以打开该文件

$fsMain = [System.IO.File]::Open("C:\stack\out.txt", "Open", "ReadWrite", "ReadWrite")
$fsReadOnly = [System.IO.File]::Open("C:\stack\out.txt", "Open", "Read", "ReadWrite")

Write-Host ("fsMain:  CanRead=" + $fsMain.CanRead + ", CanWrite=" + $fsMain.CanWrite)
Write-Host ("fsReadOnly:  CanRead= " + $fsReadOnly.CanRead + ", CanWrite=" + $fsReadOnly.CanWrite)

$fsMain.Close()
$fsReadOnly.Close()