تكرار الكود

إن تكرار الكود هو مصطلح لبرمجة الحاسوب للتعبير عن تعاقب كود مصدري لأكثر من مرة، سواء أن كان في نفس البرنامج أو في برامج مختلفة مملوكة من قبل نفس الكيان. يعتبر تكرار الكود ظاهرة غير مرغوب بها لعدة أسباب.^[1] إن الحد الأدنى المطلوب يُطبق على مقدار من الكود التي يجب أن تظهر بشكل متسلسل حتى تعتبر مكررة فضلاً عن اعتبارها متشابهة بمحض الصدفة. تسلسل تكرار الكود أحيانا تُعرف باستنساخات. الطرق التالية تشير إلى كيفية تكرار الكود المتسلسلة:

• مماثلة حرف مقابل حرف
• مماثلة حرف مقابل حرف مع تجاهل المسافات والتعليقات
• مماثلة رمز مقابل رمز
• مماثلة رمز مقابل رمز مع تغيرات نسبية (مثل: ادخال/حذف/تعديل الرموز)
• مماثل وظيفياً

كيفية خلق المكررات

يوجد العديد من الأسباب لظهور تكرار الرموز، ومن ضمنهم:

• برمجة النسخ واللصق، حيث يتم نسخ جزء من الكود «لأنه يعمل». وفي معظم الحالات تتضمن تلك العملية تعديلات بسيطة في الكود المنسوخ مثل إعادة تسمية المتغيرات أو إدخال/حذف جزء من الكود.
• وجود وظيفة مماثلة بشكل كبير لوظيفة أخرى مطلوبة في برنامج أخر فيكتب المبرمج بشكل مستقل كود مشابه لما هو موجود سابقاً.
• سرقة فكرية، حيث يتم نسخ الكود بدون إذن أو إسناد.

مشاكل متعلقة بتكرار الكود

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

• تضخيم الكود يؤثر على الفهم: غالباً ما يؤدي تكرار الكود إلى خلق أقسام من الكود طويلة ومكررة، تختلف فقط في خطوط قليلة أو حروف. وهذا الطول قد يؤدي إلى صعوبة فهم الكود بشكل سريع. وهذا يتضاد مع مبدأ «أفضل ممارسة» لـتحليل الكود.
• إخفاء الغرض: تكرار أقسام كبيرة من الكود المتماثلة قد يخفي كيف يختلف كل كود عن الأخر، وبالتالي، يختفي الغرض المحدد لكل قسم من الكود. غالباً ما يكون الاختلاف الوحيد في محيط المعامل. وأفضل ممارسة في هذه الحالة هي إعادة استخدام روتين فرعي.
• تحديث الحيود: يناقض تكرار الكود مبدأ أساسي من نظرية قاعدة البيانات: تجنب التكرار. عدم التقيد يتحمل تحديث الحيود، والذي يزيد من تكلفة الصيانة، لأن أي تعديل يطرأ على أي كود يجب أن يُطبق على كل تكرار بشكل منفرد. وفي أفضل الحالات، يتم ضرب وقت الكويد والاختبار في عدد التكرارات. وفي أسواء الحالات، بعض المواقع لا يتم تحديثها، وعلى سبيل المثال قد تظهر الأخطاء البرمجية المُعتقد أنه تم إصلاحها في الأماكن المكررة لشهور أو سنوات. وأفضل ممارسة هنا هي مكتبة برمجية.

اكتشاف تكرار الرموز

تم اقتراح عدد من الخوارزميات المختلفة لاكتشاف تكرار الكود. على سبيل المثال:

• خوارزمية بيكر.^[2]
• خوارزمية سلسلة بحث رابين كارب.
• استخدام شجرة التركيب المجردة.^[3]
• كشف الاستنساخ البصري.^[4]

مثال على التماثل الوظيفي

لاحظ هذا المثال المأخوذ من قصاصة رمز لحساب الـالمتوسط الرياضي لـمجموعة هيكل البيانات لـالأعداد الصحيحة

extern int array1[];
extern int array2[];
 
int sum1 = 0;
int sum2 = 0;
int average1 = 0;
int average2 = 0;
 
for (int i = 0; i < 4; i++)
{
   sum1 += array1[i];
}
average1 = sum1/4;
 
for (int i = 0; i < 4; i++)
{
   sum2 += array2[i];
}
average2 = sum2/4;

يمكن كتابة الحلقتين التكرارتين كمعادلة واحدة:

int calcAverage (int* Array_of_4)
{
   int sum = 0;
   for (int i = 0; i < 4; i++)
   {
       sum += Array_of_4[i];
   }
   return sum/4;
}

باستخدام المعادلة السابقة ينتج كود مصدري ليس له حلقة مكررة:

extern int array1[];
extern int array2[];

int average1 = calcAverage(array1);
int average2 = calcAverage(array2);

أدوات

تتضمن أدوات تحليل تكرار الكود التالي:

• Atomiq – تجاري
• Black Duck Suite – تجاري (سلسلة برامج تحليلية)
• CCFinder (C/C++، جافا، كوبول، فورتران، الخ / غير متكافئ مع نظم تشغيل غير ويندوز)
• Checkstyle (جافا)
• CloneAnalyzer (C/C++ وجافا / برنامج مساعدة ايكليبس فقط)
• Clone Digger (بايثون وجافا)
• CloneDR – تجاري (أيدا, C, C++, C#, جافا، كوبول, فورترن، بايثون, VB.net, VB6, PHP4/5, PLSQL, SQL2011, XML, وأخرون)
• مكتشف النسخ/اللصق (CPD) من بي ام دي (جافا، بي اتش بي، فورترن JSP, C, C++,)
• ConQAT ^[5][6](مصدر مفتوح، يدعم: ABAP، أيدا، كوبول، C/C++، C#، جافا، PL/I، PL/SQL، بيثون، نص، إجراء SQL، فيجوال بيسك، XML)
• JPlag (جافا، C#، C، C++، نص لغات طبيعية ومتداخلة)
• Pattern Miner (CP Miner) - تجاري^[7]
• Simian (برنامج) - تجاري
• CodePro Analytix – تجاري

انظر أيضا

• رائحة الكود
• لا تكرر نفسك
• شجرة بنية مجردة

المراجع

1. Spinellis، Diomidis. "The Bad Code Spotter's Guide". InformIT.com. مؤرشف من الأصل في 2016-11-05. اطلع عليه بتاريخ 2008-06-06.
2. Brenda S. Baker. A Program for Identifying Duplicated Code. Computing Science and Statistics, 24:49–57, 1992.
3. Ira D. Baxter, et al. Clone Detection Using Abstract Syntax Trees نسخة محفوظة 10 أغسطس 2017 على موقع واي باك مشين.
4. Visual Detection of Duplicated Code^{[وصلة مكسورة]}by Matthias Rieger, Stephane Ducasse. "نسخة مؤرشفة" (PDF). مؤرشف من الأصل في 2007-03-16. اطلع عليه بتاريخ 2011-05-13.
5. A Workbench for Clone Detection Research by E. Juergens, F. Deissenboeck, B. Hummel نسخة محفوظة 05 مارس 2016 على موقع واي باك مشين.
6. Do Code Clones Matter? by E. Juergens, F. Deissenboeck, B. Hummel, S. Wagner نسخة محفوظة 09 أغسطس 2017 على موقع واي باك مشين.
7. CP-Miner: A Tool for Finding Copy-paste and Related Bugs in Operating System Code. by Zhenmin Li, Shan Lu, Suvda Myagmar and Yuanyuan Zhou. نسخة محفوظة 5 فبراير 2009 على موقع واي باك مشين.