前言
最近我使用 Avalonia 开发了一个文章发布工具,StarBlog Publisher。
Avalonia 是一个跨平台的 UI 框架,它可以在 Windows、Linux 和 macOS 上运行。它的特点是高性能、跨平台、易于使用。
Avalonia 有很多优点,比如高性能、跨平台、易于使用。但是,它也有一些缺点,比如学习曲线较陡峭、文档较难找到。
但 Avalonia 是基于 .NetCore 框架开发的,最终打包出来的可执行文件,如果选择 framework-dependant 发布,那么需要在客户端上安装 .NetCore 运行时环境,这对用户来说是一个很大的负担。如果使用 self-contained 发布,体积又比较大。
并且还容易被反编译,这在一些商业软件中是不允许的。(不过我这个项目是开源的,所以没有这个问题)
本文以 StarBlog Publisher 项目为例,记录一下使用 AOT 发布 Avalonia 应用的踩坑过程。
新的1.1版本已经发布,欢迎下载尝试: https://github.com/star-blog/starblog-publisher/releases
关于 AOT
从 .Net7 开始,逐步开始支持 AOT 发布,这是一个非常重要的特性。AOT 发布可以将 .Net 应用程序编译成不依赖运行库的机器码,体积较小,而且不容易被反编译。
Native AOT = 编译时把 .NET 程序的 IL(中间语言)直接提前编译成机器码,生成真正的、单独的、没有依赖 CLR 的可执行文件。
相比传统 .NET 应用在运行时用 JIT(即时编译器)动态编译,Native AOT是 提前(Ahead of Time) 直接搞定所有编译工作。
以下是一个简单的 Native AOT 流程图- C# 代码
- ↓
- Roslyn 编译(生成 IL)
- ↓
- Native AOT 编译器 (ilc)
- ↓
- - 静态分析
- - Tree Shaking
- - IL到机器码转换
- - 链接器合成可执行文件
- ↓
- 最终单个 .exe (无JIT、无大型CLR)
复制代码 目前的 LTS 版本是 .Net8,对 AOT 的支持已经比较完善了,这次我来尝试使用 AOT 方式发布 Avalonia 应用。
PS:据说 .Net9 对 AOT 方式提供了很多优化和改进,接下来我会尝试一下。
使用 AOT 可能会遇到的问题
- 兼容性问题 :AOT编译可能与某些依赖库不兼容,特别是那些依赖反射、动态代码生成或JIT编译的库。如果遇到问题,可能需要在rd.xml中添加更多配置。
- 包大小 :AOT编译会生成更大的可执行文件(相比起 framework-dependant 模式而言),但启动速度更快。
- 调试困难 :AOT编译的应用程序调试可能更加困难。
- 第三方库 :检查项目中使用的第三方库是否支持AOT编译。例如, Microsoft.Extensions.AI 和 Microsoft.Extensions.AI.OpenAI 是预览版,可能需要特别注意其AOT兼容性。
- Avalonia特定配置 :对于Avalonia应用,可能需要确保XAML相关的类型信息被正确保留。
修改项目文件
首先需要在项目文件中添加AOT相关的配置:- <Project Sdk="Microsoft.NET.Sdk">
- <ItemGroup>
- <RdXmlFile Include="rd.xml" />
- </ItemGroup><PropertyGroup>
- <ItemGroup>
- <RdXmlFile Include="rd.xml" />
- </ItemGroup><ItemGroup>
- <RdXmlFile Include="rd.xml" />
- </ItemGroup><OutputType>WinExe</OutputType>
- <ItemGroup>
- <RdXmlFile Include="rd.xml" />
- </ItemGroup><ItemGroup>
- <RdXmlFile Include="rd.xml" />
- </ItemGroup><TargetFramework>net8.0</TargetFramework>
- <ItemGroup>
- <RdXmlFile Include="rd.xml" />
- </ItemGroup><ItemGroup>
- <RdXmlFile Include="rd.xml" />
- </ItemGroup><Nullable>enable</Nullable>
- <ItemGroup>
- <RdXmlFile Include="rd.xml" />
- </ItemGroup><ItemGroup>
- <RdXmlFile Include="rd.xml" />
- </ItemGroup><BuiltInComInteropSupport>true</BuiltInComInteropSupport>
- <ItemGroup>
- <RdXmlFile Include="rd.xml" />
- </ItemGroup><ItemGroup>
- <RdXmlFile Include="rd.xml" />
- </ItemGroup>app.manifest</ApplicationManifest>
- <ItemGroup>
- <RdXmlFile Include="rd.xml" />
- </ItemGroup><ItemGroup>
- <RdXmlFile Include="rd.xml" />
- </ItemGroup>true</AvaloniaUseCompiledBindingsByDefault>
- <ItemGroup>
- <RdXmlFile Include="rd.xml" />
- </ItemGroup><ItemGroup>
- <RdXmlFile Include="rd.xml" />
- </ItemGroup>
- <ItemGroup>
- <RdXmlFile Include="rd.xml" />
- </ItemGroup><ItemGroup>
- <RdXmlFile Include="rd.xml" />
- </ItemGroup>
- <ItemGroup>
- <RdXmlFile Include="rd.xml" />
- </ItemGroup><ItemGroup>
- <RdXmlFile Include="rd.xml" />
- </ItemGroup><PublishAot>true</PublishAot>
- <ItemGroup>
- <RdXmlFile Include="rd.xml" />
- </ItemGroup><ItemGroup>
- <RdXmlFile Include="rd.xml" />
- </ItemGroup><TrimMode>full</TrimMode>
- <ItemGroup>
- <RdXmlFile Include="rd.xml" />
- </ItemGroup><ItemGroup>
- <RdXmlFile Include="rd.xml" />
- </ItemGroup><InvariantGlobalization>true</InvariantGlobalization>
- <ItemGroup>
- <RdXmlFile Include="rd.xml" />
- </ItemGroup><ItemGroup>
- <RdXmlFile Include="rd.xml" />
- </ItemGroup><IlcGenerateStackTraceData>false</IlcGenerateStackTraceData>
- <ItemGroup>
- <RdXmlFile Include="rd.xml" />
- </ItemGroup><ItemGroup>
- <RdXmlFile Include="rd.xml" />
- </ItemGroup><IlcOptimizationPreference>Size</IlcOptimizationPreference>
- <ItemGroup>
- <RdXmlFile Include="rd.xml" />
- </ItemGroup><ItemGroup>
- <RdXmlFile Include="rd.xml" />
- </ItemGroup><IlcFoldIdenticalMethodBodies>true</IlcFoldIdenticalMethodBodies>
- <ItemGroup>
- <RdXmlFile Include="rd.xml" />
- </ItemGroup><ItemGroup>
- <RdXmlFile Include="rd.xml" />
- </ItemGroup>
- <ItemGroup>
- <RdXmlFile Include="rd.xml" />
- </ItemGroup><ItemGroup>
- <RdXmlFile Include="rd.xml" />
- </ItemGroup><JsonSerializerIsReflectionEnabledByDefault>true</JsonSerializerIsReflectionEnabledByDefault>
- <ItemGroup>
- <RdXmlFile Include="rd.xml" />
- </ItemGroup></PropertyGroup>
- <ItemGroup>
- <RdXmlFile Include="rd.xml" />
- </ItemGroup>
- </Project>
复制代码 JSON序列化问题
在AOT编译环境中,JSON序列化是一个常见的问题点,因为它通常依赖于运行时反射。
这个项目有几个地方用到了 JSON
一个是应用设置,另一个是网络请求
先说结论:Newtonsoft.Json 相比 System.Text.Json 对 AOT 的支持更好,如果要使用 AOT,优先使用 Newtonsoft.Json 库。
修改应用设置 AppSettings.cs 支持AOT
如果非要使用 System.Text.Json ,那么需要修改一下。用 Newtonsoft.Json 的话直接跳过。解释
- 添加了 [JsonSerializable] 特性和 JsonSerializerContext 派生类,这是.NET中支持AOT的JSON序列化的关键。这会在编译时生成序列化代码,而不是依赖运行时反射。
- 修改了 Load() 和 Save() 方法,使用 AppSettingsContext.Default.AppSettings 作为类型信息,而不是依赖运行时类型推断。
- 这种方法确保了在AOT环境中,所有需要的序列化代码都会在编译时生成,而不需要运行时反射。
此外,还需要在项目文件中确保已启用AOT编译的JSON源生成器:- <PropertyGroup>
- <ItemGroup>
- <RdXmlFile Include="rd.xml" />
- </ItemGroup>
- <ItemGroup>
- <RdXmlFile Include="rd.xml" />
- </ItemGroup><JsonSerializerIsReflectionEnabledByDefault>false</JsonSerializerIsReflectionEnabledByDefault>
- </PropertyGroup>
复制代码 这些修改将确保AppSettings类在AOT编译环境中能够正确地进行JSON序列化和反序列化。
Refit在AOT模式下的JSON序列化问题
在AOT模式下,Refit库的JSON处理也可以使用 Newtonsoft.Json
先安装 Refit.Newtonsoft.Json 库,并且需要额外配置来处理类型信息。
添加类型预注册
需要创建一个新的类来预注册所有API接口中使用的类型:修改ApiService类
修改ApiService类,确保在初始化时注册类型:在App.axaml.cs中初始化类型注册
确保在应用启动时调用类型注册:- public override void OnFrameworkInitializationCompleted()
- {
- <ItemGroup>
- <RdXmlFile Include="rd.xml" />
- </ItemGroup>// 确保Refit类型被注册
- <ItemGroup>
- <RdXmlFile Include="rd.xml" />
- </ItemGroup>RefitTypeRegistration.RegisterTypes();
- <ItemGroup>
- <RdXmlFile Include="rd.xml" />
- </ItemGroup>
- <ItemGroup>
- <RdXmlFile Include="rd.xml" />
- </ItemGroup>// 其他初始化代码...
- <ItemGroup>
- <RdXmlFile Include="rd.xml" />
- </ItemGroup>
- <ItemGroup>
- <RdXmlFile Include="rd.xml" />
- </ItemGroup>base.OnFrameworkInitializationCompleted();
- }
复制代码 添加AOT兼容性配置
由于AOT编译对反射和动态代码生成有限制,需要添加一个rd.xml文件来指定需要保留的类型:然后在项目文件中引用这个rd.xml文件:- <ItemGroup>
- <RdXmlFile Include="rd.xml" />
- </ItemGroup>
复制代码 发布
使用以下命令发布AOT版本的应用程序:- dotnet publish -c Release -r win-x64 -p:PublishAot=true
复制代码 对于其他平台,可以替换相应的RID:
- Windows: win-x64
- macOS: osx-x64
- Linux: linux-x64
小结
AOT 发布是 .Net 平台一个重要的特性,它能将应用程序编译成不依赖运行时的机器码,不仅减小了发布包体积,还能提升启动速度,同时也增加了反编译的难度。
使用 AOT 方式发布 Avalonia 应用程序还是有一些坑的。:JSON序列化问题、类型注册问题以及AOT兼容性问题。针对这些问题,以下解决方案可以解决:
- JSON序列化方面,优先选择了对AOT支持更好的 Newtonsoft.Json 库,并通过类型预注册确保了序列化的正确性。
- 对于需要反射的功能,通过rd.xml文件显式声明需要保留的类型,解决了AOT编译时的类型裁剪问题。
- 在项目配置方面,通过合理设置AOT相关的编译选项,平衡了性能和包大小。
虽然AOT发布还存在一些限制,比如调试相对困难、部分第三方库可能不兼容等,但随着.Net平台的发展(特别是.Net9之后的版本),AOT的支持会越来越完善。对于需要高性能、小体积、反编译保护的Avalonia应用来说,AOT发布是一个值得考虑的选择。
来源:程序园用户自行投稿发布,如果侵权,请联系站长删除
免责声明:如果侵犯了您的权益,请联系站长,我们会及时删除侵权内容,谢谢合作! |