2023年程序員培訓(xùn)SQL編碼規(guī)范

MSSQL腳本編碼規(guī)范福州星網(wǎng)視易信息系統(tǒng)有限公司更新記錄：版本作者日期內(nèi)容1.0黃晨東202３.0９．09SQL腳本編寫規(guī)范2.０蔡炆炆２023.1０.1５基于1.0版本進(jìn)行補(bǔ)充和整理?目錄ＴO(shè)C＼o＂１－3"＼h＼ｚ\ｕHYPERLＩNK＼l"＿Toc＂Tｒansａct-SＱL編程規(guī)范?PAGＥＲEF_Tｏc\h1HYPERＬＩNK＼l"_Toc"一、?概述?ＰＡGERＥＦ_Toｃ＼ｈ1ＨYPERLINK＼ｌ"_Toc"1． 基本原則?PAGEREF_Toｃ\h1HYPERLIＮK2. 基本規(guī)范?ＰＡGEREF_Toｃ\h1HＹＰERLＩNＫ\l"_Toc"二、?對(duì)象命名 PＡGＥＲEF_Toc\ｈ1HYＰERLINK＼l"＿Toc"１.?數(shù)據(jù)庫 PＡGＥREF_Toｃ\h1HYPＥRLＩNK\ｌ"_Ｔｏｃ"2. 數(shù)據(jù)庫文獻(xiàn)?ＰAGEＲEF_Toc\h１４.?數(shù)據(jù)視圖 PAＧEＲEＦ_Toc\h２HYPＥＲLINK\ｌ"_Toc"５. 數(shù)據(jù)列?PAＧEREF_Toc\h2HYPEＲLＩNK＼l"＿Toｃ"6.?存儲(chǔ)過程 PAGEREF_Ｔｏc\h2HＹPEＲLIＮＫ＼l"_Toc"7.?函數(shù) PAＧEＲEF_Toｃ\h３HYPERLINK＼l"_Ｔｏc"8.?用戶定義數(shù)據(jù)類型?PAGEREF_Tｏc\ｈ３HYPERＬINK\ｌ"＿Toc"9.?主鍵、索引 PAGＥREF_Ｔoc\h３ＨYPＥＲLIＮK三、 參數(shù)命名?PＡGERＥF_Toｃ\h３HＹPＥRＬINK\l＂_Toc"1.?數(shù)據(jù)列參數(shù) PAGEREF_Tｏc\h3ＨYPＥＲLINＫ\l"_Toc"2. 非數(shù)據(jù)列參數(shù) 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.?存儲(chǔ)格式 ＰAGEＲＥF_Ｔｏc\h4HYＰERLINK\l＂_Toc＂3. 類型選擇?PAGERＥF＿Toｃ\h4HＹPERLＩNK4. 默認(rèn)值?PＡGＥREF_Tｏc＼h５HYＰＥRLIＮK6． 使用“＇”?PAGEＲEF_Ｔoｃ＼ｈ5HＹPＥRLINK\ｌ＂_Tｏc"7. 語句縮進(jìn)?ＰＡ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. 數(shù)值比較?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Ｌ編程規(guī)范概述本規(guī)范重要規(guī)定SＱL腳本在書寫過程中所應(yīng)遵循的規(guī)則及注意事項(xiàng)。編寫該規(guī)范的目的是使公司軟件開發(fā)人員的源代碼書寫習(xí)慣保持一致。這樣做可以使每一個(gè)成員都可以理解其它成員的代碼，以便于源代碼的二次開發(fā)記憶系統(tǒng)的維護(hù)?；驹瓌t以大小寫敏感編寫SＱL語句。

盡量使用Unicoｄe數(shù)據(jù)類型。?優(yōu)先使用連接代替子查詢或嵌套查詢。?盡量使用參數(shù)化SQL查詢代替語句拼接ＳQL查詢。?盡量使用存儲(chǔ)過程代替SＱL語句。嚴(yán)禁使用[拼音]＋［英語]的方式來命名SQL對(duì)象或變量。?嚴(yán)禁使用觸發(fā)器。?嚴(yán)禁在表間創(chuàng)建外鍵關(guān)系。嚴(yán)禁創(chuàng)建自增長(zhǎng)主鍵列基本規(guī)范采用Pascaｌ樣式命名數(shù)據(jù)庫對(duì)象。大寫T－SQL語言的所有關(guān)鍵字,謂詞和系統(tǒng)函數(shù)。Pascal大小寫：組成標(biāo)記符的每個(gè)單詞的首字母大寫,其余字母小寫的書寫約定。對(duì)于縮寫的雙字母單詞，規(guī)定所有大寫。例如：AppｌiｃatiｏnExｃｅptｉon

ID對(duì)象命名數(shù)據(jù)庫命名格式為[項(xiàng)目英文名稱]。

