SQL Prompt教程:使用SQL Prompt提升数据库编码标准

通过代码分析规则,格式设置样式和代码片段,开发团队如何使用SQL Prompt建立和共享编码标准的战略视图。

SQL Prompt是一款实用的SQL语法提示工具。SQL Prompt根据数据库的对象名称、语法和代码片段自动进行检索,为用户提供合适的代码选择。自动脚本设置使代码简单易读–当开发者不大熟悉脚本时尤其有用。SQL Prompt安装即可使用,能大幅提高编码效率。此外,用户还可根据需要进行自定义,使之以预想的方式工作。

SQL Prompt正式版

通过代码分析规则,格式设置样式和代码片段,开发团队如何使用SQL Prompt建立和共享编码标准的战略视图。

近年来,我们数据管理行业中的大多数人将学会适应“敏捷”开发和部署实践。许多组织已经在工具和流程上进行了大量投资,他们希望这些工具和流程可以使他们更频繁,更可靠地向用户提供新功能,同时还保持质量标准。为此,我们需要简单的工具,既可以使我们快速有效地与数据库一起工作,又可以鼓励数据库代码始终保持较高的标准。

我从数据库优先的角度来称呼这种编写代码,在本文中,我将演示团队如何通过代码分析规则,格式设置样式和代码片段使用SQL Prompt建立和共享编码标准。以我的经验,这将带来很多好处,包括:

  • 团队工作更有效,新团队成员的入职流程更简单。
  • 流畅的代码集成,更可靠的部署
  • 生产中更可预测的性能
  • 减少维护麻烦,减少计划外工作

为什么团队需要数据库编码标准

正确实施的数据库DevOps技术允许在运营团队和交付团队之间转移有效的实践和方法。像我一样,DBA增进了我们对版本控制,变更集,软件包,单元测试等的理解……我们终于到了!同样,开发人员可以更好地了解数据库代码和体系结构标准,以确保公司的数据库可用和安全,并且将性能和可维护性问题的风险降到最低。

它是逐步完善的过程,并取得成功,我们需要一个简单的,共享的工具,这将建立共同的编码技术,标准和做法,在整个团队,并且很容易让大家对团队始终如一地执行。

为代码设计和代码格式化的各个方面定义一组团队“规则”或标准,将为您带来许多好处。例如:

  • 代码格式化标准–确保可读,一致的代码易于在团队中共享和检查,并且易于重构,而不会引起不一致和错误。
  • 码模块的标准化结构–使一致的方法更容易地应用于团队构建和测试数据库代码的方式,例如错误处理的标准方法。
  • 代码质量规则–在开发和测试工作期间自动运行的一组共享代码分析规则,将有助于最大程度地减少技术负担并降低维护成本。

一旦团队同意一致性的需求,最困难的部分便是标准和规则的细节。到目前为止,您仍然需要确保每个团队成员每次将代码提交到共享存储库时都应用标准。一个由十名开发人员组成的团队都在同一个共享代码库的不同分支或功能上工作,这听起来并不容易。但是,如果没有最后一步,不一致和错误可能并且会潜入代码库中。

这是SQL Prompt真正有用的地方。

使用SQL Prompt实施编码标准

与像Visual Studio这样的应用程序开发IDE相比,开发人员倾向于认为DBA首选的工具SQL Server Management Studio(SSMS)缺乏通用性。插入SQL Prompt,情况将大大改善。SQL IntelliSense和代码完成功能有助于更快地编写准确的代码,它还提供了许多功能,可帮助团队提高工作效率,提高代码标准

在以下各节中,我将简要回顾一下SQL Prompt如何使团队实现代码质量,代码格式样式,代码模板和代码片段的标准,以及这些带来的好处。

在每种情况下,您都会看到,在定义和配置了每个“标准”之后,SQL Prompt使得在团队之间共享它并让每个团队成员应用它几乎是一件轻松的事。您只需将相关文件保存在整个团队都可以访问的位置,最好是在版本控制系统中。每个开发人员都将“ SQL提示”指向共享文件,然后,每次团队成员打开SQL Server Management Studio时,他或她都会自动访问最新版本。

这里的所有都是它的; 从那时起,每个开发人员只需单击几下键盘即可应用该标准。设置将在团队成员之间完全共享和标准化。

通过遵循这种共享做法,团队中的任何新成员都可以加入并受信任,他们可以轻松地更改,添加和编写代码,并达到与经验最丰富的同事相同的标准。您的团队协调得越好,您的代码就越好,这意味着您可以更加自信地应用更改,并快速安全地进行部署。

使用代码分析规则的代码质量标准

现在,SQL Prompt附带了一系列代码分析规则,您可以在查询时或在键入查询时对它们运行查询。SQL Prompt将在后台运行代码分析,分析代码并检查语法是否符合内置规则集。

