Mego开发文档 - 数据注释建模

Posted 2020-10-30 CarefreeXT

数据注释建模

Mego框架使用一组约定来基于CLR类来构建模型。您可以指定其他配置来补充或覆盖通过约定发现的内容。

在 Mego 中所有的数据对象必须要有主键。这里需要声明与EF不同的是框架只支持数据注释的语法来构建模型，在框架自动发现后，只有通过其他接口才能更改模型定义，我们使用一种简单直接的方式来声明，例如：

public class Blog
{
    [Key]
    public int BlogId { get; set; }

    public string Url { get; set; }
}

常用的数据注释特性类都在

using Caredev.Mego.DataAnnotations;

命名空间下。

主键约定

我们约定一个名为Id或<type name>Id将被配置为当前数据对象的主键属性。

class Car
{
    public string Id { get; set; }

    public string Make { get; set; }
    public string Model { get; set; }
}

class Car
{
    public string CarId { get; set; }

    public string Make { get; set; }
    public string Model { get; set; }
}

您可以使用数据注释强制一个或多个属性为主键。以下为单个主键和复合主键的示例：

class Car
{
    [Key]
    public string LicensePlate { get; set; }

    public string Make { get; set; }
    public string Model { get; set; }
}

public class Warehouse
{
    [Key, Column(nameof(Id), Order = 1)]
    public int Id { get; set; }
    [Key, Column(nameof(Number), Order = 2)]
    public int Number { get; set; }

    public string Name { get; set; }
    public string Address { get; set; }
}

如果您声明数据对象为复合主键。

自增列

有不少数据库是支持标识列（自增列），使用该特性可以声明一个属性受数据库自增列控制，同时可以指定自增的起始及步长。

public class Blog
{

    [Identity(1, 1)]
    public int BlogId { get; set; }

    public string Url { get; set; }
}

排除属性

您可以指定数据对象中某个属性不参与映射，补充如果某个属性为只读属性框架会自动将它排除，这与强制声明排除特性效果相同。

public class Blog
{
    public int BlogId { get; set; }
    public string Url { get; set; }

    [NotMapped]
    public DateTime LoadedFromDatabase { get; set; }
}

并发控制

与EF相同，本框架支持乐观并发，您可以声明一个或多个属性参与提交时并发检查。

public class Person
{
    public int PersonId { get; set; }

    [ConcurrencyCheck]
    public string LastName { get; set; }

    public string FirstName { get; set; }
}

可为空属性

指示当前属性是否可以为空。

public class Blog
{
    public int BlogId { get; set; }

    [Nullable(false)]
    public string Url { get; set; }
}

长度

配置长度向数据存储提供关于用于给定属性的适当数据类型的提示。最大长度仅适用于数组或可变长度的数据类型，例如byte[]。

public class Blog
{
    public int BlogId { get; set; }

    [Length(500, false)]
    public byte[] Image { get; set; }
}

字符串

在CLR中的字符串类型将会映射到数据库中的多种字符串存储类型，该特性可确定对应的实际类型。例如下面代码中声明Url属性在SQL Server数据库中的类型为nvarchar(500)。

public class Blog
{
    public int BlogId { get; set; }

    [String(500, false)]
    public string Url { get; set; }
}

精度

用于配置存精度信息的数据类型列，例如decimal。

public class Product
{
    public int Id { get; set; }

    [Precision(12,4)]
    public decimal Price { get; set; }
}