演练：在 Visual Basic 中操作文件和目录

  • 项目

本演练简单介绍 Visual Basic 中文件 I/O 的基础知识。 描述如何创建列出并检查目录中文本文件的小型应用程序。 对于所选的每个文本文件，该应用程序都会提供文件属性和内容的第一行。 可以选择将信息写入日志文件中。

本演练使用 My.Computer.FileSystem Object 的成员，这些成员可从 Visual Basic 中获得。 有关详细信息，请参阅FileSystem。 本演练结尾部分提供等效示例，该示例使用来自 System.IO 命名空间的类。

注意

以下说明中的某些 Visual Studio 用户界面元素在计算机上出现的名称或位置可能会不同。 这些元素取决于你所使用的 Visual Studio 版本和你所使用的设置。 有关详细信息，请参阅个性化设置 IDE。

创建项目

  1. 在“文件”菜单上，单击“新建项目”。

    将显示“新建项目”对话框。

  2. 在“已安装的模板”窗格中，展开“Visual Basic”，然后单击“Windows”。 在中间的“模板”窗格中，单击“Windows 窗体应用程序”。

  3. 在“名称”框中，键入 FileExplorer 以设置项目名称，然后单击“确定”。

    Visual Studio 将项目添加到“解决方案资源管理器”中，“Windows 窗体设计器”随即打开。

  4. 将下表中的控件添加到窗体，并设置控件属性相应的值。

    控制 属性 值
    ListBox 名称 filesListBox
    Button 名称

    Text    		 browseButton

    “浏览”
    Button 名称

    Text    		 examineButton

    检查
    CheckBox 名称

    Text    		 saveCheckBox

    保存结果
    FolderBrowserDialog 名称 FolderBrowserDialog1

选择一个文件夹，并列出文件夹中的文件

  1. 通过双击窗体上的控件，创建 browseButton 的 Click 事件处理程序。 代码编辑器随即打开。

  2. 将以下代码添加到 Click 事件处理程序中。

    If FolderBrowserDialog1.ShowDialog() = DialogResult.OK Then
    ' List files in the folder.
    ListFiles(FolderBrowserDialog1.SelectedPath)
End If

    FolderBrowserDialog1.ShowDialog 调用将打开“浏览文件夹”对话框。 用户单击“确定”后，SelectedPath 属性作为参数发送给在下一步中添加的 ListFiles 方法。

  3. 添加以下 ListFiles 方法。

    Private Sub ListFiles(ByVal folderPath As String)
    filesListBox.Items.Clear()

    Dim fileNames = My.Computer.FileSystem.GetFiles(
        folderPath, FileIO.SearchOption.SearchTopLevelOnly, "*.txt")

    For Each fileName As String In fileNames
        filesListBox.Items.Add(fileName)
    Next
End Sub

    此代码首先会清除“ListBox”。

    GetFiles 方法然后检索字符串集合，一个字符串对应目录中的一个文件。 GetFiles 方法接受一个搜索模式参数来检索与特定模式匹配的文件。 在此示例中，仅返回具有 .txt 扩展名的文件。

    通过 GetFiles 方法返回的字符串随后将添加到“ListBox”中。

  4. 运行应用程序。 单击“浏览”按钮。 在“浏览文件夹”对话框中，浏览到包含 .txt 文件的文件夹，然后选择该文件夹，并单击“确定”。

    ListBox 包含所选文件夹中 .txt 文件的列表。

  5. 停止运行该应用程序。

从文本文件获取文件的属性和内容

  1. 通过双击窗体上的控件，创建 examineButton 的 Click 事件处理程序。

  2. 将以下代码添加到 Click 事件处理程序中。

    If filesListBox.SelectedItem Is Nothing Then
    MessageBox.Show("Please select a file.")
    Exit Sub
End If

' Obtain the file path from the list box selection.
Dim filePath = filesListBox.SelectedItem.ToString

' Verify that the file was not removed since the
' Browse button was clicked.
If My.Computer.FileSystem.FileExists(filePath) = False Then
    MessageBox.Show("File Not Found: " & filePath)
    Exit Sub
End If

' Obtain file information in a string.
Dim fileInfoText As String = GetTextForOutput(filePath)

