如果你常常使用 SQL Server，你可能会需要创建 SQL Server 数据库项目(SQL Server Database Project)。在这种情况下，生成器自动化工具(generator)非常有用。其中，最流行的之一就是 generator-sqlproj。在本文中，我们将会详细介绍如何使用 generator-sqlproj，并列出一些使用此工具的最佳实践。
安装 generator-sqlproj
你需要 Node.js 来安装 generator-sqlproj。你也需要根据你的操作系统安装 SQL Server 以及 SQL Server Management Studio(SSMS)。当然，你还需要从 npm 中安装 yeoman 和 generator-sqlproj。
在终端中执行以下命令：
npm install -g yo npm install -g generator-sqlproj
通过运行以下命令，你可以验证 generator-sqlproj 是否安装成功：
yo --generators
如果 generator-sqlproj 在列出的生成器之间，那么它已经被正确安装了。
创建一个 SQL Server 数据库项目
让我们来回到主题上来。如果你想要使用 generator-sqlproj 来创建一个 SQL Server 数据库项目，首先你应该切换到一个合适的项目(目录)中。
然后，在该目录中，运行以下命令：
yo sqlproj
该命令会启动一个交互式界面，提示你输入必需的信息，包括项目名称、解决方案名称、数据库名等等。
? Your Project Name
? Your Solution Name
? Your Default Schema Name
? Your Target Database Name
…
create my-project/appveyor.yml然后，generator-sqlproj 会为你创建一个符合 SQL Server 数据库项目规范的结构和文件，如下：
-- -------------------- ---- ------- - --- ---------- --- ------------ --- ----- - --- ------------------------------- --- ------ - --- --------- - --- ------- - --- -------- - --- ------ - --- ----- - --- ----- - --- --------------------------- --- --------- --- -------------------
其中，有一个 SQL Server 数据库项目(.sqlproj)、一个 Visual Studio 解决方案(.sln)以及一个 YAML 文件(appveyor.yml)(后者用来为项目构建自动化工作流)。生成的项目已经包含了一些定义数据表、视图以及其他数据库项目元素的样例代码。
SQL Server 数据库项目开发最佳实践
在本节中，我们将介绍生成 SQL Server 数据库项目的最佳实践。
创建目录
SQL Server 数据库项目中包含多个有组织的元素，如下：
- Functions
- Schemas
- Security
- Tables
- Types
- Views
我们建议为每个类型的元素创建一个文件夹。
使用合适的 Gitignore
在 SQL Server 数据库项目中，使用合适的 .gitignore 文件至关重要。最好使用一个成熟方案，比如 GitHub 的 gitignore 模板。
使用正确的源控制工具
对于 SQL Server 数据库项目，我们强烈建议使用 Git 作为源控制工具。不过，你也可以使用其他流行的工具，比如 SVN。
避免硬编码
在 SQL Server 数据库项目中，避免硬编码表名、列名以及其他信息。最好使用变量和常量，在代码中引用这些信息。
项目重构
确定项目重构(Refactoring)是否已被尽可能地优化。项目重构过程中，我们可以通过精简代码、简化函数以及增加测试等方式来提高项目的可维护性。
样例代码示例
以下是一个示例存储过程，为给定的日期返回标准化的日期字符串：
-- -------------------- ---- -------
------ --------- ----------------
-
----- ----
-
--
-----
------- ----------------- -----------
--- ----------------- - -------------------- ------ ---- -- ------ -- ------------
------ ----------------- -- ----------------
---总结
在本文中，我们介绍了如何使用 generator-sqlproj 为 SQL Server 数据库项目生成模板。同时，我们也提供了一些最佳实践，包括使用适当的 Gitignore 文件、避免硬编码以及优化项目重构。这些最佳实践将确保你的 SQL Server 数据库项目是可靠、可维护和易于扩展的。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60055d2b81e8991b448dae16