将SQLite数据映射到TypeScript对象：异步处理与类型安全实践

新闻中心 NEWS CENTER

您当前位置：首页 > 新闻中心 > 网络学院

将SQLite数据映射到TypeScript对象：异步处理与类型安全实践

2025-11-14

浏览次数：次

返回列表

将SQLite数据映射到TypeScript对象：异步处理与类型安全实践

在使用electron的`sqlite3`库时，将从sqlite数据库读取的原始行数据反序列化为强类型的typescript类是一个常见挑战。本文将详细介绍如何通过结合promise处理异步数据库操作、正确迭代查询结果以及利用typescript的类型断言，安全有效地将sqlite数据映射到预定义的typescript对象结构，从而提升代码的可读性和类型安全性。

1. 理解数据库操作的异步性

在使用Node.js环境下的数据库库（如sqlite3）时，一个核心概念是大多数数据库操作都是异步的。这意味着当你执行一个查询时，程序不会等待查询结果返回才继续执行后续代码。sqlite3库的all()方法尤其如此，它不直接返回查询结果，而是通过回调函数来提供结果。

原始代码中尝试直接从query.all()的返回值中获取数据并进行同步处理，这与sqlite3库的设计不符。query.all()方法实际上返回的是Statement对象本身，用于链式调用，而非查询结果。查询结果会在其提供的回调函数中返回。

2. 使用Promise封装异步操作

为了更好地管理异步操作并使其代码更具可读性和可维护性，推荐使用Promise来封装数据库操作。这样，调用者可以通过async/await语法来等待数据库操作完成并获取结果。

以下是如何将GetAllObjs函数改造为返回Promise的示例：

Tanka

具备AI长期记忆的下一代团队协作沟通工具

146 查看详情 Tanka

import * as sqlite3 from 'sqlite3'; // 假设 db 实例来自这里
// 假设 Obj 类已定义
interface Obj {
  id: number;
  name: string;
  amount: number;
}

// 示例数据库实例（实际应用中应妥善初始化）
const db = new sqlite3.Database(':memory:'); 

// 示例表创建函数（为演示目的，实际应用中可能在应用启动时执行）
export const CreateObjTable = (): Promise<sqlite3.RunResult> => {
  return new Promise((resolve, reject) => {
    db.run(`
      CREATE TABLE IF NOT EXISTS ObjTable
      (
        id INTEGER PRIMARY KEY AUTOINCREMENT,
        name TEXT,
        amount INTEGER
      )
    `, function(err) {
      if (err) {
        reject(err);
      } else {
        resolve(this); // 'this' 包含 lastID 和 changes
      }
    });
  });
};

// 示例数据插入（为演示目的）
export const InsertObj = (name: string, amount: number): Promise<sqlite3.RunResult> => {
  return new Promise((resolve, reject) => {
    db.run(`INSERT INTO ObjTable (name, amount) VALUES (?, ?)`, [name, amount], function(err) {
      if (err) {
        reject(err);
      } else {
        resolve(this);
      }
    });
  });
};

export const GetAllObjs = (): Promise<Obj[]> => {
    const query = db.prepare("SELECT * FROM ObjTable");

    return new Promise((resolve, reject) => {
        let objs: Obj[] = []; // 明确类型为 Obj[]

        // query.all() 方法接受一个回调函数，其中包含错误和行数据
        query.all((err, rows: any[]) => { // rows 参数的类型为 any[]
            if (err) {
                // 如果发生错误，拒绝Promise
                return reject(err);
            }

            // 正确地迭代数组元素
            for (const row of rows) { // 使用 for...of 迭代数组的元素
                objs.push(
                    {
                        // 直接通过属性名访问列值
                        id: row.id,
                        name: row.name,
                        amount: row.amount,
                    } as Obj // 使用类型断言确保对象的类型
                );
            }
            // 成功时，解决Promise并返回结果
            resolve(objs);
        });
    });
};

代码解析：

