神光《Nest 通关秘籍》学习总结-快速上手TypeORM

0570

最近在学习神光大神的《Nest通关秘籍》，该小册主要包含下面这些内容：

image.png

接下来的日子里，我将更新一系列的学习笔记。感兴趣的可以关注我的专栏《Nest 通关秘籍》学习总结。

特别申明：本系列文章已经经过作者本人的允许。
大家也不要想着白嫖，我的笔记只是个人边学习边记录的，不是很完整，大家想要深入学习还是要自己去购买原版小册，购买链接点击《传送门》。

本章我们来学习一下TypeORM。

1. 创建项目

新建项目

npx typeorm@latest init --name typeorm-all-feature --database mysql

该命令可以创建一个基础的typeorm示例。

2. 配置项

然后改下用户名密码数据库，把连接 msyql 的驱动包改为 mysql2，并修改加密密码的方式：

import "reflect-metadata"

import { DataSource } from "typeorm"

import { User } from "./entity/User"






export const AppDataSource = new DataSource({
    type: "mysql",
    host: "localhost",
    port: 3306,
    username: "root",
    password: "xxxxxx",
    database: "practice",
    synchronize: true,
    logging: false,
    entities: [User],
    migrations: [],
    subscribers: [],
    poolSize: 10,
    connectorPackage: 'mysql2',
    extra: {
        authPlugin: 'sha256_password',
    }
})

注意：需要提前创建好一个数据库practice

安装 mysql2:

npm install --save mysql2

上面的配置我们来简单解释一下：

  1. type 是数据库的类型，typeorm还支持 postgres、oracle、sqllite 。
  2. host、port 是指定数据库服务器的主机和端口号。
  3. user、password 是登录数据库的用户名和密码。
  4. database 是要指定操作的 database，因为 mysql 是可以有多个 database 或者叫 schema 的。
  5. synchronize 是根据同步建表，也就是当 database 里没有和 Entity 对应的表的时候，会自动生成建表 sql 语句并执行。
  6. logging 是打印生成的 sql 语句。
  7. entities 是指定有哪些和数据库的表对应的 Entity。
  8. migrations 是修改表结构之类的 sql。
  9. subscribers 是一些 Entity 生命周期的订阅者，比如 insert、update、remove 前后，可以加入一些逻辑
  10. poolSize 是指定数据库连接池中连接的最大数量。
  11. connectorPackage 是指定用什么驱动包。
  12. extra 是额外发送给驱动包的一些选项。

以上这些配置都在data-source.ts里面。

DataSource 会根据你传入的连接配置、驱动包，来创建数据库连接，并且如果制定了 synchronize 的话，会同步创建表。

而创建表的依据就是 Entity：

//  src/entity/User.ts
import { Entity, PrimaryGeneratedColumn, Column } from "typeorm"










@Entity()
export class User {


  @PrimaryGeneratedColumn()
  id: number


  @Column()
  firstName: string



  @Column()
  lastName: string

  @Column()
  age: number


}

当执行npm run start的时候，就会自动创建一个user表，并且生成表字段。

刷新一下数据库，就可以看到生成的user表了。

3. 映射关系

在我们上面创建的数据库中，主键为 INT 自增、firstName 和 lastName 是 VARCHAR(255)，age 是 INT。这是默认的映射关系。

那如果我 number 不是想映射到 INT 而是 DOUBLE 呢？

或者如果 string 不是想映射到 VARCHAR(255)，而是 TEXT （长文本）呢？

我们就可以使用下面的方式来写了：

import { Entity, PrimaryGeneratedColumn, Column } from "typeorm"



@Entity({
    name: 't_aaa'
})
export class Aaa {



    @PrimaryGeneratedColumn({
        comment: '这是 id'
    })
    id: number



    @Column({
        name: 'a_aa',
        type: 'text',
        comment: '这是 aaa'
    })
    aaa: string


    @Column({
        unique: true,
        nullable: false,
        length: 10,
        type: 'varchar',
        default: 'bbb'
    })
    bbb: string

    @Column({
        type: 'double',
    })
    ccc: number
}

我们新增了一个 Entity Aaa。

@Entity 指定它是一个 Entity，name 指定表名为 t_aaa。

@PrimaryGeneratedColumn 指定它是一个自增的主键，通过 comment 指定注释。

@Column 映射属性和字段的对应关系。

通过 name 指定字段名，type 指定映射的类型，length 指定长度，default 指定默认值。

nullable 设置 NOT NULL 约束，unique 设置 UNIQUE 唯一索引。

type 这里指定的都是数据库里的数据类型。

