typeshape-csharp 0.10.0

typeshape-csharp

包含 TypeShape 库的示例迁移，适应性改进以适应 C# 中的模式和习惯用法。该库提供了一种类型模型，有助于开发高性能的数据类型通用组件，如序列化器、记录器、转换器和验证器。其编程模型在核心上采用了一种 访问者模式的变体，它允许对任意类型图进行强类型遍历：它可以用于生成不产生分配成本的对象遍历算法。有关额外的指南和 API 文档，请参阅项目网站。

该项目包括两个形状模型提供者：一个 反射衍生的 和一个 源生成的。因此，任何基于形状模型构建的数据类型通用应用程序在目标源生成模型时会自动获得 trim safety/NativeAOT 支持。

使用库

用户可以使用内置的源生成器提取特定类型的形状模型

ITypeShape<MyPoco> shape = TypeShapeProvider.Resolve<MyPoco>();

[GenerateShape] // Auto-generates a static abstract factory for ITypeShape<MyPoco>
public partial record MyPoco(string x, string y);

对于当前编译中不可访问的类型，可以使用单独的见证类型生成实现

ITypeShape<MyPoco[]> shape = TypeShapeProvider.Resolve<MyPoco[], Witness>();
ITypeShape<MyPoco[][]> shape = TypeShapeProvider.Resolve<MyPoco[][], Witness>();

// Generates factories for both ITypeShape<MyPoco[]> and ITypeShape<MyPoco[][]>
[GenerateShape<MyPoco[]>]
[GenerateShape<MyPoco[][]>]
public partial class Witness;

该库还提供了一个基于反射的提供者

using TypeShape.ReflectionProvider;

ITypeShape<MyPoco> shape = ReflectionTypeShapeProvider.Default.GetShape<MyPoco>();
public record MyPoco(string x, string y);

在两种情况下，提供商将为MyPoco生成一个强类型的类型模型。可以将类型的模型输入到使用TypeShape的访问者模式声明的通用消费者。

示例：编写一个类型通用计数器

类型通用编程的最简单的例子是在给定的对象图中计算节点的数量。这可以通过扩展TypeShapeVisitor类来实现

public sealed partial class CounterVisitor : TypeShapeVisitor
{
    // For the sake of simplicity, ignore collection types and just focus on properties/fields.
    public override object? VisitObject<T>(IObjectTypeShape<T> objectShape, object? state)
    {
        // Recursively generate counters for each individual property/field:
        Func<T, int>[] propertyCounters = objectShape.GetProperties()
            .Where(prop => prop.HasGetter)
            .Select(prop => (Func<T, int>)prop.Accept(this)!)
            .ToArray();

        // Compose into a counter for the current type.
        return new Func<T?, int>(value =>
        {
            if (value is null)
                return 0;

            int count = 1; // the current node itself
            foreach (Func<T, int> propertyCounter in propertyCounters)
                count += propertyCounter(value);

            return count;
        });
    }

    public override object? VisitProperty<TDeclaringType, TPropertyType>(IPropertyShape<TDeclaringType, TPropertyType> propertyShape, object? state)
    {
        Getter<TDeclaringType, TPropertyType> getter = propertyShape.GetGetter(); // extract the getter delegate
        var propertyTypeCounter = (Func<TPropertyType, int>)propertyShape.PropertyType.Accept(this)!; // extract the counter for the property type
        return new Func<TDeclaringType, int>(obj => propertyTypeCounter(getter(ref obj))); // compose to a property-specific counter
    }
}

现在我们使用访问者定义一个计数器工厂

public static class Counter
{
    private readonly static CounterVisitor s_visitor = new();

    public static Func<T?, int> CreateCounter<T>() where T : ITypeShapeProvider<T>
    {
        ITypeShape<T> typeShape = T.GetShape();
        return (Func<T?, int>)typeShape.Accept(s_visitor)!;
    }
}

然后我们可以将其应用于我们的POCO的形状，如下所示

Func<MyPoco?, int> pocoCounter = Counter.CreateCounter<MyPoco>();

[GenerateShape]
public partial record MyPoco(string? x, string? y);

本质上，TypeShape使用访问者折叠一个强类型的Func计数器委托，但一旦调用委托，它就不再依赖于访问者：它仅定义了一个强类型委托调用链，构建后调用成本低

pocoCounter(new MyPoco("x", "y")); // 3
pocoCounter(new MyPoco("x", null)); // 2
pocoCounter(new MyPoco(null, null)); // 1
pocoCounter(null); // 0

有关更多详细信息，请参阅项目页面上的README文件。