آموزش قوانین و اصول نام‌گذاری در جاوا

آموزش قوانین و اصول نام‌گذاری در جاوا

Java Naming Conventions یا اصول نام‌گذاری در جاوا، مجموعه‌ای از قوانین و توصیه‌های استاندارد برای نام‌گذاری عناصر مختلف برنامه مانند کلاس‌ها، متدها، متغیرها و بسته‌ها است.

این اصول که در مستندات رسمی اوراکل و سبک‌نامه‌های معتبری مانند Google Java Style تعریف شده‌اند، به توسعه‌دهندگان کمک می‌کنند کدهایی خوانا، قابل فهم و یکپارچه بنویسند.

رعایت Java Naming Conventions نه تنها خوانایی کد را افزایش می‌دهد، بلکه همکاری تیمی را تسهیل کرده و نگهداری نرم‌افزار را در بلندمدت ساده‌تر می‌سازد.

اهمیت اصول نام‌گذاری در جاوا

اصول نام‌گذاری در جاوا دلایل متعددی دارد که فراتر از صرفاً زیبایی کد است.

اولاً، کدی که از قوانین نام‌گذاری پیروی می‌کند، خود-مستندساز (self-documenting) است.

یعنی یک توسعه‌دهنده دیگر با دیدن نام یک کلاس یا متد می‌تواند هدف و کاربرد آن را حدس بزند، بدون اینکه نیاز به مطالعه جزئیات پیاده‌سازی داشته باشد.

ثانیاً، یکپارچگی در نام‌گذاری در سراسر پروژه، درک ساختار کد را برای همه اعضای تیم آسان‌تر می‌کند.

زمانی که هر توسعه‌دهنده بداند چه چیزی را کجا پیدا کند، بهره‌وری تیم به شدت افزایش می‌یابد .

ثالثاً، ابزارهای خودکار مانند SonarQube و Checkstyle که برای بازبینی کیفیت کد استفاده می‌شوند، می‌توانند رعایت این اصول را بررسی کرده و در صورت تخلف، هشدار دهند

در نهایت، رعایت Java Naming Conventions باعث می‌شود کد شما حرفه‌ای‌تر به نظر برسد و به راحتی با سایر پروژه‌های جاوا قابل مقایسه باشد.

قوانین نام‌گذاری کلاس (Class Naming Conventions)

نام کلاس‌ها در جاوا باید با حرف بزرگ شروع شده و از قالب PascalCase یا UpperCamelCase پیروی کند.

به این معنا که حرف اول هر کلمه در نام کلاس باید بزرگ نوشته شود. نام کلاس‌ها معمولاً اسم هستند و نمایانگر یک موجودیت یا مفهوم در دنیای واقعی می‌باشند .

برای مثال:

• CustomerAccount

• Employee

• StringBuilder

• HttpServletRequest

نام کلاس باید توصیفی و گویا باشد و از به کار بردن کلمات اختصاری یا نام‌های مبهم پرهیز شود.

برای مثال، به جای CustAcc از CustomerAccount استفاده کنید.

همچنین بهتر است از حالت مفرد برای نام کلاس‌ها استفاده شود، مگر اینکه کلاس نمایانگر یک ظرف یا مجموعه از اشیا باشد (مانند CustomersList) 

قوانین نام‌گذاری اینترفیس (Interface Naming Conventions)

اینترفیس‌ها نیز مانند کلاس‌ها از قالب PascalCase پیروی می‌کنند.

اما از نظر معنایی، نام اینترفیس‌ها اغلب صفت هستند و نمایانگر یک قابلیت یا ویژگی هستند که کلاس‌های پیاده‌ساز می‌توانند داشته باشند.

برای مثال:

• Runnable

• Serializable

• Comparable

• Printable

برخی اینترفیس‌ها ممکن است نام‌های اسمی نیز داشته باشند، به‌ویژه زمانی که نقش یک قرارداد یا نوع داده اصلی را ایفا می‌کنند.

