2023年程序员培训SQL编码规范

MSSQL脚本编码规范福州星网视易信息系统有限公司更新记录：版本作者日期内容1.0黄晨东202３.0９．09SQL脚本编写规范2.０蔡炆炆２023.1０.1５基于1.0版本进行补充和整理ﻬ目录ＴOC＼o＂１－3"＼h＼ｚ\ｕHYPERLＩNK＼l"＿Toc＂Tｒansａct-SＱL编程规范ﻩPAGＥＲEF_Tｏc\h1HYPERＬＩNK＼l"_Toc"一、ﻩ概述ﻩＰＡGERＥＦ_Toｃ＼ｈ1ＨYPERLINK＼ｌ"_Toc"1． 基本原则ﻩPAGEREF_Toｃ\h1HYPERLIＮK2. 基本规范ﻩＰＡGEREF_Toｃ\h1HＹＰERLＩNＫ\l"_Toc"二、ﻩ对象命名 PＡGＥＲEF_Toc\ｈ1HYＰERLINK＼l"＿Toc"１.ﻩ数据库 PＡGＥREF_Toｃ\h1HYPＥRLＩNK\ｌ"_Ｔｏｃ"2. 数据库文献ﻩＰAGEＲEF_Toc\h１４.ﻩ数据视图 PAＧEＲEＦ_Toc\h２HYPＥＲLINK\ｌ"_Toc"５. 数据列ﻩPAＧEREF_Toc\h2HYPEＲLＩNK＼l"＿Toｃ"6.ﻩ存储过程 PAGEREF_Ｔｏc\h2HＹPEＲLIＮＫ＼l"_Toc"7.ﻩ函数 PAＧEＲEF_Toｃ\h３HYPERLINK＼l"_Ｔｏc"8.ﻩ用户定义数据类型ﻩPAGEREF_Tｏc\ｈ３HYPERＬINK\ｌ"＿Toc"9.ﻩ主键、索引 PAGＥREF_Ｔoc\h３ＨYPＥＲLIＮK三、 参数命名ﻩPＡGERＥF_Toｃ\h３HＹPＥRＬINK\l＂_Toc"1.ﻩ数据列参数 PAGEREF_Tｏc\h3ＨYPＥＲLINＫ\l"_Toc"2. 非数据列参数 PＡＧＥRＥF_Tｏc\ｈ4ＨYPERLIＮＫ\ｌ"_Toc"3.ﻩ常用字段命名 PＡＧEREF_Toｃ＼h4HYPERLIＮＫ四、ﻩSQL编写ﻩPAＧEREF_Toｃ＼h4ＨYPＥRLＩNＫ\l"_Toc"１. 大小写ﻩPＡGEREF_Ｔoc＼h4HYPＥＲＬIＮＫ\ｌ"_Toc"2.ﻩ存储格式 ＰAGEＲＥF_Ｔｏc\h4HYＰERLINK\l＂_Toc＂3. 类型选择ﻩPAGERＥF＿Toｃ\h4HＹPERLＩNK4. 默认值ﻩPＡGＥREF_Tｏc＼h５HYＰＥRLIＮK6． 使用“＇”ﻩPAGEＲEF_Ｔoｃ＼ｈ5HＹPＥRLINK\ｌ＂_Tｏc"7. 语句缩进ﻩＰＡGERＥＦ_Toｃ\h5ＨYPERLINK9．ﻩ语句分割ﻩPAＧEREF_Toc\h５HYＰERLＩＮＫ\l＂_Tｏｃ"10. 使用“*” ＰＡGＥREＦ_Tｏc\h5HＹPＥRLIＮK\l"_Tｏc"11. 表名别名 PAＧＥREF_Ｔｏc\h5HYPERＬINK13. 数值比较ﻩPAGERＥF_Toｃ\ｈ６HYPERLIＮK１4.ﻩ排序 PAＧＥREF_Ｔｏc\h6ＨYPERLINK1５.ﻩＵnicoｄｅ字符串 ＰＡGEREF＿Toc\h6ＨＹPERＬIＮＫ16. BEＧＩN..．END块 ＰAGEREF_Toc\h６ＨYPＥRLINK\l"_Tｏc"17.ﻩTOP子句 PＡGEREF_Tｏc\h６１8．ﻩTRAＮSＡCTIＯN编写 PAＧERＥF＿Tｏc＼h6HYPＥRLINK2. TRANSＡCTIＯＮ注释 PAGEREＦ_Ｔoｃ\ｈ７Ｔransacｔ-SQＬ编程规范概述本规范重要规定SＱL脚本在书写过程中所应遵循的规则及注意事项。编写该规范的目的是使公司软件开发人员的源代码书写习惯保持一致。这样做可以使每一个成员都可以理解其它成员的代码，以便于源代码的二次开发记忆系统的维护。基本原则以大小写敏感编写SＱL语句。

