阅读 672

[TypeORM]官方示例详解-Vol.1 创建数据库连接和第一个实体映射类

前言

本系列将对TypeORM中官方提供的33个示例逐一进行说明讲解。 本期是第一期,官方示例地址https://github.com/typeorm/typeorm/tree/master/sample/sample1-simple-entity。 本期主要用于演示如何编写一个数据库连接和如何利用TypeORM的注解(装饰器)编写数据库表的实体映射。

一、 创建数据库连接

利用TypeORM创建一个数据库连接十分容易,只需要使用createConnections函数并传入必要的连接配置的参数便可以对数据库进行连接和操作。

export async function createConnections(options?: ConnectionOptions[]): Promise<Connection[]>
复制代码

官方示例中使用了MySQL数据库的连接配置:

const options: ConnectionOptions = {
    "name": "mysql",
    "type": "mysql",
    "host": "localhost",
    "port": 3306,
    "username": "test",
    "password": "test",
    "database": "test",
    synchronize: true,
    entities: [Post]
};
复制代码

其中name,type,host,port,passowrd,database参数基本上是现在所有数据库配置都有的,比较特殊的是synchronizeentities这两个参数。

synchronize与migration

在解释说明synchronize,我们先引入一个概念叫Migration即迁移。在数据库的实体映射发生变化的时候,TypeORM会根据变化对现有的视图Schema进行修改、增加、删除调整至当前实体映射所期望的样子。我们可以把每个数据库视图之间的变化称为Migration。 而synchronize 则标识了是否需要在每次应用启动后自动对数据库的视图Schema进行自动的Migration。通常这个开关在我们开发的时候都是默认打开的,但是在生产环境推荐关闭,免得某一个实体定义写错,直接就把一些表给删除了。

entities

entities则表明要引入的实体文件,一般来说更推荐大家使用路径的形式进行引入,一个一个引入实在会手疼……

    __dirname + '/entity/*.{ts,js}',
复制代码

这里有一个很大的坑,便是如果通过路径文件引入一定记得后缀要同时写上js和ts两个后缀格式,因为ts在编译后会变成js文件,但是数据库连接启动读取的部分并不会变化从而会导致读不到编译后的js文件导致错误。

创建连接

了解了主要的配置文件参数后,我们便可调用createConnection(options)进行数据库连接十分简单。

createConnection(options)
    .then(async connection => {
        // 成功连接后通过connection变量操作数据库
    }, error => console.log("Cannot connect: ", error));
复制代码

二、 实体映射类定义

官方示例中给出了一个Post即我们常见的博客发帖的帖子的类定义。 我们通过TypeORM的实体Entity去映射数据库中的对应的表Table。 首先我们来看下Post Entity的代码。

@Entity("sample01_post")
export class Post {

    @PrimaryColumn("integer")
    @Generated()
    id: number;

    @Column()
    title: string;

    @Column()
    text: string;

    @Column({ nullable: false })
    likesCount: number;

}
复制代码

首先,我们说下最重要的装饰器@Entity,一个class如果被@Entity装饰了,则表示这个class是一个实体类,如果我们在数据库连接的时候正确的将它放入了entitis数组中那么TypeORM便会将其纳入实体管理中。 @Entity()如果我们不指定表命,一般这种无参形式就可以了,TypeORM会自动将类名变为小写加下划线形式创建表名。不如这个例子中的Post便会变为改名post创建一个表。

其次,每一个类的属性上的注解@Column(),则是用于标注这个属性需要被吃持久化为一个表中的列,其无参情况下命名方式与@Entity()是一样的。

最后,说一下@PrimaryColumn("integer"),@Generated(),这两个主键上的注解。@PrimaryColumn("integer")是表示id这一列是主键列且主键的类型是整形,这边在装饰器中的类型通常使用的是数据库类型,而映射成ts的属性id类型则是number。@Generated()则表示列是一个主键的创建策略。下面我简单的介绍下TypeORM中关于主键创建策略的说明。

@Generated的主键创建策略

TypeORM中提供的主键创建策略主要有几种:

  • increment:自增,一般默认都使用这个
  • uuid: string类型的uuid,类似Oracle没有自增便需要使用其他策略了
  • rowid: number类型的rowid

当我们完成了Post实体的定义,并且在应用启动时、创建数据库连接时并正确的将Post的加载到TypeORM的配置中去后,在应用启动时,系统便会自动创建一个名为sample01_post表。

三、通过connection创建一条记录

首先让我们回顾下,创建连接后的Promise如果进行操作。

createConnection(options)
    .then(async connection => {
        // 成功连接后通过connection变量操作数据库
    }, error => console.log("Cannot connect: ", error));
复制代码

可以在then方法内获取连接成功后的connection变量,并进行操作。 我们尝试像数据库中新增一个Post记录。 跟其他语言的ORM一样,我们并不直接通过INSERT语句去操作数据库,而是创建一个实体类,并对其进行保存操作。 首先,我们通过代码创建一个Post对象。

    let post = new Post();
    post.text = "Hello how are you?";
    post.title = "hello";
    post.likesCount = 100;
复制代码

接着,我们通过通过数据库连接获取Repository仓库类,可能有些同学对Repository比较陌生,其实Repository可以简单理解成我们操作Entity使用的工具类,类似DAO层。

    let postRepository = connection.getRepository(Post);
复制代码

最后,最后我们通过Repositorysave方法保存刚刚创建的Post对象。

    postRepository
        .save(post)
        .then(post => console.log("Post has been saved: ", post))
        .catch(error => console.log("Cannot save. Error: ", error));
复制代码

完成的代码如下:

createConnection(options).then(async connection => {
    let post = new Post();
    post.text = "Hello how are you?";
    post.title = "hello";
    post.likesCount = 100;

    let postRepository = connection.getRepository(Post);

    postRepository
        .save(post)
        .then(post => console.log("Post has been saved: ", post))
        .catch(error => console.log("Cannot save. Error: ", error));

}, error => console.log("Cannot connect: ", error));
复制代码

这样我们便完成了第一个基于TypeORM的数据库操作的编码工作。通过TyepORM可以避免了通过编写SQL语句模板操作数据库的工作,大大提高了编码效率。