Логирование

AircraftCarrier/AircraftCarrier/AircraftCarrier.csproj

@@ -8,6 +8,24 @@
     <ImplicitUsings>enable</ImplicitUsings>
   </PropertyGroup>
 
+  <ItemGroup>
+    <None Remove="nlog.config" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <EmbeddedResource Include="nlog.config">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </EmbeddedResource>
+  </ItemGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="7.0.0" />
+    <PackageReference Include="Microsoft.Extensions.Logging" Version="7.0.0" />
+    <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="7.0.0" />
+    <PackageReference Include="NLog.Extensions.Logging" Version="5.1.0" />
+    <PackageReference Include="Serilog.Extensions.Hosting" Version="5.0.1" />
+  </ItemGroup>
+
   <ItemGroup>
     <Compile Update="Properties\Resources.Designer.cs">
       <DesignTime>True</DesignTime>

AircraftCarrier/AircraftCarrier/FormMapWithSetWarships.cs

@@ -1,4 +1,5 @@
-using System;
+using Microsoft.Extensions.Logging;
+using System;
 using System.Collections.Generic;
 using System.ComponentModel;
 using System.Data;
@@ -26,11 +27,16 @@ namespace AircraftCarrier
         /// </summary>
         private readonly MapsCollection _mapsCollection;
         /// <summary>
+        /// Логер
+        /// </summary>
+        private readonly ILogger _logger;
+        /// <summary>
         /// Конструктор
         /// </summary>
-        public FormMapWithSetWarships()
+        public FormMapWithSetWarships(ILogger<FormMapWithSetWarships> logger)
         {
             InitializeComponent();
+            _logger = logger;
             _mapsCollection = new MapsCollection(pictureBox.Width, pictureBox.Height);
             comboBoxSelectorMap.Items.Clear();
             foreach (var elem in _mapsDict)
@@ -70,15 +76,18 @@ namespace AircraftCarrier
             if (comboBoxSelectorMap.SelectedIndex == -1 || string.IsNullOrEmpty(textBoxNewMapName.Text))
             {
                 MessageBox.Show("Не все данные заполнены", "Ошибка", MessageBoxButtons.OK, MessageBoxIcon.Error);
+                _logger.LogInformation("При добавлении карты {0}", comboBoxSelectorMap.SelectedIndex == -1 ? "Не была выбрана карта" : "Не была названа карта");
                 return;
             }
             if (!_mapsDict.ContainsKey(comboBoxSelectorMap.Text))
             {
                 MessageBox.Show("Нет такой карты", "Ошибка", MessageBoxButtons.OK, MessageBoxIcon.Error);
+                _logger.LogWarning("Нет карты с названием: {0}", textBoxNewMapName.Text);
                 return;
             }
             _mapsCollection.AddMap(textBoxNewMapName.Text, _mapsDict[comboBoxSelectorMap.Text]);
             ReloadMaps();
+            _logger.LogInformation("Добавлена карта {0}", textBoxNewMapName.Text);
         }
         /// <summary>
         /// Выбор карты
@@ -88,6 +97,7 @@ namespace AircraftCarrier
         private void ListBoxMaps_SelectedIndexChanged(object sender, EventArgs e)
         {
             pictureBox.Image = _mapsCollection[listBoxMaps.SelectedItem?.ToString() ?? string.Empty].ShowSet();
+            _logger.LogInformation("Был осуществлен переход на карту под названием: {0}", listBoxMaps.SelectedItem?.ToString() ?? string.Empty);
         }
         /// <summary>
         /// Удаление карты
@@ -104,6 +114,7 @@ namespace AircraftCarrier
             if (MessageBox.Show($"Удалить карту {listBoxMaps.SelectedItem}?", "Удаление", MessageBoxButtons.YesNo, MessageBoxIcon.Question) == DialogResult.Yes)
             {
                 _mapsCollection.DelMap(listBoxMaps.SelectedItem?.ToString() ?? string.Empty);
+                _logger.LogInformation("Удалена карта {0}", listBoxMaps.SelectedItem?.ToString() ?? string.Empty);
                 ReloadMaps();
             }
         }
@@ -135,16 +146,19 @@ namespace AircraftCarrier
                 if (_mapsCollection[listBoxMaps.SelectedItem?.ToString() ?? string.Empty] + warship >= 0)
                 {
                     MessageBox.Show("Объект добавлен");
+                    _logger.LogInformation("Добавлен объект {@Airplane}", warship);
                     pictureBox.Image = _mapsCollection[listBoxMaps.SelectedItem?.ToString() ?? string.Empty].ShowSet();
                 }
                 else
                 {
                     MessageBox.Show("Не удалось добавить объект");
+                    _logger.LogInformation("Не удалось добавить объект");
                 }
             }
             catch(StorageOverflowException ex)
             {
                 MessageBox.Show("Не удалось добавить объект");
+                _logger.LogWarning("Ошибка переполнения хранилища: {0}", ex.Message);
                 MessageBox.Show($"Ошибка переполнения хранилища: {ex.Message}", "Результат", MessageBoxButtons.OK, MessageBoxIcon.Error);
             }
         }
