공부 기록

잘 설계된 컴포넌트는 모든 내부 구현을 완벽히 숨겨, 구현과 API를 깔끔히 분리한다. 오직 API를 통해서만 다른 컴포넌트와 소통하며 서로의 내부 동작 방식에는 전혀 개의치 않는다. 정보 은닉, 혹은 캡슐화라고 하는 이 개념은 소프트웨어 설계의 근간이 되는 원리다

자바는 정보 은닉을 위한 다양한 장치를 제공한다. 그중 접근 제어 메커니즘은 클래스, 인터페이스, 멤버의 접근 허용 범위를 명시한다.

접근 제어 매커니즘을 쉽게 말하자면 모든 클래스와 멤버의 접근성을 가능한 한 좁혀야 한다는 원리이다.

가장 바깥의 클래스를 톱레벨 클래스라고 할 때, 이 톱 레벨 클래스의 인터페이스에 부여할 수 있는 접근 수준은 package-private(default)과 public 두 가지다.

톱레벨 클래스나 인터페이스 를 public으로 선언하면 공개 API가 되며, package-private으로 선언하면 해당 패키지 안에서만 이용할 수 있다.

패키지 외부에서 쓸 이유가 없다면 package-private으로 선언하자. 그러면 내부 구현이 되어 언제든 수정할 수 있다. 하지만, public으로 선언하게 되면 공개 API가 되므로 하위 호환을 위해 영원히 관리해줘야만 한다. (public 클래스는 그 패키지의 API인 반면, package-private 톱레벨 클래스는 내부 구현이기 때문)

한 클래스에서만 사용하는 package-private 톱레벨 클래스나 인터페이스는 이를 사용하는 클래스 안에 private static으로 중첩시켜보자(아이템 24). => private static inner class 로 만들자. (톱 레벨로 두면 같은 패키지의 모든 클래스가 접근할 수 있지만, private static 으로 중첩시키면 바깥 클래스 하나에서만 접근할 수 있기 때문)

멤버(필드, 메서드, 중첩 클래스, 중첩 인터페이스)에 부여할 수 있는 접근 수 준은 네 가지다. 접근 범위가 좁은 것부터 보면,

• private： 멤버를 선언한 톱레벨 클래스에서만 접근할 수 있다.
• package-private(default)： 멤버가 소속된 패키지 안의 모든 클래스에서 접근할 수 있다.
• protected： package-private의 접근 범위를 포함하며, 이 멤버를 선언한 클래스의 하위 클래스에서도 접근할 수 있다
• public： 모든 곳에서 접근할 수 있다 (인터페이스 멤버는 default가 public이다)

private과 package-private 멤버는 모두 해당 클래스의 구현에 해당하므로 보통은 공개 API에 영향을 주지 않는다. 단, Serializable을 구현한 클래스에서는 그 필드들도 의도치 않게 공개 API가 될 수도 있다(아이템 86,87).

public 클래스의 protected 멤버 또한 공개 API이므로 영원히 지원돼야 한다. 또한 내부 동작 방식을 API 문서에 적어 사용자에게 공개해야 할 수도 있다(아이템 19). 따라서 protected 멤버의 수는 적을수록 좋다.

그런데 멤버 접근성을 좁히지 못하게 방해하는 제약이 하나 있다. 상위 클래스의 메서드를 재정의할 때는 그 접근 수준을 상위 클래스에서 보다 좁게 설정 할 수 없다는 것이다. 이 제약은 상위 클래스의 인스턴스는 하위 클래스의 인스턴스로 대체해 사용할 수 있어야 한다는 규칙(리스코프 치환 원칙, 아이템 10)을 지키기 위해 필요하다. 이 규칙을 어기면 하위 클래스를 컴파 일할 때 컴파일 오류가 난다. 클래스가 인터페이스를 구현하는 건 이 규칙의 특별한 예로 볼 수 있고, 이때 클래스는 인터페이스가 정의한 모든 메서드를 public으로 선언해야 한다.

