Übungsprojekt Verbesserungen/Änderungen

  • VB.NET
  • .NET (FX) 4.5–4.8

Es gibt 7 Antworten in diesem Thema. Der letzte Beitrag () ist von Amelie.

    Übungsprojekt Verbesserungen/Änderungen

    Moin moin

    Ich habe ein weiteres Projekt zur Übung von verschiedenen Sachen begonnen.
    Ein kleines Programm um Dateien um zu benennen. Ich habe das aus mehreren Gründen gemacht.
    1.) Was ich im www fand war alles nicht so richtig zu gebrauchen
    2.) Weil mein Opa auch eins brauchte ;)
    3.) Um noch weiter zu Üben auch was das Kommentieren von Code betrifft.

    Bisher funktioniert alles so wie ich es mir vorstellte. Hier mal ein Teil des Programmes:

    Erweiterungen in der XML Hinzufügen und das MainForm aktualisieren.

    Es gibt bestimmt noch viel was zu ändern wäre, ich habe mich auch bemüht alles OOP-Konform zu machen. :)

    Spoiler anzeigen
    ​
    Das Form

    VB.NET-Quellcode

    1. ​
    2. Public Class frm_Extensions
    3. Private Property XML_Path As String = Path.Combine(Application.StartupPath, "Extensions.xml")
    4. Private WithEvents CreateXMLFile As New CreateXMLFile
    5. Private WithEvents SaveXMLFile As New SaveXMLFile
    6. ''' <summary>
    7. ''' Konstruktor der Klasse frm_Extensions.
    8. ''' </summary>
    9. Public Sub New()
    10. InitializeComponent()
    11. If Not File.Exists(XML_Path) Then
    12. CreateXMLFile.CheckAndCreateXMLFile(XML_Path)
    13. MessageBox.Show("Keine XML-Datei gefunden, es wurde eine neue erstellt.", "Hinweis", MessageBoxButtons.OK, MessageBoxIcon.Information)
    14. End If
    15. LoadFromXMLFile(XML_Path)
    16. LoadGroupNamesFromXML(XML_Path)
    17. LoadFromXMLFile(XML_Path)
    18. LoadGroupNamesFromXML(XML_Path)
    19. End Sub
    20. ''' <summary>
    21. ''' Meldungs und Fehlerbahandlung der SpeichernKlasse,
    22. ''' sowie EvendHandels für die Speicherung der XML-Datei.
    23. ''' </summary>
    24. Private Sub CreateXML_Error(ByVal errorMessage As String) Handles CreateXMLFile.ErrorOccurred
    25. ' Ausgaben wenn Fehler
    26. MessageBox.Show(errorMessage, "Fehler", MessageBoxButtons.OK, MessageBoxIcon.Error)
    27. End Sub
    28. ' Ausgaben wenn ok
    29. Public Sub CreateXML_XMLFileCreated() Handles CreateXMLFile.XMLFileCreated
    30. MessageBox.Show("Keine XML-Datei gefunden, es wurde eine neue erstellt.", "Hinweis", MessageBoxButtons.OK, MessageBoxIcon.Information)
    31. End Sub
    32. ''' <summary>
    33. ''' Übergabe der Variablen an die SpeichernKlasse,
    34. ''' sowie EvendHandels für die Speicherung der XML-Datei.
    35. ''' </summary>
    36. Private Sub btn_Save_Click(sender As Object, e As EventArgs) Handles btn_Save.Click
    37. Dim groupName As String = txt_Group.Text.Trim()
    38. Dim extensions As String = txt_Extension.Text.Trim()
    39. SaveXMLFile.SaveDataToFile(XML_Path, groupName, extensions)
    40. End Sub
    41. ' Aktionen ausführen, wenn die Daten erfolgreich gespeichert wurden
    42. Private Sub DataSavedSuccessfullyHandler(sender As Object, e As EventArgs) Handles SaveXMLFile.DataSavedSuccessfully
    43. ' Listboxen aktualisieren
    44. LoadFromXMLFile(XML_Path)
    45. LoadGroupNamesFromXML(XML_Path)
    46. ' Textboxen leeren
    47. txt_Group.Text = String.Empty
    48. txt_Extension.Text = String.Empty
    49. MessageBox.Show("Die Daten wurden erfolgreich gespeichert.", "Erfolg", MessageBoxButtons.OK, MessageBoxIcon.Information)
    50. End Sub
    52. Private Sub SaveDataErrorHandler(sender As Object, e As SaveDataErrorEventArgs) Handles SaveXMLFile.SaveDataErrorOccurred
    53. ' Aktionen ausführen, wenn ein Fehler beim Speichern der Daten aufgetreten ist
    54. MessageBox.Show(e.ErrorMessage, "Fehler", MessageBoxButtons.OK, MessageBoxIcon.Error)
    55. ' Optional: Weitere Informationen zur Fehlerbehandlung anzeigen
    56. If e.Exception IsNot Nothing Then
    57. MessageBox.Show("Fehlerdetails: " & e.Exception.Message, "Fehlerdetails", MessageBoxButtons.OK, MessageBoxIcon.Error)
    58. End If
    59. End Sub
    60. ''' <summary>
    61. ''' Lädt die Gruppen und Erweiterungen aus der XML-Datei
    62. ''' und fügt sie der ListView hinzu.
    63. ''' </summary>
    64. Private Sub LoadFromXMLFile(filePath As String)
    65. Try
    66. Dim xdoc As XDocument = XDocument.Load(filePath)
    67. ListView1.Items.Clear()
    68. For Each groupElement As XElement In xdoc.Descendants("Group")
    69. Dim groupName As String = groupElement.Attribute("Name").Value
    70. Dim groupHeader As New ListViewGroup(groupName)
    71. ListView1.Groups.Add(groupHeader)
    72. For Each extensionElement As XElement In groupElement.Descendants("Extension")
    73. Dim extension As String = extensionElement.Value
    74. Dim item As New ListViewItem(extension)
    75. item.Group = groupHeader
    76. ListView1.Items.Add(item)
    77. Next
    78. Next
    79. Catch ex As Exception
    80. MessageBox.Show(ex.Message, "Fehler", MessageBoxButtons.OK, MessageBoxIcon.Error)
    81. End Try
    82. End Sub
    83. ''' <summary>
    84. ''' Event-Handler für das SelectedIndexChanged-Ereignis der CheckedListBox.
    85. ''' Füllt das Gruppenname-Textfeld mit dem ausgewählten Gruppennamen.
    86. ''' </summary>
    87. Private Sub ListBox_Group_SelectedIndexChanged(sender As Object, e As EventArgs) Handles ListBox_Group.SelectedIndexChanged
    88. ' Überprüfen, ob ein Gruppenname ausgewählt wurde
    89. If ListBox_Group.SelectedIndex >= 0 Then
    90. ' Den ausgewählten Gruppennamen in die Textbox der Gruppe eintragen
    91. txt_Group.Text = ListBox_Group.SelectedItem.ToString()
    92. End If
    93. End Sub
    94. ''' <summary>
    95. ''' Lädt die Gruppennamen aus der XML-Datei in die CheckedListBox.
    96. ''' </summary>
    97. Private Sub LoadGroupNamesFromXML(filePath As String)
    98. ListBox_Group.Items.Clear()
    99. Try
    100. Dim settings As New XmlReaderSettings()
    101. ' Leerzeichen ignorieren
    102. settings.IgnoreWhitespace = True
    103. Using reader As XmlReader = XmlReader.Create(filePath, settings)
    104. Dim xdoc As XDocument = XDocument.Load(reader)
    105. ' Durchsuchen der XML und Extrahieren der Gruppennamen
    106. For Each groupElement As XElement In xdoc.Descendants("Group")
    107. Dim groupName As String = groupElement.Attribute("Name").Value
    108. ListBox_Group.Items.Add(groupName)
    109. Next
    110. End Using
    111. Catch ex As Exception
    112. MessageBox.Show(ex.Message, "Fehler", MessageBoxButtons.OK, MessageBoxIcon.Error)
    113. End Try
    114. End Sub
    115. End Class


    Klasse zum speichern / ergänzen des XML-Files

    VB.NET-Quellcode

    1. ​
    2. Public Class SaveXMLFile
    3. ''' <summary>
    4. ''' Event, das ausgelöst wird, wenn die Daten erfolgreich gespeichert wurden.
    5. ''' </summary>
    6. Public Shared Event DataSavedSuccessfully As EventHandler
    7. ''' <summary>
    8. ''' Event, das ausgelöst wird, wenn ein Fehler beim Speichern der Daten auftritt.
    9. ''' </summary>
    10. Public Shared Event SaveDataErrorOccurred As EventHandler(Of SaveDataErrorEventArgs)
    11. ''' <summary>
    12. ''' Speichert die eingegebenen Erweiterungen in der XML-Datei.
    13. ''' </summary>
    14. Public Shared Sub SaveDataToFile(filePath As String, groupName As String, extensions As String)
    15. ' Überprüfen, ob sowohl Gruppenname als auch Erweiterungen eingegeben wurden
    16. If String.IsNullOrEmpty(groupName) OrElse String.IsNullOrEmpty(extensions) Then
    17. RaiseEvent SaveDataErrorOccurred(Nothing, New SaveDataErrorEventArgs("Bitte geben Sie einen Gruppennamen und Erweiterungen ein."))
    18. Return
    19. End If
    20. ' Aufteilen der eingegebenen Erweiterungen anhand des Kommas
    21. Dim extensionList As List(Of String) = extensions.Split(","c).Select(Function(ext) ext.Trim()).ToList()
    22. ' Überprüfen, ob mehr als 5 Erweiterungen eingegeben wurden
    23. If extensionList.Count > 5 Then
    24. RaiseEvent SaveDataErrorOccurred(Nothing, New SaveDataErrorEventArgs("Es können maximal 5 Erweiterungen pro Speichervorgang eingegeben werden."))
    25. Return
    26. End If
    27. Try
    28. ' Laden der vorhandenen XML-Datei
    29. Dim xdoc As XDocument = XDocument.Load(filePath)
    30. ' Überprüfen, ob die Gruppe bereits existiert
    31. Dim existingGroup As XElement = xdoc.Descendants("Group").FirstOrDefault(Function(g) g.Attribute("Name").Value = groupName)
    32. If existingGroup IsNot Nothing Then
    33. ' Gruppe existiert bereits, Erweiterungen hinzufügen
    34. Dim extensionsElement As XElement = existingGroup.Element("Extensions")
    35. ' Hinzufügen der neuen Erweiterungen zur Gruppe
    36. extensionList.ForEach(Sub(extension) extensionsElement.Add(New XElement("Extension", extension)))
    37. Else
    38. ' Gruppe existiert noch nicht, neue Gruppe mit Erweiterungen hinzufügen
    39. Dim fileExtensionGroupsElement As XElement = xdoc.Descendants("FileExtensionGroups").FirstOrDefault()
    40. Dim newGroupElement As New XElement("Group", New XAttribute("Name", groupName))
    41. Dim extensionsElement As New XElement("Extensions")
    42. extensionList.ForEach(Sub(extension) extensionsElement.Add(New XElement("Extension", extension)))
    43. newGroupElement.Add(extensionsElement)
    44. fileExtensionGroupsElement.Add(newGroupElement)
    45. End If
    46. ' Speichern der aktualisierten XML-Datei
    47. xdoc.Save(filePath)
    48. ' Daten erfolgreich gespeichert
    49. RaiseEvent DataSavedSuccessfully(Nothing, EventArgs.Empty)
    50. Catch ex As Exception
    51. RaiseEvent SaveDataErrorOccurred(Nothing, New SaveDataErrorEventArgs("Beim Speichern der Daten ist ein Fehler aufgetreten.", ex))
    52. End Try
    53. End Sub
    54. End Class
    56. ''' <summary>
    57. ''' Stellt ein Ereignisargument dar, das Informationen über einen Fehler beim Speichern von Daten enthält.
    58. ''' </summary>
    59. Public Class SaveDataErrorEventArgs
    60. Inherits EventArgs
    61. ''' <summary>
    62. ''' Initialisiert eine neue Instanz der SaveDataErrorEventArgs-Klasse mit der angegebenen Fehlermeldung.
    63. ''' </summary>
    64. ''' <param name="errorMessage">Die Fehlermeldung.</param>
    65. Public Sub New(errorMessage As String)
    66. Me.New(errorMessage, Nothing)
    67. End Sub
    68. ''' <summary>
    69. ''' Initialisiert eine neue Instanz der SaveDataErrorEventArgs-Klasse mit der angegebenen Fehlermeldung und Ausnahme.
    70. ''' </summary>
    71. ''' <param name="errorMessage">Die Fehlermeldung.</param>
    72. ''' <param name="exception">Die Ausnahme, die den Fehler verursacht hat.</param>
    73. Public Sub New(errorMessage As String, exception As Exception)
    74. Me._ErrorMessage = errorMessage
    75. Me._Exception = exception
    76. End Sub
    78. Private _ErrorMessage As String
    79. ''' <summary>
    80. ''' Ruft die Fehlermeldung ab.
    81. ''' </summary>
    82. Public ReadOnly Property ErrorMessage As String
    83. Get
    84. Return _ErrorMessage
    85. End Get
    86. End Property
    88. Private _Exception As Exception
    89. ''' <summary>
    90. ''' Ruft die Ausnahme ab, die den Fehler verursacht hat.
    91. ''' </summary>
    92. Public ReadOnly Property Exception As Exception
    93. Get
    94. Return _Exception
    95. End Get
    96. End Property
    97. End Class


    Klasse zum erstellen des XML-Files

    VB.NET-Quellcode

    1. ​
    2. Public Class CreateXMLFile
    3. ' Ereignis, das auftritt, wenn ein Fehler auftritt
    4. Public Shared Event ErrorOccurred(ByVal errorMessage As String)
    5. Public Shared Event XMLFileCreated()
    6. ''' <summary>
    7. ''' Überprüft, ob die XML-Datei vorhanden ist, und erstellt sie falls nicht.
    8. ''' </summary>
    9. Public Shared Sub CheckAndCreateXMLFile(filePath As String)
    10. ' Überprüfen, ob die XML-Datei vorhanden ist
    11. If File.Exists(filePath) Then Return
    12. Try
    13. ' XML-Struktur erstellen
    14. Dim xdoc As XDocument = CreateInitialXMLStructure()
    15. xdoc.Save(filePath)
    16. ' Event auslösen, um anzuzeigen, dass die XML-Datei erstellt wurde
    17. RaiseEvent XMLFileCreated()
    18. Catch ex As Exception
    19. ' Event auslösen, um den Fehler beim Erstellen der XML-Datei zu melden
    20. RaiseEvent ErrorOccurred(ex.Message)
    21. End Try
    22. End Sub
    23. ''' <summary>
    24. ''' Erstellt die initiale XML-Struktur mit den vordefinierten Gruppen und Erweiterungen.
    25. ''' </summary>
    26. Private Shared Function CreateInitialXMLStructure() As XDocument
    27. ' Liste der Gruppen und zugehörigen Erweiterungen erstellen
    28. Dim groups As New List(Of GroupElement) From {
    29. New GroupElement("Bildertypen", New List(Of String) From {".jpg", ".jpeg", ".png"}),
    30. New GroupElement("Texttypen", New List(Of String) From {".txt", ".doc", ".pdf"})
    31. }
    32. Dim fileExtensionGroupsElement As New XElement("FileExtensionGroups")
    33. For Each group In groups
    34. fileExtensionGroupsElement.Add(group.ToXElement())
    35. Next
    36. ' XML-Dokument erstellen und zurückgeben
    37. Return New XDocument(
    38. New XElement("FileExtensionDictionary",
    39. fileExtensionGroupsElement
    40. )
    41. )
    42. End Function
    43. ''' <summary>
    44. ''' Stellt eine Gruppe mit dem Gruppennamen und den zugehörigen Erweiterungen dar.
    45. ''' </summary>
    46. Private Class GroupElement
    47. Public Sub New(name As String, extensions As List(Of String))
    48. Me.Name = name
    49. Me.Extensions = extensions
    50. End Sub
    52. Public Property Name As String
    53. Public Property Extensions As List(Of String)
    54. ''' <summary>
    55. ''' Konvertiert das GroupElement-Objekt in ein XElement-Objekt für die XML-Darstellung.
    56. ''' </summary>
    57. ''' <returns>Das XElement-Objekt, das die Gruppe repräsentiert.</returns>
    58. Public Function ToXElement() As XElement
    59. Dim groupElement As New XElement("Group", New XAttribute("Name", Name))
    60. Dim extensionsElement As New XElement("Extensions")
    61. For Each extension In Extensions
    62. extensionsElement.Add(New XElement("Extension", extension))
    63. Next
    64. groupElement.Add(extensionsElement)
    65. Return groupElement
    66. End Function
    67. End Class
    68. End Class

    Bilder

    • frmExtension.jpg

      110,83 kB, 507×336, 43 mal angesehen

    • frmMain.jpg

      173,19 kB, 535×670, 43 mal angesehen
    Asperger Autistin. Brauche immer etwas um gewisse Sachen zu verstehen. :huh:

    Beim schnellen Durchlesen, fallen mir ad hoc 2 Dinge in der Klasse frm_Extensions auf :

    VB.NET-Quellcode

    1. Private Property XML_Path As String = Path.Combine(Application.StartupPath, "Extensions.xml")


    Je nachdem, wo das Programm installiert wurde, wird man Schwiergkeit haben dort etwas zu schreiben. Verschiebe die Datei in den AppData Ordner (Special Folders: LocalApplicationData oder ApplicationData).

    In den Zeilen 15-18 hast Du eine Code-Doppelung.

    VB.NET-Quellcode

    1. ​ LoadFromXMLFile(XML_Path)
    2. LoadGroupNamesFromXML(XML_Path)
    3. LoadFromXMLFile(XML_Path)
    4. LoadGroupNamesFromXML(XML_Path)
    NB. Es ist doch schön, wenn man lesbare Namen vergibt. Siehe auch [VB.NET] Beispiele für guten und schlechten Code (Stil).

    Dieser Beitrag wurde bereits 1 mal editiert, zuletzt von „INOPIAE“ ()

    @INOPIAE

    LoadGroupNamesFromXML(XML_Path)

    Habe mein Code überprüft, finde den doppelten Eintrag nicht. Entweder hatte ich das schon verbessert oder .... ;)

    Was den Ordner betrifft, wo die XML-Datei abgelegt wird, war meine Idee, das dieses Programm auch von einem USB-Stick laufen sollte.
    Aber ich werde deinen Vorschlag mal mit aufnehmen.

    EDIT: 08:10 Uhr
    Kleine Änderung vorgenommen.

    VB.NET-Quellcode

    1. ​
    2. Private Property XML_Path As String = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData), "RenameWizard\Extensions.xml")
    3. Public Sub New()
    4. InitializeComponent()
    5. Dim directoryPath As String = Path.GetDirectoryName(XML_Path)
    6. If Not Directory.Exists(directoryPath) Then
    7. Directory.CreateDirectory(directoryPath)
    8. End If
    9. CheckAndCreateXMLFile(XML_Path)
    10. End Sub
    Asperger Autistin. Brauche immer etwas um gewisse Sachen zu verstehen. :huh:

    Dieser Beitrag wurde bereits 1 mal editiert, zuletzt von „Amelie“ ()

    Amelie schrieb:

    das dieses Programm auch von einem USB-Stick laufen sollte.


    Dann prüfe doch, wo das Programm installiert wurde. Wenn es der SpecialFolder ProgramFiles bzw. ProgramFilesX86 ist dann lege die Daten in AppData sonst in den StartupPath.
    NB. Es ist doch schön, wenn man lesbare Namen vergibt. Siehe auch [VB.NET] Beispiele für guten und schlechten Code (Stil).

    Mal als Pseudo Code:
    Beim Start des Programmes
    If StartupPath contains SpecialFolder.ProgramFiles then
    Speicherpfad = SpecialFolders.Appdata
    Else
    Speicherpfad = StartupPath
    End if

    Öffne Datei Spiecherpfad &"\wasimmer.xml"
    NB. Es ist doch schön, wenn man lesbare Namen vergibt. Siehe auch [VB.NET] Beispiele für guten und schlechten Code (Stil).

    Du könntest auch das Arbeitsverzeichnis auf %LocalAppData% festlegen falls die Anwendung nicht von einem USB gestartet wird.
    Spoiler anzeigen

    C#-Quellcode

    1. // Ermittelt den Laufwerksbuchstaben C:\, D:\ ect...
    2. string applicationRootDir = new System.IO.FileInfo(Application.StartupPath).Directory.Root.Name;
    4. // Prüfen ob es sich um z.B. einen USB stick handelt
    5. System.IO.DriveInfo drive = System.IO.DriveInfo.GetDrives().FirstOrDefault(x => x.RootDirectory.Name == applicationRootDir);
    6. if (drive.DriveType != System.IO.DriveType.Removable)
    7. {
    8. // Es ist kein USB, Arbeitsverzeichnis auf %LocalAppData% festlegen.
    9. System.IO.Directory.SetCurrentDirectory(System.IO.Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData), System.Reflection.Assembly.GetExecutingAssembly().GetName().Name));
    10. }
    11. // Datei ggf. erstellen, es wird kein absoluter Pfad benötigt.
    12. string extensionXmlFileName = "Extensions.xml";
    13. if (System.IO.File.Exists(extensionXmlFileName))
    14. {
    15. // Erstelle Datei
    16. }
    18. // Datei lesen, es wird kein absoluter Pfad benötigt.
    19. string xmlContent = System.IO.File.ReadAllText(extensionXmlFileName);



    Edit:
    Zeile 9 läst sich auch kürzer formulieren

    C#-Quellcode

    1. System.IO.Directory.SetCurrentDirectory(Application.LocalUserAppDataPath);

    Dieser Beitrag wurde bereits 2 mal editiert, zuletzt von „Fakiz“ ()

Facebook
Telefonspende