WPF 引用 ASP.NET Core 的 AOT 版本

WPF 引用 ASP.NET Core 的 AOT 版本

引言：从桌面到云端，再回到桌面的新思路作为一名技术博主，我经常收到这样的问题："WPF 应用能不能调用 ASP.NET Core 的 API？能不能用上 AOT 编译带来的性能优势？" 答案是：可以，而且比你想象中更简单！ 在 .NET 生态中，WPF（桌面应用框架）和 ASP.NET Core（Web 框架）并非孤岛，它们可以通过多种方式协作。而 AOT（Ahead-of-Time 编译）技术，更是让这种协作如虎添翼------减少启动时间、降低内存占用，甚至能让你在桌面应用中直接嵌入一个轻量级的 Web 服务器。本文将通过两个完整的代码示例，带你一步步实现"WPF 引用 ASP.NET Core 的 AOT 版本"，并在实战中理解背后的原理。## 为什么要在 WPF 中使用 ASP.NET Core AOT？传统 WPF 应用与后端交互时，通常需要依赖外部 Web 服务（如部署在服务器上的 ASP.NET Core API）。但有些场景下，我们希望应用自身就具备 Web 服务能力 ，比如：- 提供本地 REST API 供其他工具调用（如脚本、浏览器扩展）。- 实现桌面应用内部的 IPC（进程间通信）时，用 HTTP 比命名管道更灵活。- 利用 ASP.NET Core 强大的路由、中间件和依赖注入特性来组织本地逻辑。而 AOT 编译的优势在于：- 启动速度极快 ：无需 JIT 编译，代码在生成时已编译为机器码。- 内存占用低 ：不需要加载庞大的运行时 JIT 编译器。- 发布体积小 ：发布时只包含必需的代码，适合嵌入式场景。但是，WPF 本身是桌面框架，ASP.NET Core 是 Web 框架，如何将它们"合体"？答案是：将 ASP.NET Core 的 AOT 版本作为 WPF 项目的依赖，并在 WPF 启动时内嵌一个 Web 服务器。## 环境准备与项目结构### 你需要安装- .NET 8.0 SDK 或更高版本（因为 AOT 在 .NET 7+ 中逐步成熟，.NET 8 是推荐选择）。- Visual Studio 2022 或 JetBrains Rider。- 确保安装 ".NET 桌面开发" 和 "ASP.NET 和 Web 开发" 工作负载。### 项目结构建议我们将创建两个项目：1. WpfAppWithAot ：WPF 主项目，负责界面显示和启动内嵌 Web 服务器。2. AotApiLibrary ：ASP.NET Core 类库，包含 AOT 兼容的 API 端点，并编译为 AOT 模式。> 为什么不用一个项目？因为 WPF 项目不能直接设置为 AOT 编译（AOT 主要用于控制台应用或类库），但我们可以将 API 逻辑封装到一个独立的 AOT 类库中，然后被 WPF 引用。## 第一步：创建 ASP.NET Core AOT 类库### 1. 新建类库项目使用命令行创建一个类库项目：bashdotnet new classlib -n AotApiLibrary -f net8.0cd AotApiLibrary### 2. 添加必要的 NuGet 包AOT 需要特定的包来支持最小化 API 和 JSON 序列化：bashdotnet add package Microsoft.AspNetCore.App.Ref --version 8.0.0dotnet add package System.Text.Json### 3. 编写 AOT 兼容的 API 代码AOT 编译需要避免使用反射和动态代码生成，因此我们将使用"最小 API"风格，并显式指定 JSON 序列化上下文。创建 MyApi.cs ：csharpusing System.Text.Json.Serialization;// 定义一个简单的模型，标记为 JSON 序列化上下文public class GreetingResponse{ public string Message { get; set; } public DateTime Timestamp { get; set; }}// 必须为 AOT 创建 JsonSerializerContext[JsonSerializable(typeof(GreetingResponse))][JsonSerializable(typeof(string))]internal partial class AppJsonSerializerContext : JsonSerializerContext{}创建 Startup.cs （注意：AOT 类库中没有 Startup 类，我们直接构建 WebApplication）：csharpusing Microsoft.AspNetCore.Builder;using Microsoft.AspNetCore.Http;using Microsoft.Extensions.DependencyInjection;public class ApiStartup{ // 返回一个配置好的 WebApplication 实例 public static WebApplication CreateApp(string[] args) { var builder = WebApplication.CreateSlimBuilder(args); // 明确注册 JSON 序列化上下文，避免反射 builder.Services.ConfigureHttpJsonOptions(options => { options.SerializerOptions.TypeInfoResolver = AppJsonSerializerContext.Default; }); var app = builder.Build(); // 定义 GET /greet 端点 app.MapGet("/greet", (string? name) => { var response = new GreetingResponse { Message = $"Hello, {name ?? "World"}!", Timestamp = DateTime.UtcNow }; return Results.Json(response, AppJsonSerializerContext.Default.GreetingResponse); }); return app; }}### 4. 配置 AOT 编译编辑 AotApiLibrary.csproj，添加以下属性：xml<PropertyGroup> <PublishAot>true</PublishAot> <OptimizationPreference>Speed</OptimizationPreference></PropertyGroup>然后发布为 AOT 类库（注意：类库发布 AOT 后会生成 .aot 文件，但我们需要的是 DLL 引用，所以这一步只是为了验证编译成功）：bashdotnet publish -c Release -r win-x64## 第二步：创建 WPF 项目并引用 AOT 类库### 1. 新建 WPF 项目bashdotnet new wpf -n WpfAppWithAot -f net8.0### 2. 添加项目引用bashcd WpfAppWithAotdotnet add reference ../AotApiLibrary/AotApiLibrary.csproj### 3. 修改 WPF 的 MainWindow.xaml.cs我们将在 WPF 窗口初始化时，启动内嵌的 ASP.NET Core 服务器，并绑定到一个本地端口。MainWindow.xaml （简化版）：xml<Window x:Class="WpfAppWithAot.MainWindow" xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" Title="WPF + ASP.NET Core AOT" Height="200" Width="400"> <StackPanel VerticalAlignment="Center" HorizontalAlignment="Center"> <TextBlock Text="内嵌 Web 服务器已启动" FontSize="16" /> <Button Content="测试 API" Click="OnTestApi" Margin="0,10" /> <TextBlock x:Name="ResultText" Text="等待测试..." /> </StackPanel></Window>MainWindow.xaml.cs （核心代码）：csharpusing System;using System.Net.Http;using System.Threading.Tasks;using System.Windows;using Microsoft.AspNetCore.Hosting;namespace WpfAppWithAot{ public partial class MainWindow : Window { private IDisposable _webHost; // 用于管理 Web 服务器的生命周期 public MainWindow() { InitializeComponent(); StartWebServer(); } /// <summary> /// 启动内嵌的 ASP.NET Core AOT Web 服务器 /// </summary> private void StartWebServer() { // 注意：这里使用 AotApiLibrary 中的 ApiStartup 类 var app = AotApiLibrary.ApiStartup.CreateApp(new string[] { "--urls", "http://localhost:5000" }); _webHost = app.RunAsync(); // 异步启动，不会阻塞 UI 线程 } /// <summary> /// 测试按钮点击事件：调用本地的 API /// </summary> private async void OnTestApi(object sender, RoutedEventArgs e) { try { using var httpClient = new HttpClient(); var response = await httpClient.GetStringAsync("http://localhost:5000/greet?name=WPF"); ResultText.Text = $"API 返回: {response}"; } catch (Exception ex) { ResultText.Text = $"错误: {ex.Message}"; } } /// <summary> /// 窗口关闭时停止 Web 服务器 /// </summary> protected override void OnClosed(EventArgs e) { _webHost?.Dispose(); base.OnClosed(e); } }}### 4. 运行与测试按 F5 运行 WPF 应用，你会看到窗口显示"内嵌 Web 服务器已启动"。点击"测试 API"按钮，结果将显示从本地 API 返回的 JSON 数据。## 代码示例详解### 示例 1：AOT 类库中的 JSON 序列化上下文这段代码的关键在于 [JsonSerializable] 特性。AOT 编译无法使用 System.Text.Json 默认的反射式序列化，所以我们需要显式声明 哪些类型会被序列化。AppJsonSerializerContext 继承自 JsonSerializerContext，它会在编译时生成具体的序列化代码，而不是运行时反射。csharp[JsonSerializable(typeof(GreetingResponse))][JsonSerializable(typeof(string))]internal partial class AppJsonSerializerContext : JsonSerializerContext{}注意：partial 关键字必不可少，因为编译器会自动生成 AppJsonSerializerContext 的实现部分。### 示例 2：WPF 中启动内嵌 Web 服务器这里我们调用了 AotApiLibrary.ApiStartup.CreateApp，它返回一个 WebApplication 对象。RunAsync() 方法会启动服务器并监听端口，但由于它是异步的，我们需要将其分配给一个 IDisposable 字段，以便在窗口关闭时释放资源。csharpvar app = AotApiLibrary.ApiStartup.CreateApp(new string[] { "--urls", "http://localhost:5000" });_webHost = app.RunAsync();潜在问题 ：如果 WPF 的 UI 线程阻塞，RunAsync 可能不会立即启动。解决方案是确保 CreateApp 和 RunAsync 在非 UI 线程上执行（但这里 RunAsync 本身就是异步的，不会阻塞）。## 进阶：优化与调试### 性能对比你可以在 WPF 的 OnTestApi 中添加计时，对比 AOT 版本与普通 JIT 版本的启动时间。通常 AOT 版本的 API 响应时间更稳定，首次调用延迟更低。### 端口冲突如果 5000 端口被占用，可以动态分配端口：csharpvar port = new Random().Next(10000, 60000);var app = ApiStartup.CreateApp(new[] { $"--urls=http://localhost:{port}" });### 发布为单文件WPF 项目也可以结合 AOT 类库发布为单文件应用：bashdotnet publish -c Release -r win-x64 --self-contained true -p:PublishSingleFile=true## 总结通过本文，我们成功实现了：1. 创建 ASP.NET Core AOT 类库 ：通过 [JsonSerializable] 和最小 API 模式，让代码兼容 AOT 编译。2. 在 WPF 中内嵌 Web 服务器 ：利用 WebApplication.RunAsync() 在桌面应用生命周期内运行 HTTP 服务。3. 实现端到端调用 ：WPF 界面通过 HttpClient 调用本地 API，获取 JSON 响应。这种架构特别适合需要提供本地 API 的桌面工具 、自动化测试框架 或轻量级微服务边缘场景。AOT 编译带来的性能提升（启动时间减少 50% 以上，内存降低 30%）让桌面应用也能拥有 Web 服务的灵活性。最后提醒：AOT 编译并非万能------它限制了动态代码生成（如 EFCore 的 LINQ 查询），但如果你坚持使用静态类型和显式序列化，AOT 绝对是桌面应用现代化的利器。现在，不妨在你的下一个 WPF 项目中尝试一下！