단지 코드를 테스트하려는 목적으로 클래스, 인터페이스, 멤버의 접근 범위 를 넓힐 때에는, public 클래스의 private 멤버를 package-private까지 풀어주는 것은 허용할 수 있지만, 그 이상은 하지 않도록 하자. (테스트 코드를 테스트 대상과 같은 패키지에 두면 package-private 요소에 접근할 수 있으니까 굳이 더 열어주지 않아도 된다)

public 클래스의 인스턴스 필드는 되도록 public이 아니어야 한다(아이템 16). 하지만 상수라면 public static final 필드로 공개해도 좋다.

길이가 0이 아닌 배열은 모두 변경 가능하니 주의하자. 따라서 클래스에서 public static final 배열 필드를 두거나 이 필드를 반환하는 접근자 메서드를 제공해서는 안 된다. 이런 필드나 접근자를 제공한다면 클라이언트에서 그 배열 의 내용을 수정할 수 있게 된다. 

public static final Thing[] VALUES = { ... };

이 경우 해결 방법은 2가지가 있다.

1) 앞 코드의 public 배열을 private으로 만들고 public 불변 리스트를 추가

private static final Thing[] PRIVATE_VALUES = { ... }; 
public static final List<Thing> VALUES = Collections.unmodifiableList(Arrays.asList(PRIVATE_VALUES));

2) 배열을 private으로 만들고 그 복사본을 반환하는 public 메서드를 추가하는 방법(방어적 복사)

private static final Thing[] PRIVATE_VALUES = { ... }; 
public static final Thing[] values() { return PRIVATE_VALUES.clone(); }

자바 9부터는 모듈 시스템이라는 개념이 도입되면서 두 가지 암묵적 접근 수준이 추가되었다.

패키지가 클래스들의 묶음이듯, 모듈은 패키지들의 묶음이다.

모듈은 자신에 속하는 패키지 중 공개(export)할 것들을 선언하는데, protected 혹은 public 멤버라도 해당 패키지를 공개하지 않았다면 모듈 외부에서는 접근할 수 없다. (모듈 안에서는 exports로 선언했는지 여부에 영향X)

모듈 시스템을 활용 하면 클래스를 외부에 공개하지 않으면서도 같은 모듈을 이루는 패키지 사이에서는 자유롭게 공유할 수 있다.

모듈에 적용되는 새로운 두 접근 수준은 매우 주의하도록 하자.

만약 모듈의 JAR 파일을 자신의 모듈 경로가 아닌 애플리케이션의 클래스패스(classpath)에 두면 그 모듈 안의 모든 패키지는 마치 모듈이 없는 것처럼 행동한다. 즉, 모듈이 공개했는지 여부와 상관없이 public 클래스가 선언한 모든 public 혹은 protected 멤버를 모듈 밖에서도 접근할 수 있게 된다. => 새로 등장한 이 접근 수준을 적극 활용한 대표적인 예가 바로 JDK 자체이다. (자바 라이브러리에서 공개하지 않은 패키지들은 해당 모듈 밖에서는 절대로 접근 불가하다.)

public 클래스의 경우 필드를 public으로 두지 말고, 모두 private + public 접근자(getter)를 추가하도록 하자.

특히 절대 가변 필드를 직접 노출해서는 안 된다. 불변 필드라면 노출해도 덜 위험하지만 완전히 안심할 수는 없다.

package-private 클래스 혹은 private 중첩 클래스의 경우는 데이터 필드를 노출하더라도 문제 없다.

클라이언트 코드가 이 클래스 내부 표현에 묶이기는 하나, 클라이언트도 어차피 이 클래스를 포함하는 패키지 안에서만 동작하는 코드이기 때문이다.

따라서 패키지 바깥 코드는 전혀 손대지 않고도 데이터 표현 방식을 바꿀 수 있다.

private 중첩 클래스의 경우 라면 수정 범위가 더 좁아져서 이 클래스를 포함하는 외부 클래스까지로 제한 된다.

