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].［存儲過程名字]代碼注釋代碼頭部