Clean Code-리터럴 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 달러를 소비하지만, 한 명 이상이있을 때 물과 음식을 사야한다면 더 많은 돈을 소비해야한다. 아마도 6 달러가 될 것이다. 코드를 변경 하고 리터럴 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은 완벽하게 의미가 있습니다.

그러나 persons.size ()가 0이면 어떻게됩니까? persons.getMoney()0과 2에서는 작동하지만 1 에서는 작동하지 않는 이상한 것처럼 보입니다 .

코드에 왜 특정 리터럴 값이 포함되어 있습니까?

• 이 값이 문제 영역 에서 특별한 의미가 있습니까?
• 아니면이 값은 구현 세부 사항 입니까?이 값은 주변 코드의 직접적인 결과입니까?

리터럴 값이 문맥에서 명확하지 않은 의미를 갖는 경우 예, 상수 또는 변수를 통해 해당 값의 이름을 지정하면 도움이됩니다. 나중에 원래 컨텍스트를 잊었을 때 의미있는 변수 이름을 가진 코드를 유지 관리하기가 더 쉽습니다. 코드의 대상은 주로 컴파일러가 아니며 (컴파일러는 끔찍한 코드로 즐겁게 작업 할 것입니다.) 코드의 미래 관리자는 코드가 다소 자기 설명 적인지 잘 알고 있습니다.

• 첫 번째 예에서와 같은 리터럴의 의미는 34, 4, 5문맥으로부터 명백하지 않다. 대신, 이러한 값 중 일부는 문제 영역에서 특별한 의미를 갖습니다. 그러므로 그들에게 이름을주는 것이 좋았습니다.

• 두 번째 예에서 리터럴의 의미 1는 문맥에서 매우 분명합니다. 이름을 소개하는 것은 도움이되지 않습니다.

실제로, 실제 값을 숨기므로 명백한 값의 이름을 도입하는 것도 좋지 않을 수 있습니다.

• 명명 된 값이 변경되거나 올바르지 않은 경우, 특히 관련이없는 코드에서 동일한 변수가 재사용되는 경우 버그가 사라질 수 있습니다.

• 코드는 특정 값에 대해서는 잘 작동하지만 일반적인 경우에는 올바르지 않을 수 있습니다. 불필요한 추상화를 도입함으로써 코드는 더 이상 정확하지 않습니다.

"명백한"리터럴에는 크기 제한이 없습니다. 이는 컨텍스트에 따라 달라지기 때문입니다. 예를 들어 리터럴 1024은 파일 크기 계산 31의 컨텍스트에서, 또는 해시 함수 padding: 0.5em의 컨텍스트에서 또는 리터럴 이 CSS 스타일 시트 의 컨텍스트에서 완전히 명확 할 수 있습니다 .

이 코드 조각에는 몇 가지 문제가 있으며, 다음과 같이 단축 할 수 있습니다.

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

1. 한 사람이 왜 특별한 경우인지는 확실하지 않습니다. 한 사람의 돈을받는 것이 여러 사람의 돈을 얻는 것과는 다르다는 특정 비즈니스 규칙이 있다고 가정합니다. 그러나, 나는 가서 모두 내부 봐야 getMoneyIfHasOnePerson하고 getMoney이 뚜렷한 경우 이유를 이해하는 기대.

2. 이름 getMoneyIfHasOnePerson이 맞지 않습니다. 이름에서 나는 한 사람이 있는지 확인하고,이 경우에는 그에게서 돈을 얻는 방법을 기대합니다. 그렇지 않으면 아무것도하지 마십시오. 코드에서 이것은 일어나고 있지 않습니다 (또는 조건을 두 번 수행하고 있습니다).

3. List<Money>컬렉션 이 아닌 반품해야 할 이유가 있습니까?

귀하의 질문으로 돌아 가면, 왜 한 사람에게 특별한 대우가 있는지 확실하지 않기 때문에 규칙을 명시 적으로 표현하는 다른 방법이 없다면 숫자를 상수로 대체해야합니다 . 여기서 하나는 다른 마법 번호와 크게 다르지 않습니다. 특별 대우가 1 명, 2 명 또는 3 명 또는 12 명 이상에게만 적용된다는 비즈니스 규칙이있을 수 있습니다.

최상의 솔루션을 선택하기 위해 컨텍스트를 어떻게 구별 할 수 있습니까?

코드를보다 명확하게 만드는 것은 무엇이든합니다.

실시 예 1

다음 코드를 상상해보십시오.

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

return this.processSequence(sequence);

