MySQL2 与 TypeScript 类型化开发实践指南-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00638/article/details/148548609

MySQL2 与 TypeScript 类型化开发实践指南

node-mysql2 :zap: fast mysqljs/mysql compatible mysql driver for node.js 项目地址: https://gitcode.com/gh_mirrors/no/node-mysql2

MySQL2 是一个高性能的 Node.js MySQL 客户端库，当它与 TypeScript 结合使用时，可以充分发挥类型系统的优势，提高代码的健壮性和开发体验。本文将详细介绍如何在 TypeScript 项目中使用 MySQL2 进行类型安全的数据库操作。

环境准备

首先需要安装必要的依赖：

npm install --save mysql2
npm install --save-dev @types/node

@types/node 包确保了 TypeScript 能够正确识别 Node.js 核心模块（如 net、events、stream 等）的类型定义。

:::tip 版本要求 MySQL2 要求 TypeScript 版本 >=4.5.2 :::

基础使用方式

MySQL2 提供了两种导入方式，取决于你的 tsconfig.json 中 esModuleInterop 的配置：

当 esModuleInterop 为 true 时：

import mysql from 'mysql2';
import mysql from 'mysql2/promise';

当 esModuleInterop 为 false 时：

import * as mysql from 'mysql2';
import * as mysql from 'mysql2/promise';

连接数据库

创建单一连接

import mysql, { ConnectionOptions } from 'mysql2';

const config: ConnectionOptions = {
  host: 'localhost',
  user: 'root',
  password: 'password',
  database: 'test_db'
};

const connection = mysql.createConnection(config);

创建连接池

对于高并发应用，使用连接池是更好的选择：

import mysql, { PoolOptions } from 'mysql2';

const poolConfig: PoolOptions = {
  host: 'localhost',
  user: 'root',
  password: 'password',
  database: 'test_db',
  waitForConnections: true,
  connectionLimit: 10,
  queueLimit: 0
};

const pool = mysql.createPool(poolConfig);

执行查询

MySQL2 提供了 query 和 execute 两种方法执行 SQL 语句：

// 使用 query 方法
connection.query('SELECT * FROM users WHERE id = ?', [1], (err, results) => {
  // 处理结果
});

// 使用 execute 方法（推荐用于参数化查询）
connection.execute('SELECT * FROM users WHERE id = ?', [1], (err, results) => {
  // 处理结果
});

类型系统详解

MySQL2 为 TypeScript 提供了丰富的类型定义，让我们可以精确地描述查询结果的类型。

RowDataPacket

RowDataPacket 是 SELECT 查询返回的基本类型：

interface User extends mysql.RowDataPacket {
  id: number;
  name: string;
  email: string;
}

connection.query<User[]>('SELECT * FROM users', (err, results) => {
  // results 是 User[] 类型
  console.log(results[0].name); // 类型安全
});

数组形式的结果

通过设置 rowsAsArray: true，可以让结果以数组形式返回：

connection.query<mysql.RowDataPacket[]>(
  'SELECT id, name FROM users',
  { rowsAsArray: true },
  (err, results) => {
    // results 是 any[][] 类型
    console.log(results[0][0]); // 第一个字段的值
  }
);

多语句查询

启用 multipleStatements: true 可以执行多个 SQL 语句：

connection.query<mysql.RowDataPacket[][]>(
  'SELECT * FROM users; SELECT * FROM products',
  (err, results) => {
    // results 是 [User[], Product[]] 类型
    const [users, products] = results;
  }
);

操作结果类型

对于 INSERT、UPDATE、DELETE 等操作，结果类型为 ResultSetHeader：

connection.query<mysql.ResultSetHeader>(
  'UPDATE users SET name = ? WHERE id = ?',
  ['新名字', 1],
  (err, result) => {
    console.log(result.affectedRows); // 受影响的行数
    console.log(result.insertId); // 插入的ID（仅INSERT）
  }
);

存储过程调用

调用存储过程会返回 ProcedureCallPacket 类型：

connection.query<mysql.ProcedureCallPacket<mysql.RowDataPacket[]>>(
  'CALL get_user_data(?)',
  [1],
  (err, results) => {
    // 处理存储过程返回的结果集
  }
);