Facebook 开源 Golang 实体框架 Ent

Posted GoCN

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Facebook 开源 Golang 实体框架 Ent相关的知识,希望对你有一定的参考价值。

对于后端开发者来说,一款好用的框架能够大大提升应用的开发效率。为了降低开发者使用 TiDB 的门槛,方便开发者快速连接到 TiDB,我们也在和合作伙伴一起,逐步完善面向主流开发语言和框架的连接支持


近日,Facebook 开源的 Golang 实体框架 Ent 完成了对 TiDB 数据库的支持。
Ent 是一款易于构建和维护应用程序与大数据模型的框架。具有以下特点:
· Schema 即代码:能将任何数据库表建模为 Go 对象;
· 轻松地遍历任何图形 :可以轻松地运行查询、聚合和遍历任何图形结构;
· 静态类型和显式 API:使用代码生成静态类型和显式 API,查询数据更加便捷;
· 多存储驱动程序:支持 mysql、PostgreSQL、SQLite、Gremlin,现在也已经支持了 TiDB
· 可扩展:易于扩展和使用 Go 模板自定义。

下面通过一个 Hello World 的应用示例,来看下如何快速实现一个基于 Ent + TiDB 的应用

Hello World 应用示例

1. 用 Docker 在本地启动一个 TiDB Server
docker run -p 4000:4000 pingcap/tidb
现在你应该有一个运行的 TiDB 实例,开放了 4000 端口监听。

2. 在本地拷贝 hello world 的示例 repo
git clone https://github.com/hedwigz/tidb-hello-world.git

在这个示例 repo 中我们定义了一个简单的 User schema
go title="ent/schema/user.go"
 func (User) Fields() []ent.Field 
           return []ent.Field
                  field.Time("created_at").
                          Default(time.Now),
                  field.String("name"),
                  field.Int("age"),
          
 

然后,连接 Ent 和 TiDB:
go title="main.go"
client, err := ent.Open("mysql""root@tcp(localhost:4000)/test?parseTime=true")
if err != nil 
        log.Fatalf("failed opening connection to TiDB: %v", err)

defer client.Close()
// Run the auto migration tool, with Atlas.
if err := client.Schema.Create(context.Background(), schema.WithAtlas(true)); err != nil 
        log.Fatalf("failed printing schema changes: %v", err)


可以看到,在第一行我们通过一个 MySQL 语句去连接 TiDB Server,因为 TiDB 是兼容 MySQL 的,所以不需要其他特殊的 driver。
话虽如此,TiDB 和 MySQL 还是有很多不同,尤其是与 Schema 迁移相关的操作,比如 SQL 诊断和迁移规划。所以,Atlas 可以自动监测出是连接到 TiDB,做相应的迁移处理。
此外,第七行我们使用 schema.WithAtlas(true),表示 Ent 是使用“Atlas”作为迁移引擎。Atlas 是 Ent 刚刚发布的迁移引擎,得益于 Atlas 的最新设计,对新数据库的支持也变得前所未有的简单。

最后,我们新建一条 user 数据,并保存到 TiDB 中,以用于后需的数据读取和输出。
go title="main.go"
client.User.Create().
               SetAge(30).
               SetName("hedwigz").
               SaveX(context.Background())
user := client.User.Query().FirstX(context.Background())
fmt.Printf("the user: %s is %d years old\\n", user.Name, user.Age)

3. 运行这个示例程序:
$ go run main.go
the user: hedwigz is 30 years old

在这次快速演练中,我们成功实现了:
· 启动一个本地的 TiDB 实例;
· 连接 Ent 和 TiDB 数据库;
· 使用 Atlas 迁移 Ent Schema;
· 使用 Ent 从 TiDB 中插入和读取数据;

版本说明

目前,这个示例应用在 Ent v0.10 和 TiDB v5.4.0 中可以正常运行,Ent 也计划在未来继续拓展对 TiDB 的支持。如果你使用其他版本的 TiDB 或者需要帮助,欢迎加入 asktug.com 来交流。如果你也有项目希望与 TiDB 适配,欢迎来 GitHub 提交 issue
除了 Ent,TiDB 此前已经添加了对 GORM 和 go-sql-driver/mysql 的支持,详情可查看文档:https://docs.pingcap.com/appdev/dev

开源实体映射框架EmitMapper介绍

开源实体映射框架EmitMapper介绍

 

 

  • 综述
      EmitMapper是一个开源实体映射框架,地址:http://emitmapper.codeplex.com/
      EmitMapper映射效率比较高,接近硬编码。EmitMapper采用emit方式在运行时动态生成IL,而其他映射框架多是采用反射机制。此外EmitMapper最大限度地减少了拆箱装箱操作和映射过程中的额外的调用。
      EmitMapper支持.net的所有平台:Framework 3.5、Microsoft Silverlight 3、Mono。
 
      EmitMapper的使用非常简单,不需要指定任何的映射策略。系统会采用默认的映射配置器DefaultMapConfig完成映射操作。
 
 
 1     public class Sourse
