تبديل الأرقام السحرية بثوابت رمزية (Replace Magic Number with Symbolic Constant)

المشكلة

تستخدم الشيفرة البرمجية رقمًا له معنىً معين له.

function potentialEnergy($mass, $height) {
  return $mass * $height * 9.81;
}

الحل

استبدال هذا الرقم بثابت له اسم يمكن قراءته ويشرح معنى الرقم.

define("GRAVITATIONAL_CONSTANT", 9.81);

function potentialEnergy($mass, $height) {
  return $mass * $height * GRAVITATIONAL_CONSTANT;
}

لم إعادة التصميم؟

الرقم السحري هو القيمة الرقمية التي تتصادف في المصدر ولكن ليس لها معنىً واضح. ويجعل هذا "النمط المضاد" فهم البرنامج وإعادة تصميم الشيفرة البرمجية أمرًا صعبًا.

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

فوائد تطبيق الحل

يمكن أن يخدم الثابت الرمزي كتوثيق حي لمعنى قيمته.
من الأسهل بكثير تغيير قيمة ثابتٍ ما عن البحث عن هذا الرقم في مصدر الشيفرة البرمجية بأكمله، دون خطر تغيير نفس الرقم المستخدم في مكان آخر لغرض مختلف بطريق الخطأ.
تقليل الاستخدام المُكرَر لرقم أو سلسلة نصية في الشيفرة البرمجية. وهو مهم بشكل خاص عندما تكون القيمة معقدة وطويلة (مثل 3.14159 أو 0xCAFEBABE).

من الجيد أن نعرف

ليس كل الأرقام سحرية.

وإذا كان الغرض من العدد واضحَا، فلا حاجة إلى استبداله. والمثال الكلاسيكي هو:

for (i = 0; i < сount; i++) { ... }

البدائل

في بعض الأحيان يمكن استبدال الرقم السحري باستدعاءات التابع. علي سبيل المثال، إذا كان لديك رقم سحري يدل على عدد العناصر في مجموعة، فإنك لن تحتاج إلى استخدامه للتحقق من العنصر الأخير من المجموعة. وبدلا من ذلك، يُستخدم التابع القياسي للحصول علي طول المجموعة.
تُستخدم الأرقام السحرية أحيانُا كرموز للأنواع. لنفترض أن لديك نوعين من المستخدمين وأنك تستخدم حقل عددي في صنف لتحديد كِلاهما: ١ للمسؤولين و ٢ للمستخدمين العاديين.

في هذه الحالة، يجب استخدام أحد توابع أعادة التصميم لتجنب رموز الأنواع:

تبديل رموز الأنواع بالأصناف.

تبديل رموز الأنواع بالأصناف الفرعية.

تبديل رموز الأنواع بالحالة/الاستراتيجية.

آلية الحل

عرِّف ثابت وعيّن له قيمة الرقم السحر.
إبحث عن كل ذِكر للرقم السحري.
لكل من الأرقام التي تجدها، تحقق مرتين من أن الرقم السحري في هذه الحالة بالذات يتوافق مع الغرض من الثابت. إذا كان الجواب نعم، استبدل الرقم بالثابت. هذه خطوة هامة بما أن الرقم نفسه قد يعني أشياء مختلفة تمامًا (ويستبدل مع ثوابت مختلفة بحسب الحالة).