示例：ＡdventureWｏrks數(shù)據(jù)庫文獻(xiàn)數(shù)據(jù)文獻(xiàn)：[數(shù)據(jù)庫名稱］+_Data．mdｆ?日記文獻(xiàn)：[數(shù)據(jù)庫名稱］+_Ｌｏg.ldf?示例：AｄventｕreＷｏrks＿Ｄatａ.mｄf

AdｖentuｒｅWorks_Lｏg.lｄf數(shù)據(jù)表命名格式為ＢL_TＢL＿+[表名]。

示例：BL＿TBL＿Ｅmployeｅ

BL＿ＴBL_Product

表名以英文單數(shù)命名。

示例：使用BL_ＴBL＿Product而不是BＬ＿TＢL_Ｐroducｔs數(shù)據(jù)視圖命名格式為BL＿V_+[視圖名稱］。

示例:ＢL_V_Emｐloyee

BL_V＿SaｌesPersoｎ數(shù)據(jù)列列名稱命名采用英文單詞或縮寫,英文單詞只來自于具體業(yè)務(wù)定義,盡量表達(dá)清楚含義。命名格式為［列名稱]。?示例:AｄdｒｅsｓID?

PostａlCｏｄｅ?盡量避免使用拼音命名，假如不可避免，對(duì)于比較短的列名,采用拼音全寫,假如拼音列名比較復(fù)雜，可以采用首個(gè)字用全拼，其它字用首字母大寫表達(dá)。

示例：寧波Ningbo

經(jīng)營(yíng)方式JiｎｇYFS存儲(chǔ)過程命名格式為BL＿HV＿+［存儲(chǔ)過程名稱]。

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

BL_ＨV_AddＵsｅｒ每個(gè)過程必須要有兩個(gè)輸出參數(shù)@ErrorCｏdｅ和＠ErrorMessａge。存儲(chǔ)過程書寫格式如下：ifｅxists（ｓeｌecｔ１fｒｏｍsyｓobｊectｓwherｅid=ｏbjeｃｔ_id(‘ｂｌ_hv_Cheｃｋout’）)dｒopprｏcedurｅbｌ_hｖ_Cheｃｋoutgocreａt(yī)eproceｄuｒｅＣｈｅckout(…．@EｒｒoｒＣodeiｎtｏｕｔput，--返回錯(cuò)誤代碼0表達(dá)成功非0表達(dá)失敗@ErrorＭeｓsagevaｒchar(１00)output--返回錯(cuò)誤信息)aｓdeclarｅ@checｋoutidint,--變量聲明在此處…bｅｇin…endgo函數(shù)命名格式為BL_Fn＿+[函數(shù)名]。

示例:ＢＬ_Fｎ_ＧeｔUseｒ系統(tǒng)函數(shù)使用所有大寫。?示例:SＥＬECＴIＳNＵLL（@LａstName，'Unknownｌａstnaｍe');

GETDＡTＥ()用戶定義數(shù)據(jù)類型命名格式為［自定義數(shù)據(jù)類型名稱]。

示例：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ｎI(lǐng)D

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

示例：PXML＿Store_Ｄemograpｈics參數(shù)命名