@@ -166,16 +180,19 @@ namespace AircraftCarrier
                 if (_mapsCollection[listBoxMaps.SelectedItem?.ToString() ?? string.Empty] - pos != null)
                 {
                     MessageBox.Show("Объект удален");
+                    _logger.LogInformation("Из текущей карты удален объект {@ship}", (_mapsCollection[listBoxMaps.SelectedItem?.ToString() ?? string.Empty] - pos));
                     pictureBox.Image = _mapsCollection[listBoxMaps.SelectedItem?.ToString() ?? string.Empty].ShowSet();
                 }
                 else
                 {
                     MessageBox.Show("Не удалось удалить объект");
+                    _logger.LogInformation("Не удалось добавить объект по позиции {0} равен null", pos);
                 }
             }
             catch (WarshipNotFoundException ex)
             {
                 MessageBox.Show($"Ошибка удаления: {ex.Message}");
+                _logger.LogWarning("Ошибка удаления: {0}", ex.Message);
             }
         }
         /// <summary>
@@ -247,10 +264,12 @@ namespace AircraftCarrier
                 try
                 {
                     _mapsCollection.SaveData(saveFileDialog.FileName);
+                    _logger.LogInformation("Сохранение прошло успешно. Файл находится: {0}", saveFileDialog.FileName);
                     MessageBox.Show("Сохранение прошло успешно", "Результат", MessageBoxButtons.OK, MessageBoxIcon.Information);
                 }
                 catch(Exception ex)
                 {
+                    _logger.LogWarning("Не удалось сохранить файл '{0}'. Текст ошибки: {1}", saveFileDialog.FileName, ex.Message);
                     MessageBox.Show($"Не сохранилось: {ex.Message}", "Результат", MessageBoxButtons.OK, MessageBoxIcon.Error);
                 }
             }
@@ -267,11 +286,13 @@ namespace AircraftCarrier
                 try
                 {
                     _mapsCollection.LoadData(openFileDialog.FileName);
-                    MessageBox.Show("Загрузка прошла успешно!", "Результат", MessageBoxButtons.OK, MessageBoxIcon.Information);
+                    _logger.LogInformation("Открытие файла '{0}' прошло успешно", openFileDialog.FileName);
+                    MessageBox.Show("Загрузка прошла успешно", "Результат", MessageBoxButtons.OK, MessageBoxIcon.Information);
                     ReloadMaps();
                 }
                 catch (Exception ex)
                 {
+                    _logger.LogWarning("Не удалось открыть файл {0}. Текст ошибки: {1}", openFileDialog.FileName, ex.Message);
                     MessageBox.Show($"Не удалось открыть: {ex.Message}", "Результат", MessageBoxButtons.OK, MessageBoxIcon.Error);
                 }
             }

AircraftCarrier/AircraftCarrier/Program.cs

@@ -1,3 +1,8 @@
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Logging;
+using NLog.Extensions.Logging;
+using System.ServiceProcess;
+
 namespace AircraftCarrier
 {
     internal static class Program
@@ -11,7 +16,24 @@ namespace AircraftCarrier
             // To customize application configuration such as set high DPI settings or default font,
             // see https://aka.ms/applicationconfiguration.
             ApplicationConfiguration.Initialize();
-            Application.Run(new FormMapWithSetWarships());
+            var services = new ServiceCollection();
+            ConfigureServices(services);
+            using (ServiceProvider serviceProvider = services.BuildServiceProvider())
+            {
+                Application.Run(serviceProvider.GetRequiredService<FormMapWithSetWarships>());
+            }
+        }
+
+        private static void ConfigureServices(ServiceCollection services)
+        {
+            services.AddSingleton<FormMapWithSetWarships>()
+                    .AddLogging(option =>
+                    {
+
+
+                        option.SetMinimumLevel(LogLevel.Information);
+                        option.AddNLog("nlog.config");
+                    });
         }
     }
 }

AircraftCarrier/AircraftCarrier/nlog.config

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<configuration>
+	<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        autoReload="true" internalLogLevel="Info">
+
+		<targets>
+			<target xsi:type="File" name="tofile" fileName="warshiplog-${shortdate}.log" />
+		</targets>
+
+		<rules>
+			<logger name="*" minlevel="Debug" writeTo="tofile" />
+		</rules>
+	</nlog>
+</configuration>