اتفاقيات ترميز جافا. أي منها يجب اتباعه ولماذا

إن معرفة واتباع معايير الصناعة وأفضل الممارسات أمر مهم للغاية في أي مجال، وخاصة في البرمجة بمزيجها المعقد والفوضوي أحيانًا من لغات البرمجة والأدوات والأساليب والتقنيات. لهذا السبب يجب أن يكون مبرمج Java المحترف على دراية جيدة باتفاقيات Java Coding، وهو ما سنتحدث عنه اليوم.

ما هي اتفاقيات الترميز؟

اصطلاحات البرمجة هي مجموعات من الإرشادات لكل لغة برمجة محددة مع توصيات بشأن الجوانب المختلفة لتطوير البرمجيات في هذه اللغة، بما في ذلك أسلوب البرمجة وأفضل الممارسات والأساليب. من المفترض أن يتبع مبرمجو البرامج الذين يقومون بالترميز بهذه اللغة اصطلاحات الترميز كدليل للجودة للتأكد من أن الكود الخاص بهم قابل للقراءة ومن الممكن إجراء صيانة مناسبة للبرنامج من قبل أشخاص آخرين. تغطي اصطلاحات الترميز عادة كل عنصر أساسي في صنع البرامج بلغة البرمجة هذه، بما في ذلك تنظيم الملفات، والمسافات البادئة، والتعليقات، والإعلانات، والبيانات، والمسافات البيضاء، واصطلاحات التسمية، وممارسات البرمجة، ومبادئ البرمجة، وقواعد البرمجة الأساسية، وأفضل الممارسات المعمارية، والمزيد. .

ما هو الغرض من اتفاقيات الترميز؟

هناك عدد من الأسباب التي تجعل اتفاقيات البرمجة تلعب دورًا مهمًا في تطوير البرمجيات.

• الحفاظ على نمط الكود الموحد

يسمح اتباع قواعد البرمجة بكتابة مشروع البرنامج بأسلوب موحد واحد، وهو أمر مفيد بعدة طرق مختلفة مثل ما يلي.

• تقليل تكاليف صيانة البرمجيات

أحد أهمها هو تسهيل صيانة ودعم منتج البرنامج، حيث أنه في كثير من الأحيان لا يكون المؤلفون الأصليون للبرنامج هم من يدعمونه. وهذا أمر مهم لأن 80% من تكلفة عمر البرنامج تذهب إلى الصيانة.

• تحسين إمكانية قراءة البرامج

يعد تحسين إمكانية قراءة البرامج فائدة رئيسية أخرى، والتي لها أيضًا آثار متعددة مثل تبسيط تقديم المطورين الجدد للمشروع وزيادة كفاءة التعاون بين أعضاء فريق التطوير.

• تسريع العمل

أخيرًا، يعد وجود كود مكتوب ومنظم بشكل صحيح أمرًا ضروريًا لتسير عملية تطوير البرمجيات بأسرع ما يمكن.

اتفاقيات ترميز جافا

عندما يتعلق الأمر بـ Java، هناك نوعان من اتفاقيات الترميز الأكثر شيوعًا والمعروفة: اتفاقيات Java Code الخاصة بـ Oracle واتفاقية ترميز Java Style Guide من Google .

• اتفاقية كود Java الخاصة بشركة Oracle

يتم التعرف على اتفاقية كود أوراكل باعتبارها الأكثر أهمية لعدد من الأسباب الواضحة: اتفاقية أوراكل هي الاتفاقية الرسمية لأن أوراكل هي المالك لجافا، بالإضافة إلى كونها الأقدم (تم إجراء المراجعة الأخيرة لهذه الوثيقة في 20 أبريل، 1999). ستكون بعض الأجزاء المهمة من اتفاقية Java Code الخاصة بـ Oracle هي التوصية باستخدام حالة الجمل عند تعريف الفئات أو الأساليب أو المتغيرات، لبدء الفئات بحرف كبير واستخدام الأسماء لتسميتها، أثناء استخدام الأفعال بصيغة الأمر والبدء من حرف صغير للطرق، وهكذا.

