Sparkdo.Serialization 1.0.0

Sparkdo.Serialization

Sparkdo 序列化处理库，提供对象序列化和反序列化的通用功能。

功能特性

• 基于 System.Text.Json 的默认序列化实现
• 支持自定义特定类型的序列化器
• 通过模块系统自动注册服务
• 支持依赖注入扩展

安装

<PackageReference Include="Sparkdo.Serialization" Version="x.x.x" />

使用方法

基本用法

// 通过依赖注入获取序列化服务
public class MyService
{
    private readonly IObjectSerializer _serializer;
    
    public MyService(IObjectSerializer serializer)
    {
        _serializer = serializer;
    }
    
    public byte[] SerializeObject<T>(T obj)
    {
        return _serializer.Serialize(obj);
    }
    
    public T DeserializeObject<T>(byte[] data)
    {
        return _serializer.Deserialize<T>(data);
    }
}

自定义特定类型序列化器

对于特定类型，可以实现自定义序列化器：

// 实现特定类型的序列化器
public class CustomTypeSerializer : IObjectSerializer<CustomType>
{
    public byte[] Serialize(CustomType obj)
    {
        // 自定义序列化逻辑
        return Encoding.UTF8.GetBytes(obj.ToString());
    }

    public CustomType Deserialize(byte[] bytes)
    {
        // 自定义反序列化逻辑
        return new CustomType(Encoding.UTF8.GetString(bytes));
    }
}

// 注册自定义序列化器
services.AddObjectSerializer<CustomType, CustomTypeSerializer>();

当为特定类型注册了自定义序列化器后，DefaultObjectSerializer 会自动使用该序列化器。

模块注册

SparkdoSerializationModule 会自动注册默认的序列化服务：

public class SparkdoSerializationModule : Module
{
    public override void Configure(IConfigureContext context)
    {
        // 注册默认序列化服务
        context.Services.AddTransient<IObjectSerializer, DefaultObjectSerializer>();
    }
}

接口定义

IObjectSerializer

通用对象序列化接口：

public interface IObjectSerializer
{
    byte[] Serialize<T>(T obj);
    T Deserialize<T>(byte[] bytes);
}

IObjectSerializer<T>

特定类型序列化接口：

public interface IObjectSerializer<T>
{
    byte[] Serialize(T obj);
    T Deserialize(byte[] bytes);
}

扩展方法

提供了扩展方法用于注册自定义序列化器：

// 扩展方法定义在 Microsoft/Extensions/DependencyInjection/SerializationServiceCollectionExtensions.cs 文件中
public static class SerializationServiceCollectionExtensions
{
    public static IServiceCollection AddObjectSerializer<T, TObjectSerializer>(this IServiceCollection services)
        where TObjectSerializer : class, IObjectSerializer<T>
    {
        services.AddTransient<IObjectSerializer<T>, TObjectSerializer>();
        return services;
    }
}

扩展性

可以通过以下方式扩展序列化功能：

1. 实现 IObjectSerializer<T> 接口并注册为服务来自定义特定类型的序列化
2. 通过 AddObjectSerializer<T, TObjectSerializer> 扩展方法注册自定义序列化器