استانداردسازی قالب بندی TSQL Codeدر SQL Server برای خوانایی و نگهداری بهتر

استانداردسازی قالب بندی TSQL Code در SQL Server: راهنمای جامع برای خوانایی و نگهداری بهتر

بسیاری از سازمان‌ها به دلایل مختلفی استانداردهای کدنویسی را اعمال می‌کنند. دلایل اصلی شامل خوانایی، قابلیت نگهداری و سازگاری کد است. تصور کنید چندین توسعه‌دهنده روی یک پایگاه داده کار می‌کنند؛ اگر هر یک از آن‌ها سبک‌های کدنویسی متفاوتی داشته باشند، خواندن و درک کد به یک کابوس تبدیل می‌شود. اینجاست که قالب‌بندی و استانداردسازی کد اهمیت پیدا می‌کند و به بهبود خوانایی کد SQL Server کمک شایانی می‌کند.

برخی از مشکلات رایج در قالب‌بندی کد T-SQL که مانع از خوانایی آن می‌شوند، عبارتند از:

• کلمات کلیدی با یک سبک استاندارد (حروف بزرگ/کوچک) نوشته نمی‌شوند.
• عدم استفاده از تورفتگی (indentation) مناسب.
• عدم درج کامنت‌گذاری (commenting) صحیح.
• استفاده نکردن از نام‌های مستعار (aliases).
• عدم استفاده از پیشوند طرحواره (schema prefix) برای جداول.
• نبود استانداردی برای نوشتن شرط‌های JOIN با پرانتز.
• کد بسیار فشرده و متراکم است که خواندن و درک آن را دشوار می‌کند.

راه‌های زیادی برای استانداردسازی کد T-SQL شما وجود دارد. می‌توانید از قابلیت‌های داخلی SSMS، ابزارهای شخص ثالث مانند Redgate، ApexSQL و dbForge و یا تعریف استانداردهای کدنویسی خود استفاده کنید.

• قابلیت‌های داخلی SSMS: محیط SQL Server Management Studio (SSMS) دارای برخی قابلیت‌های اولیه قالب‌بندی است. می‌توانید از گزینه “Format Document” استفاده کنید، اما این گزینه کنترل محدودی روی سبک (style) قالب‌بندی ارائه می‌دهد.
• ابزارهای شخص ثالث: ابزارهایی مانند Redgate SQL Prompt، ApexSQL Refactor و dbForge SQL Refactor گزینه‌های گسترده‌ای برای قالب‌بندی کد SQL فراهم می‌کنند. این ابزارها اغلب به شما امکان می‌دهند سبک‌های قالب‌بندی سفارشی تعریف کرده و آن‌ها را به صورت خودکار اعمال کنید.

در ادامه به برخی از قوانین رایج قالب‌بندی کد و نحوه پیاده‌سازی آن‌ها می‌پردازیم.

قالب‌بندی کلمات کلیدی (حروف بزرگ/کوچک)
این یکی از بحث‌برانگیزترین موضوعات است. برخی ترجیح می‌دهند تمام کلمات کلیدی با حروف بزرگ باشند، در حالی که برخی دیگر حروف کوچک یا ترکیبی را ترجیح می‌دهند. نکته کلیدی حفظ سازگاری است.

مثال زیر تفاوت بین استفاده از حروف بزرگ و کوچک برای کلمات کلیدی SQL را نشان می‌دهد:

SELECT * FROM MyTable WHERE ID = 1

در مقابل:

select * from MyTable where ID = 1

هر دو سبک معتبر هستند، اما انتخاب یک سبک و پایبندی به آن برای استانداردسازی کد SQL حیاتی است.

تورفتگی (Indentation)
تورفتگی مناسب خوانایی کد را به شدت افزایش می‌دهد. این کار به درک محدوده بلاک‌ها و دستورات تو در تو کمک می‌کند.

این مثال نشان‌دهنده استفاده از تورفتگی برای بهبود خوانایی دستورات SQL است:

SELECT
    ID,
    Name
FROM
    MyTable
WHERE
    ID = 1

مشاهده می‌کنید که چگونه تورفتگی باعث می‌شود ساختار کوئری به وضوح مشخص شود.