new Promise((resolve, reject) => { ... }): 创建一个新的Promise，它接受一个执行器函数，该函数有两个参数：resolve（当异步操作成功时调用）和reject（当异步操作失败时调用）。
query.all((err, rows: any[]) => { ... }): 这是sqlite3库提供的all()方法的标准回调签名。err参数用于捕获可能发生的数据库错误，rows参数则是一个包含所有查询结果行的数组。
错误处理: 在回调函数内部，首先检查err是否存在。如果存在，调用reject(err)来表示Promise失败。
for (const row of rows): 这是J*aScript/TypeScript中迭代数组元素的正确方式。与for...in（迭代对象的键或数组的索引）不同，for...of直接迭代数组的每个元素（即每一行数据对象）。
row.id, row.name, row.amount: sqlite3查询返回的行对象通常会将其列名作为属性。因此，可以直接通过row.columnName的方式访问每个列的值。
{} as Obj: 尽管TypeScript在运行时会被编译为J*aScript，但使用类型断言as Obj可以帮助TypeScript编译器在开发阶段进行类型检查，确保你创建的对象符合Obj接口的结构。
resolve(objs): 当所有行都被处理并映射到Obj数组后，调用resolve(objs)来完成Promise，并将objs数组作为其结果返回。

3. 示例用法

现在，你可以使用async/await语法来调用GetAllObjs函数，使其代码看起来更像同步代码：

// 假设 db 已经连接
// db = new sqlite3.Database('your_database.db');

async function main() {
  try {
    // 确保表已创建
    await CreateObjTable();
    console.log("ObjTable created.");

    // 插入一些示例数据
    await InsertObj('Item A', 100);
    await InsertObj('Item B', 250);
    console.log("Sample data inserted.");

    // 获取所有对象
    const allObjs = await GetAllObjs();
    console.log("Fetched objects:", allObjs);

    // 预期输出:
    // Fetched objects: [
    //   { id: 1, name: 'Item A', amount: 100 },
    //   { id: 2, name: 'Item B', amount: 250 }
    // ]

  } catch (error) {
    console.error("An error occurred:", error);
  } finally {
    // 确保在应用退出时关闭数据库连接
    // db.close(); 
  }
}

main();

4. 注意事项与最佳实践

错误处理: 始终在Promise的reject分支中处理数据库操作可能出现的错误。
数据库连接管理: 确保数据库连接在应用程序生命周期中得到妥善的打开和关闭。在Electron主进程中，通常在应用启动时打开，在应用关闭时关闭。
类型定义: 为你的数据库表结构定义清晰的TypeScript接口或类，这有助于提升代码的可读性和可维护性。
SQL注入: 在构建SQL查询时，如果涉及用户输入，请务必使用参数化查询（如db.run('INSERT INTO ... VALUES (?, ?)', [value1, value2])）来防止SQL注入攻击。
ORM工具: 对于更复杂的数据库交互和对象映射需求，可以考虑使用Object-Relational Mapping (ORM) 工具，如TypeORM或Sequelize。它们提供了更高级的抽象，可以自动化大部分数据到对象的映射工作。
for...in vs for...of: 再次强调，for...in用于迭代对象的属性名（或数组的索引），而for...of用于迭代可迭代对象（如数组）的元素值。在处理数组时，几乎总是应该使用for...of。

总结

通过将sqlite3的异步回调方法封装在Promise中，并结合正确的数组迭代方式（for...of）和TypeScript的类型断言，我们可以优雅且类型安全地将SQLite数据库的原始行数据反序列化为预定义的TypeScript类或接口对象。这种方法不仅解决了异步处理的挑战，还大大提高了代码的健壮性和可维护性。

以上就是将SQLite数据映射到TypeScript对象：异步处理与类型安全实践的详细内容，更多请关注其它相关文章！

# 这是 # 上海营销推广方法 # 学网站建设去那里 # 公众号营销推广网站推荐 # 美团关键词搜索排名操作 # 襄樊网站建设路成都 # 资兴网站优化排名 # 洛阳网站建设优化公司 # 静海购物商城网站建设 # 宜兴外贸营销推广 # 简报模板网站或软件推广 # 它与 # 如何使用 # 链式 # 使其 # 行数 # javascript # 如何实现 # 查询结果 # 迭代 # 回调 # sq # ai # 工具 # 回调函数 # app # typescript # node # node.js # js # java