v1.4.0+ 已自动识别 EFCore 实体特性 Key/Required/NotMapped/Table/Column

主键(Primary Key)

class Topic {
[Column(IsPrimary = true)]
public int Id { get; set; }
}

约定:

  • 当没有指明主键时,命名为 id 的字段将成为主键;(不区分大小写)

  • 当主键是 Guid 类型时,插入时会自动创建(有序、不重复)的值,所以不需要自己赋值;(支持分布式)

自增(Identity)

class Topic {
[Column(IsIdentity = true)]
public int Id { get; set; }
}

约定:

  • 当没有指明主键时,标记自增的成员将成为主键;

唯一键(Unique Key)、索引(Index)

[Index("uk_phone", "phone", true)]
[Index("uk_group_index", "group,index", true)]
[Index("uk_group_index22", "group, index22 desc", true)]
class AddUniquesInfo
{
public Guid id { get; set; }
public string phone { get; set; } public string group { get; set; }
public int index { get; set; }
public string index22 { get; set; }
}

第三个参数 true 的时候是唯一键,false 的时候是普通索引。

数据库类型(DbType)

class Topic {
[Column(DbType = "varchar(128) NOT NULL")]
public string Title { get; set; }
}

可以在类型上指定 NOT NULL,也可以通过 [Column(IsNullable = false)] 设置;

0.12.8 版本增加了 [Column(StringLength = 128)] 针对字符串的长度设置;

0.9.12 版本增加了对 MaxLength 特性的解析,上面的 varchar(128) 可改写成:

class Topic {
[MaxLength(128)]
public string Title { get; set; }
}

当 string 长度 -1 时产生的映射如下:

MySql PostgreSQL SqlServer Oracle Sqlite MsAccess
text text varchar(max) nclob text longtext

注意:Oracle nclob 需要 v1.3.2+ 版本才支持,否则将映射 nvarchar2(4000)

服务器时间(ServerTime)

class Topic {

    [Column(ServerTime = DateTimeKind.Utc, CanUpdate = false)]
public DateTime CreateTime { get; set; } [Column(ServerTime = DateTimeKind.Utc)]
public DateTime UpdateTime { get; set; }
}

v0.12.4 使用数据库时间执行插入数据,注意:

1、一但设置了这个特性,插入的时候设置属性值是无效的;

2、插入实体执行成功后,实体的值还是 c# 时间;

v1.1 - ServerTime 特性,对 Update 方法时也能生效

其他参考:如果对时间精度要求不高,推荐下面的做法,先计算本地与服务器时间差距,再使用 Aop 统一处理:

var serverTime = fsql.Select<T>().Limit(1).First(a => DateTime.UtcNow);
var timeOffset = DateTime.UtcNow.Subtract(serverTime); //减去数据库时间 fsql.Aop.AuditValue += new EventHandler<Aop.AuditValueEventArgs>((_, e) =>
{
if (e.Column.Attribute.MapType.NullableTypeOrThis() == typeof(DateTime))
{
if (e.Value == null || (DateTime)e.Value == default(DateTime))
{
e.Value = DateTime.Now.Subtract(timeOffset); //使用本地时区保存
return;
}
}
});

可空(Nullable)

class Topic {
[Column(IsNullable = false)]
public string Title { get; set; }
}

在不指定 DbType、IsNullable 时,FreeSql 提供默认设定,如:

  • int -> not null(不可为空)
  • int? -> null(可空)

一般在使用 string 类型时,才需要手工指明是否可空(string 默认可空);

忽略(Ignore)

class Topic {
[Column(IsIgnore = true)]
public string Title { get; set; }
}

当实体有属性不需要映射的时候使用,内部自动忽略了对象的映射;

当实体内的属性不是可接受的类型时,可以不用指定该特定,如下不必要的指定:

class Topic {
[Column(IsIgnore = true)]
public Topic Parent { get; set; }
}

乐观锁(RowVersion)

class Topic {
public Guid id { get; set; }
public string Title { get; set; } [Column(IsVersion = true)]
public int Version { get; set; }
}

更新整个实体数据时,在并发情况下极容易造成旧数据将新的记录更新。

乐观锁的原理,是利用实体某字段,如:long version,更新前先查询数据,此时 version 为 1,更新时产生的 SQL 会附加 where version = 1,当修改失败时(即 Affrows == 0)抛出异常。

每个实体只支持一个乐观锁属性。

适用 SetSource 更新,无论使用什么方法更新 version 的值都会增加 1

自定义类型映射(MapType)