这些规则鼓励良好的编码习惯,并警告团队进行编码,例如冒犯代码样式规则,使用不赞成使用的语法或在某些时候可能导致性能问题,不可预测的行为甚至安全漏洞。如果代码违反了一条规则,则在SSMS中您会看到它用“波浪下划线”表示,并且您可以单击以查看该规则的描述,并且潜在的问题是由不遵守该规则的代码引起的。

SQL Prompt教程:使用SQL Prompt提升数据库编码标准

当然,并非所有规则都适用于所有代码库,在处理遗留代码时,您可能会希望禁用某些规则,这仅仅是因为您当时无法修复它们。

要配置要应用的规则,只需从SQL提示菜单中选择“管理代码分析规则”。选择并取消选择所需的规则,然后点击保存。这会将本地用户的设置文件保存在屏幕顶部显示的位置。

SQL Prompt教程:使用SQL Prompt提升数据库编码标准

将团队希望执行的规则定义为团队之后,只需单击另存为,然后将其保存到团队可以访问的位置,例如共享源代码控制存储库中的文件夹,或者只是开发共享驱动器。然后,每个团队成员只需使用图2中的省略号按钮来找到团队设置文件,然后点击保存。

使用SQL提示样式的代码格式化标准

没有标准化的格式,我们的代码将更容易出现人为错误,最终会降低我们在生产中交付的产品或服务的质量。最大限度地减少错误,可以大大改善我们的工作和产品的质量。

SQL Prompt允许我们定义样式,每种样式都准确地描述了我们希望如何布置SQL代码。我们使用“编辑格式样式”菜单项来创建新的自定义样式并编辑现有样式。

SQL Prompt教程:使用SQL Prompt提升数据库编码标准

单击以编辑现有的自定义样式时,您将能够设置一系列样式选项,这些样式选项控制关键字的大小写以及各个子句,条件,列表项等的对齐方式。所有这些选项仅影响空格,例如回车符/换行符,制表符和空格。

配置了“团队样式”后,您只需将文件存储在共享文件夹中的样式文件夹中,并让每个开发人员从本地客户端访问文件,就可以像代码分析设置一样轻松地共享设置文件。完成此操作后,每个团队成员只需在SQL提示中将“团队样式”设置为“活动样式”,然后单击几次键盘即可将其应用(Ctrl K,Y)。当然,每个团队成员也可以在本地使用自己的自定义样式(如果他们总是切换到团队样式并应用它),然后再与他人共享代码。

带有提示代码段的标准化代码模块

SQL提示代码段定义了代码块或创建通用类型的数据库对象的T-SQL语句的基本结构。您可以从查询窗格的任何位置调用代码段,以将代码段插入代码中。

它们不仅是保存和重用有用代码的一种好方法,还将有助于提高代码质量。经验丰富的团队成员可以共享摘要,以帮助在团队构建模块的方式上引入标准和一致性,例如,在任何标题的结构,包含保护条款等方面。这将使代码更安全地执行,更易于理解和测试。

用于测试代码或研究运行缓慢的代码的标准化代码段将意味着始终以标准格式提供结果,这使故障排除期间的团队协作更加轻松。

同样,与团队共享有用的片段很容易。代码段以.sqlpromptsnippet文件扩展名存储为XML文件,因此只需在团队中每个人都可以访问的位置创建一个Prompt Snippets文件夹,然后将要共享的所有自定义代码段文件以及所有团队使用的内置摘要。每个团队成员都调整其Snippet文件夹位置,以指向访问文件夹和代码片段。

SQL Prompt教程:使用SQL Prompt提升数据库编码标准

结论

SQL提示是可用来帮助我们编写SQL的最先进的工具之一。它帮助我们对团队的编码标准有了新的认识,并且可以在许多方面改善我们的日常工作。

长期在代码库中工作的开发人员可能会发现自己养成了不良习惯。因此,通过主动提醒他们注意代码问题,并为他们提供检查和自动格式化代码的方式,您可以帮助他们遵循与其他团队成员相同的标准,而不会影响他们的工作效率。

同样,新开发人员从项目初期就可以提高生产力,编写符合高质量标准的数据库代码。

试用下载>>>

SQL Prompt 使用教程>>>


想要购买SQL Prompt正版授权,或了解更多产品信息请点击【咨询在线客服】
标签:

来源:慧都

声明:本站部分文章及图片转载于互联网,内容版权归原作者所有,如本站任何资料有侵权请您尽早请联系jinwei@zod.com.cn进行处理,非常感谢!

上一篇 2020年11月26日
下一篇 2020年11月26日

相关推荐

发表回复

登录后才能评论