' Show the file information.
MessageBox.Show(fileInfoText)

    该代码验证是否在 ListBox 中选中某项。 然后，将从 ListBox 获取文件路径项。 FileExists 方法用于检查文件是否仍然存在。

    该文件路径作为参数发送给下一步中添加的 GetTextForOutput 方法。 此方法返回一个包含文件信息字符串。 该文件信息将出现在“MessageBox”中。

  3. 添加以下 GetTextForOutput 方法。

    Private Function GetTextForOutput(ByVal filePath As String) As String
    ' Verify that the file exists.
    If My.Computer.FileSystem.FileExists(filePath) = False Then
        Throw New Exception("File Not Found: " & filePath)
    End If

    ' Create a new StringBuilder, which is used
    ' to efficiently build strings.
    Dim sb As New System.Text.StringBuilder()

    ' Obtain file information.
    Dim thisFile As System.IO.FileInfo = My.Computer.FileSystem.GetFileInfo(filePath)

    ' Add file attributes.
    sb.Append("File: " & thisFile.FullName)
    sb.Append(vbCrLf)
    sb.Append("Modified: " & thisFile.LastWriteTime.ToString)
    sb.Append(vbCrLf)
    sb.Append("Size: " & thisFile.Length.ToString & " bytes")
    sb.Append(vbCrLf)

    ' Open the text file.
    Dim sr As System.IO.StreamReader =
        My.Computer.FileSystem.OpenTextFileReader(filePath)

    ' Add the first line from the file.
    If sr.Peek() >= 0 Then
        sb.Append("First Line: " & sr.ReadLine())
    End If
    sr.Close()

    Return sb.ToString
End Function

    该代码使用 GetFileInfo 方法来获取文件参数。 文件参数添加到 StringBuilder。

    OpenTextFileReader 方法将文件内容读取到 StreamReader。 该内容的第一行是从 StreamReader 获取的，然后将添加到 StringBuilder。

  4. 运行应用程序。 单击“浏览”，然后浏览到包含 .txt 文件的文件夹。 单击“确定”。

    在 ListBox 中选择一个文件，然后单击“检查”。 MessageBox 显示文件信息。

  5. 停止运行该应用程序。

添加日志项目

  1. 将以下代码添加到 examineButton_Click 事件处理程序末尾。

    If saveCheckBox.Checked = True Then
    ' Place the log file in the same folder as the examined file.
    Dim logFolder As String = My.Computer.FileSystem.GetFileInfo(filePath).DirectoryName
    Dim logFilePath = My.Computer.FileSystem.CombinePath(logFolder, "log.txt")

    Dim logText As String = "Logged: " & Date.Now.ToString &
        vbCrLf & fileInfoText & vbCrLf & vbCrLf

    ' Append text to the log file.
    My.Computer.FileSystem.WriteAllText(logFilePath, logText, append:=True)
End If

    该代码设置日志文件路径以便将日志文件放在与所选文件相同的目录中。 日志项目的文本设置为当前日期和文件信息后的时间。

    WriteAllText 方法，其 append 参数设置为 True，用于创建日志条目。

  2. 运行应用程序。 浏览到一个文本文件，在 ListBox 中选中它，选择“保存结果”复选框，然后再单击“检查”。 验证日志条目是否写入 log.txt 文件。

  3. 停止运行该应用程序。

使用当前目录

  1. 通过双击窗体，创建 Form1_Load 的事件处理程序。

  2. 将以下代码添加到该事件处理程序中。

    ' Set the default directory of the folder browser to the current directory.
FolderBrowserDialog1.SelectedPath = My.Computer.FileSystem.CurrentDirectory

    此代码将文件夹浏览器的默认目录设置为当前目录。

  3. 运行应用程序。 第一次单击“浏览”时，“浏览文件夹”对话框将打开到当前目录。

  4. 停止运行该应用程序。

有选择地启用控件

  1. 添加以下 SetEnabled 方法。

    Private Sub SetEnabled()
    Dim anySelected As Boolean =
        (filesListBox.SelectedItem IsNot Nothing)

    examineButton.Enabled = anySelected
    saveCheckBox.Enabled = anySelected
