クリーンコード-リテラル1を定数に変更する必要がありますか？

マジックナンバーを避けるために、リテラルに意味のある名前を付ける必要があるとよく耳にします。といった：

//THIS CODE COMES FROM THE CLEAN CODE BOOK
for (int j = 0; j < 34; j++) {
    s += (t[j] * 4) / 5;
}

-------------------- Change to --------------------

int realDaysPerIdealDay = 4;
const int WORK_DAYS_PER_WEEK = 5;
int sum = 0;
for (int j = 0; j < NUMBER_OF_TASKS; j++) {
    int realTaskDays = taskEstimate[j] * realDaysPerIdealDay;
    int realTaskWeeks = (realdays / WORK_DAYS_PER_WEEK);
    sum += realTaskWeeks;
}

私はこのようなダミーメソッドを持っています：

説明：提供する人のリストがあり、デフォルトでは食べ物だけを買うために5ドルを費やしていると思いますが、複数の人がいる場合、水と食べ物を買う必要があります。コードを変更します。リテラル1に注目してください。それについての質問です。

public int getMoneyByPersons(){
    if(persons.size() == 1){ 
        // TODO - return money for one person
    } else {
        // TODO - calculate and return money for people.
    }

}

友達にコードをレビューするように頼んだとき、1人は値1に名前を付けるときれいなコードが得られると言い、もう1人は値が意味があるのでここに定数名は必要ないと言った。

したがって、私の質問は、リテラル値1に名前を付ける必要がありますか？値はいつ魔法の数であり、そうでないのですか？コンテキストを区別して最適なソリューションを選択するにはどうすればよいですか？

いいえ。その例では、1は完全に意味があります。

ただし、persons.size（）がゼロの場合はどうなりますか？persons.getMoney()0と2で機能するが1では機能しない奇妙なようです。

なぜコードにはその特定のリテラル値が含まれているのですか？

• この値は問題のあるドメインで特別な意味を持ちますか？
• または、この値は単なる実装の詳細であり、その値は周囲のコードの直接的な結果ですか？

リテラル値がコンテキストから明確でない意味を持っている場合、はい、その値に定数または変数を介して名前を付けると役立ちます。後で、元のコンテキストが忘れられると、意味のある変数名を持つコードの保守性が高まります。コードの対象者は、主にコンパイラーではありません（コンパイラーは恐ろしいコードを喜んで処理します）が、そのコードの将来のメンテナーです。

• あなたの最初の例では、などのリテラルの意味は34、4、5文脈から明らかではありません。代わりに、これらの値の一部は、問題の領域で特別な意味を持ちます。したがって、彼らに名前を付けるのは良かったです。

• 2番目の例では、リテラルの意味は1コンテキストから非常に明確です。名前の紹介は役に立ちません。

実際、明らかな値に名前を付けると、実際の値が隠されるため、悪い場合もあります。

• これにより、特に同じ変数が関連のないコード部分で再利用される場合、名前付きの値が変更されたり間違っていたりすると、バグがわかりにくくなる可能性があります。

• コードの一部は特定の値に対しては正常に機能する場合もありますが、一般的な場合は正しくない場合があります。不要な抽象化を導入することにより、コードは明らかに正しくなくなります。

「明白な」リテラルにはサイズの制限はありません。これはコンテキストに完全に依存するためです。たとえば、リテラル1024は、ファイルサイズの計算のコンテキストでは完全に明白で31あり、ハッシュ関数のコンテキストではリテラルpadding: 0.5emであり、CSSスタイルシートのコンテキストではリテラルです。

このコードにはいくつかの問題がありますが、これは次のように短縮できます。

public List<Money> getMoneyByPersons() {
    return persons.size() == 1 ?
        moneyService.getMoneyIfHasOnePerson() :
        moneyService.getMoney(); 
}

1. 1人が特別なケースである理由は不明です。ある人からお金を得るのは、複数の人からお金を得るのとは根本的に異なるという特定のビジネスルールがあると思います。しかし、私は、との両方を調べて、なぜ個別のケースがあるのか​​を理解したいgetMoneyIfHasOnePersonとgetMoney考えています。

2. 名前getMoneyIfHasOnePersonが正しくありません。名前から、このメソッドが1人の人物がいるかどうかを確認し、そうであれば、彼からお金を得ることが期待されます。それ以外の場合は、何もしません。あなたのコードから、これは起こっていることではありません（または、条件を2回実行しています）。

3. List<Money>コレクションではなくを返す理由はありますか？

戻るあなたの質問に、ので、一人のための特別な治療法があり、なぜそれが不明である、数字1は、定数に置き換える必要がある場合を除き、ルールを明示的にする別の方法があります。ここで、1つは他のマジックナンバーと大差ありません。特別な待遇は1人、2人、3人、または12人以上にのみ適用されるというビジネスルールがあります。

コンテキストを区別して最適なソリューションを選択するにはどうすればよいですか？

コードをより明確にするために何でもします。

例1

次のコードを想像してください。

if (sequence.size() == 0) {
    return null;
}

return this.processSequence(sequence);