尽量使用Unicoｄe数据类型。ﻫ优先使用连接代替子查询或嵌套查询。ﻫ尽量使用参数化SQL查询代替语句拼接ＳQL查询。ﻫ尽量使用存储过程代替SＱL语句。严禁使用[拼音]＋［英语]的方式来命名SQL对象或变量。ﻫ严禁使用触发器。ﻫ严禁在表间创建外键关系。严禁创建自增长主键列基本规范采用Pascaｌ样式命名数据库对象。大写T－SQL语言的所有关键字,谓词和系统函数。Pascal大小写：组成标记符的每个单词的首字母大写,其余字母小写的书写约定。对于缩写的双字母单词，规定所有大写。例如：AppｌiｃatiｏnExｃｅptｉon

ID对象命名数据库命名格式为[项目英文名称]。

示例：ＡdventureWｏrks数据库文献数据文献：[数据库名称］+_Data．mdｆﻫ日记文献：[数据库名称］+_Ｌｏg.ldfﻫ示例：AｄventｕreＷｏrks＿Ｄatａ.mｄf

AdｖentuｒｅWorks_Lｏg.lｄf数据表命名格式为ＢL_TＢL＿+[表名]。

示例：BL＿TBL＿Ｅmployeｅ

BL＿ＴBL_Product

表名以英文单数命名。

示例：使用BL_ＴBL＿Product而不是BＬ＿TＢL_Ｐroducｔs数据视图命名格式为BL＿V_+[视图名称］。

示例:ＢL_V_Emｐloyee

BL_V＿SaｌesPersoｎ数据列列名称命名采用英文单词或缩写,英文单词只来自于具体业务定义,尽量表达清楚含义。命名格式为［列名称]。ﻫ示例:AｄdｒｅsｓIDﻫ

PostａlCｏｄｅﻫ尽量避免使用拼音命名，假如不可避免，对于比较短的列名,采用拼音全写,假如拼音列名比较复杂，可以采用首个字用全拼，其它字用首字母大写表达。

示例：宁波Ningbo

经营方式JiｎｇYFS存储过程命名格式为BL＿HV＿+［存储过程名称]。

示例:ＢL_ＨＶ_ＧetUsｅrﻫ

BL_ＨV_AddＵsｅｒ每个过程必须要有两个输出参数@ErrorCｏdｅ和＠ErrorMessａge。存储过程书写格式如下：ifｅxists（ｓeｌecｔ１fｒｏｍsyｓobｊectｓwherｅid=ｏbjeｃｔ_id(‘ｂｌ_hv_Cheｃｋout’）)dｒopprｏcedurｅbｌ_hｖ_CheｃｋoutgocreａteproceｄuｒｅＣｈｅckout(…．@EｒｒoｒＣodeiｎtｏｕｔput，--返回错误代码0表达成功非0表达失败@ErrorＭeｓsagevaｒchar(１00)output--返回错误信息)aｓdeclarｅ@checｋoutidint,--变量声明在此处…bｅｇin…endgo函数命名格式为BL_Fn＿+[函数名]。

示例:ＢＬ_Fｎ_ＧeｔUseｒ系统函数使用所有大写。ﻫ示例:SＥＬECＴIＳNＵLL（@LａstName，'Unknownｌａstnaｍe');

GETDＡTＥ()用户定义数据类型命名格式为［自定义数据类型名称]。

示例：Flaｇ

NａmeStyle主键、索引主键:PＫ_[表名称]＿[主键]；假如是组合主键,使用PK_[表名]_[主键1]_[主键２]。

示例：ＰK_ＢＬ_ＴBＬ_Stoｒe＿CustｏmerIDﻫ

PK_BL_TBＬ_StｏreConｔａct＿CustoｍerIＤ_ConｔaｃｔＩD

聚集索引:PK_[表名称］_[主键]；假如是组合主键,使用PK_[表名]_[主键１]_[主键2]。

示例:ＰK_Sｔｏre＿CustｏmerＩD

PK_StorｅContａct＿CustomeｒID_ContactIDﻫ唯一非聚集索引：ＡK_［表名称]_[列名称]。ﻫ示例：AK_Stｏrｅ＿roｗｇuiｄ

不唯一非聚集索引:ＰK_[表名称]_［列名称]。

示例:ＩＸ＿Sｔorｅ_SalesPerｓoｎID

主XＭＬ索引:PXＭＬ_[表名称]_[Xml类型列名称]。

示例：PXML＿Store_Ｄemograpｈics参数命名

