کنوانسیون های کدنویسی جاوا کدام یک را دنبال کنید و چرا

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

قراردادهای کدنویسی چیست؟

کنوانسیون‌های کدنویسی مجموعه‌ای از دستورالعمل‌ها برای هر زبان برنامه‌نویسی خاص با توصیه‌هایی در مورد جنبه‌های مختلف توسعه نرم‌افزار در این زبان، از جمله سبک کدنویسی، بهترین شیوه‌ها و روش‌ها هستند. قراردادهای کدنویسی باید توسط برنامه نویسان نرم افزاری که به این زبان کدنویسی می کنند به عنوان راهنمای کیفیت برای اطمینان از خوانایی کد آنها و امکان نگهداری صحیح از نرم افزار توسط افراد دیگر رعایت شود. قراردادهای کدنویسی معمولاً تمام اجزای ضروری ساخت نرم‌افزار در این زبان برنامه‌نویسی را پوشش می‌دهند، از جمله سازمان‌دهی فایل، تورفتگی، نظرات، اعلان‌ها، بیانیه‌ها، فضای خالی، قراردادهای نام‌گذاری، شیوه‌های برنامه‌نویسی، اصول برنامه‌نویسی، قوانین کلی برنامه‌نویسی، بهترین شیوه‌های معماری و موارد دیگر. .

هدف از کدگذاری قراردادها چیست؟

دلایل متعددی وجود دارد که چرا قراردادهای کدنویسی نقش مهمی در توسعه نرم افزار دارند.

• حفظ سبک کد یکپارچه

پیروی از یک قرارداد کد نویسی به پروژه نرم افزار اجازه می دهد تا در یک سبک واحد نوشته شود، که از چندین راه مختلف مانند موارد زیر مفید است.

• به حداقل رساندن هزینه های نگهداری نرم افزار

یکی از مهمترین آنها تسهیل نگهداری و پشتیبانی از محصول نرم افزاری است، زیرا اغلب نویسندگان اصلی برنامه کسانی نیستند که از آن پشتیبانی می کنند. این مهم است زیرا 80٪ از هزینه طول عمر یک نرم افزار صرف نگهداری می شود.

• بهبود خوانایی نرم افزار

بهبود خوانایی نرم افزار یکی دیگر از مزایای عمده است که پیامدهای متعددی مانند ساده کردن معرفی توسعه دهندگان جدید به پروژه و افزایش کارایی همکاری اعضای تیم توسعه را نیز به همراه دارد.

• تسریع در کار

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

کنوانسیون های کدنویسی جاوا

وقتی صحبت از جاوا به میان می‌آید، دو قرارداد رایج و شناخته‌شده کدنویسی وجود دارد: قراردادهای کد جاوای Oracle و کنوانسیون کدنویسی راهنمای سبک جاوا Google .

• کنوانسیون کد جاوا اوراکل

کنوانسیون کد Oracle به دلایل واضحی به عنوان مهمترین آن شناخته می شود: کنوانسیون Oracle رسمی است زیرا Oracle مالک جاوا است، و همچنین یکی از قدیمی ترین ها (آخرین ویرایش این سند در 20 آوریل انجام شد، 1999). برخی از بخش‌های مهم قرارداد کد جاوا Oracle توصیه به استفاده از camel case هنگام تعریف کلاس‌ها، روش‌ها یا متغیرها، برای شروع کلاس‌ها با حروف بزرگ و استفاده از اسم‌ها برای نام‌گذاری آن‌ها است، در حالی که از افعال در فرم دستوری و شروع استفاده می‌شود. از حروف کوچک برای متدها و غیره.

• راهنمای سبک جاوا گوگل

کنوانسیون های کدنویسی جاوا از گوگل به دلیل جایگاه گوگل به عنوان یک شرکت اینترنتی و فناوری یادگیری با تجربه عظیم در توسعه انواع برنامه های کاربردی جاوا، مهم تلقی می شوند. دلیل مهم دیگر این واقعیت است که کنوانسیون کد جاوا گوگل در 22 می 2018 به روز شد، که آن را نسبت به قرارداد کدهای Oracle مرتبط تر می کند، به خصوص وقتی صحبت از توصیف ویژگی های نسبتاً جدید جاوا می شود که فقط به عنوان بخش جاوا 8 منتشر شده بودند. در سال 2014، مانند لامبدا و استریم. در اینجا نحوه توصیف نویسندگان راهنمای سبک جاوا گوگل، محتوای این کنوانسیون کدنویسی آمده است: «این سند به عنوان تعریف کامل استانداردهای کدگذاری گوگل برای کد منبع در جاوا عمل می کند. مانند سایر راهنماهای سبک برنامه نویسی، موضوعات تحت پوشش نه تنها مسائل زیبایی شناختی قالب بندی، بلکه انواع دیگر قراردادها یا استانداردهای کدنویسی را نیز در بر می گیرند. با این حال، این سند اساساً بر قوانین سخت و سریعی که ما به طور جهانی از آنها پیروی می‌کنیم تمرکز دارد و از دادن توصیه‌هایی که به وضوح قابل اجرا نیستند (خواه توسط انسان یا ابزار) اجتناب می‌کند.» «راهنمای سبک جاوا گوگل در بیشتر موارد مرجع خوبی است، اما در برخی از موضوعات کمی سهل‌انگیز است. دیوید ریوس، معمار نرم افزار و برنامه نویس باتجربه جاوا، در پستی در لینکدین با برخی انطباق های پیشنهادی با Google Style Style Guide گفت: از طرف دیگر، به عنوان یک برنامه نویس جاوا، شما باید از 4 فاصله برای تورفتگی کد استفاده کنید. مال خودش.

بیشترین استفاده از استانداردهای کدنویسی جاوا

در اینجا برخی از پرکاربردترین استانداردهای کدنویسی جاوا که در قراردادهای کد نویسی ذکر شده از Oracle و Google و همچنین اسناد دیگر از این دست یافت می شوند، آورده شده است.

• از قرارداد نامگذاری مناسب پیروی کنید.
• اضافه کردن نظرات؛
• شناسه به معنای یک نام نمادین است که به نام کلاس ها، بسته ها، متدها و متغیرها در یک برنامه جاوا اشاره دارد.
• نام متغیر باید با هدف آن مرتبط باشد.
• نام روش باید با عملکرد روش مرتبط باشد.
• روش نباید بیش از 50 خط داشته باشد.
• هیچ کد تکراری در همان کلاس یا کلاس دیگر نباید وجود داشته باشد.
• متغیرهای سراسری را فقط در صورت لزوم برای استفاده در روش‌های دیگر اعلام کنید.
• ایجاد متغیرهای استاتیک در داخل یک کلاس را دوبار بررسی کنید.
• از دسترسی مستقیم به متغیرها از کلاس های دیگر خودداری کنید به جای استفاده از متدهای getter و setter.
• تمام منطق کسب و کار باید فقط در کلاس خدمات انجام شود.
• تمام کدهای مربوط به DB باید فقط در کلاس های DAO باشد.
• از گیرنده ها و ستترها استفاده کنید.
• متغیر نمونه را به عنوان خصوصی اعلام کنید.
• دامنه متغیرها را حداقل نگه دارید.
• نام های معنی دار را به متغیرها اختصاص دهید.
• با آزاد کردن اتصالات پایگاه داده پس از تکمیل پرس و جو، از نشت حافظه جلوگیری کنید.
• سعی کنید تا حد امکان از بلوک نهایی استفاده کنید.
• از چارچوب Executor برای برنامه نویسی چند رشته ای استفاده کنید.