aot使用經驗總結

一、引言

站长接触 AOT 已有 3 个月之久，此前在《好消息：NET 9 X86 AOT 的突破 - 支持老旧 Win7 与 XP 环境》一文中就有所提及。在这段时间里，站长使用 Avalonia 开发的项目也成功完成了 AOT 发布测试。然而，这一过程并非一帆风顺。站长在项目功能完成大半部分才开始进行 AOT 测试，期间遭遇了不少问题，可谓是 “踩坑无数”。为了方便日后回顾，也为了给广大读者提供参考，在此将这段经历进行总结。

net aot 是將.net 代碼提前編譯為本機代碼的技術。其優勢眾多，啟動速度快，減少運行時資源占用，還提高安全性。aot 發布後無需再安裝.net 運行時等依賴。. net 8、9 aot 發布後，可在 xp、win7 非 sp1 作業系統下運行。這使得應用部署更便捷，能適應更多老舊系統環境，為開發者拓展了應用場景，在性能提升的同時，也增加了系統兼容性，讓.net 應用的開發和部署更具靈活性和廣泛性，給用戶帶來更好的體驗。

二、經驗之談

（一）測試策略的重要性

從項目創建伊始，就應養成良好的習慣，即只要添加了新功能或使用了較新的語法，就及時進行 aot 發布測試。否則，問題積累到後期，解決起來會異常艱難，站長就因前期忽視了這一點，付出了慘痛的代價。無奈的解決方法是重新創建項目，然後逐個還原功能並進行 aot 測試。經過了一周的加班 aot 測試，每個 aot 發布過程大致如下：

內網 aot 發布一次需 2、3 分鐘，這段時間只能看看需求文檔、技術文章、需求文檔、技術文章。。。
發布完成，運行無效果，體現在雙擊未出現界面，進程列表沒有它，說明程式崩潰了，查看系統應用事件日誌，日誌中通常會包含異常警告信息。
依據日誌信息檢查代碼，修改相關 api。
再次進行 aot 發布，重複上述 1 - 3 步驟。

經過一周的努力，項目 aot 後功能測試終於正常，至此收工。

（二）aot 需要注意的點及解決方法

1. 添加 rd.xml

在主工程创建一个 XML 文件，例如Roots.xml，内容大致如下：

<linker>
	<assembly fullname="CodeWF.Toolbox.Desktop" preserve="All" />
</linker>

需要支持 AOT 的工程，在该 XML 中添加一个assembly节点，fullname是程序集名称，CodeWF.Toolbox.Desktop是站长小工具的主工程名，点击查看源码。

在主工程添加ItemGroup节点关联该 XML 文件：

<ItemGroup>
    <TrimmerRootDescriptor Include="Roots.xml" />
</ItemGroup>

2. prism 支持

站長使用了 prism 框架及 dryioc 容器，若要支持 aot，需要添加以下 nuget 包：

<PackageReference Include="Prism.Avalonia" Version="8.1.97.11073" />
<PackageReference Include="Prism.DryIoc.Avalonia" Version="8.1.97.11073" />

rd.xml需要添加

<assembly fullname="Prism" preserve="All" />
<assembly fullname="DryIoc" preserve="All" />
<assembly fullname="Prism.Avalonia" preserve="All" />
<assembly fullname="Prism.DryIoc.Avalonia" preserve="All" />

8.1.97.11073版本為最後一個開源版本，9.x及後面的為收費版本

3. app.config 讀寫

在.NET Core 中使用System.Configuration.ConfigurationManager包操作 App.config 文件，rd.xml需添加如下内容：

<assembly fullname="System.Configuration.ConfigurationManager" preserve="All" />

使用Assembly.GetEntryAssembly().location失败，目前使用ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None)获取的应用程序程序配置，指定路径的方式后续再研究。

4. httpclient 使用

rd.xml添加如下内容：

<assembly fullname="System.Net.Http" preserve="All" />

一般不直接使用HttpClient，可尝试Refit之类的三方库用作Http请求更便捷：

<assembly fullname="Refit" preserve="All" />

5. dapper 支持

Dapper 的 AOT 支持需要安装Dapper.AOT包，rd.xml添加如下内容：

<assembly fullname="Dapper" preserve="All" />
<assembly fullname="Dapper.AOT" preserve="All" />

数据库操作的方法需要添加DapperAOT特性，举例如下：

[DapperAot]
public static bool EnsureTableIsCreated()
{
    try
    {
        using var connection = new SqliteConnection(DBConst.DBConnectionString);
        connection.Open();

        const string sql = $@"
            CREATE TABLE IF NOT EXISTS {nameof(JsonPrettifyEntity)}(
                {nameof(JsonPrettifyEntity.IsSortKey)} Bool,
                {nameof(JsonPrettifyEntity.IndentSize)} INTEGER
        )";

        using var command = new SqliteCommand(sql, connection);
        return command.ExecuteNonQuery() > 0;
    }
    catch (Exception ex)
    {
        return false;
    }
}

6. System.Text.Json

参考JsonExtensions.cs

序列化

public static bool ToJson<T>(this T obj, JsonSerializerOptions? options,  out string? json, out string? errorMsg)
{
    if (obj == null)
    {
        json = default;
        errorMsg = "Please provide object";
        return false;
    }

    if (options == null)
    {
        options = new JsonSerializerOptions()
        {
            WriteIndented = true,
            Encoder = JavaScriptEncoder.UnsafeRelaxedJsonEscaping,
            TypeInfoResolver = new DefaultJsonTypeInfoResolver(),
        };
    }

    try
    {
        json = JsonSerializer.Serialize(obj, options);
        errorMsg = default;
        return true;
    }
    catch (Exception ex)
    {
        json = default;
        errorMsg = ex.Message;
        return false;
    }
}

