後續來啦：Winform/WPF中快速搭建日誌面板

2021 年 4 月 18 日
筆記
c#, WinForm, WPF

後續來啦：Winform/WPF中快速搭建日誌面板

繼昨天發文ASP.NET Core 可視化日誌組件使用(閱讀文章，查看視頻)後，視頻下有朋友留言 「Winform客戶端的程序能用它不?」，微信也有朋友問能否嫁接到WPF上，站長今早嘗試了，是可以的！

原理是將Winform或WPF 應用程序，宿主到ASP.NET Core Web API上，具體先來個小視頻看看效果，想要代碼直接往下面翻：

【視頻佔位】

實戰步驟：

創建一個 WPF 應用程序
添加ASP.NET Core、Serilog支持
WPF窗體中使用Serilog
完結

本文實戰開始

1. 創建一個 WPF 應用程序

使用VS 2019，創建一個WPF 應用程序項目，命名為WPFWithLogDashboard，本文基於.NET 6搭建。

2. 添加`ASP.NET Core`、`Serilog`支持

2.1 Nuget 安裝相關Nuget包

Microsoft.Extensions.Hosting要指定版本，不能高於2.2.0:

Install-Package Microsoft.Extensions.Hosting -Version 2.2.0
Install-Package Serilog.AspNetCore
Install-Package LogDashboard

2.2 配置 Serilog 和 ASP.NET Core

打開App.xaml.cs文件，添加如下代碼。仔細看，如下配置和上一篇文章 Program.cs 文件中的配置都是差不多的，主要是配置Serilog，記得輸出日誌分割符使用 ||。

using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Hosting;
using Serilog;
using Serilog.Events;
using System;
using System.Windows;

namespace WPFWithLogDashboard
{
	/// <summary>
	/// Interaction logic for App.xaml
	/// </summary>
	public partial class App : Application
	{
		protected override void OnStartup(StartupEventArgs e)
		{
			base.OnStartup(e);

			#region Serilog配置

			string logOutputTemplate = "{Timestamp:HH:mm:ss.fff zzz} || {Level} || {SourceContext:l} || {Message} || {Exception} ||end {NewLine}";
			Log.Logger = new LoggerConfiguration()
			  .MinimumLevel.Override("Default", LogEventLevel.Information)
			  .MinimumLevel.Override("Microsoft", LogEventLevel.Error)
			  .MinimumLevel.Override("Microsoft.Hosting.Lifetime", LogEventLevel.Information)
			  .Enrich.FromLogContext()
			  .WriteTo.Console(theme: Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.Code)
			  .WriteTo.File($"{AppContext.BaseDirectory}Logs/Dotnet9.log", rollingInterval: RollingInterval.Day, outputTemplate: logOutputTemplate)
			  .CreateLogger();

			#endregion

			Host.CreateDefaultBuilder(e.Args)
				.UseSerilog()
				.ConfigureWebHostDefaults(webBuilder =>
				{
					webBuilder.UseStartup<Startup>();
				}).Build().RunAsync();
		}
	}
}

添加Startup.cs文件，代碼如下：

using LogDashboard;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.DependencyInjection;
using Serilog;

namespace WPFWithLogDashboard
{
	public class Startup
	{
		private ILogger logger;
		public ILogger MyLoger
		{
			get
			{
				if (logger == null)
				{
					logger = Log.ForContext<Startup>();
				}
				return logger;
			}
		}

		public void ConfigureServices(IServiceCollection services)
		{
			MyLoger.Information("ConfigureServices");

			services.AddLogDashboard();
			services.AddControllers();
		}

		public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
		{
			MyLoger.Information("Configure");

			app.UseLogDashboard();

			app.UseRouting();

			app.UseEndpoints(endpoints =>
			{
				endpoints.MapControllers();
			});
		}
	}
}

在該文件中，主要作用是添加LogDashboard組件，配置.NET CORE Web API路由。

完成上面的代碼，Serilog和LogDashboard兩個組件其實已經安裝、配置完成了:

程序輸出目錄的Logs目錄已經產生了日誌文件。
瀏覽器輸入下面的鏈接，也能打開LogDashboard可視化日誌面板了。

//localhost:5000/logdashboard

3. WPF窗體中使用Serilog

主窗體MainWindow.xaml添加幾個按鈕，用於模擬添加普通日誌、添加異常日誌、打開可視化日誌面板網頁：

<Window x:Class="WPFWithLogDashboard.MainWindow"
        xmlns="//schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="//schemas.microsoft.com/winfx/2006/xaml"
        Title="Windows中使用Serilog" Height="250" Width="350">
    <StackPanel Margin="20">
        <Button Content="打開日誌面板" Width="100" Height="35" Click="OpenLogDashboard_Click"/>
        <Button Content="添加普通日誌" Width="100" Height="35" Margin="0 20" Click="AddInfoLog_Click"/>
        <Button Content="添加異常日誌" Width="100" Height="35" Click="AddErrorLog_Click"/>
    </StackPanel>
</Window>

MainWindow.xaml.cs中完成上面所說的功能：

using Serilog;
using System.Diagnostics;
using System.Windows;

namespace WPFWithLogDashboard
{
	public partial class MainWindow : Window
	{
		private ILogger logger;
		public ILogger MyLoger
		{
			get
			{
				if (logger == null)
				{
					logger = Log.ForContext<MainWindow>();
				}
				return logger;
			}
		}

		public MainWindow()
		{
			InitializeComponent();

			MyLoger.Information("WPF窗體中記錄的日誌");
		}
		private void AddInfoLog_Click(object sender, RoutedEventArgs e)
		{
			MyLoger.Information("測試添加Info日誌");

		}

		private void AddErrorLog_Click(object sender, RoutedEventArgs e)
		{
			MyLoger.Error("測試添加異常日誌");
		}

		private void OpenLogDashboard_Click(object sender, RoutedEventArgs e)
		{
			OpenUrl("//localhost:5000/logdashboard");
		}

		private void OpenUrl(string url)
		{
			Process.Start(new ProcessStartInfo("cmd", $"/c start {url}")
			{
				UseShellExecute = false,
				CreateNoWindow = true
			});
		}
	}
}

OK，功能已經完成，本文基於WPF搭建的項目，也是適用於Winform項目模板的。

4. 完結

本文注重實踐，如果您對ASP.NET Core不是很了解，建議您查看微軟官方文檔系統學習；不求甚解，直接Copy文中代碼也成。

本文是否對您有用？記得3連走起哦。

時間如流水，只能流去不流回。

公眾號：Dotnet9

作者、編輯：沙漠盡頭的狼

文中示例源碼：//github.com/dotnet9/TerminalMACS.ManagerForWPF/tree/master/src/Demo/WPFWithLogDashboard

日期：2021-04-18

Tags: c# WinForm WPF