برای مثال List یا Map در فریمورک کالکشن‌ها.

یک قانون مهم دیگر این است که از افزودن پیشوندهای مصنوعی مانند I (مثلاً IAnimal) برای اینترفیس‌ها خودداری کنید.

قوانین نام‌گذاری متد (Method Naming Conventions)

نام متدها در جاوا باید با حرف کوچک شروع شده و از قالب camelCase پیروی کنند.

به این معنا که حرف اول کلمه اول کوچک و حرف اول هر کلمه بعدی بزرگ نوشته می‌شود.

نام متدها معمولاً فعل هستند و بیانگر عملی هستند که متد انجام می‌دهد.

برای مثال:

• ()getName

• ()calculateTotalPrice

• setBalance(double amount)

• ()print

نام متد باید گویا باشد و هدف آن را به روشنی بیان کند.

متدهایی که یک مقدار را برمی‌گردانند، معمولاً با get، is یا has شروع می‌شوند (مانند getFirstName، isAvailable، hasNext).

متدهایی که مقداری را تغییر می‌دهند، با set شروع می‌شوند.

اگر متدی چندین آیتم را بازمی‌گرداند، استفاده از حالت جمع در نام آن می‌تواند گویا باشد (مثلاً getAllCustomers) .

 

🚀 از صفر تا قهرمان جاوا، فقط با یک دوره!
به دنبال یه فرصت طلایی برای شروع برنامه‌نویسی می‌گردی؟
دوره آموزشی جاوا ما، همون چیزیه که نیاز داری!

✨ چرا این دوره رو انتخاب می‌کنی؟
🎯 از مبتدی تا حرفه‌ای
بدون پیش‌زمینه شروع می‌کنی و به یه برنامه‌نویس جاوا تبدیل می‌شی که بازار کار منتظرته!

🛠 پروژه‌محور و عملی
با انجام پروژه‌های واقعی، کدنویسی رو یاد می‌گیری، نه فقط تئوری!

👨‍🏫 پشتیبانی همیشگی
هرجا گیر کنی، تیم پشتیبانی کنارته تا مشکلت حل بشه.

🔓 دسترسی مادام‌العمر
هر وقت خواستی به محتوا دسترسی داری، برای همیشه!

 

🔥 همین حالا ثبت‌نام کن 

قوانین نام‌گذاری متغیر (قوانین نام گذاری متغیر در جاوا)

متغیرها در جاوا به چند دسته تقسیم می‌شوند که هر کدام قوانین خاص خود را دارند.

• متغیرهای محلی و نمونه (Local and Instance Variables)

  نام این متغیرها نیز مانند متدها از قالب camelCase پیروی می‌کند و با حرف کوچک شروع می‌شود.
  این نام‌ها باید اسم باشند و هدف متغیر را به روشنی بیان کنند. برای مثال:

  • customerName

  • totalAmount

  • employeeList

از نام‌های یک حرفی می‌توان برای متغیرهای موقتی با عمر کوتاه مانند شمارنده‌های حلقه استفاده کرد (مثلاً i, j, k برای اعداد صحیح و c برای کاراکترها) .

• ثابت‌ها (Constants)

  ثابت‌ها متغیرهایی هستند که با کلمه کلیدی final تعریف می‌شوند و مقدار آن‌ها تغییر نمی‌کند.
  نام ثابت‌ها باید کاملاً با حروف بزرگ نوشته شود و کلمات مختلف با استفاده از زیرخط (Underscore) از هم جدا شوند.
  این قالب UPPER_SNAKE_CASE نام دارد . برای مثال:

• • MAX_BALANCE

  • DEFAULT_TIMEOUT

  • PI

قوانین نام‌گذاری بسته (Package Naming Conventions)

بسته‌ها (Packages) در جاوا برای سازمان‌دهی کلاس‌ها و اینترفیس‌ها استفاده می‌شوند.

نام بسته‌ها باید کاملاً با حروف کوچک نوشته شود.