여기서 0은 마법의 가치입니까? 코드는 다소 명확합니다. 시퀀스에 요소가 없으면 처리하지 말고 특수한 값을 반환하십시오. 그러나이 코드는 다음과 같이 다시 작성할 수도 있습니다.

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

return this.processSequence(sequence);

여기서는 더 이상 일정하지 않으며 코드가 더 명확합니다.

실시 예 2

다른 코드를 보자.

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

round(value, precision)과부하 가없는 JavaScript와 같은 언어에서 수행하는 작업을 이해하는 데 시간이 많이 걸리지 않습니다 .

이제 상수를 도입하려면 어떻게 호출합니까? 얻을 수있는 가장 가까운 용어는 Precision입니다. 그래서:

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

가독성이 향상됩니까? 그것은 수 있습니다. 여기서 상수의 값은 다소 제한되어 있으므로 리팩토링을 실제로 수행해야하는지 스스로에게 물어볼 수 있습니다. 여기서 좋은 점은 이제 정밀도가 한 번만 선언되므로 변경하면 다음과 같은 실수를 할 위험이 없다는 것입니다.

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

한 위치에서 값을 변경하고 다른 위치에서 값을 잊어 버립니다.

실시 예 3

이러한 예에서 숫자가 모든 경우 에 상수로 대체되어야한다는 인상을받을 수 있습니다 . 사실이 아닙니다. 경우에 따라 상수가 있다고해서 코드가 향상되지는 않습니다.

다음 코드를 보자.

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

0을 변수로 바꾸려고하면 의미있는 이름을 찾는 것이 어려울 것입니다. 이름을 어떻게 지정 하시겠습니까? ZeroPosition? Base? Default? 여기에 상수를 도입하면 코드가 향상되지 않습니다. 조금 더 길어질 것입니다.

그러나 그러한 경우는 드 rare니다. 따라서 코드에서 숫자를 찾을 때마다 코드를 리팩터링하는 방법을 찾으려고 노력하십시오. 숫자에 비즈니스 의미가 있는지 자문 해보십시오. 그렇다면 상수가 필수입니다. 아니면 번호를 어떻게 지정 하시겠습니까? 의미있는 이름을 찾으면 좋습니다. 그렇지 않은 경우 상수가 필요하지 않은 경우가 있습니다.

단일 매개 변수를 사용하고 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]);
    }
}  

내가 기본이 아니지만 자바 스크립트 개발자 일 경우 미안합니다. 나는 이것이 어떤 구성을 정당화했는지 잘 모르겠습니다. 모든 것이 배열이나 목록에 있어야 할 필요는 없지만 .length는 많은 의미가 있다고 생각합니다. 그리고 * 4는 그 기원이 모호하기 때문에 좋은 것을 일정하게 만들 것입니다.

그 숫자 1, 다른 숫자 일 수 있습니까? 2 또는 3 일 수 있습니까, 아니면 1이어야하는 논리적 이유가 있습니까? 1이어야한다면 1을 사용하는 것이 좋습니다. 그렇지 않으면 상수를 정의 할 수 있습니다. 그 상수를 ONE이라고 부르지 마십시오. (나는 그것을 보았다).

분당 60 초-상수가 필요합니까? 음, 그것은 이다 60초,하지 (50) 또는 (70) 그리고 모두가 그것을 알고있다. 그래서 그것은 숫자를 유지할 수 있습니다.

페이지 당 60 개의 항목이 인쇄되었습니다.이 수는 59 또는 55 또는 70 일 수 있습니다. 실제로 글꼴 크기를 변경하면 55 또는 70이 될 수 있습니다. 따라서 여기에는 의미있는 상수가 더 필요합니다.

의미가 얼마나 명확한 지 또한 중요합니다. "분 = 초 / 60"이라고 쓰면 분명합니다. "x = y / 60"이라고 쓰면 명확하지 않습니다. 가 있어야합니다 몇 가지 의미있는 이름 어딘가에.

하나의 절대 규칙이 있습니다. 절대 규칙이 없습니다. 실제로는 숫자를 사용할 때와 명명 된 상수를 사용할 때를 알아냅니다. 책이 그렇게 말하는 이유를 이해하기 전까지는 그렇게하지 마십시오.

DB 검색의 (수정 된) OP와 같이 상당한 양의 코드를 보았습니다. 쿼리는 목록을 반환하지만 비즈니스 규칙에 따르면 하나의 요소 만있을 수 있습니다. 그리고 물론, '이 경우 하나'에 대해 무언가가 하나 이상의 항목이있는 목록으로 변경되었습니다. (예, 나는 꽤 많은 시간을 말했다. 그것은 거의 ... 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;
}