Node.js mysql2中传递connection对象至不同函数的方式是否正确？

示例代码 #

database.js #

// database.js
exports.connection = mysql2.createPool({
      host: process.env.DB_HOST,
      user: process.env.DB_USERNAME,
      password: process.env.DB_PASS,
      database: process.env.DB_NAME,
      supportBigNumbers: true,
      bigNumberStrings: true,
      dateStrings: true,
    });

users.js #

// users.js
const { connection } = require('./database.js');

async function createUsers(params) {
  const conn = await connection.getConnection();
  try {
    await conn.beginTransaction();
    const sql = "INSERT INTO users (name,pass) VALUES (?,?)";
    const [id] = await conn.query(sql, [params.user, params.pass]);

    // 我希望像这样将连接传递给任意函数
    await loginRoles(conn, { id: id.insertId, role: "user" });

    await conn.commit();
    return id.insertId;
  } catch (error) {
    await conn.rollback();
    return Promise.reject(error);
  } finally {
    conn.release();
  }
}
async function loginRoles(conn, params) {
  try {
    const sql = "INSERT INTO login (id, role) VALUES (?,?)";
    return conn.query(sql, [params.id, params.role]);
  } catch (error) {
    return Promise.reject(error);
  }
}

回答 #

这种将数据库连接作为参数传递给不同函数的方式完全正确，而且是事务场景下的标准最佳实践，理由如下：

• 保障事务原子性：所有操作基于同一个连接，处于同一事务上下文，要么全部提交，要么全部回滚，不会出现部分操作成功、部分失败的不一致状态。
• 合理管理连接资源：在入口函数createUsers中统一获取、释放连接，避免每个函数单独拿连接导致的资源浪费，也能确保事务结束后及时归还连接到连接池。
• 代码职责清晰：loginRoles只负责执行自身的SQL逻辑，不关心连接的生命周期，实现了逻辑解耦，后续维护和扩展更方便。

小优化建议 #

1. 简化loginRoles的错误处理：外层createUsers已经有try/catch捕获异常并回滚事务，loginRoles不需要单独捕获再抛出，直接让错误向上传递即可：

async function loginRoles(conn, params) {
  const sql = "INSERT INTO login (id, role) VALUES (?,?)";
  return conn.query(sql, [params.id, params.role]);
}

2. 可尝试依赖注入模式：如果后续需要测试，可以将连接作为依赖注入到模块中，方便用模拟连接替换真实连接，提升代码可测试性。

内容的提问来源于stack exchange，提问作者Ordinary Person