反序列化

public static bool FromJson<T>(this string? json, JsonSerializerOptions? options, out T? obj, out string? errorMsg)
{
    if (string.IsNullOrWhiteSpace(json))
    {
        obj = default;
        errorMsg = "Please provide json string";
        return false;
    }

    try
    {
        if (options == null)
        {
            options = new JsonSerializerOptions()
            {
                Encoder = JavaScriptEncoder.UnsafeRelaxedJsonEscaping,
                TypeInfoResolver = new DefaultJsonTypeInfoResolver(),
                Converters = { new NullableDateTimeConverter() }
            };
        }

        obj = JsonSerializer.Deserialize<T>(json!, options);
        errorMsg = default;
        return true;
    }
    catch (Exception ex)
    {
        obj = default;
        errorMsg = ex.Message;
        return false;
    }
}

上面配置简单类序列化与反序列化正常用，如果类中存在int?、double?之类的可空类型：

public class Project
{
    public int? Id { get; set; }

    public string Name { get; set; }

    public int Record { get; set; }

    [XmlArray(ElementName = "Members")]
    [XmlArrayItem(typeof(Member))]
    public List<Member> Members { get; set; }
}

则创建一个JsonSerializerContext的子类即可解决：

[JsonSerializable(typeof(Project))]
[JsonSerializable(typeof(List<Member>))]
internal partial class ProjectJsonSerializerContext : JsonSerializerContext
{
}

注意：創建好即可，不需要主動調用

傳統的 jsonserializer.serialize(project) 底層依賴運行時反射來解析 project 類的屬性、特性等信息，但 aot 編譯會在編譯期裁剪掉未被顯式引用的反射元數據，導致序列化失敗（拋出 notsupportedexception 或無法序列化/反序列化某些屬性）。

而 projectjsonserializercontext 是通過編譯期生成靜態元數據的方式工作。

7. 反射問題

参考项目CodeWF.NetWeaver

创建指定类型的List<T>或Dictionary<T>实例：

public static object CreateInstance(Type type)
{
    var itemTypes = type.GetGenericArguments();
    if (typeof(IList).IsAssignableFrom(type))
    {
        var lstType = typeof(List<>);
        var genericType = lstType.MakeGenericType(itemTypes.First());
        return Activator.CreateInstance(genericType)!;
    }
    else
    {
        var dictType = typeof(Dictionary<,>);
        var genericType = dictType.MakeGenericType(itemTypes.First(), itemTypes[1]);
        return Activator.CreateInstance(genericType)!;
    }
}

反射调用List<T>和Dictionary<T>的Add方法添加元素失败，下面是伪代码：

// List<T>
var addMethod = type.GetMethod("Add");
addMethod.Invoke(obj, new[]{ child })

// Dictionary<Key, Value>
var addMethod = type.GetMethod("Add");
addMethod.Invoke(obj, new[]{ key, value })

解決辦法，轉換為實現的接口調用：

// List<T>
(obj as IList).Add(child);

// Dictionary<Key, Value>
(obj as IDictionary)[key] = value;

获取数组、List<T>、Dictionary<key, value>的元素个数

同上面 Add 方法反射获取 Length 或 Count 属性皆返回 0，value.Property("Length", 0)，封装的 Property 非 AOT 运行正确：

public static T Property<T>(this object obj, string propertyName, T defaultValue = default)
{
    if (obj == null) throw new ArgumentNullException(nameof(obj));
    if (string.IsNullOrEmpty(propertyName)) throw new ArgumentNullException(nameof(propertyName));

    var propertyInfo = obj.GetType().GetProperty(propertyName);
    if (propertyInfo == null)
    {
        return defaultValue;
    }

    var value = propertyInfo.GetValue(obj);

    try
    {
        return (T)Convert.ChangeType(value, typeof(T));
    }
    catch (InvalidCastException)
    {
        return defaultValue;
    }
}

aot 成功：直接通過轉換為基類型或實現的接口調用屬性即可：

// 数组
var length = ((Array)value).Length;

// List<T>
 if (value is IList list)
{
    var count = list.Count;
}

// Dictionary<key, value>
if (value is IDictionary dictionary)
{
    var count = dictionary.Count;
}

8. windows 7 支持

如遇 AOT 后无法在Windows 7运行，请添加YY-Thunks包：

<PackageReference Include="YY-Thunks" Version="1.1.4-Beta3" />

并指定目标框架为net9.0-windows。

9. winform\兼容 xp

如果第 8 条后还运行不了，请参考上一篇文章《.NET 9 AOT 的突破 - 支持老旧 Win7 与 XP 环境 - 码坊 (dotnet9.com)》添加 VC-LTL 包，这里不赘述。

10. 其他

還有許多其他需要注意的地方，後續想起來逐漸完善本文。

三、總結

aot 發布測試雖然過程中可能會遇到諸多問題，但通過及時的測試和正確的配置調整，最終能夠實現項目的順利發布。希望以上總結的經驗能對大家在 aot 使用過程中有所幫助，讓大家在開發過程中少走彎路，提高項目的開發效率和質量。同時，也期待大家在實踐中不斷探索和總結，共同推動技術的進步和發展。

aot 可參考項目：

CodeWF.NetWeaver: https://github.com/dotnet9/CodeWF.NetWeaver
CodeWF.Tools：https://github.com/dotnet9/CodeWF.Tools
CodeWF.Toolbox：https://github.com/dotnet9/CodeWF.Toolbox