ここでゼロは魔法の値ですか？コードはかなり明確です。シーケンスに要素がない場合は、処理せずに特別な値を返しましょう。ただし、このコードは次のように書き換えることもできます。

if (sequence.isEmpty()) {
    return null;
}

return this.processSequence(sequence);

ここでは、これ以上定数はなく、コードはさらに明確です。

例2

別のコードを取得します。

const result = Math.round(input * 1000) / 1000;

JavaScriptなどのround(value, precision)オーバーロードのない言語で何をするのかを理解するのに時間がかかりません。

さて、定数を導入したい場合、どのように呼び出されますか？取得できる最も近い用語はPrecisionです。そう：

const precision = 1000;
const result = Math.round(input * precision) / precision;

可読性が向上しますか？それは可能性があります。ここで、定数の値はかなり制限されており、リファクタリングを本当に実行する必要があるかどうかを自問することができます。ここでの良い点は、精度が1回だけ宣言されるようになったことです。したがって、変更しても、次のような間違いを犯すリスクはありません。

const result = Math.round(input * 100) / 1000;

1つの場所で値を変更し、他の場所でそれを行うのを忘れます。

例3

これらの例から、数字はすべての場合に定数に置き換えられるべきであるという印象を持つかもしれません。本当じゃない。状況によっては、定数を使用してもコードが改善されないことがあります。

次のコードを取得します。

class Point
{
    ...
    public void Reset()
    {
        x, y = (0, 0);
    }
}

ゼロを変数で置き換えようとすると、意味のある名前を見つけることが困難になります。どう名前をつけますか？ZeroPosition？Base？Default？ここで定数を導入しても、コードはまったく強化されません。それはわずかに長くなり、それだけになります。

ただし、そのようなケースはまれです。そのため、コードで数字を見つけたときはいつでも、コードをリファクタリングする方法を見つけようと努力してください。番号にビジネス上の意味があるかどうかを自問してください。はいの場合、定数は必須です。いいえの場合、どのように番号を付けますか？意味のある名前を見つけたら、それは素晴らしいことです。そうでない場合は、定数が不要な場合があります。

単一のパラメーターを取り、4を5で割った値を返す関数を作成することで、最初の例を使用しながら、その機能に明確なエイリアスを提供できます。

私は自分の通常の戦略を提供しているだけですが、多分何かを学ぶでしょう。

私が考えているのは。

// Just an example name  
function normalize_task_value(task) {  
    return (task * 4) / 5;  // or to `return (task * 4) / NUMBER_OF_TASKS` but it really matters what logic you want to convey and there are reasons to many ways to make this logical. A comment would be the greatest improvement

}  

// Is it possible to just use tasks.length or something like that?  
// this NUMBER_OF_TASKS is the only one thats actually tricky to   
// understand right now how it plays its role.  

function normalize_all_task_values(tasks, accumulator) {  
    for (int i = 0; i < NUMBER_OF_TASKS; i++) {  
        accumulator += normalize_task_value(tasks[i]);
    }
}  

私がベースを離れていても申し訳ありませんが、私はただのJavaScript開発者です。私がこれを正当化した構成がわからない。すべてが配列またはリストにある必要はないが、.lengthが多くの意味をなすと思う。そして* 4は、その起源が曖昧であるため、良い定数になります。

その番号1、別の番号でしたか？2、3、または1でなければならない論理的な理由はありますか？1でなければならない場合は、1を使用しても問題ありません。それ以外の場合は、定数を定義できます。その定数ONEを呼び出さないでください。（私はそれを見ました）。

1分で60秒-定数が必要ですか？まあ、それは 50秒や70秒ではなく、60秒です。そして誰もがそれを知っています。だから、それは数字を維持することができます。

1ページあたり60個のアイテムが印刷されます。その数は簡単に59または55または70だったはずです。実際、フォントサイズを変更すると、55または70になる可能性があります。

また、その意味がいかに明確であるかも問題です。「分=秒/ 60」と書くと、それは明らかです。「x = y / 60」と書くと、それは明らかではありません。どこかに意味のある名前がなければなりません。

絶対ルールが1つあります。絶対ルールはありません。練習すれば、いつ数字を使用するか、いつ名前付き定数を使用するかがわかります。本がそう言うので、それをしないでください-それがなぜそれを言うかを理解するまで。

DB取得の（変更された）OPのようなかなりの量のコードを見てきました。クエリはリストを返しますが、ビジネスルールでは要素は1つしか存在できないとされています。そして、もちろん、「この1つのケース」のために、複数の項目を持つリストに何かが変更されました。（ええ、私はかなりの回数言った。それはほとんど彼らのようだ... nm）

したがって、定数を作成するのではなく、（クリーンコードメソッドで）名前を指定するメソッドを作成するか、条件の検出対象を明確にします（検出方法をカプセル化します）。

public int getMoneyByPersons(){
  if(isSingleDepartmentHead()){ 
    // TODO - return money for one person
  } else {
    // TODO - calculate and return money for people.
  }
}

public boolean isSingleDepartmentHead() {
   return persons.size() == 1;
}