• دليل نمط جافا من جوجل

تعتبر اتفاقيات ترميز Java من Google مهمة نظرًا لمكانة Google باعتبارها شركة التعلم عبر الإنترنت والتكنولوجيا التي تتمتع بخبرة هائلة في تطوير جميع أنواع تطبيقات Java. سبب آخر مهم هو حقيقة أنه تم تحديث اتفاقية كود Java الخاصة بشركة Google في 22 مايو 2018، مما يجعلها أكثر صلة باتفاقية التعليمات البرمجية من Oracle، خاصة عندما يتعلق الأمر بوصف ميزات Java الجديدة نسبيًا والتي تم إصدارها فقط كجزء من Java 8 في عام 2014، مثل لامدا والجداول. وإليك كيفية وصف مؤلفي دليل Java Style Guide من Google لمحتوى اتفاقية الترميز هذه: "يعمل هذا المستند كتعريف كامل لمعايير ترميز Google للتعليمات البرمجية المصدر في Java. مثل أدلة أنماط البرمجة الأخرى، فإن المشكلات التي يتم تناولها لا تمتد فقط إلى المشكلات الجمالية المتعلقة بالتنسيق، بل أيضًا إلى أنواع أخرى من الاتفاقيات أو معايير الترميز. ومع ذلك، تركز هذه الوثيقة في المقام الأول على القواعد الصارمة التي نتبعها عالميًا، وتتجنب تقديم المشورة التي لا يمكن تنفيذها بشكل واضح (سواء بواسطة الإنسان أو الأداة)." "يعد Google Java Style Guide مرجعًا جيدًا في معظم الأحيان، ولكنه متساهل بعض الشيء في بعض المواضيع. من ناحية أخرى، باعتبارك مبرمج جافا، يجب أن تكون معتادًا على 4 مسافات للمسافات البادئة للتعليمات البرمجية، من بين أمور أخرى،" كما قال ديفيد ريوس، مهندس البرمجيات ومبرمج جافا ذو الخبرة، في منشور على LinkedIn مع بعض التعديلات المقترحة على Google Java Style Guide . خاص به.

معايير ترميز Java الأكثر استخدامًا

فيما يلي بعض معايير تشفير Java الأكثر استخدامًا والتي يمكن العثور عليها في اتفاقيات التشفير المذكورة أعلاه من Oracle وGoogle، بالإضافة إلى مستندات أخرى من هذا النوع.

• اتبع اصطلاح التسمية الصحيح؛
• إضافة تعليقات؛
• المعرف يعني اسمًا رمزيًا يشير إلى اسم الفئات والحزم والأساليب والمتغيرات في برنامج Java؛
• يجب أن يكون اسم المتغير مرتبطًا بالغرض منه؛
• يجب أن يرتبط اسم الطريقة بوظيفة الطريقة؛
• يجب ألا تحتوي الطريقة على أكثر من 50 سطرًا؛
• يجب ألا يكون هناك رمز مكرر في نفس الفصل أو فئة أخرى؛
• قم بتعريف المتغيرات العامة فقط إذا كان من الضروري استخدامها في الطرق الأخرى؛
• التحقق مرة أخرى من إنشاء المتغيرات الثابتة داخل الفصل؛
• تجنب الوصول إلى المتغيرات مباشرةً من الفئات الأخرى بدلاً من استخدام أساليب getter وsetter؛
• يجب التعامل مع كل منطق الأعمال في فئة الخدمة فقط؛
• يجب أن تكون جميع التعليمات البرمجية المتعلقة بقاعدة البيانات موجودة في فئات DAO فقط؛
• استخدام الحروف والمستوطنين؛
• قم بتعريف المثيل المتغير كخاص؛
• إبقاء نطاق المتغيرات في حده الأدنى؛
• تعيين أسماء ذات معنى للمتغيرات؛
• تجنب تسرب الذاكرة عن طريق تحرير اتصالات قاعدة البيانات عند اكتمال الاستعلام؛
• حاول استخدام الكتلة الأخيرة كلما أمكن ذلك؛
• استخدم إطار Executor للبرمجة متعددة الخيوط.