如何在NodeJS中静态测试SQL语法？如何用Jest实现该测试？

一、NodeJS中SQL语法静态测试的可行方案 #

当然有可行方案，核心思路是借助SQL解析库对生成的SQL字符串进行语法校验。这类库能将SQL字符串解析为抽象语法树（AST），如果解析过程抛出错误，就说明SQL语法存在问题。常用的库包括：

• pg-query-parser：针对PostgreSQL的语法解析器，支持完整的PG SQL语法
• sql-parser：通用SQL解析器，支持多种数据库方言
• @sqltools/formatter：除了格式化，也能辅助做语法校验

这些库不仅能验证语法合法性，还能检测一些潜在问题（比如未闭合的引号、无效的关键字），部分库还能分析AST结构，检查逻辑合理性（比如是否存在无WHERE子句的DELETE）。

二、用Jest完成SQL语法测试的实现 #

完全可以用Jest来实现，下面结合你提供的示例代码，给出具体实现步骤：

1. 安装依赖 #

以pg-query-parser为例，先安装依赖：

npm install pg-query-parser --save-dev

2. 编写测试用例 #

假设你的SQL生成逻辑在sql-queries.js文件中：

// sql-queries.js
const fromQueryUsers = 'users_table';

export const generateUserQuery = (userId, hobbyId) => {
  return `
    SELECT USER_NAME FROM ${fromQueryUsers}
    WHERE USER_ID = '${userId}' AND HOBBY_ID = '${hobbyId}'
  ;`;
};

对应的Jest测试文件sql-queries.test.js：

// sql-queries.test.js
import { generateUserQuery } from './sql-queries';
import { parse } from 'pg-query-parser';

test('生成的SQL语法合法', () => {
  // 模拟正常参数
  const validQuery = generateUserQuery('123', '456');
  const parseResult = parse(validQuery);
  
  // 解析无错误则语法合法
  expect(parseResult.error).toBeUndefined();
  
  // 可选：验证AST结构，确保查询的表和字段正确
  expect(parseResult.query[0].SelectStmt.fromClause[0].RangeVar.relname).toBe('users_table');
  expect(parseResult.query[0].SelectStmt.targetList[0].ResTarget.val.ColumnRef.fields[0].String.str).toBe('USER_NAME');
});

test('含特殊字符的参数不会导致SQL语法错误', () => {
  // 模拟含单引号的参数（这里会导致语法错误，正好测试出问题）
  const invalidQuery = generateUserQuery("123'", '456');
  const parseResult = parse(invalidQuery);
  
  // 预期解析报错，暴露SQL注入风险
  expect(parseResult.error).not.toBeUndefined();
});

3. 运行测试 #

直接执行Jest命令即可：

npx jest sql-queries.test.js

注意事项 #

你提供的示例代码使用了字符串拼接生成SQL，存在严重的SQL注入风险。静态测试能检测到这类拼接导致的语法错误，但更推荐使用参数化查询（比如数据库驱动自带的参数占位符），从根源避免注入问题，同时也能减少语法错误的概率。

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