End Sub

    SetEnabled 方法启用还是禁用控件是由是否选中 ListBox 中的项决定的。

  2. 通过双击窗体上的 ListBox 控件，创建 filesListBox 的 SelectedIndexChanged 事件处理程序。

  3. 在新的 filesListBox_SelectedIndexChanged 事件处理程序中添加对 SetEnabled 的调用。

  4. 在 browseButton_Click 事件处理程序末尾添加对 SetEnabled 的调用。

  5. 在 Form1_Load 事件处理程序末尾添加对 SetEnabled 的调用。

  6. 运行应用程序。 如果在 ListBox 中未选中任何项，将禁用“保存结果”复选框和“检查”按钮。

使用 My.Computer.FileSystem 的完整示例

以下是完整示例。


' This example uses members of the My.Computer.FileSystem
' object, which are available in Visual Basic.

Private Sub Form1_Load(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles MyBase.Load
    ' Set the default directory of the folder browser to the current directory.
    FolderBrowserDialog1.SelectedPath = My.Computer.FileSystem.CurrentDirectory

    SetEnabled()
End Sub

Private Sub browseButton_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles browseButton.Click
    If FolderBrowserDialog1.ShowDialog() = DialogResult.OK Then
        ' List files in the folder.
        ListFiles(FolderBrowserDialog1.SelectedPath)
    End If
    SetEnabled()
End Sub

Private Sub ListFiles(ByVal folderPath As String)
    filesListBox.Items.Clear()

    Dim fileNames = My.Computer.FileSystem.GetFiles(
        folderPath, FileIO.SearchOption.SearchTopLevelOnly, "*.txt")

    For Each fileName As String In fileNames
        filesListBox.Items.Add(fileName)
    Next
End Sub

Private Sub examineButton_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles examineButton.Click
    If filesListBox.SelectedItem Is Nothing Then
        MessageBox.Show("Please select a file.")
        Exit Sub
    End If

    ' Obtain the file path from the list box selection.
    Dim filePath = filesListBox.SelectedItem.ToString

    ' Verify that the file was not removed since the
    ' Browse button was clicked.
    If My.Computer.FileSystem.FileExists(filePath) = False Then
        MessageBox.Show("File Not Found: " & filePath)
        Exit Sub
    End If

    ' Obtain file information in a string.
    Dim fileInfoText As String = GetTextForOutput(filePath)

    ' Show the file information.
    MessageBox.Show(fileInfoText)

    If saveCheckBox.Checked = True Then
        ' Place the log file in the same folder as the examined file.
        Dim logFolder As String = My.Computer.FileSystem.GetFileInfo(filePath).DirectoryName
        Dim logFilePath = My.Computer.FileSystem.CombinePath(logFolder, "log.txt")

        Dim logText As String = "Logged: " & Date.Now.ToString &
            vbCrLf & fileInfoText & vbCrLf & vbCrLf

        ' Append text to the log file.
        My.Computer.FileSystem.WriteAllText(logFilePath, logText, append:=True)
    End If
End Sub

Private Function GetTextForOutput(ByVal filePath As String) As String
    ' Verify that the file exists.
    If My.Computer.FileSystem.FileExists(filePath) = False Then
        Throw New Exception("File Not Found: " & filePath)
    End If

    ' Create a new StringBuilder, which is used
    ' to efficiently build strings.
    Dim sb As New System.Text.StringBuilder()

    ' Obtain file information.
    Dim thisFile As System.IO.FileInfo = My.Computer.FileSystem.GetFileInfo(filePath)

    ' Add file attributes.
    sb.Append("File: " & thisFile.FullName)
    sb.Append(vbCrLf)
    sb.Append("Modified: " & thisFile.LastWriteTime.ToString)
    sb.Append(vbCrLf)
    sb.Append("Size: " & thisFile.Length.ToString & " bytes")
    sb.Append(vbCrLf)

    ' Open the text file.
    Dim sr As System.IO.StreamReader =
        My.Computer.FileSystem.OpenTextFileReader(filePath)

    ' Add the first line from the file.
    If sr.Peek() >= 0 Then
        sb.Append("First Line: " & sr.ReadLine())
    End If
    sr.Close()

    Return sb.ToString
End Function

Private Sub filesListBox_SelectedIndexChanged(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles filesListBox.SelectedIndexChanged
    SetEnabled()
End Sub

Private Sub SetEnabled()
    Dim anySelected As Boolean =
        (filesListBox.SelectedItem IsNot Nothing)

    examineButton.Enabled = anySelected
    saveCheckBox.Enabled = anySelected
End Sub

使用 System.IO 的完整示例

以下等效示例使用来自 System.IO 命名空间的类，而不使用 My.Computer.FileSystem 对象。


' This example uses classes from the System.IO namespace.

Private Sub Form1_Load(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles MyBase.Load
    ' Set the default directory of the folder browser to the current directory.
    FolderBrowserDialog1.SelectedPath =
        System.IO.Directory.GetCurrentDirectory()

    SetEnabled()
End Sub

Private Sub browseButton_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles browseButton.Click
    If FolderBrowserDialog1.ShowDialog() = DialogResult.OK Then
        ' List files in the folder.
        ListFiles(FolderBrowserDialog1.SelectedPath)
        SetEnabled()
    End If
End Sub

Private Sub ListFiles(ByVal folderPath As String)
    filesListBox.Items.Clear()

    Dim fileNames As String() =
        System.IO.Directory.GetFiles(folderPath,
            "*.txt", System.IO.SearchOption.TopDirectoryOnly)

    For Each fileName As String In fileNames
        filesListBox.Items.Add(fileName)
    Next
End Sub

Private Sub examineButton_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles examineButton.Click
    If filesListBox.SelectedItem Is Nothing Then
        MessageBox.Show("Please select a file.")
        Exit Sub
    End If

    ' Obtain the file path from the list box selection.
    Dim filePath = filesListBox.SelectedItem.ToString

    ' Verify that the file was not removed since the
    ' Browse button was clicked.
    If System.IO.File.Exists(filePath) = False Then
        MessageBox.Show("File Not Found: " & filePath)
        Exit Sub
    End If

    ' Obtain file information in a string.
    Dim fileInfoText As String = GetTextForOutput(filePath)

    ' Show the file information.
    MessageBox.Show(fileInfoText)

    If saveCheckBox.Checked = True Then
        ' Place the log file in the same folder as the examined file.
        Dim logFolder As String =
            System.IO.Path.GetDirectoryName(filePath)
        Dim logFilePath = System.IO.Path.Combine(logFolder, "log.txt")

        ' Append text to the log file.
        Dim logText As String = "Logged: " & Date.Now.ToString &
            vbCrLf & fileInfoText & vbCrLf & vbCrLf

        System.IO.File.AppendAllText(logFilePath, logText)
    End If
End Sub

Private Function GetTextForOutput(ByVal filePath As String) As String
    ' Verify that the file exists.
    If System.IO.File.Exists(filePath) = False Then
        Throw New Exception("File Not Found: " & filePath)
    End If

    ' Create a new StringBuilder, which is used
    ' to efficiently build strings.
    Dim sb As New System.Text.StringBuilder()

    ' Obtain file information.
    Dim thisFile As New System.IO.FileInfo(filePath)

    ' Add file attributes.
    sb.Append("File: " & thisFile.FullName)
    sb.Append(vbCrLf)
    sb.Append("Modified: " & thisFile.LastWriteTime.ToString)
    sb.Append(vbCrLf)
    sb.Append("Size: " & thisFile.Length.ToString & " bytes")
    sb.Append(vbCrLf)

    ' Open the text file.
    Dim sr As System.IO.StreamReader =
        System.IO.File.OpenText(filePath)

    ' Add the first line from the file.
    If sr.Peek() >= 0 Then
        sb.Append("First Line: " & sr.ReadLine())
    End If
    sr.Close()

    Return sb.ToString
End Function

Private Sub filesListBox_SelectedIndexChanged(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles filesListBox.SelectedIndexChanged
    SetEnabled()
End Sub

Private Sub SetEnabled()
    Dim anySelected As Boolean =
        (filesListBox.SelectedItem IsNot Nothing)

    examineButton.Enabled = anySelected
    saveCheckBox.Enabled = anySelected
End Sub

另请参阅