냄새 6. 가변 데이터 (Mutable Data)

데이터를 변경하다보면 예상치 못했던 결과나 해결하기 어려운 버그가 발생하기도 한다.
함수형 프로그래밍 언어는 데이터를 변경하지 않고 복사본을 전달한다. 하지만 그밖의 프로그래밍 언어는 데이터 변경을 허용하고 있다. 따라서 변경되는 데이터 사용 시 발생할 수 있는 리스크(Side Effect)를 관리할 수 있는 방법을 적용하는 것이 좋다.

리팩토링 18. 변수 쪼개기 (Split Variable)

한 변수가 하나의 역할만 하도록 이름을 분리하고 변수를 나눠주는 리팩토링이다.
어떤 변수가 여러번 재할당 되어도 적절한 경우
- 반복문에서 순회하는데 사용하는 변수 또는 인덱스
- 값을 축적시키는데 사용하는 변수
그밖에 경우에 재할당 되는 변수가 있다면 해당 변수는 여러 용도로 사용되는 것이며 변수를 분리해야 더 이해하기 좋은 코드를 만들 수 있다.
- 변수 하나 당 하나의 책임(Responsibility)을 지도록 만든다.
- 상수를 활용하자. (자바스크립트의 const, 자바의 final)

예제

Rectangle
- 위의 변수 temp→perimeter, 아래의 temp→area 변경해주면 의미해주는 바가 명확해져 가독성이 좋아진다.
- 변수 쪼개기 리팩토링은 IDE의 도움을 받기 힘든 경우가 있지만 그 효과는 대단하다. (가독성 ↑)
- double final perimeter로 final을 사용하면 의미가 조금 더 명확해진다.
- 리팩토링 후 바로 테스트를 돌려 확인해가며 리팩토링을 진행한다.
```
public class Rectangle {
```
private double perimeter; private double area;

public void updateGeometry(double height, double width) { double temp = 2 * (height + width); System.out.println("Perimeter: " + temp); perimeter = temp;
```
temp = height * width;
System.out.println("Area: " + temp);
this.area = temp;
```
} ... }

Haggis
- acc 가 다른 계산에 두 번 사용되었기 때문에, primaryAcceleration과 secondaryAcceleration으로 변수를 쪼개주면 변수의 의미가 조금 더 명확해진다.
- result는 값이 추가되는 변수이기 때문에 사용이 옳다고 판단한다.
```
public class Haggis {
```
private double primaryForce; private double secondaryForce; private double mass; private int delay;

public Haggis(double primaryForce, double secondaryForce, double mass, int delay) { ... }

public double distanceTravelled(int time) { double result; double acc = primaryForce / mass; int primaryTime = Math.min(time, delay); result = 0.5 acc primaryTime * primaryTime;
```
int secondaryTime = time - delay;
if (secondaryTime > 0) {
    double primaryVelocity = acc * delay;
    acc = (primaryForce + secondaryForce) / mass;
    result += primaryVelocity * secondaryTime + 0.5 * acc * secondaryTime + secondaryTime;
}

return result;
```
}

Order
- inputValue의 중복된 사용으로 가독성이 떨어져 새로운 변수 result를 추가하도록 하자.

public class Order {

    public double discount(double inputValue, int quantity) {
        if (inputValue > 50) inputValue = inputValue - 2;
        if (quantity > 100) inputValue = inputValue - 1;
        return inputValue;
    }
}

리팩토링 19. 질의 함수와 변경 함수 분리하기 (Separate Query from Modifier)

“눈에 띌만한” 사이드 이팩트 없이 값을 조회할 수 있는 메소드는 테스트 하기도 쉽고, 메소드를 이동하기도 편하다.
명령-조회 분리 (command-query separation) 규칙:
- 어떤 값을 리턴하는 함수는 사이드 이팩트가 없어야 한다.
“눈에 띌만한 (observable) 사이드 이팩트”
- 가령, 캐시는 중요한 객체 상태 변화는 아니다. 따라서 어떤 메소드 호출로 인해, 캐시 데이터를 변경하더라도 분리할 필요는 없다.

예제

변경 전 (Billing)
- 조회와 변경을 getTotalOutstandingAndSendBill()에서 실행하고 있다.
- 조회는 조회로, 변경은 변경으로 분리해낸다.
```
public class Billing {
...
```
public Billing(Customer customer, EmailGateway emailGateway) { this.customer = customer; this.emailGateway = emailGateway; }

public double getTotalOutstandingAndSendBill() { double result = customer.getInvoices().stream() .map(Invoice::getAmount) .reduce((double) 0, Double::sum); sendBill(); return result; }

private void sendBill() { emailGateway.send(formatBill(customer)); } ... }

변경 후 (Billing)