数据列参数命名格式为＠＋[列名称］。

示例:@EmｐloｙｅeＩＤﻫ在列名不符合Ｐａｓcal样式时(初期遗留系统），例如使用所有大写的列名称，或使用“_”进行连接的字段名称,参数名称定义使用@+[列名称]，这里的列名称尽量符合Pascal样式命名。非数据列参数在参数无法跟列名称进行关联时，使用可以反映该参数功能的英文单词或单词组合，采用Pａｓcal样式命名。

示例：@ＥrrorIDﻫ

@Fｌag常用字段命名这里的常用字段是指在建表时频繁使用的表名或列名,下表对常用字段进行建议性定义,列名称数据类型说明CrｅateｄDatｅdａtetiｍe纪录创建日期，一般使用GETDAＴE(）自动生成ＭodiｆieｄDａtedateｔime

纪录最后修改日期,初次使用GETDAＴE（)ＤeletedDatedａtetｉｍe记录删除（标记删除）日期StarｔDaｔｅdａｔetime开始日期ＥnｄDaｔe

datetime结束日期ＳtａrtTimedatetime开始时间EｎdＴｉｍedａteｔime结束时间ID

inｔ

使用IＤ代替Id或iｄＰaｒentIDint父ＩDStatusinｔ状态SQL编写大小写大写T-SQＬ语言的所有关键字，谓词和系统函数。变量名称及游标名称使用Paｓcal样式。数据类型定义使用所有小写。

示例：DＥCLARE@ＬastＮaｍenvarchaｒ(32）;存储格式尽量采用Unｉcoｄe数据存储格式,提高可移植性和兼容性，实际应用中尽量使用ｎchａr、nvarchar、nteｘt代替char、varｃｈar、ｔexｔ。类型选择假如字符具有明确的长度，使用nchar代替ｎvａrchａr;chaｒ代替varcｈａr。在只有两个也许数值时，使用bit代替ｉnt或sｍａｌｌｉｎt。在SQＬServer2023中,使用ｎvａrchar（MＡX)代替ntext；vaｒｃhar(MAX)代替text;varbinaｒｙ(ＭＡＸ)代替ｉmage。在特殊的数据表结构中可考虑ｘml数据类型,达成事半工倍的效果。默认值在建立数据表时，尽量使用默认值代替NULL值。比如设立ＣｒｅatedDate列默认值为GＥTＤATE(）。在可行的情况下设立字段为不允许空。字段长度始终指定字符数据类型的长度,并保证允许用户也许需要的最大字符数，避免超过最大长度时出现字符丢失现象。对于字符型数据，建议采用2的n次方来定义数据长度。示例：nvaｒchaｒ(32)

varchａｒ(６4)使用“＇”在T－SQL代码中为字符常量使用单引号，避免使用双引号。语句缩进一个嵌套代码块中的语句使用2个空格的缩进。语句换行建议SQL代码每行以关键字或“'”开头。示例:SＥＬECT［SｈｉｆｔID］

,[Name]

,[ＳtaｒtＴime］

,[EndTiｍe］

,［ＭoｄifiｅdDate］FROM［AdvｅnｔｕreＷorkｓ]．[HumanResourceｓ].[Ｓｈiｆｔ]语句分割使用一个(而不是两个）空行分隔T-SQL代码的逻辑块。使用“*”尽量避免在任何代码中使用“SELECT＊”。表名别名表名别名要简短,但意义要尽量明确。通常使用大写的表名作为别名,使用AS关键字指定表或字段的别名。类型转换不要依赖任何隐式的数据类型转换，不要假定Ｔ-SQL会进行必要的转换。例如,把数字变量赋予字符值。相反，在为变量赋值或比较值之前,应使用适当的CONＶＥRＴ函数使数据类型相匹配。数值比较不要将空的变量值直接与比较运算符（符号）比较。假如变量也许为空,应使用ＩＳNUＬＬ或ＩSNOTNULＬ进行比较,或者使用IＳNULＬ函数。排序决不要依赖SELECT语句会按任何特定顺序返回行，除非在ＯＲDERBY子句中指定了顺序。通常,应将OＲＤEＲBY子句与SELEＣT语句一起使用。可预知的顺序（即使不是最方便的)比不可预知的顺序强，特别是在开发或调试过程中。在返回行的顺序无关紧要的情况下，可以忽略ＯRDＥRBＹ,减少资源开销。Unｉcode字符串在Unicｏdｅ字符前面使用Ｎ前缀,避免引起数据的不一致。示例：--AｓｓｕmestｈｅｄefaulｔcoｄepagｅisnｏtGreekＣREＡＴＥTAＢLE#t１(c1ｎｃhar(１))INSＥRT＃t1VALＵES（N'Ω')INＳEＲT#t1VALUES('Ω'）ＳEＬECT*ＦROM#t１输出结果:ｃ1

ΩOBEGIN.．.EＮD块在SQＬ代码快中尽量使用BEGIN..．END语句块,提高代码可阅读性。TOP子句尽量使用TOP(变量)来减少SＱＬ拼串现象。TＲANＳACTION编写只要在例程中使用多个数据库修改语句,涉及在一个循环中多次执行一个语句，就应考虑声明显式事务。实例:

BEGINＴRANSＡCTIＯNTraｎ_1;

UＰＤAＴＥ[ＨumａｎReｓoｕrceｓ].[Ｅｍｐloyee]

ＳET[Titｌe]=＠Title

,[HｉreDａte]＝@HｉrｅＤate

,[ＣuｒrｅntFlag]=@CurrｅntFlａg

ＷＨERE[ＥｍplｏyｅeID]=@EmｐｌoｙeｅID;

IF@@ERROR>0

ＢＥGＩＮ

RＯLＬBACKTRANSＡCTＩONTran_1;

END

CＯMＭIＴTRANSAＣTIONTran_1;存储过程在编写存储过程时，使用PROCEDＵＲE代替ＰROC简写。示例：CREATEPROCEＤＵRE［dbo].［存储过程名字]代码注释代码头部