اگر نام از چند کلمه تشکیل شده باشد، کلمات با استفاده از زیرخط از هم جدا می‌شوند، هرچند استفاده از کلمات به هم‌چسبیده بدون جداکننده نیز رایج است .

یک قانون بسیار مهم برای نام‌گذاری بسته‌های عمومی، استفاده از نام دامنه اینترنتی به صورت معکوس به عنوان پیشوند است .

این کار از برخورد نام بسته‌ها در پروژه‌های مختلف جلوگیری می‌کند. برای مثال:

• com.baeldung.namingconventions

• org.apache.commons.lang

• io.educative.example

اجزای مختلف نام بسته، لایه‌های مختلف معماری نرم‌افزار و کامپوننت‌های تجاری را از هم تفکیک می‌کنند .

قوانین نام‌گذاری enum و Annotation

• Enum‌ها

  نام نوع enum (شبیه به کلاس) با PascalCase نوشته می‌شود، در حالی که ثابت‌های آن (مقادیر enum) با UPPER_SNAKE_CASE نوشته می‌شوند .
  برای مثال:

enum DayOfWeek {
    SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY
}

• Annotation‌ها

  نام نوع annotation نیز مانند کلاس‌ها و اینترفیس‌ها با PascalCase نوشته می‌شود . برای مثال @Override، @Deprecated، @Auditable [۳].

قوانین نام‌گذاری پارامترهای جنریک (Generic Type Parameter Names)

پارامترهای نوع جنریک معمولاً با یک حرف بزرگ و مفهوم نمایش داده می‌شوند  برخی از پرکاربردترین‌ها عبارتند از:

• E - Element (عنصر) که در فریمورک کالکشن‌ها استفاده می‌شود 

• T - Type (نوع) 

• K - Key (کلید) و V - Value (مقدار) برای نگاشت‌ها (Maps) 

• S - Service Loader 

• ID, DTO, ENTITY - گاهی برای وضوح بیشتر از این نام‌های بلندتر استفاده می‌شود .

بهترین شیوه‌ نام گذاری در جاوا

• استفاده از نام‌های گویا و کوتاه (Short but Speaking Names)

  همیشه برای همه عناصر کد از نام‌های کوتاه و گویا استفاده کنید 

• پرهیز از کاراکترهای خاص

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

• ترجیح حالت مفرد

  برای نام قطعات بسته و نام نوع‌ها، حالت مفرد را به جمع ترجیح دهید، مگر اینکه معنای کلمه به جمع نیاز داشته باشد (CustomerEntity به جای CustomersEntity)

• پرهیز از نام‌های تکراری

  از وجود نام‌های تکراری برای نوع‌ها (کلاس‌ها، اینترفیس‌ها و ...) در یک پروژه خودداری کنید

• CamelCase حتی برای کوته‌نوشت‌ها

  حتی برای کوته‌نوشت‌ها (Acronyms) از قالب CamelCase استفاده کنید، یعنی تنها حرف اول کوته‌نوشت بزرگ نوشته شود (XmlUtil به جای XMLUtil).

• عدم استفاده از پیشوندها و پسوندهای مصنوعی

  برای اینترفیس‌ها از پیشوند I و برای کلاس‌ها از پسوند Impl (در همه موارد) استفاده نکنید، مگر اینکه واقعاً ضروری باشد 

نتیجه‌گیری

رعایت Java Naming Conventions و اصول نام‌گذاری در جاوا یک علامت حرفه‌ای بودن و دقت نظر یک توسعه‌دهنده است.

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

قوانین نام‌گذاری متغیر در جاوا و سایر عناصر، همانند علائم راهنمایی و رانندگی عمل می‌کنند و مسیر را برای هر کسی که کد را می‌خواند هموار می‌سازند.

چه در حال نوشتن یک کلاس ساده باشید و چه یک فریمورک بزرگ، پیروی از این java-naming-conventions-and-rules-guide نانوشته، همکاری را تسهیل و کیفیت نهایی نرم‌افزار را تضمین می‌کند.