public class Billing {
...

    public Billing(Customer customer, EmailGateway emailGateway) {
        this.customer = customer;
        this.emailGateway = emailGateway;
    }

    public double totalOutstanding() {
        return customer.getInvoices().stream()
                .map(Invoice::getAmount)
                .reduce((double) 0, Double::sum);
    }

    public void sendBill() {
        emailGateway.send(formatBill(customer));
    }
...
}

변경 전 (Criminal)
- modifier와 query가 한 메소드에 있으면 테스트하기도 어렵다.
- for문과 if문의 중첩을 분리해준다.

public class Criminal {

    public String alertForMiscreant(List<Person> people) {
        for (Person p : people) {
            if (p.getName().equals("Don")) {
                setOffAlarms();
                return "Don";
            }

            if (p.getName().equals("John")) {
                setOffAlarms();
                return "John";
            }
        }

        return "";
    }

    private void setOffAlarms() {
        System.out.println("set off alarm");
    }
}

변경 후 (Criminal)

public class Criminal {

    public void alertForMiscreant(List<Person> people) {
        if (!findMiscreant(people).isBlank())
            setOffAlarms();
    }

    public String findMiscreant(List<Person> people) {
        for (Person p : people) {
            if (p.getName().equals("Don")) {
                return "Don";
            }

            if (p.getName().equals("John")) {
                return "John";
            }
        }

        return "";
    }

    private void setOffAlarms() {
        System.out.println("set off alarm");
    }
}

리팩토링 20. 세터 제거하기 (Remove Setting Method)

세터를 제공한다는 것은 해당 필드가 변경될 수 있다는 것을 뜻한다. (세터를 쓸 수 있는 시점에는 언제든지)
객체 생성시 처음 설정된 값이 변경될 필요가 없다면 해당 값을 설정할 수 있는 생성자를 만들고 세터를 제거해서 변경될 수 있는 가능성을 제거해야 한다.

예제

변경 전
- "id"는 초기에 설정한 값을 계속 유지하고 싶다고 가정해보자.
- 생성자 주입으로 해결할 수 있다.

public class Person {

    private String name;

    private int id;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }
}

변경 후

public class Person {

    private String name;

    private int id;

    public Person(int id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getId() {
        return id;
    }
}

리팩토링 21. 파생 변수를 질의 함수로 바꾸기 (Replace Derived Variable with Query)

변경할 수 있는 데이터를 최대한 줄이도록 노력해야 한다.
계산해서 알아낼 수 있는 변수는 제거할 수 있다.
- 계산 자체가 데이터의 의미를 잘 표현하는 경우도 있다.
- 해당 변수가 어디선가 잘못된 값으로 수정될 수 있는 가능성을 제거할 수 있다.
계산에 필요한 데이터가 변하지 않는 값(불변)이라면, 계산의 결과에 해당하는 데이터 역시 불변 데이터기 때문에 해당 변수는 그대로 유지할 수 있다. (이런 경우 리팩토링이 굳이 필요 없다.)

예제

변경 전 (Discount)
- discountedTotal은 discount와 baseTotal로부터 derived된 값이다.
- setDiscount() 호출 전에 getDiscount()를 호출하면 discountedTotal의 값이 계산 전의 가격이 출력될 것이다.
- getDiscount()의 첫째 줄에 "assert this.discountedTotal == this.baseTotal - thi.discount;" 를 입력한다.
  - 변경 후 참조

public class Discount {

    private double discountedTotal;

    private double discount;
    private double baseTotal;

    public Discount(double baseTotal) {
        this.baseTotal = baseTotal;
    }

    public double getDiscountedTotal() {
        return this.discountedTotal;
    }

    public void setDiscount(double number) {
        this.discount = number;
        this.discountedTotal = this.baseTotal - this.discount;
    }
}

변경 후 (Discount)

public class Discount {

    private double discount;
    private double baseTotal;

    public Discount(double baseTotal) {
        this.baseTotal = baseTotal;
    }

    public double getDiscountedTotal() {
        return this.baseTotal - this.discount;
    }

    public void setDiscount(double number) {
        this.discount = number;
    }
}

변경 전 (ProductionPlan)
- 마찬가지로 production을 리팩토링할 여지가 있다.
- 먼저 함수로 빼내보고 테스트를 돌려 올바르게 동작하는지 확인한다.
- derived 변수와 바꿔주고 inline 리팩토링해준다.

public class ProductionPlan {

    private double production;
    private List<Double> adjustments = new ArrayList<>();

    public void applyAdjustment(double adjustment) {
        this.adjustments.add(adjustment);
        this.production += adjustment;
    }

    public double getProduction() {
        return this.production;
    }
}

변경 후 (ProductionPlan)

public class ProductionPlan {