کامنت‌گذاری (Comments)
کامنت‌ها برای توضیح منطق پیچیده یا کد غیرمعمول ضروری هستند. آن‌ها تاثیری بر اجرای کد ندارند، اما برای نگهداری آینده بسیار ارزشمندند.

نمونه‌ای از استفاده از کامنت در کنار یک کوئری SQL:

SELECT * FROM MyTable -- This is a comment

این کامنت توضیح می‌دهد که هدف از این بخش از کد چیست.

نام‌های مستعار (Aliases)
استفاده از نام‌های مستعار برای جداول و ستون‌ها می‌تواند کوئری‌ها را کوتاه‌تر و خواناتر کند، به خصوص در دستورات JOIN.

مثال زیر نحوه استفاده از نام مستعار ‘t’ برای جدول ‘MyTable’ را نشان می‌دهد:

SELECT t.ID, t.Name FROM MyTable t WHERE t.ID = 1

این کار به ساده‌سازی کوئری‌های SQL کمک می‌کند.

پرانتز برای شرط‌های JOIN
قرار دادن شرط‌های JOIN درون پرانتز می‌تواند وضوح را افزایش دهد، به ویژه زمانی که چندین شرط یا منطق پیچیده وجود دارد.

مثالی از استفاده از پرانتز برای شرط‌های JOIN که به وضوح کد SQL می‌افزاید:

SELECT * FROM TableA a JOIN TableB b ON (a.ID = b.ID AND a.Status = 'Active')

این سبک، خوانایی شرط‌های پیچیده JOIN را بهبود می‌بخشد.

پیشوند طرحواره (Table Schema Prefix)
همواره استفاده از پیشوند طرحواره (مانند `dbo.MyTable`) برای جداول و ویوها می‌تواند از ابهام جلوگیری کرده و اطمینان حاصل کند که شیء صحیح مورد ارجاع قرار گرفته است.

نمونه‌ای از ارجاع به جدول با استفاده از پیشوند طرحواره ‘dbo’:

SELECT * FROM dbo.MyTable WHERE ID = 1

این رویکرد برای نگهداری و امنیت پایگاه داده SQL Server توصیه می‌شود.

اکنون نحوه استفاده از Redgate SQL Prompt را برای استانداردسازی قالب‌بندی کد T-SQL بررسی می‌کنیم.

1. باز کردن SSMS و گزینه‌های SQL Prompt: به مسیر SQL Prompt -> Options بروید.
2. سبک‌های قالب‌بندی: در پنجره Options، به بخش “Formatting” بروید. در اینجا می‌توانید گزینه‌های مختلف قالب‌بندی را مشاهده کنید.
3. تعریف یک سبک جدید: برای ایجاد یک سبک قالب‌بندی سفارشی روی “New Style…” کلیک کنید. یک نام برای آن انتخاب کنید، مثلاً “MyStandardStyle”.
4. پیکربندی قوانین: در سبک جدید خود، می‌توانید قوانین متعددی مانند قالب حروف کلمات کلیدی، تورفتگی، شکست خط و غیره را پیکربندی کنید.
   • قالب حروف کلمات کلیدی: در بخش “Casing”، گزینه دلخواه خود (مثلاً “Uppercase for keywords”) را انتخاب کنید.
   • تورفتگی: در بخش “Indentation”، تنظیمات دلخواه خود برای Tab/Space را وارد کنید.
   • شکست خط: در بخش “Line breaks”، تصمیم بگیرید که خطوط جدید در کجا درج شوند.
5. اعمال قالب‌بندی: پس از پیکربندی، می‌توانید با راست کلیک روی پنجره کوئری و انتخاب “Format SQL”، این سبک را روی کد T-SQL خود اعمال کنید.
6. برون‌بری/درون‌ریزی سبک‌ها: SQL Prompt به شما امکان می‌دهد سبک‌های سفارشی خود را به یک فایل (`.sqbf`) برون‌بری (Export) کرده و آن‌ها را در سایر نصب‌های SSMS درون‌ریزی (Import) کنید. این قابلیت برای استانداردسازی کد در سطح تیم بسیار مفید است.