class EnumTestMap {
public Guid id { get; set; } [Column(MapType = typeof(string))]
public ToStringMapEnum enum_to_string { get; set; }
[Column(MapType = typeof(string))]
public ToStringMapEnum? enumnullable_to_string { get; set; } [Column(MapType = typeof(int))]
public ToStringMapEnum enum_to_int { get; set; }
[Column(MapType = typeof(int?))]
public ToStringMapEnum? enumnullable_to_int { get; set; } [Column(MapType = typeof(string))]
public BigInteger biginteger_to_string { get; set; }
[Column(MapType = typeof(string))]
public BigInteger? bigintegernullable_to_string { get; set; }
}
public enum ToStringMapEnum { 中国人, abc, 香港 }

BigInteger 也可以映射使用,但请注意:仅仅是 CURD 方便, Equals == 判断可以使用,无法实现 + - * / 等操作;

v0.9.15 版本还可以将值对象映射成 typeof(string),安装扩展包:

dotnet add package FreeSql.Extensions.JsonMap

fsql.UseJsonMap(); //开启功能

class TestConfig
{
public int clicks { get; set; }
public string title { get; set; }
}
[Table(Name = "sysconfig")]
public class S_SysConfig
{
[Column(IsPrimary = true)]
public string Name { get; set; } [JsonMap]
public TestConfig Config { get; set; }
}

字段位置(Position)

适用场景:当实体类继承时,CodeFirst创建表的字段顺序可能不是想要的,通过该特性可以设置顺序。

