翻譯|使用教程|編輯:楊鵬連|2020-12-29 11:49:30.197|閱讀 334 次
概述:通過代碼分析規(guī)則,格式設(shè)置樣式和代碼片段,開發(fā)團(tuán)隊(duì)如何使用SQL Prompt建立和共享編碼標(biāo)準(zhǔn)的戰(zhàn)略視圖。
# 界面/圖表報(bào)表/文檔/IDE等千款熱門軟控件火熱銷售中 >>
相關(guān)鏈接:
SQL Prompt是一款實(shí)用的SQL語法提示工具。SQL Prompt根據(jù)數(shù)據(jù)庫(kù)的對(duì)象名稱、語法和代碼片段自動(dòng)進(jìn)行檢索,為用戶提供合適的代碼選擇。自動(dòng)腳本設(shè)置使代碼簡(jiǎn)單易讀--當(dāng)開發(fā)者不大熟悉腳本時(shí)尤其有用。SQL Prompt安裝即可使用,能大幅提高編碼效率。此外,用戶還可根據(jù)需要進(jìn)行自定義,使之以預(yù)想的方式工作。
通過代碼分析規(guī)則,格式設(shè)置樣式和代碼片段,開發(fā)團(tuán)隊(duì)如何使用SQL Prompt建立和共享編碼標(biāo)準(zhǔn)的戰(zhàn)略視圖。
近年來,我們數(shù)據(jù)管理行業(yè)中的大多數(shù)人將學(xué)會(huì)適應(yīng)“敏捷”開發(fā)和部署實(shí)踐。許多組織已經(jīng)在工具和流程上進(jìn)行了大量投資,他們希望這些工具和流程可以使他們更頻繁,更可靠地向用戶提供新功能,同時(shí)還保持質(zhì)量標(biāo)準(zhǔn)。為此,我們需要簡(jiǎn)單的工具,既可以使我們快速有效地與數(shù)據(jù)庫(kù)一起工作,又可以鼓勵(lì)數(shù)據(jù)庫(kù)代碼始終保持較高的標(biāo)準(zhǔn)。
我從數(shù)據(jù)庫(kù)優(yōu)先的角度來稱呼這種編寫代碼,在本文中,我將演示團(tuán)隊(duì)如何通過代碼分析規(guī)則,格式設(shè)置樣式和代碼片段使用SQL Prompt建立和共享編碼標(biāo)準(zhǔn)。以我的經(jīng)驗(yàn),這將帶來很多好處,包括:
正確實(shí)施的數(shù)據(jù)庫(kù)DevOps技術(shù)允許在運(yùn)營(yíng)團(tuán)隊(duì)和交付團(tuán)隊(duì)之間轉(zhuǎn)移有效的實(shí)踐和方法。像我一樣,DBA增進(jìn)了我們對(duì)版本控制,變更集,軟件包,單元測(cè)試等的理解……我們終于到了!同樣,開發(fā)人員可以更好地了解數(shù)據(jù)庫(kù)代碼和體系結(jié)構(gòu)標(biāo)準(zhǔn),以確保公司的數(shù)據(jù)庫(kù)可用和安全,并且將性能和可維護(hù)性問題的風(fēng)險(xiǎn)降到最低。
它是逐步完善的過程,并取得成功,我們需要一個(gè)簡(jiǎn)單的,共享的工具,這將建立共同的編碼技術(shù),標(biāo)準(zhǔn)和做法,在整個(gè)團(tuán)隊(duì),并且很容易讓大家對(duì)團(tuán)隊(duì)始終如一地執(zhí)行。
為代碼設(shè)計(jì)和代碼格式化的各個(gè)方面定義一組團(tuán)隊(duì)“規(guī)則”或標(biāo)準(zhǔn),將為您帶來許多好處。例如:
這是SQL Prompt真正有用的地方。
使用SQL Prompt實(shí)施編碼標(biāo)準(zhǔn)
與像Visual Studio這樣的應(yīng)用程序開發(fā)IDE相比,開發(fā)人員傾向于認(rèn)為DBA首選的工具SQL Server Management Studio(SSMS)缺乏通用性。插入SQL Prompt,情況將大大改善。SQL IntelliSense和代碼完成功能有助于更快地編寫準(zhǔn)確的代碼,它還提供了許多功能,可幫助團(tuán)隊(duì)提高工作效率,提高代碼標(biāo)準(zhǔn)
在以下各節(jié)中,我將簡(jiǎn)要回顧一下SQL Prompt如何使團(tuán)隊(duì)實(shí)現(xiàn)代碼質(zhì)量,代碼格式樣式,代碼模板和代碼片段的標(biāo)準(zhǔn),以及這些帶來的好處。
在每種情況下,您都會(huì)看到,在定義和配置了每個(gè)“標(biāo)準(zhǔn)”之后,SQL Prompt使得在團(tuán)隊(duì)之間共享它并讓每個(gè)團(tuán)隊(duì)成員應(yīng)用它幾乎是一件輕松的事。您只需將相關(guān)文件保存在整個(gè)團(tuán)隊(duì)都可以訪問的位置,最好是在版本控制系統(tǒng)中。每個(gè)開發(fā)人員都將“ SQL提示”指向共享文件,然后,每次團(tuán)隊(duì)成員打開SQL Server Management Studio時(shí),他或她都會(huì)自動(dòng)訪問最新版本。
這里的所有都是它的; 從那時(shí)起,每個(gè)開發(fā)人員只需單擊幾下鍵盤即可應(yīng)用該標(biāo)準(zhǔn)。設(shè)置將在團(tuán)隊(duì)成員之間完全共享和標(biāo)準(zhǔn)化。
通過遵循這種共享做法,團(tuán)隊(duì)中的任何新成員都可以加入并受信任,他們可以輕松地更改,添加和編寫代碼,并達(dá)到與經(jīng)驗(yàn)最豐富的同事相同的標(biāo)準(zhǔn)。您的團(tuán)隊(duì)協(xié)調(diào)得越好,您的代碼就越好,這意味著您可以更加自信地應(yīng)用更改,并快速安全地進(jìn)行部署。
使用代碼分析規(guī)則的代碼質(zhì)量標(biāo)準(zhǔn)
現(xiàn)在,SQL Prompt附帶了一系列代碼分析規(guī)則,您可以在查詢時(shí)或在鍵入查詢時(shí)對(duì)它們運(yùn)行查詢。SQL Prompt將在后臺(tái)運(yùn)行代碼分析,分析代碼并檢查語法是否符合內(nèi)置規(guī)則集。
這些規(guī)則鼓勵(lì)良好的編碼習(xí)慣,并警告團(tuán)隊(duì)進(jìn)行編碼,例如冒犯代碼樣式規(guī)則,使用不贊成使用的語法或在某些時(shí)候可能導(dǎo)致性能問題,不可預(yù)測(cè)的行為甚至安全漏洞。如果代碼違反了一條規(guī)則,則在SSMS中您會(huì)看到它用“波浪下劃線”表示,并且您可以單擊以查看該規(guī)則的描述,并且潛在的問題是由不遵守該規(guī)則的代碼引起的。
當(dāng)然,并非所有規(guī)則都適用于所有代碼庫(kù),在處理遺留代碼時(shí),您可能會(huì)希望禁用某些規(guī)則,這僅僅是因?yàn)槟?dāng)時(shí)無法修復(fù)它們。
要配置要應(yīng)用的規(guī)則,只需從SQL提示菜單中選擇“管理代碼分析規(guī)則”。選擇并取消選擇所需的規(guī)則,然后點(diǎn)擊保存。這會(huì)將本地用戶的設(shè)置文件保存在屏幕頂部顯示的位置。
將團(tuán)隊(duì)希望執(zhí)行的規(guī)則定義為團(tuán)隊(duì)之后,只需單擊另存為,然后將其保存到團(tuán)隊(duì)可以訪問的位置,例如共享源代碼控制存儲(chǔ)庫(kù)中的文件夾,或者只是開發(fā)共享驅(qū)動(dòng)器。然后,每個(gè)團(tuán)隊(duì)成員只需使用圖2中的省略號(hào)按鈕來找到團(tuán)隊(duì)設(shè)置文件,然后點(diǎn)擊保存。
使用SQL提示樣式的代碼格式化標(biāo)準(zhǔn)
沒有標(biāo)準(zhǔn)化的格式,我們的代碼將更容易出現(xiàn)人為錯(cuò)誤,最終會(huì)降低我們?cè)谏a(chǎn)中交付的產(chǎn)品或服務(wù)的質(zhì)量。最大限度地減少錯(cuò)誤,可以大大改善我們的工作和產(chǎn)品的質(zhì)量。
SQL Prompt允許我們定義樣式,每種樣式都準(zhǔn)確地描述了我們希望如何布置SQL代碼。我們使用“編輯格式樣式”菜單項(xiàng)來創(chuàng)建新的自定義樣式并編輯現(xiàn)有樣式。
單擊以編輯現(xiàn)有的自定義樣式時(shí),您將能夠設(shè)置一系列樣式選項(xiàng),這些樣式選項(xiàng)控制關(guān)鍵字的大小寫以及各個(gè)子句,條件,列表項(xiàng)等的對(duì)齊方式。所有這些選項(xiàng)僅影響空格,例如回車符/換行符,制表符和空格。
配置了“團(tuán)隊(duì)樣式”后,您只需將文件存儲(chǔ)在共享文件夾中的樣式文件夾中,并讓每個(gè)開發(fā)人員從本地客戶端訪問文件,就可以像代碼分析設(shè)置一樣輕松地共享設(shè)置文件。完成此操作后,每個(gè)團(tuán)隊(duì)成員只需在SQL提示中將“團(tuán)隊(duì)樣式”設(shè)置為“活動(dòng)樣式”,然后單擊幾次鍵盤即可將其應(yīng)用(Ctrl K,Y)。當(dāng)然,每個(gè)團(tuán)隊(duì)成員也可以在本地使用自己的自定義樣式(如果他們總是切換到團(tuán)隊(duì)樣式并應(yīng)用它),然后再與他人共享代碼。
帶有提示代碼段的標(biāo)準(zhǔn)化代碼模塊
SQL提示代碼段定義了代碼塊或創(chuàng)建通用類型的數(shù)據(jù)庫(kù)對(duì)象的T-SQL語句的基本結(jié)構(gòu)。您可以從查詢窗格的任何位置調(diào)用代碼段,以將代碼段插入代碼中。
它們不僅是保存和重用有用代碼的一種好方法,還將有助于提高代碼質(zhì)量。經(jīng)驗(yàn)豐富的團(tuán)隊(duì)成員可以共享摘要,以幫助在團(tuán)隊(duì)構(gòu)建模塊的方式上引入標(biāo)準(zhǔn)和一致性,例如,在任何標(biāo)題的結(jié)構(gòu),包含保護(hù)條款等方面。這將使代碼更安全地執(zhí)行,更易于理解和測(cè)試。
用于測(cè)試代碼或研究運(yùn)行緩慢的代碼的標(biāo)準(zhǔn)化代碼段將意味著始終以標(biāo)準(zhǔn)格式提供結(jié)果,這使故障排除期間的團(tuán)隊(duì)協(xié)作更加輕松。
同樣,與團(tuán)隊(duì)共享有用的片段很容易。代碼段以.sqlpromptsnippet文件擴(kuò)展名存儲(chǔ)為XML文件,因此只需在團(tuán)隊(duì)中每個(gè)人都可以訪問的位置創(chuàng)建一個(gè)Prompt Snippets文件夾,然后將要共享的所有自定義代碼段文件以及所有團(tuán)隊(duì)使用的內(nèi)置摘要。每個(gè)團(tuán)隊(duì)成員都調(diào)整其Snippet文件夾位置,以指向訪問文件夾和代碼片段。
結(jié)論
SQL提示是可用來幫助我們編寫SQL的最先進(jìn)的工具之一。它幫助我們對(duì)團(tuán)隊(duì)的編碼標(biāo)準(zhǔn)有了新的認(rèn)識(shí),并且可以在許多方面改善我們的日常工作。
長(zhǎng)期在代碼庫(kù)中工作的開發(fā)人員可能會(huì)發(fā)現(xiàn)自己養(yǎng)成了不良習(xí)慣。因此,通過主動(dòng)提醒他們注意代碼問題,并為他們提供檢查和自動(dòng)格式化代碼的方式,您可以幫助他們遵循與其他團(tuán)隊(duì)成員相同的標(biāo)準(zhǔn),而不會(huì)影響他們的工作效率。
同樣,新開發(fā)人員從項(xiàng)目初期就可以提高生產(chǎn)力,編寫符合高質(zhì)量標(biāo)準(zhǔn)的數(shù)據(jù)庫(kù)代碼。
本站文章除注明轉(zhuǎn)載外,均為本站原創(chuàng)或翻譯。歡迎任何形式的轉(zhuǎn)載,但請(qǐng)務(wù)必注明出處、不得修改原文相關(guān)鏈接,如果存在內(nèi)容上的異議請(qǐng)郵件反饋至chenjj@fc6vip.cn
文章轉(zhuǎn)載自: