OpenRobot.Framework.DynamicModel 1.2.0

OpenRobot.Framework.DynamicModel

OpenRobot.Framework.DynamicModel 是一个 .NET 8.0 类库，用于在强类型 DTO 和动态属性模型之间进行双向转换。主要应用于数据模型的扁平化存储和恢复场景。

特性

• DTO 到 OpenModel: 将强类型 DTO 转换为扁平化的 OpenModel 集合，便于数据库存储
• OpenModel 到 Entity: 将 OpenModel 集合转换为 ORM 实体，用于数据库操作
• IOpenModel 到自定义对象: 通过基于特性的灵活配置，将 IOpenModel 集合映射回自定义对象
• 嵌套对象支持: 无缝处理复杂的嵌套对象和集合
• 验证元数据: 保留源 DTO 的验证规则和显示属性
• 自定义转换器: 使用 ICustomApressConverter 扩展自定义转换逻辑

安装

dotnet add package OpenRobot.Framework.DynamicModel

快速开始

1. 定义 DTO

using OpenRobot.Framework.DynamicModel;
using System.ComponentModel;
using System.ComponentModel.DataAnnotations;

public class UserDto : IDynamicTemplateDto
{
    [MainKey]
    public int Id { get; set; }

    [Description("用户名")]
    public string Name { get; set; }

    [RegularExpression(@"^\d{6}$", ErrorMessage = "必须是6位数字")]
    public string Code { get; set; }

    public AddressDto Address { get; set; }
    public List<PhoneDto> Phones { get; set; }
}

public class AddressDto
{
    public string City { get; set; }
    public string Street { get; set; }
}

2. 转换 DTO 为 OpenModel

var dto = new UserDto
{
    Id = 1,
    Name = "张三",
    Code = "123456",
    Address = new AddressDto { City = "北京", Street = "长安街" }
};

// 转换为扁平化的 OpenModel 集合
var models = dto.ModelToDynamicProperties(mainId: 1);

3. 转换 OpenModel 为数据库实体

// 定义实现 IDynamicPropEntity 的实体
public class DynamicProperty : IDynamicPropEntity
{
    public int Id { get; set; }
    public int DynamicPropertyId { get; set; }
    public string PropertyName { get; set; }
    public string Value { get; set; }
    // ... 其他属性
}

// 转换并保存到数据库
var entities = models.OpenModelConvertDynamicPropEntity<DynamicProperty>();
await dbContext.DynamicProperties.AddRangeAsync(entities);
await dbContext.SaveChangesAsync();

4. 映射回自定义对象

基础映射示例

public class UserViewModel : ICustomPropConvert
{
    [CustomPropMap("Name")]
    public string UserName { get; set; }

    [CustomPropMap("Address", HasObject = true)]
    public AddressViewModel Address { get; set; }
}

public class AddressViewModel : ICustomPropConvert
{
    [CustomPropMap("City")]
    public string CityName { get; set; }
}

// 从数据库加载并映射回
var openModels = await dbContext.DynamicProperties
    .Where(m => m.DynamicPropertyId == 1)
    .ToListAsync();

var viewModel = new UserViewModel();
viewModel.OpenDynamicPropertryBuild(openModels);

使用 PropDetailNode 获取属性元数据

public class UserViewModel : ICustomPropConvert
{
    [CustomPropMap("Name")]
    public string UserName { get; set; }

    // PropDetailNode 会自动填充属性的元数据（标题、验证规则等）
    [CustomPropMap("Code")]
    public PropDetailNode CodeDetail { get; set; }

    [CustomPropMap("Email")]
    public PropDetailNode EmailDetail { get; set; }
}

// 从数据库加载并映射
var viewModel = new UserViewModel();
viewModel.OpenDynamicPropertryBuild(openModels);

// 访问属性值和元数据
string code = viewModel.CodeDetail.Value;              // 属性值
string title = viewModel.CodeDetail.Title;             // 显示标题
string regex = viewModel.CodeDetail.Regex;             // 验证规则
string errorMsg = viewModel.CodeDetail.ErrorMessage;   // 错误消息

// 用于前端验证展示
var validationRules = new
{
    Code = new
    {
        Value = viewModel.CodeDetail.Value,
        Title = viewModel.CodeDetail.Title,
        Regex = viewModel.CodeDetail.Regex,
        ErrorMessage = viewModel.CodeDetail.ErrorMessage
    }
};

特性说明

高级用法

自定义转换器

public class DateTimeConverter : ICustomApressConverter
{
    public string PropertyConvert(object? value)
    {
        if (value is DateTime dt)
            return dt.ToString("yyyy-MM-dd");
        return "";
    }

    public object? ApressConvert(IList<OpenModel> models)
    {
        // 自定义转换逻辑
        return null;
    }
}

public class EventDto : IDynamicTemplateDto
{
    [CustomOpenConvert(typeof(DateTimeConverter))]
    public DateTime EventDate { get; set; }
}

选择性属性转换

// 仅转换指定属性
var models = dto.ModelToDynamicProperties(mainId: 1, "Name", "Address");

嵌套对象转换

// 带父 ID 和属性前缀的嵌套转换
var models = dto.ModelToDynamicProperties(mainId: 1, parentId: "P01", propNamePreTag: "Parent");

数据结构

OpenModel 使用扁平化结构表示嵌套对象：

public class OpenModel : IOpenModel
{
    public int DynamicPropertyId { get; set; }  // 主实体 ID
    public string PropertyName { get; set; }     // 点号表示路径（如 "Address.City"）
    public string Value { get; set; }            // 序列化值
    public string ParentID { get; set; }         // 十六进制层级路径
    public int Index { get; set; }               // 数组元素索引
    public bool IsBaseType { get; set; }         // 基元类型标志
    public bool IsArray { get; set; }            // 数组标志
    public string Title { get; set; }            // 来自 Description 的显示名
    public string Regex { get; set; }            // 验证正则表达式
    public string ErrorMessage { get; set; }     // 验证错误消息
}

版本要求

• .NET 8.0 或更高版本

构建和发布

# 构建
dotnet build

# 打包
dotnet pack

# 发布到 NuGet
nuget push *.nupkg -Source https://api.nuget.org/v3/index.json

许可证

Copyright © OpenRobot

版本历史

• 1.1.0 - 重构架构，简化转换流程，新增 ICustomPropConvert 支持
• 1.0.0 - 初始版本