创建表时指定字段位置,如:[Column(Position = 1],可为负数即反方向位置;

可插入(CanInsert)、可更新(CanUpdate)

该字段是否可以插入或更新,默认值true,指定为false插入或更新时该字段会被忽略。

当指明了 InsertColumn/UpdateColumns 等方法时,该特性作用可能失效。例如 CanInsert = false 时,又指明了 InsertColumns 该属性,则仍然会插入。

自定义插入值(InsertValueSql)

执行 Insert 方法时使用此值,它的语法是 SQL。

注意:如果是 getdate() 这种请可考虑使用 ServerTime,因为它对数据库间作了适配。

class Type
{
[Column(InsertValueSql = "'xxx'")]
public string Name { get; set; }
} fsql.Insert(new Type()).ExecuteAffrows();
//INSERT INTO `type`(`Name`) VALUES('xxx')

名称

FreeSql 默认使用实体的类名,或属性名与数据库映射,也可以指定映射的名称;

指定实体的表名,指定 Name 后,实体类名变化不影响数据库对应的表。FreeSql尽量支持了对多数据库或schema支持,不防试试指定表名为:其他数据库.表名,不同数据库的指定方式有差异,这一点以后深入解答。

[Table(Name = "db2.tb_topic111")]
class Topic {
//...
}

注意:尽量不要使用带点的表名,只有 MySql/Sqlite 对此类表名支持 CodeFirst。但是它不影响 CRUD 功能,使用 [Table(Name = "`sys.config`")] 解决

指定实体的表名,修改为实体类名。指定数据库旧的表名,修改实体命名时,同时设置此参数为修改之前的值,CodeFirst才可以正确修改数据库表;否则将视为【创建新表】。

[Table(OldName = "Topic")]
class Topic2 {
//...
}

实体的属性也有相同的功能,[Column(Name = "xxx")]

禁用迁移

IFreeSql.CodeFirst.IsAutoSyncStructure 可设置全局【自动迁移结构】功能,也可通过 FreeSqlBuilder.UseAutoSyncStructure(true) 创建 IFreeSql 的时候设置功能。

当【实体类】对应的是数据库【视图】或者其他时,可通过 [Table(DisableSyncStructure = true)] 禁用指定的实体迁移操作。

[Table(DisableSyncStructure = true)]
class ModelDisableSyncStructure {
[Column(IsPrimary = false)]
public int pkid { get; set; }
}

备注

FreeSql CodeFirst 支持将 c# 代码内的注释,迁移至数据库的备注。先决条件:

1、实体类所在程序集,需要开启 xml 文档功能;

2、xml 文件必须与程序集同目录,且文件名:xxx.dll -> xxx.xml;

v1.5.0+ 版本增加了对 Description 特性的解析,优先级低于 c# 代码注释;

系列文章导航

FreeSql (三)实体特性的更多相关文章

  1. FreeSql (四)实体特性 Fluent Api

    FreeSql 提供使用 Fluent Api, 在外部配置实体的数据库特性,Fluent Api 的方法命名与特性名保持一致,如下: fsql.CodeFirst .ConfigEntity< ...

  2. [LINQ2Dapper]最完整Dapper To Linq框架(三)---实体类关系映射

    此特性需要安装Kogel.Dapper.Mssql或者Oracle 3.06及以上版本,实体类层需要安装Kogel.Dapper.Extension 3.06及以上版本 目录 [LINQ2Dapper ...

  3. php开发面试题---php面向对象详解(对象的主要三个特性)

    php开发面试题---php面向对象详解(对象的主要三个特性) 一.总结 一句话总结: 对象的行为:可以对 对象施加那些操作,开灯,关灯就是行为. 对象的形态:当施加那些方法是对象如何响应,颜色,尺寸 ...

  4. 黑马程序员——OC基础 三种特性之封装

    Java培训.Android培训.iOS培训..Net培训.期待与您交流! (以下内容是对黑马苹果入学视频的个人知识点总结) 三种特性之一封装 (一)set方法和get方法 1)  set方法 1&g ...

  5. java多线程中的三种特性

    java多线程中的三种特性 原子性(Atomicity) 原子性是指在一个操作中就是cpu不可以在中途暂停然后再调度,既不被中断操作,要不执行完成,要不就不执行. 如果一个操作时原子性的,那么多线程并 ...

  6. 分布式CAP定理,为什么不能同时满足三个特性?

    在弄清楚这个问题之前,我们先了解一下什么是分布式的CAP定理. 根据百度百科的定义,CAP定理又称CAP原则,指的是在一个分布式系统中,Consistency(一致性). Availability(可 ...

  7. C#面向对象的编程语言具三个特性

    C#面向对象的编程语言具三个特性:有封装性.继承性.多态性 .

  8. Entity Framework 第三篇 实体特性声明

    Entity Framework中对实体的特性声明有着严格的要求 1.实体必须要有主键特性,但是如果实体没有主键特性那怎么办? public int ExecuteSqlCommand(string ...

  9. c#学习<三>:特性

    特性(Attribute) 用于在运行时传递程序中各种元素(比如类.方法.结构.枚举.组件等)的行为信息的声明性标签.您可以通过使用特性向程序添加声明性信息.一个声明性标签是通过放置在它所应用的元素前 ...

随机推荐

  1. Ubuntu 16.04 安装 SVN-Client (RaabitVCS)

    1.添加源 sudo add-apt-repository ppa:rabbitvcs/ppa 2. 更新源 sudo apt-get update 3.安装依赖库 sudo apt-get inst ...

  2. 前端模板引擎doT.js的用法

    简介 一款简单好用的前端模板引擎 用法 <script type="text/javascript" src="js/doT.min.js">< ...

  3. js五子棋游戏代码分享

    HTML代码 <canvas id="game"></canvas> CSS代码 * { margin: 0; padding: 0; } #game { ...

  4. Tomcat源码分析 (七)----- Tomcat 启动过程(二)

    在上一篇文章中,我们分析了tomcat的初始化过程,是由Bootstrap反射调用Catalina的load方法完成tomcat的初始化,包括server.xml的解析.实例化各大组件.初始化组件等逻 ...

  5. 在使用Lists.transform时,不会直接生成PurchaseOrderVo的集合对象,而是生成一个Function的集合

    但是在使用Lists.transform时,不会直接生成PurchaseOrderVo的集合对象,而是生成一个Function的集合,在循环的时候,会去调用apply 生成一个PurchaseOrde ...

  6. Python机器学习之数据探索可视化库yellowbrick-tutorial

    背景介绍 从学sklearn时,除了算法的坎要过,还得学习matplotlib可视化,对我的实践应用而言,可视化更重要一些,然而matplotlib的易用性和美观性确实不敢恭维.陆续使用过plotly ...

  7. 查看centos中的用户和用户组和修改密码

    查看centos中的用户和用户组 1.用户列表文件: vim /etc/passwd/ 2.用户组列表文件: vim /etc/group 3.查看系统中有哪些用户: cut -d : -f /etc ...

  8. Visual Studio 2015&2017 key

    Visual Studio 2015 key Key : HMGNV-WCYXV-X7G9W-YCX63-B98R2 Visual Studio Enterprise 2015 Key :HM6NR- ...

  9. @WebInitParam注解

    Servlet注解——@WebInitParam多个InitParam的写法 使用@WebInitParam配置多个InitParam,使某些页面不被拦截.在过滤器Filter.java下添加注解:@ ...

  10. Unity打包——Android和IOS

    推荐阅读:  我的CSDN  我的博客园  QQ群:704621321  我的个人博客 Android包 (1)首先需要安装Android SDK和Java JDK.SDK需要添加tools目录,JD ...