언뜻 보면 public 에서 바로 접근해서 고치나 private+public 접근자로 setXX형태로 고치나 결국 로직상으로는 동일하다고 느껴질 수 있다.

public class Point {
    public int x;
    public int y;
}

public class Point {
    private int x;
    private int y;

    public void setX(int x) {
        this.x = x;
    }

    public void setY(int y) {
        this.y = y;
    }
}

위의 방식처럼 point.x = 10 으로 설정하는 것과 아래와 같이 point.setX(10) 으로 설정하는 것이

결국 로직상으로는 동일한데, 왜 다들 안된다고 하는 것인지.. 궁금해져서 조금 알아 보았다.

1) 동작의 캡슐화 - 나중에 더 쉽게 추가 기능(유효성 검사 등)을 추가 할 수 있다

   public void setSpeed(int speed) {
     if ( speed > 100 ) {
       this.speed = 100;
     } else {
       this.speed = speed;
     }
   }

2) 대체 표현(setX)을 사용하여 속성을 노출하는 동안 속성의 내부 표현(x)을 숨긴다 -> 구현 변경 사항을 숨길 수 있다.

- before

      private boolean alive = true;

      public boolean isAlive() { return alive; }
      public void setAlive(boolean alive) { this.alive = alive; }

- after

      private int hp; // change!

      public boolean isAlive() { return hp > 0; } // old signature 
      //method looks the same, no change in client code
      public void setAlive(boolean alive) { this.hp = alive ? 100 : 0; }

3) getter와 setter는 polymorphic하고 필드는 그렇지 않다.

      public class Animal{
        public void setSound(Animal a) {

          if (a instanceof Dog) {         // Checking animal type
            System.out.println("Bark");
          } else if (a instanceof Cat) {     // Checking animal type
            System.out.println("Meowww");
          }
        }
      }

4) getter / setter가 값이 아닌 `람다식으로 전달`될 수 있다.
5) getter / setter에 `서로 다른 액세스 수준을 허용` 할 수 있다.
6) getter / setter에 대해 `lazyloading`이 가능해진다.
7) `디버깅`이 편리해진다. (중단 점을 여러 필드 참조에서 걸지 않고 하나의 메서드에만 걸면 되니까)

여러 장점들이 있지만 한 줄로 정리하자면, 추상화와 캡슐화가 setter을 사용하는 가장 큰 이유인 것 같다.
(그치만 뒷 장에서도 나오듯이 setter도 결국 필드 값을 바꾸는 것이기 때문에 사용을 자제 해야겠다)

자바 플랫폼 라이브러리에도 public 클래스의 필드를 직접 노출하지 말라는 규칙을 어기는 사례가 종종 있다.

1) java.awt.package.Point

2) java.awt.package.Dimension

Point를 상속하는 PointExtension 클래스를 만들어 봤다.

package com.example.sypark9646.item16;

import java.awt.Point;

public class PointExtension extends Point {
    double x, y;
}

    @DisplayName("java.awt.package.Point 상속 테스트")
    @Test
    void pointExtensionTest() {
        PointExtension pointExtension = new PointExtension();
        System.out.println(pointExtension.x + "" + pointExtension.y);

        // pointExtension.x = 10;
        // pointExtension.y = 10;
        pointExtension.move(10, 10); // 0, 0
        Assertions.assertAll(
            () -> Assertions.assertNotEquals(pointExtension.x, 10), // 0
            () -> Assertions.assertNotEquals(pointExtension.y, 10) // 0
        );

        Assertions.assertAll(
            () -> Assertions.assertEquals(10.0, pointExtension.getX()), // 10.0
            () -> Assertions.assertEquals(10.0, pointExtension.getY()) // 10.0
        );
    }

위의 경우 직접 접근 하게 되면 pointExtension의 값을 사용하게 되고, move나 getter는 point class의 함수를 사용하게 된다.

reference

stackoverflow.com/questions/1568091/why-use-getters-and-setters-accessors

stackoverflow.com/questions/11071407/advantage-of-set-and-get-methods-vs-public-variable