    private List<Double> adjustments = new ArrayList<>();

    public void applyAdjustment(double adjustment) {
        this.adjustments.add(adjustment);
    }

    public double getProduction() {
        return this.adjustments.stream()
                .mapToDouble(Double::valueOf).sum();
//                reduce((double) 0, Double::sum);
    }
}

리팩토링 22. 여러 함수를 변환 함수로 묶기 (Combine Functions into Transform)

관련있는 여러 파생 변수를 만들어내는 함수가 여러곳에서 만들어지고 사용된다면 그러한 파생 변수를 “변환 함수 (transform function)”를 통해 한 곳으로 모아둘 수 있다.
소스 데이터가 변경될 수 있는 경우에는“여러 함수를 클래스로 묶기 (Combine Functions into Class)”를 사용하는 것이 적절하다.
소스 데이터가 변경되지 않는 경우에는 두 가지 방법을 모두 사용할 수 있지만, 변환 함수 를 사용해서 불변 데이터의 필드로 생성해 두고 재사용할 수도 있다.

여러 함수를 클래스로 묶기
- 소스에 해당하는 데이터가 변경될 여지가 있는 - 클래스로 묶는게 타당 : 매개변수가 많은 경우에 클래스로 묶기 했었지.
- 변경될 값을 필드로 하고 메소드로 그 필드를 매번 참조해서 리턴하면 된다.
- 파생된 변수를 해당하는 클래스에 만들면 된다. derived도 쿼리로 묶었잖아. 결국 메소드들 모아서 클래스
여러 함수를 transform으로 묶기
- 변환함수로 불변한 필드로 만들어도 된다.
- 소스에 해당하는 데이터가 변경될 여지가 있는 경우에는 적절한 방법이 아니다.

리팩토링 23. 참조를 값으로 바꾸기 (Change Reference to Value)

레퍼런스 (Reference) 객체 vs 값 (Value) 객체
- https://martinfowler.com/bliki/ValueObject.html
- “Objects that are equal due to the value of their properties, in this case their x and y coordinates, are called value objects.”
- 값 객체는 객체가 가진 필드의 값으로 동일성을 확인한다.
- 값 객체는 변하지 않는다.
- 어떤 객체의 변경 내역을 다른 곳으로 전파시키고 싶다면 레퍼런스, 아니라면 값 객체를 사용한다.
  - Reference Object : 객체 내부의 값이 언제든 변할 수 있는 객체
  - Value Object : 객체의 동일성은 객체가 가진 필드의 값들로 판단하는 값 객체 (불변 객체)

예제

TelephoneNumber 는 바뀔 여지가 있다. (Setter도 존재)

public class TelephoneNumber {

    private String areaCode;

    private String number;

    public String areaCode() {
        return areaCode;
    }

    public void areaCode(String areaCode) {
        this.areaCode = areaCode;
    }

    public String number() {
        return number;
    }

    public void number(String number) {
        this.number = number;
    }
}

만약 이를 VO로 바꾸고 싶다고 한다면 다음과 같이 변경하면 된다.
- 생성자 생성
- final 키워드 추가
- setter 삭제
- equals(), hashcode() 추가
  - TelephoneNumber가 콜랙션에 들어갈 때 값이 같으면 hashcode도 같아야 올바르기 때문이다.

public class TelephoneNumber {

    private final String areaCode;
    private final String number;

    public TelephoneNumber(String areaCode, String number) {
        this.areaCode = areaCode;
        this.number = number;
    }

    public String areaCode() {
        return areaCode;
    }

    public String number() {
        return number;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        TelephoneNumber that = (TelephoneNumber) o;
        return Objects.equals(areaCode, that.areaCode) && Objects.equals(number, that.number);
    }

    @Override
    public int hashCode() {
        return Objects.hash(areaCode, number);
    }
}

사실 Java 14 이후부터 제공하는 기능인 record를 사용하면 위와 같은 기능을 동일하게 제공할 수 있다.

tonykang22 / study

[Refactoring] 냄새 6. 가변 데이터 #12

냄새 6. 가변 데이터 (Mutable Data)

관련 리팩토링

리팩토링 18. 변수 쪼개기 (Split Variable)

예제

리팩토링 19. 질의 함수와 변경 함수 분리하기 (Separate Query from Modifier)

예제

리팩토링 20. 세터 제거하기 (Remove Setting Method)

예제

리팩토링 21. 파생 변수를 질의 함수로 바꾸기 (Replace Derived Variable with Query)

예제

리팩토링 22. 여러 함수를 변환 함수로 묶기 (Combine Functions into Transform)

리팩토링 23. 참조를 값으로 바꾸기 (Change Reference to Value)

예제