TransactSQL编程规范.docx

TransactSQL编程规范.docx

《TransactSQL编程规范.docx》由会员分享，可在线阅读，更多相关《TransactSQL编程规范.docx（8页珍藏版）》请在冰豆网上搜索。

TransactSQL编程规范

Transact-SQL编程规范

文档信息

文档名称：

Transact-SQL编程规范

电子文档：

版本号：

1.00

密级：

公开

文档编号：

编写人：

江剑平

日期：

2013-9-11

校对人：

日期：

审核人：

日期：

批准人：

日期：

更改记录

更改

序号

更改原因

更改

页码

更改前版本号

更改后版本号

更改人

生效日期

备注

1概述

1.1规范制定原则

1、方便代码的交流和维护。

2、不影响编码的效率，不与大众习惯冲突。

3、使代码更美观、阅读更方便。

4、使代码的逻辑更清晰、更易于理解。

1.2相关原则

1.2.1大小写

大写所有的T-SQL关键字，包括T-SQL函数。

变量名称及游标名称使用大驼峰样式。

数据类型定义使用全部小写。

示例：

DECLARE@LastNamenvarchar（32）;

1.2.2使用“;”

使用“;”作为Transact-SQL语句终止符。

虽然分号不是必需的，但使用它是一种好的习惯。

1.2.3存储格式

尽量采用Unicode数据存储格式，提高可移植性和兼容性，实际应用中使用nchar、nvarchar、ntext代替char、varchar、text。

1.2.4默认值

在建立数据表时，尽量使用默认值代替NULL值。

比如设置CreatedDate列默认值为GETDATE（）。

在可避免的情况下设置字段为不允许空。

1.2.5使用“'”

在T-SQL代码中为字符常量使用单引号,避免使用双引号。

1.2.6数值比较

不要将空的变量值直接与比较运算符（符号）比较。

如果变量可能为空，应使用ISNULL或ISNOTNULL进行比较，或者使用ISNULL函数。

1.2.7表名别名

表名别名要简短，但意义要尽量明确。

通常使用大写的表名作为别名，使用AS关键字指定表或字段的别名。

1.2.8禁止使用“*”

禁止在任何代码中使用“SELECT*”。

1.2.9排序

决不要依赖SELECT语句会按任何特定顺序返回行，除非在ORDERBY子句中指定了顺序。

通常，应将ORDERBY子句与SELECT语句一起使用。

可预知的顺序（即使不是最方便的）比不可预知的顺序强，尤其是在开发或调试过程中。

在返回行的顺序无关紧要的情况下，可以忽略ORDERBY的开销。

1.2.10BEGIN...END块的

在SQL代码快中尽量使用BEGIN...END语句块，提高代码可阅读性。

1.2.11TRY块

在SQLServer2005中增加TRY块，Transact-SQL语句组可以包含在TRY块中。

如果TRY块内部发生错误，则会将控制传递给CATCH块中包含的另一个语句组。

示例：

BEGINTRY

SQL语句组1

ENDTRY

BEGINCATCH

SQL语句组2

ENDCATCH;

1.2.12TOP子句

在SQLServer2005中加强了TOP的使用，尽量使用TOP（变量）来减少SQL拼串的使用。

1.3相关注释

1.3.1小驼峰法

小驼峰法的意思是：

除第一个单词之外，其他单词的首字母大写。

譬如要获取学生总人数可以如下命名规则：

getStudentCount，第一个单词是全部小写，后面的单词首字母大写。

1.3.2大驼峰法

相比小驼峰法，大驼峰法把第一个单词的首字母也大写了。

譬如同样是获取学生总人数可以采取如下命名规则：

GetStudentCount。

2命名规范

2.1对象命名

2.1.1数据库

采用大驼峰命名，命名格式为【项目英文名称】+【版本号】。

示例：

JOBBMSV1.0.1.7

2.1.2数据表

采用大驼峰命名，命名格式为【表名】。

示例：

Product

表名以英文单数命名，个人建议不采用复数是为了更好的使用ORM工具生成符合编程规范的代码（比如C#）。

示例：

使用Product

而不是Products

2.1.3数据列

列名称命名采用英文单词或缩写，英文单词只来自于具体业务定义，尽量表达清楚含义。

采用大驼峰命名，命名格式为【列名称】。

示例：

AddressID

PostalCode

尽量避免使用拼音命名，如果不可避免，对于比较短的列名，采用拼音全写，如果拼音列名比较复杂，可以采用首个字用全拼，其它字用首字母大写表示。

示例：

宁波Ningbo

经营方式JingYFS

2.1.4数据视图

建议采用大驼峰命名，命名格式为V+【视图名称】。

示例：

VEmployee

VSalesPerson

2.1.5存储过程

建议采用大驼峰命名，命名格式为P_【存储过程名称】。

示例：

P_GetUser

P_AddUser

2.1.6自定义函数

自定义函数采用大驼峰命名，命名格式为F_【函数名】。

示例：

F_GetAllUser

F_GetAllStudent

2.1.7主键、外键关系

主键:

PK_【表名称】_【主键】；如果是组合主键，使用PK_【表名】_【主键1】_【主键2】。

示例：

PK_Store_CustomerID

PK_StoreContact_CustomerID_ContactID

2.1.8索引

1、聚集索引：

PK_[表名称]_[主键]；如果是组合主键，使用PK_[表名]_[主键1]_[主键2]。

示例：

PK_Store_CustomerID

PK_StoreContact_CustomerID_ContactID

2、唯一非聚集索引:

AK_[表名称]_[列名称]。

示例：

AK_Store_rowguid

3、不唯一非聚集索引：

PK_[表名称]_[列名称]。

示例：

IX_Store_SalesPersonID

4、主XML索引：

PXML_[表名称]_[Xml类型列名称]。

示例：

PXML_Store_Demographics

备注：

以上命名参考SqlServer2005示例数据库，一般只需设计器自动生成，不需要额外修改。

2.1.9DML触发器

DML触发器是当数据库服务器中发生数据操作语言（DML）事件时要执行的操作。

DML事件包括对表或视图发出的UPDATE、INSERT或DELETE语句。

根据事件不同命名规则使用前缀进行区分,格式为TRI_[U|I|D]_[表名|视图名]

示例：

TRI_U_Employee

另外一种方式为，

AFTER触发器：

TRI_表名_[后面插入加I,修改加U,删除加D]。

INSTEADOF触发器：

TRI_表名或视图名_OF[后面插入加I,修改加U,删除加D]

2.1.10DDL触发器

响应各种数据定义语言（DDL）事件而激发。

这些事件主要与以关键字CREATE、ALTER和DROP开头的Transact-SQL语句对应。

执行DDL式操作的系统存储过程也可以激发DDL触发器。

采用大驼峰命名，命名单词能够描述DDL触发器功能。

示例：

CREATETRIGGERSafeTy

ONDATABASE

FORDROP_TABLE,ALTER_TABLE

AS

  PRINT'YoumustdisableTrigger"safety"todroporaltertables!

'

  ROLLBACK;

2.2参数命名

2.2.1数据列参数

命名格式为@+【列名称】。

示例：

@EmployeeID

2.2.2非数据列参数

在参数无法跟列名称进行关联时，使用能够反映该参数功能的英文单词或单词组合,采用大驼峰命名。

示例：

@ErrorID

@Flag

3注释规范

3.1代码头部注释

在SQL代码块（sql文件或存储过程）的头部进行注释，标注创建人（Author）、创始日期（Createdate）、描述（Description）、修改信息（Modify[n]）。

格式：

--=============================================

--Author:

--Createdate:

--Description:

--Modify[n]:

--=============================================

示例：

--================================================

--Author:

 JpJiang

--Createdate:

2013-9-11

--Description:

H2000报关单回执处理

--Modify[1]:

 JpJiang,2013-9-11,简化逻辑判断流程

--Modify[2]:

 JpJiang,2013-9-11,更新条件判断

--================================================

注：

日期格式使用yyyy-MM-dd。

Modify[n]n代表修改序号，从1开始，每次修改加1。

3.2事物注释

建议在每个事务的开头进行注释，说明该事务的功能。

--

BEGINTRANSACTION;

3.3游标注释

建议在每个游标的开头进行注释，说明该游标的功能。

--

declare【游标名称】scrollcursorforselect字段名1、…字段nfrom【表名】forreadonly

4代码风格

4.1语句缩进

一个嵌套代码块中的语句使用四个空格的缩进。

使用MicrosoftSQLServerManagementStudio,选择“工具”菜单，打开“选项”菜单，在选项对话框中选择文本编辑器->纯文本->制表符,选中“插入空格单选框”,设置“制表符大小”为4，缩进大小为“4”。

4.2语句换行

建议SQL代码每行以关键字或“,”开头。

示例：

SELECT[ShiftID]

     ,[Name]

     ,[StartTime]

     ,[EndTime]

     ,[ModifiedDate]

 FROM[AdventureWorks].[HumanResources].[Shift]

4.3语句分割

使用一个（而不是两个）空行分隔T-SQL代码的逻辑块。