然后在 DataSource 的 entities 里引入下：

import "reflect-metadata"

import { DataSource } from "typeorm"

import { User } from "./entity/User"






import { Aaa } from "./entity/Aaa"
export const AppDataSource = new DataSource({
    type: "mysql",
    host: "localhost",
    port: 3306,
    username: "root",
    password: "xxxxxx",
    database: "practice",
    synchronize: true,
    logging: false,
    entities: [User, Aaa],
    migrations: [],
    subscribers: [],
    poolSize: 10,
    connectorPackage: 'mysql2',
    extra: {
        authPlugin: 'sha256_password',
    }
})

重新跑 npm run start。

又生成了一个t_aaa的表：

看一下它的表字段：

表有了，接下来就是对表的增删改查操作。

4. 增删改查

我们来看看src/index.ts文件中：

import { AppDataSource } from "./data-source"





import { User } from "./entity/User"














AppDataSource.initialize().then(async () => {










    console.log("Inserting a new user into the database...")
    const user = new User()
    user.firstName = "Timber"
    user.lastName = "Saw"
    user.age = 24
    await AppDataSource.manager.save(user, )
    console.log("Saved a new user with id: " + user.id)


    console.log("Loading users from the database...")
    const users = await AppDataSource.manager.find(User)
    console.log("Loaded users: ", users)

    console.log("Here you can setup and run express / fastify / any other framework.")


}).catch(error => console.log(error))

4.1. 添加/修改

使用AppDataSource.manager.save来操作数据。我们在前面测试的时候，user表中已经被添加了数据了。就是在这里添加的。

如果指定了 id，就会变成修改操作：

import { AppDataSource } from "./data-source"
import { User } from "./entity/User"










AppDataSource.initialize().then(async () => {






    const user = new User()
    user.id = 1;
    user.firstName = "aaa111"
    user.lastName = "bbb"
    user.age = 25



    await AppDataSource.manager.save(user)


}).catch(error => console.log(error))

我们修改id=1的数据，重新npm run start,可以看到id=1的数据被修改了：

那如果想批量插入和修改呢？可以这样写：

import { AppDataSource } from "./data-source"


import { User } from "./entity/User"












AppDataSource.initialize().then(async () => {







    await AppDataSource.manager.save(User, [

        { firstName: 'ccc', lastName: 'ccc', age: 21},
        { firstName: 'ddd', lastName: 'ddd', age: 22},
        { firstName: 'eee', lastName: 'eee', age: 23}
    ]);







}).catch(error => console.log(error))

批量修改是这样写：

import { AppDataSource } from "./data-source"


import { User } from "./entity/User"












AppDataSource.initialize().then(async () => {







    await AppDataSource.manager.save(User, [

        { id: 2 ,firstName: 'ccc111', lastName: 'ccc', age: 21},
        { id: 3 ,firstName: 'ddd222', lastName: 'ddd', age: 22},
        { id: 4, firstName: 'eee333', lastName: 'eee', age: 23}
    ]);




}).catch(error => console.log(error))

这就是 typeorm 里新增和修改的方式，使用 save 方法。

其实 EntityManager 还有 update 和 insert 方法，分别是修改和插入的，但是它们不会先查询一次。而 save 方法会先查询一次数据库来确定是插入还是修改。

4.2. 删除

删除和批量删除用 delete 方法：

import { AppDataSource } from "./data-source"





import { User } from "./entity/User"














AppDataSource.initialize().then(async () => {










    await AppDataSource.manager.delete(User, 1);
    await AppDataSource.manager.delete(User, [2,3]);


}).catch(error => console.log(error))

这里也可以用 remove 方法：

import { AppDataSource } from "./data-source"





import { User } from "./entity/User"














AppDataSource.initialize().then(async () => {










    const user = new User();
    user.id = 1;


    await AppDataSource.manager.remove(User, user);

}).catch(error => console.log(error))

delete 和 remove 的区别是，delete 直接传 id、而 remove 则是传入 entity 对象。

4.3. 查询

使用 find 方法查询：

const users = await AppDataSource.manager.find(User)

使用 findBy方法条件查询：

const users = await AppDataSource.manager.findBy(User, {
    id: 6
});

使用 findAndCount 来拿到有多少条记录：

const { count } = await AppDataSource.manager.findAndCount(User)

findAndCountBy可以传入指定条件:

const users = await AppDataSource.manager.findAndCountBy(User, { "age": 23})

使用 findOne 查询一条：

import { AppDataSource } from "./data-source"


import { User } from "./entity/User"