2 {
3 public int A;
4 public decimal? B;
5 public string C;
6 public Inner D;
7 public string E;
8 }
9
10 public class Dest
11 {
12 public int? A;
13 public decimal B;
14 public DateTime C;
15 public Inner D;
16 public string F;
17 }
18
19 public class Inner
20 {
21 public long D1;
22 public Guid D2;
23 }
24
25 Sourse src = new Sourse
26 {
27 A = 1,
28 B = 0M,
29 C = "2011/9/21 0:00:00",
30 D = new Inner
31 {
32 D2 = Guid.NewGuid()
33 },
34 E = "test"
35 };
36
37 ObjectsMapper<Sourse, Dest> mapper =
38 ObjectMapperManager.DefaultInstance.GetMapper<Sourse, Dest>();
39 Dest dst = mapper.Map(src);
40
41 Assert.AreEqual<string>(dst.B.ToString(), src.B);
42 Assert.AreEqual<long>(dst.C.C1, 0L);
43 Assert.AreEqual<Guid>(dst.C.C2, src.C.C2);
44 Assert.IsNull(dst.E);
 
 
 
  • 默认映射配置器
      默认的映射配置器能自动转换以下几种类型:
任何类型到string类型使用ToString()方法;
可以使用System.Convert类转换的原始类型;
可空类型、枚举类型、各种集合类型、结构与类;
复杂的嵌套类型采用递归方式转换;
 
      如果默认的转换满足不了需求,默认的映射配置器还允许指定命名约定,自定义构造函数,自定义转换器,忽略成员等。
     

支持的方法

描述

ConvertUsing

为指定的成员提供自定义的转换逻辑

ConvertGeneric

为指定的泛型类型成员提供自定义的转换逻辑

ConstructBy

为目标对象使用指定的构造函数替代默认构造函数

NullSubstitution

当源对象中指定的成员在为null时,给目标对象的成员赋值

IgnoreMembers

忽略指定成员的映射

PostProcess

在映射完成后执行指定的方法

ShallowMap

指定的成员采用浅拷贝方式映射

DeepMap

指定的成员采用深拷贝方式映射

MatchMembers

如果成员名称的映射不采用精确匹配,可以指定具体的映射逻辑

 
      选择几个方法简单示例如下:
 
 
 1     public class Sourse
2 {
3 public int A;
4 public decimal? B;
5 public string C;
6 public Inner D;
7 public string E;
8 }
9
10 public class Dest
11 {
12 public int? A;
13 public decimal B;
14 public DateTime C;
15 public Inner2 D;
16 public string F;
17 }
18
19 public class Inner
20 {
21 public long D1;
22 public Guid D2;
23 }
24
25 public class Inner2
26 {
27 public long D12;
28 public Guid D22;
29 }
30
31 ObjectsMapper<Sourse, Dest> mapper1 =
32 new ObjectMapperManager().GetMapper<Sourse, Dest>(
33 new DefaultMapConfig()
34 .IgnoreMembers<Sourse, Dest>(new string[] { "A" })
35 .NullSubstitution<decimal?, decimal>((value) => -1M)
36 .ConvertUsing<Inner, Inner2>(value => new Inner2 { D12 = value.D1, D22 = value.D2 })
37 .PostProcess<Dest>((value, state) => { value.F = "nothing"; return value; })
38 );
39 Dest dst = mapper1.Map(src);
40
41 Assert.IsNull(dst.A);
42 Assert.AreEqual<decimal>(dst.B, -1M);
43 Assert.AreEqual<Guid>(dst.D.D22, src.D.D2);
44 Assert.AreEqual<string>(dst.F, "nothing");
 
  
 
  • 自定义映射配置器
      当然EmitMapper是个非常灵活的框架,也可以自定义映射配置器,实现定制的映射操作。
      自定义的映射配置器可以继承自DefaultMapConfig或CustomMapConfig,利用基类的一些功能实现定制的映射,也可以继承自接口ImappingConfigurator,完全从头实现。
 
      比如可以实现从HTTP中通过Post方式提交的Form数据到具体业务实体类的映射,下面通过继承ImappingConfigurator来实现。
 
自定义映射配置器
 
 
 
 
 
 

 

以上是关于Facebook 开源 Golang 实体框架 Ent的主要内容,如果未能解决你的问题,请参考以下文章

开源实体映射框架EmitMapper介绍

golang有没有好的开源游戏框架

golang 学习之grpc+ protobuf

才云正式开源其Golang API框架Nirvana

字节跳动开源的一个 Golang 微服务 HTTP 框架

Pythia:Facebook最新开源的视觉语言多任务学习框架