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