AppDataSource.initialize().then(async () => {
    const user = await await AppDataSource.manager.findOne(User, {
        select: {
            firstName: true,
            age: true
        },
        where: {
            id: 4
        },
        order: {
            age: 'ASC'
        }
    });
    console.log(user);


}).catch(error => console.log(error))

findOne 只是比 find 多加了个 LIMIT 1，其余的都一样：

import { In } from "typeorm";
import { AppDataSource } from "./data-source"
import { User } from "./entity/User"






AppDataSource.initialize().then(async () => {


    const users = await await AppDataSource.manager.find(User, {
        select: {
            firstName: true,
            age: true
        },
        where: {
            id: In([4, 8])
        },
        order: {
            age: 'ASC'
        }
    });
    console.log(users);

}).catch(error => console.log(error))

通过 findOneBy 也可以查询：

import { AppDataSource } from "./data-source"





import { User } from "./entity/User"














AppDataSource.initialize().then(async () => {




    const user = await AppDataSource.manager.findOneBy(User, {
        age: 23
    });
    console.log(user);


}).catch(error => console.log(error))

此外，findOne 还有两个特殊的方法：

import { AppDataSource } from "./data-source"





import { User } from "./entity/User"














AppDataSource.initialize().then(async () => {




    try {
        const user = await AppDataSource.manager.findOneOrFail(User, {
            where: {
                id: 666
            }
        });
        console.log(user);
    }catch(e) {
        console.log(e);
        console.log('没找到该用户');
    }

}).catch(error => console.log(error))

findOneOrFail 或者 findOneByOrFail，如果没找到，会抛一个 EntityNotFoundError 的异常。

此外，你还可以用 query 方法直接执行 sql 语句：

import { AppDataSource } from "./data-source"








AppDataSource.initialize().then(async () => {




    const users = await AppDataSource.manager.query('select * from user where age in(?, ?)', [21, 22]);
    console.log(users);



}).catch(error => console.log(error))

但复杂 sql 语句不会直接写，而是会用 query builder：

const queryBuilder = await AppDataSource.manager.createQueryBuilder();



const user = await queryBuilder.select("user")
    .from(User, "user")
    .where("user.age = :age", { age: 21 })
    .getOne();



console.log(user);

使用 query builder，我们可以做一些复杂的联表查询：

我们现在调用每个方法的时候都要先传入实体类，比较麻烦，我们先调用 getRepository 传入 Entity，拿到专门处理这个 Entity 的增删改查的类，再调用这些方法：

© 版权声明
文章版权归作者所有，未经允许请勿转载，侵权请联系 admin@trc20.tw 删除。
THE END
后端
# MySQL# NestJS
喜欢就支持一下吧
点赞0

Warning: mysqli_query(): (HY000/3): Error writing file '/tmp/MYzHCez1' (Errcode: 28 - No space left on device) in /www/wwwroot/583.cn/wp-includes/class-wpdb.php on line 2345
admin的头像-五八三
相关推荐
Nest JS配置最佳实践-五八三
Nest JS配置最佳实践
Nest JS配置最佳实践
2年前 269
MybatisPlus方法详细使用，实现无SQL式开发-五八三
MybatisPlus方法详细使用，实现无SQL式开发
MybatisPlus方法详细使用，实现无SQL式开发
3年前 116
MCSM面板一键搭建我的世界服务器 – 外网远程联机【内网穿透工具】-五八三
MCSM面板一键搭建我的世界服务器 – 外网远程联机【内网穿透工具】
MCSM面板一键搭建我的世界服务器 – 外网远程联机【内网穿透工具】
2年前 108
JVM 参数：`-D`、`-X`、`-XX`，傻傻分不清？-五八三
JVM 参数：`-D`、`-X`、`-XX`，傻傻分不清？
JVM 参数：`-D`、`-X`、`-XX`，傻傻分不清？
2年前 92
我的世界(MC) Forge 1.20.1 服务端搭建教程，MCSM安装和使用教程-五八三
我的世界(MC) Forge 1.20.1 服务端搭建教程，MCSM安装和使用教程
我的世界(MC) Forge 1.20.1 服务端搭建教程，MCSM安装和使用教程
2年前 89
Error系列-CVE CIS-2023系统漏洞处理方案集合-五八三
Error系列-CVE CIS-2023系统漏洞处理方案集合
Error系列-CVE CIS-2023系统漏洞处理方案集合
2年前 85
评论 抢沙发
头像
欢迎您留下宝贵的见解！
提交
头像

昵称

图形验证码
取消
昵称

请填写用户信息：

  • 昵称(必填)
  • 邮箱(必填)
代码

请输入代码：

确认
图片
热门推荐