الفرق بين المراجعتين ل"Refactoring/replace magic number with symbolic constant"
اذهب إلى التنقل
اذهب إلى البحث
جميل-بيلوني (نقاش | مساهمات) (تدقيق.) |
جميل-بيلوني (نقاش | مساهمات) ط (مراجعة وتدقيق.) |
||
| سطر 1: | سطر 1: | ||
| − | <noinclude>{{DISPLAYTITLE: تبديل | + | <noinclude>{{DISPLAYTITLE: تبديل الأعداد السحرية بثوابت رمزية (Replace Magic Number with Symbolic Constant)}}</noinclude> |
== المشكلة == | == المشكلة == | ||
| − | تستخدم الشيفرة البرمجية | + | تستخدم الشيفرة البرمجية عددًا له معنىً معين له.<syntaxhighlight lang="php"> |
function potentialEnergy($mass, $height) { | function potentialEnergy($mass, $height) { | ||
return $mass * $height * 9.81; | return $mass * $height * 9.81; | ||
| سطر 8: | سطر 8: | ||
== الحل == | == الحل == | ||
| − | استبدال هذا | + | استبدال هذا العدد بثابت له اسم يمكن قراءته ويشرح معنى العدد.<syntaxhighlight lang="php"> |
define("GRAVITATIONAL_CONSTANT", 9.81); | define("GRAVITATIONAL_CONSTANT", 9.81); | ||
| سطر 17: | سطر 17: | ||
== لم إعادة التصميم؟ == | == لم إعادة التصميم؟ == | ||
| − | + | العدد السحري هو القيمة العددية التي تتصادف في المصدر ولكن ليس لها معنىً واضح. ويجعل هذا "النمط المضاد" فهم البرنامج وإعادة تصميم الشيفرة البرمجية أمرًا صعبًا. | |
| − | ومع ذلك، تنشأ المزيد من الصعوبات عندما تحتاج إلى تغيير هذا | + | ومع ذلك، تنشأ المزيد من الصعوبات عندما تحتاج إلى تغيير هذا العدد السحري. ولن يعمل البحث والاستبدال مع هذا الأمر؛ قد يُستخدَم نفس العدد لأغراض مختلفة في أماكن مختلفة، مما يعني أنه سيتعين عليك التحقق من كل سطر من الشيفرة البرمجية التي تستخدم هذا العدد. |
== فوائد تطبيق الحل == | == فوائد تطبيق الحل == | ||
* يمكن أن يخدم الثابت الرمزي كتوثيق حي لمعنى قيمته. | * يمكن أن يخدم الثابت الرمزي كتوثيق حي لمعنى قيمته. | ||
| − | * من الأسهل بكثير تغيير قيمة ثابتٍ ما عن البحث عن هذا | + | * من الأسهل بكثير تغيير قيمة ثابتٍ ما عن البحث عن هذا العدد في مصدر الشيفرة البرمجية بأكمله، دون خطر تغيير نفس العدد المستخدم في مكان آخر لغرض مختلف بطريق الخطأ. |
| − | * تقليل الاستخدام المُكرَر | + | * تقليل الاستخدام المُكرَر لعدد أو سلسلة نصية في الشيفرة البرمجية. وهو مهم بشكل خاص عندما تكون القيمة معقدة وطويلة (مثل 3.14159 أو 0xCAFEBABE). |
== من الجيد أن نعرف == | == من الجيد أن نعرف == | ||
| سطر 33: | سطر 33: | ||
== البدائل == | == البدائل == | ||
| − | # في بعض الأحيان، يمكن استبدال | + | # في بعض الأحيان، يمكن استبدال العدد السحري باستدعاءات التابع. على سبيل المثال، إذا كان لديك عدد سحري يدل على عدد العناصر في مجموعة، فإنك لن تحتاج إلى استخدامه للتحقق من العنصر الأخير من المجموعة. وبدلًا من ذلك، يُستخدم التابع القياسي للحصول على طول المجموعة. |
# تُستخدم الأعداد السحرية أحيانُا كرموز للأنواع. لنفترض أنَّ لديك نوعين من المستخدمين وأنك تستخدم حقل عددي في صنف لتحديد كِلاهما: فيكون العدد <code>1</code> للمسؤولين والعدد <code>2</code> للمستخدمين العاديين. في هذه الحالة، يجب استخدام أحد توابع إعادة التصميم لتجنب رموز الأنواع: '''-''' [[Refactoring/replace type code with class|تبديل رموز الأنواع بالأصناف]]. '''-''' [[Refactoring/replace type code with subclasses|تبديل رموز الأنواع بالأصناف الفرعية]]. '''-''' [[Refactoring/replace type code with state strategy|تبديل رموز الأنواع بالحالة/الاستراتيجية]]. | # تُستخدم الأعداد السحرية أحيانُا كرموز للأنواع. لنفترض أنَّ لديك نوعين من المستخدمين وأنك تستخدم حقل عددي في صنف لتحديد كِلاهما: فيكون العدد <code>1</code> للمسؤولين والعدد <code>2</code> للمستخدمين العاديين. في هذه الحالة، يجب استخدام أحد توابع إعادة التصميم لتجنب رموز الأنواع: '''-''' [[Refactoring/replace type code with class|تبديل رموز الأنواع بالأصناف]]. '''-''' [[Refactoring/replace type code with subclasses|تبديل رموز الأنواع بالأصناف الفرعية]]. '''-''' [[Refactoring/replace type code with state strategy|تبديل رموز الأنواع بالحالة/الاستراتيجية]]. | ||
== آلية الحل == | == آلية الحل == | ||
| سطر 46: | سطر 46: | ||
== مصادر == | == مصادر == | ||
| − | * [https://refactoring.guru/replace-magic-number-with-symbolic-constant صفحة توثيق تبديل الأعداد السحرية بثوابت رمزية في موقع refactoring.guru]. [[تصنيف:Refactoring]] [[تصنيف:Refactoring Techniques]] [[تصنيف:Refactoring Organizing Data]] | + | * [https://refactoring.guru/replace-magic-number-with-symbolic-constant صفحة توثيق تبديل الأعداد السحرية بثوابت رمزية في موقع refactoring.guru]. [[تصنيف:Refactoring]] [[تصنيف:Refactoring Techniques]] [[تصنيف:Refactoring Organizing Data]] |
مراجعة 06:52، 21 نوفمبر 2018
المشكلة
تستخدم الشيفرة البرمجية عددًا له معنىً معين له.
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++) { ... }
البدائل
- في بعض الأحيان، يمكن استبدال العدد السحري باستدعاءات التابع. على سبيل المثال، إذا كان لديك عدد سحري يدل على عدد العناصر في مجموعة، فإنك لن تحتاج إلى استخدامه للتحقق من العنصر الأخير من المجموعة. وبدلًا من ذلك، يُستخدم التابع القياسي للحصول على طول المجموعة.
- تُستخدم الأعداد السحرية أحيانُا كرموز للأنواع. لنفترض أنَّ لديك نوعين من المستخدمين وأنك تستخدم حقل عددي في صنف لتحديد كِلاهما: فيكون العدد
1للمسؤولين والعدد2للمستخدمين العاديين. في هذه الحالة، يجب استخدام أحد توابع إعادة التصميم لتجنب رموز الأنواع: - تبديل رموز الأنواع بالأصناف. - تبديل رموز الأنواع بالأصناف الفرعية. - تبديل رموز الأنواع بالحالة/الاستراتيجية.
آلية الحل
- عرِّف ثابتًا وعيّن له قيمة العدد السحري.
- ابحث عن كل إِشارة للعدد السحري.
- لكل من الأعداد التي تجدها، تحقق مرتين من أن العدد السحري في هذه الحالة بالذات يتوافق مع الغرض من الثابت. إذا كان الجواب نعم، استبدل العدد بالثابت. هذه خطوة مهمة بما أن العدد نفسه قد يعني أشياء مختلفة تمامًا (ويستبدل مع ثوابت مختلفة بحسب الحالة).
انظر أيضًا
- تبديل رموز الأنواع بالأصناف.
- تبديل رموز الأنواع بالأصناف الفرعية.
- تبديل رموز الأنواع بالحالة/الاستراتيجية.