數(shù)據(jù)列參數(shù)命名格式為＠＋[列名稱］。

示例:@Emｐloｙｅe(cuò)ＩＤ?在列名不符合Ｐａｓcal樣式時(shí)(初期遺留系統(tǒng)），例如使用所有大寫的列名稱，或使用“_”進(jìn)行連接的字段名稱,參數(shù)名稱定義使用@+[列名稱]，這里的列名稱盡量符合Pascal樣式命名。非數(shù)據(jù)列參數(shù)在參數(shù)無法跟列名稱進(jìn)行關(guān)聯(lián)時(shí)，使用可以反映該參數(shù)功能的英文單詞或單詞組合，采用Pａｓcal樣式命名。

示例：@ＥrrorID?

@Fｌag常用字段命名這里的常用字段是指在建表時(shí)頻繁使用的表名或列名,下表對(duì)常用字段進(jìn)行建議性定義,列名稱數(shù)據(jù)類型說明CrｅateｄDatｅdａt(yī)etiｍe紀(jì)錄創(chuàng)建日期，一般使用GETDAＴE(）自動(dòng)生成ＭodiｆieｄDａt(yī)edateｔime

紀(jì)錄最后修改日期,初次使用GETDAＴE（)ＤeletedDatedａt(yī)etｉｍe記錄刪除（標(biāo)記刪除）日期StarｔDaｔｅdａｔetime開始日期ＥnｄDaｔe

datetime結(jié)束日期ＳtａrtTimedatetime開始時(shí)間EｎdＴｉｍedａt(yī)eｔime結(jié)束時(shí)間ID

inｔ

使用IＤ代替Id或iｄＰaｒentIDint父ＩDStatusinｔ狀態(tài)SQL編寫大小寫大寫T-SQＬ語言的所有關(guān)鍵字，謂詞和系統(tǒng)函數(shù)。變量名稱及游標(biāo)名稱使用Paｓcal樣式。數(shù)據(jù)類型定義使用所有小寫。

示例：DＥCLARE@ＬastＮaｍenvarchaｒ(32）;存儲(chǔ)格式盡量采用Unｉcoｄe數(shù)據(jù)存儲(chǔ)格式,提高可移植性和兼容性，實(shí)際應(yīng)用中盡量使用ｎchａr、nvarchar、nteｘt代替char、varｃｈar、ｔexｔ。類型選擇假如字符具有明確的長(zhǎng)度，使用nchar代替ｎvａrchａr;chaｒ代替varcｈａr。在只有兩個(gè)也許數(shù)值時(shí)，使用bit代替ｉnt或sｍａｌｌｉｎt。在SQＬServer2023中,使用ｎvａrchar（MＡX)代替ntext；vaｒｃhar(MAX)代替text;varbinaｒｙ(ＭＡＸ)代替ｉmage。在特殊的數(shù)據(jù)表結(jié)構(gòu)中可考慮ｘml數(shù)據(jù)類型,達(dá)成事半工倍的效果。默認(rèn)值在建立數(shù)據(jù)表時(shí)，盡量使用默認(rèn)值代替NULL值。比如設(shè)立ＣｒｅatedDate列默認(rèn)值為GＥTＤATE(）。在可行的情況下設(shè)立字段為不允許空。字段長(zhǎng)度始終指定字符數(shù)據(jù)類型的長(zhǎng)度,并保證允許用戶也許需要的最大字符數(shù)，避免超過最大長(zhǎng)度時(shí)出現(xiàn)字符丟失現(xiàn)象。對(duì)于字符型數(shù)據(jù)，建議采用2的n次方來定義數(shù)據(jù)長(zhǎng)度。示例：nvaｒchaｒ(32)

varchａｒ(６4)使用“＇”在T－SQL代碼中為字符常量使用單引號(hào)，避免使用雙引號(hào)。語句縮進(jìn)一個(gè)嵌套代碼塊中的語句使用2個(gè)空格的縮進(jìn)。語句換行建議SQL代碼每行以關(guān)鍵字或“'”開頭。示例:SＥＬECT［SｈｉｆｔID］

,[Name]

,[ＳtaｒtＴime］

,[EndTiｍe］

,［ＭoｄifiｅdDate］FROM［AdvｅnｔｕreＷo(hù)rkｓ]．[HumanResourceｓ].[Ｓｈiｆｔ]語句分割使用一個(gè)(而不是兩個(gè)）空行分隔T-SQL代碼的邏輯塊。使用“*”盡量避免在任何代碼中使用“SELECT＊”。表名別名表名別名要簡(jiǎn)短,但意義要盡量明確。通常使用大寫的表名作為別名,使用AS關(guān)鍵字指定表或字段的別名。類型轉(zhuǎn)換不要依賴任何隱式的數(shù)據(jù)類型轉(zhuǎn)換，不要假定Ｔ-SQL會(huì)進(jìn)行必要的轉(zhuǎn)換。例如,把數(shù)字變量賦予字符值。相反，在為變量賦值或比較值之前,應(yīng)使用適當(dāng)?shù)腃ONＶＥRＴ函數(shù)使數(shù)據(jù)類型相匹配。數(shù)值比較不要將空的變量值直接與比較運(yùn)算符（符號(hào)）比較。假如變量也許為空,應(yīng)使用ＩＳNUＬＬ或ＩSNOTNULＬ進(jìn)行比較,或者使用IＳNULＬ函數(shù)。排序決不要依賴SELECT語句會(huì)按任何特定順序返回行，除非在ＯＲDERBY子句中指定了順序。通常,應(yīng)將OＲＤEＲBY子句與SELEＣT語句一起使用?？深A(yù)知的順序（即使不是最方便的)比不可預(yù)知的順序強(qiáng)，特別是在開發(fā)或調(diào)試過程中。在返回行的順序無關(guān)緊要的情況下，可以忽略ＯRDＥRBＹ,減少資源開銷。Unｉcode字符串在Unicｏdｅ字符前面使用Ｎ前綴,避免引起數(shù)據(jù)的不一致。示例：--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１輸出結(jié)果:ｃ1

ΩOBEGIN.．.EＮD塊在SQＬ代碼快中盡量使用BEGIN..．END語句塊,提高代碼可閱讀性。TOP子句盡量使用TOP(變量)來減少SＱＬ拼串現(xiàn)象。TＲANＳACTION編寫只要在例程中使用多個(gè)數(shù)據(jù)庫修改語句,涉及在一個(gè)循環(huán)中多次執(zhí)行一個(gè)語句，就應(yīng)考慮聲明顯式事務(wù)。實(shí)例:

BEGINＴRANSＡCTIＯNTraｎ_1;

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

ＳET[Titｌe]=＠Title

,[HｉreDａt(yī)e]＝@HｉrｅＤate

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

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

IF@@ERROR>0

ＢＥGＩＮ

RＯLＬBACKTRANSＡCTＩONTran_1;

END

CＯMＭIＴTRANSAＣTIONTran_1;存儲(chǔ)過程在編寫存儲(chǔ)過程時(shí)，使用PROCEDＵＲE代替ＰROC簡(jiǎn)寫。示例：CREATEPROCEＤＵRE［dbo].［存儲(chǔ)過程名字]代碼注釋代碼頭部