Node 操作 MySQL 的两种方式

前面我们学习了 MySQL 的数据库、表、增删改查等，目的还是在 Node 应用里操作它。

这节我们就来学习下用 mysql2 和 typeorm 两种方式来操作 MysSQL 数据库。

# 先来看下 mysql2:

它是用的最多的连接 mysql 的 npm 包，是 mysql 包的升级版，有更多特性。

我们创建个目录，然后进入这个目录执行 npm init -y 创建 package.json。

然后安装 mysql2

npm install --save mysql2

# 连接数据库

添加这样一个 index.js：

const mysql = require("mysql2");

const connection = mysql.createConnection({
  host: "localhost",
  port: 3306,
  user: "root",
  password: "guang",
  database: "practice",
});

connection.query("SELECT * FROM customers", function (err, results, fields) {
  console.log(results);
  console.log(fields.map((item) => item.name));
});

1
2
3
4
5
6
7
8
9
10
11
12
13
14

连接 mysql server，指定用户名、密码、要操作的数据库（这里要改成你自己的 mysql 连接密码）。

然后通过 query 方法跑一个查询 sql。

results 是结果，fields 是一些元信息，比如字段名这些。

node 执行下：

和我们在 mysql workbench 里执行效果一样。

查询也可以指定占位符：

connection.query(
  "SELECT * FROM customers WHERE name LIKE ?",
  ["李%"],
  function (err, results, fields) {
    console.log(results);
    console.log(fields.map((item) => item.name));
  }
);

1
2
3
4
5
6
7
8

# 我们查询了姓李的顾客有哪些：

当然，增删改也是可以的。

# 比如我们插入一条数据：

connection.execute('INSERT INTO customers (name) VALUES (?)',
    ['光'], (err, results, fields) => {
    console.log(err);
});

1
2
3
4

在 mysql workbench 里可以看到，确实插入了：

再来试下修改。

connection.execute('UPDATE customers SET name="guang" where name="光"', (err) => {
  console.log(err);
});

1
2
3

# 把刚才插入的记录改个名字。

node 跑一下：

点下刷新，可以看到确实修改了：

# 再试试删除：

connection.execute("DELETE  FROM customers where name=?", ["guang"], (err) => {
  console.log(err);
});

1
2
3

执行后数据库中这条记录也删除了：

这就是用 mysql2 做增删改查的方式。

是不是还挺简单的，就和我们在 mysql workbench 里写 sql 差不多。

# 当然，这些 api 也都有 promise 版本。

这样写：

const mysql = require('mysql2/promise');

(async function() {

    const connection = await mysql.createConnection({
        host: 'localhost',
        port: 3306,
        user: 'root',
        password: 'guang',
        database: 'practice'
    });

    const [results, fields] = await connection.query('SELECT * FROM customers');

    console.log(results);
    console.log(fields.map(item => item.name));

})();

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

结果一样：

这是最基本的使用：需要操作数据库的时候，建立连接，用完之后释放连接。

但这样性能并不高。

因为数据库的连接建立还是很耗时的，而且一个连接也不够用。

# 我们一般都是用连接池来管理：

连接池中放着好几个 mysql 的连接对象，用的时候取出来执行 sql，用完之后放回去，不需要断开连接。

mysql2 自然也封装了连接池的功能。

这样用：

const mysql = require("mysql2/promise");

const pool = mysql.createPool({
  host: "localhost",
  user: "root",
  password: "123456",
  database: "study",
  waitForConnections: true,
  connectionLimit: 10,
  maxIdle: 10,
  idleTimeout: 60000,
  queueLimit: 0,
  enableKeepAlive: true,
  keepAliveInitialDelay: 0,
});

async function query(sql) {
  try {
    const [results] = await pool.promise().query(sql);
    console.dir(results, { depth: null });
  } catch (err) {
    console.error(err);
  }
}

query("SELECT * FROM courses");

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

只要把 createConnection 换成 createPool 就好了。query 或者 execute 的时候会自动从 pool 中取 connection 来用，用完会放回去。

或者你也可以手动取：

async function query(sql) {
  pool.getConnection((err, connection) => {
    connection.query(sql, (err, result) => {
      console.log(result);
      //    当不再使用时，归还到连接池中
      connection.release();
    });
  });
}

query("SELECT * FROM courses");

1
2
3
4
5
6
7
8
9
10
11

回过头来再看看这些 option：

connectionLimit 是指定最多有多少个连接，比如 10 个，那就是只能同时用 10 个，再多需要排队等。

maxIdle 是指定最多有多少个空闲的，超过这个数量的空闲连接会被释放。

waitForConnections 是指如果现在没有可用连接了，那就等待，设置为 false 就是直接返回报错。

idleTimeout 是指空闲的连接多久会断开。

queueLimit 是可以排队的请求数量，超过这个数量就直接返回报错说没有连接了。设置为 0 就是排队没有上限。

enableKeepAlive、keepAliveInitialDelay 是保持心跳用的，用默认的就好。

这就是 mysql2 的用法，是不是还会挺简单的？

只要建立个连接或者连接池，就可以在 node 里执行 sql 了。

但是我们一般不会直接这样执行 sql，而是会用 ORM 框架。

# ORM 框架

ORM 是 Object Relational Mapping，对象关系映射。也就是说把关系型数据库的表映射成面向对象的 class，表的字段映射成对象的属性映射，表与表的关联映射成属性的关联。

其实这个想法也很自然，比如我们前面执行的这些 sql：

返回的不就是 js 对象么。

那不如直接操作这个对象，让 ORM 框架自动执行 sql 去同步数据库。

TypeORM 就是一个流行的 ORM 框架。

# 初始化 typeorm

我们来试一下：

npm install typeorm -g
npx typeorm init

1
2

此命令将在MyProject目录中生成一个包含以下文件的新项目:

MyProject
├── src              // TypeScript 代码
│   ├── entity       // 存储实体（数据库模型）的位置
│   │   └── User.ts  // 示例 entity
│   ├── migration    // 存储迁移的目录
│   └── index.ts     // 程序执行主文件
├── .gitignore       // gitignore文件
├── ormconfig.json   // ORM和数据库连接配置
├── package.json     // node module 依赖
├── README.md        // 简单的 readme 文件
└── tsconfig.json    // TypeScript 编译选项

1
2
3
4
5
6
7
8
9
10
11

修改下 data-source.ts

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: "guang",
  database: "practice",
  synchronize: true,
  entities: [User],
  migrations: [],
  subscribers: [],
  connectorPackage: "mysql2",
  extra: {
    authPlugin: "sha256_password",
  },
});