VS2022中验证字符串字面量T-SQL语法的Roslyn分析器及替代方案

一、Roslyn分析器相关情况 #

目前没有广泛普及的、专门用于验证字符串字面量中T-SQL纯语法的Roslyn分析器，但可以自行定制：

• 基于官方的Microsoft.SqlServer.TransactSql.ScriptDom库（它能完整解析T-SQL并做语法校验），开发自定义Roslyn分析器。
• 核心思路：扫描代码中标记过的SQL字符串（比如给字符串加[SqlLiteral]这类自定义特性），提取内容后用ScriptDom解析，一旦发现语法错误（比如多余的AND、未闭合括号），就在编译时抛出警告或错误。

二、替代解决方案（无需切换ORM） #

1. 编译时验证方案 #

• 自定义Roslyn代码生成器：
  给包含T-SQL的字符串常量添加自定义特性（如[ValidateSql]），编写代码生成器在编译阶段扫描这些字符串，用Microsoft.SqlServer.TransactSql.ScriptDom做语法校验，发现错误直接终止编译并提示问题。
• CI/CD环节静态校验：
  编写脚本提取项目中所有SQL字符串，用ScriptDom批量验证，把这个脚本加入CI/CD的编译流程，一旦检测到语法错误就阻止构建。

2. 单元测试阶段验证方案 #

• 批量SQL语法校验测试：
  编写单元测试，通过反射或手动收集项目中所有Dapper调用的SQL字符串（比如从Query、Execute方法的参数里提取），用对应版本的TSQL解析器校验语法：

  using Microsoft.SqlServer.TransactSql.ScriptDom;
  using System.IO;
  using System.Linq;
  using NUnit.Framework;
  
  [TestFixture]
  public class SqlSyntaxValidationTests
  {
      [Test]
      public void AllSqlStringsShouldBeValid()
      {
          // 这里可以替换成实际收集SQL字符串的逻辑
          var sqlStrings = new[]
          {
              "SELECT Id, Name FROM Users WHERE Id = @UserId",
              "UPDATE Users SET Name = @Name WHERE Id = @Id AND " // 这里有多余的AND，会触发错误
          };
  
          var parser = new TSql160Parser(false);
          foreach (var sql in sqlStrings)
          {
              using var reader = new StringReader(sql);
              parser.Parse(reader, out var errors);
              if (errors.Any())
              {
                  Assert.Fail($"SQL语法错误: {string.Join("; ", errors.Select(e => e.Message))}\n出错SQL: {sql}");
              }
          }
      }
  }
  

  把这个测试设为必过项，提交代码前或CI/CD中强制执行，提前拦截语法错误。

3. 开发阶段辅助手段 #

• 用SQL辅助工具：比如Visual Studio的SQL Prompt扩展，能在编写字符串中的SQL时提供实时语法高亮和错误提示，开发时就能发现低级问题。
• 代码片段复用：把常用的SQL结构做成代码片段（比如正确的WHERE子句模板），减少手动编写时的失误。

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