RESTful API, 관심사 분리, @Setter 지양

RESTful API

RESTful API는 두 컴퓨터 시스템이 인터넷을 통해 정보를 안전하게 교환하기 위해 사용하는 인터페이스

RESTful API는 안전하고 신뢰할 수 있으며 효율적인 소프트웨어 통신 표준을 따름

 

API(Application Programming Interface)

다른 소프트웨어 시스템과 통신하기 위해 따라야 하는 규칙을 정의, 개발자는 다른 애플리케이션이 프로그래밍 방식으로 애플리케이션과 통신할 수 있도록 API를 표시하거나 생성

 

웹 API는 클라이언트와 웹 리소스 사이의 게이트웨이

 

클라이언트

웹에서 정보에 액세스하려는 사용자, 클라이언트는 API를 사용하는 사람이거나 소프트웨어 시스템일 수 있음

 

리소스

리소스는 다양한 애플리케이션이 클라이언트에게 제공하는 정보, 리소스는 이미지, 동영상, 텍스트, 숫자 또는 모든 유형의 데이터일 수 있음, 클라이언트에 리소스를 제공하는 시스템을 서버라고함.

조직은 API를 사용하여 리소스를 공유하고 보안, 제어 및 인증을 유지하면서 웹 서비스를 제공.

 

REST

Representational State Transfer(REST)는 API 작동 방식에 대한 조건을 부과하는 소프트웨어 아키텍처

REST 기반 아키텍처를 사용하여 대규모의 고성능 통신을 안정적으로 지원할 수 있음, 쉽게 구현하고 수정할 수 있어 모든 API 시스템을 파악하고 여러 플랫폼에서 사용할 수 있음

 

REST 아키텍처 스타일을 따르는 API를 REST API라고 함

REST 아키텍처를 구현하는 웹 서비스를 RESTful 웹 서비스라고 함

RESTful API라는 용어는 일반적으로 RESTful 웹 API를 나타냄, 하지만 REST API와 RESTful API라는 용어는 같은 의미로 사용할 수 있음

 

REST 아키텍쳐 스타일의 원칙

균일한 인터페이스

균일한 인터페이스는 모든 RESTful 웹 서비스 디자인의 기본(서버가 표준 형식으로 정보를 전송함을 나타냄)

형식이 지정된 리소스를 REST에서 표현이라고 부름( 이 형식은 서버 애플리케이션에 있는 리소스의 내부 표현과 다를 수 있음)

• 서버는 데이터를 텍스트로 저장하되, HTML 표현 형식으로 전송할 수 있음

균일한 인터페이스의  4가지 아키텍처 제약 조건

1. 요청은 리소스를 식별해야 합니다. 이를 위해 균일한 리소스 식별자를 사용
2. 클라이언트는 원하는 경우 리소스를 수정하거나 삭제하기에 충분한 정보를 리소스 표현에서 가지고 있음, 서버는 리소스를 자세히 설명하는 메타데이터를 전송하여 이 조건을 충족합니다.
3. 클라이언트는 표현을 추가로 처리하는 방법에 대한 정보를 수신함, 이를 위해 서버는 클라이언트가 리소스를 적절하게 사용할 수 있는 방법에 대한 메타데이터가 포함된 명확한 메시지를 전송함.
4. 클라이언트는 작업을 완료하는 데 필요한 다른 모든 관련 리소스에 대한 정보를 수신함, 이를 위해 서버는 클라이언트가 더 많은 리소스를 동적으로 검색할 수 있도록 표현에 하이퍼링크를 넣어 전송함

 

 

무상태

REST 아키텍처에서 무상태는 서버가 이전의 모든 요청과 독립적으로 모든 클라이언트 요청을 완료하는 통신 방법을 나타냄.

클라이언트는 임의의 순서로 리소스를 요청할 수 있으며 모든 요청은 무상태이거나 다른 요청과 분리됨.

REST API 설계 제약 조건은 서버가 매번 요청을 완전히 이해해서 이행할 수 있음을 의미

 

 

계층화 시스템

계층화된 시스템 아키텍처에서 클라이언트는 클라이언트와 서버 사이의 다른 승인된 중개자에게 연결할 수 있으며 여전히 서버로부터도 응답을 받음

서버는 요청을 다른 서버로 전달할 수도 있습니다. 클라이언트 요청을 이행하기 위해 함께 작동하는 보안, 애플리케이션 및 비즈니스 로직과 같은 여러 계층으로 여러 서버에서 실행되도록 RESTful 웹 서비스를 설계할 수 있음

이러한 계층은 클라이언트에 보이지 않는 상태로 유지됨

 

 

캐시 가능성

RESTful 웹 서비스는 서버 응답 시간을 개선하기 위해 클라이언트 또는 중개자에 일부 응답을 저장하는 프로세스인 캐싱을 지원함.

RESTful 웹 서비스는 캐시 가능 또는 캐시 불가능으로 정의되는 API 응답을 사용하여 캐싱을 제어함.

 

 

온디맨드 코드

REST 아키텍처 스타일에서 서버는 소프트웨어 프로그래밍 코드를 클라이언트에 전송하여 클라이언트 기능을 일시적으로 확장하거나 사용자 지정할 수 있음.

예를 들어, 웹 사이트에서 등록 양식을 작성하면 브라우저는 잘못된 전화번호와 같은 실수를 즉시 강조 표시함, 서버에서 전송한 코드로 인해 이 작업을 수행할 수 있음.

 

 

RESTful API를 사용 이점

확장성

REST API를 구현하는 시스템은 REST가 클라이언트-서버 상호 작용을 최적화하기 때문에 효율적으로 크기 조정할 수 있음

무상태는 서버가 과거 클라이언트 요청 정보를 유지할 필요가 없기 때문에 서버 로드를 제거함

잘 관리된 캐싱은 일부 클라이언트-서버 상호 작용을 부분적으로 또는 완전히 제거함

이러한 모든 기능은 성능을 저하시키는 통신 병목 현상을 일으키지 않으면서 확장성을 지원함

 

유연성

RESTful 웹 서비스는 완전한 클라이언트-서버 분리를 지원함

각 부분이 독립적으로 발전할 수 있도록 다양한 서버 구성 요소를 단순화하고 분리함

서버 애플리케이션의 플랫폼 또는 기술 변경은 클라이언트 애플리케이션에 영향을 주지 않음

애플리케이션 함수를 계층화하는 기능은 유연성을 더욱 향상시킴

예를 들어, 개발자는 애플리케이션 로직을 다시 작성하지 않고도 데이터베이스 계층을 변경할 수 있음

 

독립성

REST API는 사용되는 기술과 독립적임

API 설계에 영향을 주지 않고 다양한 프로그래밍 언어로 클라이언트 및 서버 애플리케이션을 모두 작성할 수 있음

통신에 영향을 주지 않고 양쪽의 기본 기술을 변경할 수 있음

 

 

RESTful API 작동방식

RESTful API의 기본 기능은 인터넷 브라우징과 동일함, 클라이언트는 리소스가 필요할 때 API를 사용하여 서버에 접속함

API 개발자는 서버 애플리케이션 API 문서에서 클라이언트가 REST API를 어떻게 사용해야 하는지 설명함

모든 REST API 호출에 대한 일반 단계임

 

1. 클라이언트가 서버에 요청을 전송함, 클라이언트가 API 문서에 따라 서버가 이해하는 방식으로 요청 형식을 지정함
2. 서버가 클라이언트를 인증하고 해당 요청을 수행할 수 있는 권한이 클라이언트에 있는지 확인함
3. 서버가 요청을 수신하고 내부적으로 처리함
4. 서버가 클라이언트에 응답을 반환함, 응답에는 요청이 성공했는지 여부를 클라이언트에 알려주는 정보가 포함됨, 응답에는 클라이언트가 요청한 모든 정보도 포함됨

REST API 요청 및 응답 세부 정보는 API 개발자가 API를 설계하는 방식에 따라 약간씩 다름

 

 

RESTful API 클라이언트 요청에 포함되는 것

RESTful API에는 다음과 같은 주요 구성요소를 포함하는 요청이 필요함

 

고유 리소스 식별자

서버는 고유한 리소스 식별자로 각 리소스를 식별함, REST 서비스의 경우 서버는 일반적으로 URL(Uniform Resource Locator)을 사용하여 리소스 식별을 수행

URL은 리소스에 대한 경로를 지정함, URL은 웹페이지를 방문하기 위해 브라우저에 입력하는 웹 사이트 주소와 유사

URL은 요청 엔드포인트라고도 하며 클라이언트가 요구하는 사항을 서버에 명확하게 지정함

 

메서드

개발자는 종종 Hypertext Transfer Protocol(HTTP)을 사용하여 RESTful API를 구현함. HTTP 메서드는 리소스에 수행해야 하는 작업을 서버에 알려줌.

다음은 4가지의 일반적인 HTTP 메서드임

• GET
  • 클라이언트는 GET을 사용하여 서버의 지정된 URL에 있는 리소스에 액세스함, GET 요청을 캐싱하고 RESTful API 요청에 파라미터를 넣어 전송하여 전송 전에 데이터를 필터링하도록 서버에 지시할 수 있음
• POST
  • 클라이언트는 POST를 사용하여 서버에 데이터를 전송함. 여기에는 요청과 함께 데이터 표현이 포함, 동일한 POST 요청을 여러 번 전송하면 동일한 리소스를 여러 번 생성하는 부작용이 있음
• PUT
  • 클라이언트는 PUT을 사용하여 서버의 기존 리소스를 업데이트함. POST와 달리, RESTful 웹 서비스에서 동일한 PUT 요청을 여러 번 전송해도 결과는 동일함
• DELETE
  • 클라이언트는 DELETE 요청을 사용하여 리소스를 제거함, DELETE 요청은 서버 상태를 변경할 수 있음. 하지만 사용자에게 적절한 인증이 없으면 요청은 실패

HTTP 헤더

요청 헤더는 클라이언트와 서버 간에 교환되는 메타데이터. 예) 요청 헤더는 요청 및 응답의 형식을 나타내고 요청 상태 등에 대한 정보를 제공

 

데이터

REST API 요청에는 POST, PUT 및 기타 HTTP 메서드가 성공적으로 작동하기 위한 데이터가 포함될 수 있음

 

파라미터

RESTful API 요청에는 수행해야 할 작업에 대한 자세한 정보를 서버에 제공하는 파라미터가 포함될 수 있음.

다음은 몇 가지 파라미터 유형임

• URL 세부정보를 지정하는 경로 파라미터
• 리소스에 대한 추가 정보를 요청하는 쿼리 파라미터
• 클라이언트를 빠르게 인증하는 쿠키 파라미터

 

 

RESTful API 인증 방법

RESTful 웹 서비스는 응답을 보내기 전에 먼저 요청을 인증해야 함, 인증은 신원을 확인하는 프로세스임.

RESTful 서비스 클라이언트는 신뢰를 구축하기 위해 서버에 자신의 신원를 증명해야함

 

RESTful API에는 4가지의 일반적인 인증 방법이 있음

• HTTP 인증
  • HTTP는 REST API를 구현할 때 직접 사용할 수 있는 일부 인증 체계를 정의
  • 기본 인증
    • 기본 인증에서 클라이언트는 요청 헤더에 사용자 이름과 암호를 넣어 전송함. 안전한 전송을 위해 이 페어를 64자의 세트로 변환하는 인코딩 기술인 base64로 인코딩
  • 전달자 인증
    • 전달자(bearer) 인증이라는 용어는 토큰 전달자에 대한 액세스 제어를 제공하는 프로세스를 나타냄.
    • 일반적으로 전달자 토큰은 서버가 로그인 요청에 대한 응답으로 생성하는 암호화된 문자열임.
    • 클라이언트는 리소스에 액세스하기 위해 요청 헤더에 토큰을 넣어 전송함
• API 키
  • API 키는 REST API 인증을 위한 또 다른 옵션
  • 이 접근 방식에서 서버는 고유하게 생성된 값을 최초 클라이언트에 할당함
  • 클라이언트는 리소스에 액세스하려고 할 때마다 고유한 API 키를 사용하여 본인을 검증
  • API 키의 경우 클라이언트가 이 키를 전송해야 해서 네트워크 도난에 취약하기 때문에 덜 안전함
• OAuth
  • OAuth는 모든 시스템에 대해 매우 안전한 로그인 액세스를 보장하기 위해 암호와 토큰을 결합
  • 서버는 먼저 암호를 요청한 다음 권한 부여 프로세스를 완료하기 위해 추가 토큰을 요청
  • 특정 범위와 수명으로 언제든지 토큰을 확인할 수 있음

 

 

RESTful API 서버 응답에 포함되어 있는 것

EST 원칙에 따라 서버 응답에 다음과 같은 주요 구성 요소를 포함해야 함.

상태 표시줄

상태 표시줄에는 요청 성공 또는 실패를 알리는 3자리 상태 코드가 있음

• 200: 일반 성공 응답
• 201: POST 메서드 성공 응답
• 400: 서버가 처리할 수 없는 잘못된 요청
• 404: 리소스를 찾을 수 없음

메시지 본문

응답 본문에는 리소스 표현이 포함, 서버는 요청 헤더에 포함된 내용을 기반으로 적절한 표현 형식을 선택함.

클라이언트는 데이터 작성 방식을 일반 텍스트로 정의하는 XML 또는 JSON 형식으로 정보를 요청할 수 있음.

• 예)  클라이언트가 John이라는 사람의 이름과 나이를 요청하면 서버는 다음과 같이 JSON 표현을 반환.
• '{"name":"John", "age":30}'

헤더
응답에는 응답에 대한 헤더 또는 메타데이터도 포함, 이는 응답에 대한 추가 컨텍스트를 제공하고 서버, 인코딩, 날짜 및 콘텐츠 유형과 같은 정보를 포함한다.

 

 

 

RESTful API 평가

ChatGPT

RESTful API 설계를 확인하는 것은 API가 REST 아키텍처 스타일을 얼마나 잘 따르고 있는지를 평가하는 과정입니다. REST (Representational State Transfer)는 클라이언트와 서버 간의 상호작용을 위한 아키텍처 스타일로, 웹 기술과 HTTP 프로토콜을 활용합니다.

RESTful API가 되기 위한 주요 원칙들을 확인하는 것으로 시작할 수 있습니다.

다음은 RESTful API를 평가할 때 고려해야 할 몇 가지 핵심 요소입니다:

 

1. 자원 기반 통신(Resource-Based Communication): REST API는 URI (Uniform Resource Identifier)를 사용하여 자원(Resource)을 식별합니다. 각 URI는 특정 자원을 나타내며, 해당 자원에 대한 작업은 HTTP 메소드 (GET, POST, PUT, DELETE 등)를 통해 수행됩니다.
2. 무상태성(Statelessness): REST API는 무상태성을 유지해야 합니다. 즉, 서버는 클라이언트의 상태 정보를 저장하지 않으며, 각 요청은 독립적이어야 하고 모든 필요한 정보를 포함해야 합니다.
3. 캐시 가능(Cacheability): 응답은 캐시 가능하도록 명시되어야 합니다. 이를 통해 클라이언트는 반복되는 요청에 대해 서버의 부하를 줄이고 응답 시간을 개선할 수 있습니다.
4. 계층형 시스템(Layered System): 클라이언트는 서버와 직접 통신할 수도 있고, 중간 서버를 통해 간접적으로 통신할 수도 있습니다. 이 계층 구조는 로드 밸런싱, 캐싱, 암호화 계층 등을 통해 확장성과 보안을 개선할 수 있습니다.
5. 코드 온 디맨드(Code on Demand) (선택적): 서버는 실행 가능한 코드를 클라이언트에 전송할 수 있습니다. 이는 선택적 기능이며, 클라이언트의 기능성을 임시로 확장하는 데 사용될 수 있습니다.
6. 일관된 인터페이스(Uniform Interface): REST API는 일관된 인터페이스를 제공해야 합니다. 이는 리소스 식별, 자기 기술적 메시지, 애플리케이션 상태의 하이퍼미디어로의 전환 등을 포함할 수 있습니다.

API가 위의 원칙들을 어떻게 준수하고 있는지 평가하기 위해서는 API 문서, 실제 API 요청 및 응답, 그리고 API 설계 방식을 자세히 검토해야 합니다. 또한, RESTful API를 테스트하고 평가하기 위한 도구(예: Postman, Swagger)를 사용하여 API의 행동을 직접 확인하고, 각 요청과 응답이 위의 원칙들을 어떻게 반영하고 있는지 평가할 수 있습니다.

 

RESTful API 설계 여부 판단을 위해 필요한 파일

• Controller 파일
  • URI 구조와 자원의 식별: Controller 파일은 API의 URI 구조와 HTTP 메소드(GET, POST, PUT, DELETE 등)의 사용 방법을 보여줍니다. RESTful API는 자원(Resource) 기반의 URI를 사용하며, 자원에 대한 행동은 HTTP 메소드를 통해 정의됩니다.
  • 상태 코드와 응답: HTTP 응답 상태 코드(200, 404, 500 등)의 사용이 적절한지, 클라이언트에게 유용한 피드백을 제공하는지 확인합니다.
• Service 파일
  • 비즈니스 로직의 처리: Service 파일은 비즈니스 로직을 처리하며, REST API의 무상태성을 유지하는 데 중요한 역할을 합니다. 각 요청은 모든 필요한 정보를 포함해야 하며, 서버 측 상태를 유지해서는 안 됩니다.
• 추가적으로 필요한 요소들
  • 데이터 모델: 데이터베이스 스키마나 ORM(Object-Relational Mapping) 모델 파일을 통해 데이터 구조와 관계를 이해할 필요가 있습니다. RESTful API는 자원 중심의 설계를 강조하기 때문에, 데이터 모델이 어떻게 구성되어 있는지 이해하는 것이 중요합니다.
  • 구성 파일(Configuration Files): API 서버의 구성을 정의하는 파일들은 API의 동작 방식, 보안 설정, 미들웨어 구성 등을 이해하는 데 도움이 될 수 있습니다.
  • 인증 및 권한 부여(Authentication and Authorization): RESTful API는 종종 토큰 기반 인증(예: OAuth, JWT)을 사용합니다. 인증 및 권한 부여를 처리하는 파일들은 API의 보안 설계를 이해하는 데 중요합니다.
  • 라우팅 파일(Routing Files): API의 전체적인 라우팅 구조와 각 라우트가 어떤 Controller로 매핑되는지 보여줍니다. RESTful 설계에서는 각 URI가 특정 자원과 연결되고 적절한 HTTP 메소드를 사용하는 것이 중요합니다.
  • 문서화: API의 문서화는 사용자가 API를 이해하고 올바르게 사용할 수 있도록 돕습니다. Swagger 같은 도구를 통해 생성된 문서는 RESTful 설계의 일관성과 명확성을 평가하는 데 유용할 수 있습니다.

 

프로젝트 RESTful API 평가

• 좋은 부분
  • 리소스 기반의 URI 사용과 적절한 HTTP 메소드를 통해 CRUD 작업을 명확하게 처리합니다.
  • DTO를 활용하여 클라이언트와 서버 간의 데이터 전송을 명확하게 관리합니다.
  • 비즈니스 로직과 데이터 액세스를 분리하여 API의 유지 관리성과 확장성을 향상시킵니다.
• 개선이 필요한 부분
  • 모든 요청에 대한 접근을 허용하는 보안 설정은 운영 환경에서 적절하지 않습니다. 세부적인 접근 제어와 보안 강화가 필요합니다.
  • 오류 처리와 HTTP 상태 코드의 사용에 대한 구체적인 구현 사례가 부족하여, 클라이언트에게 보다 명확한 피드백을 제공할 수 있는 방법을 고려해야 합니다.
  • HATEOAS와 같은 RESTful 원칙을 더 깊게 적용하여 클라이언트의 API 사용성을 향상시킬 여지가 있습니다.

 

관심사 분리 평가(Controller, Service, Repository)

프로젝트는 Controller, Service, Repository의 관심사 분리 원칙을 잘 따르고 있습니다.

• Controller (PostController.java): HTTP 요청을 처리하고, 적절한 서비스 메소드를 호출합니다. 클라이언트와의 통신을 담당합니다.
• Service (PostService.java): 비즈니스 로직을 처리합니다. 이는 애플리케이션의 비즈니스 규칙을 구현하며, 데이터의 가공 및 변환을 담당합니다.
• Repository (PostRepository.java): 데이터베이스와의 통신을 담당합니다. Spring Data JPA를 사용하여 데이터베이스 연산을 추상화합니다.

이러한 분리는 코드의 유지보수성과 확장성을 향상시키며, 각 계층의 독립성을 보장합니다. 하지만, 세부적인 실행 및 오류 처리 방식, 보안 구성의 강화 등은 각 계층에서 더욱 심도 있게 다루어질 필요가 있습니다.

 

수정, 삭제 API의 request 방식(param, query, body)

• 수정 (Update): @PutMapping("/posts/{id}")를 사용하여 수정 API를 구현하였으며, {id} 경로 변수를 통해 수정할 게시물의 ID를 지정합니다. 요청 본문(@RequestBody)을 통해 PostRequestDto 객체를 전달받아 게시물의 내용을 업데이트합니다. 이는 RESTful API에서 자원을 수정하기 위한 적절한 방식입니다.
• 삭제 (Delete): @DeleteMapping("/posts/{id}")를 사용하여 삭제 API를 구현하였으며, {id} 경로 변수를 통해 삭제할 게시물의 ID를 지정합니다. 요청 매개변수(@RequestParam)를 사용하여 비밀번호를 전달받습니다. 삭제 요청에서는 경로 변수를 통해 특정 자원을 식별하고, 추가적인 인증 정보(여기서는 비밀번호)를 쿼리 매개변수로 전달하는 방식을 채택했습니다.

 

 

 

@Getter, @Setter 지양해야 하는 이유

무분별한 Getter와 Setter의 사용은 객체 지향의 핵심인 정보 은닉을 해치게 된다. 이로 인해 외부에서 객체의 상태를 알게 되거나 객체의 상태를 그대로 수정하게 되고, 객체의 상태가 변경되면 의도하지 않은 동작을 수행하여 문제가 발생할 수 있다.

 

Getter, Setter를 사용하는 이유

객체 지향의 원칙 중 하나는 정보 은닉(Information Hiding)이다. 객체의 구체적인 정보를 외부에 노출하지 말라는 것이다. 

이러한 이유 때문에 자바에서는 클래스를 작성할 때 모든 필드를 private으로 숨기고 public 메소드(Getter와 Setter)를 통해 간접적으로 필드를 다루게 된다.

 

왜 Getter와 Setter를 쓰지말라는 거?

엄밀히 말해서 필드를 private으로 숨겨놓고 Getter와 Setter를 모두 public으로 열어서 사용하는 것은 정보 은닉의 효과를 볼 수 없다. 필드 자체는 잘 숨겨놓고 그 값을 Getter로 조회할 수 있고 Setter로 수정할 수 있으면 이 정보가 정말로 숨겨졌다고 할 수 있을까?

 

객체 지향 프로그래밍은 다양한 객체들이 협력하여 하나의 애플리케이션으로 동작하도록 하는 프로그래밍 방법이다.

이런 객체 지향 프로그래밍의 장점 중에는 상대 객체의 세부 정보를 알 필요 없이 그저 객체에 무언가를 요청만 하면 된다는 점이 있다.

 

그런데 객체에 요청을 하지 않고 객체의 정보를 조회하여 직접 비즈니스 로직을 수행하거나 객체의 속성을 다짜고짜 바꾸라고 한다면? 객체 지향의 장점은 퇴색되고 말 것이다.

 

Getter 지양은 메소드의 인자로 넘기기 위한 경우처럼 정말로 값이 필요해서 사용하는 경우가 아니라 Getter로 값을 가져와서 비즈니스 로직을 수행하는 경우를 말함

 

 

Setter를 지양해야 하는 이유

• Setter는 값을 바꾸는 이유를 드러내지 않는다(Setter 메소드를 사용하면 값을 변경한 의도를 파악하기 힘듬)
• 객체의 일관성을 유지하기 어려움
• 다른 객체들로 책임이 분산된다.

예제 1

class Account {
    private long balance;
    
    public Account(long balance) {
        this.balance = balance;
    }
    
    public void setBalance(long balance) {
        this.balance = balance;
    }
}
 
Account myAccount = new Account(500);
myAccount.setBalance(1000);

• 위 코드에서 myAccount.setBalance(1000)만 봤을 때는 계좌에 입금을 해서 잔액이 1000이 되었는지, 계좌에서 인출을 해서 잔액이 1000이 남았는지 알 수 없다.
• Setter를 사용하면 객체의 속성이 갖는 값을 바꾼 이유를 명확하게 알 수 없다.

예제 2

@Service
public class AccountService {
    ...
    
    public void withdraw(long id, long amount) {
        Account account = accountRepository.findById(id).orElseThrow();
        long newBalance = account.getBalance() - amount;
        
        if (newBalance < 0) {
            throw new IllegalArgumentException("잔액이 부족합니다.");
        }
        
        account.setBalance(newBalance);
    }
    
    ...
}

• Account 객체에서 자신의 잔고를 관리하는 책임을 져야하지만 코드에서는 AccountService가 출금하려는 계좌의 잔고가 충분한지까지 확인하고 있음, Account가 책임을 다하지 않았기 대문에 AccountService에서 Account가 할 일을 대신 해주고 있는 것
• 어떤 객체가 해야할 일을 다른 객체가 대신 해주고 있는 경우 객체의 구조가 변경될 경우, 그 객체의 일을 대신 해주는 모든 코드를 수정해야 함

 

 

Getter를 지양해야 하는 이유

• Getter는 조회로 끝나지 않는 경우가 많다
• Getter를 통해 조건을 검사하면 변경에 취약하다

예제 1

public void withdraw(long id, long amount) {
    Account account = accountRepository.findById(id).orElseThrow();
    long newBalance = account.getBalance() - amount;
 
    if (newBalance < 0) {
        throw new IllegalArgumentException("잔액이 부족합니다.");
    }
 
    account.setBalance(newBalance);
}

• 코드는 Account 객체에서 잔액을 조회해서 인출할 금액만큼 차감해보고 그 금액이 음수가 되는지 확인하고 있음
• 인출할 금액을 전달해서 잔액이 충분한지만 물어보면 되는데 그걸 직접 확인하고 있는 셈

예제 2

@Getter
class Customer {
    private long charge;
}
 
@Service
public class CustomerService {
    ...
    
    public void printMembershipGrade(Customer customer) {
        if (customer.getCharge() >= 100000) {
            System.out.println("Gold");
        } else if (customer.getCharge() >= 50000) {
            System.out.println("Silver");
        } else {
            System.out.println("Bronze");
        }
    }
    
    ...
}

• 코드에서 요구사항이 변경되어 고객이 요금 대신 사용량과 단가만 갖게 될 경우 이용 요금에 대한 정보가 사라짐에도 CustomerService에서는 이러한 사실을 모르고 조회하려고 할테니 컴파일 에러가 발생함
• 기존에 charge의 값을 조회해서 사용하고 있던 코드를 모두 수정해야 함

 

 

대안

Setter 대신 명확한 의도를 가진 메서드를 사용하라

• 생성자를 오버로딩
• Builder 패턴 사용
• 정적 팩토리 메서드

예제 - 정적 팩토리 메서드

class Account {
    private long balance;
    
    public void withdraw(long amount) {
        if (amount > balance) {
            throw new IllegalArgumentException("잔액이 부족합니다.");
        }
        
        balance -= amount;
    }
}
 
@Service
public class AccountService {
    ...
    
    public void withdraw(long id, long amount) {
        Account account = accountRepository.findById(id).orElseThrow();
        account.withdraw(amount);
    }
    
    ...
}

• 코드처럼 Account에 출금할 금액을 전달하고 출금하라고 수정하면, 코드도 간결해지고 출금하겠다는 의도도 명확해짐
• 출금 로직이 변경되어도 Account 클래스의 withdarw( )의 내용만 수정하면 됨, 다른 코드는 Account의 withdraw( )를 호출하고만 있어서 신경 쓸 필요가 없음
• 로직의 의도가 확실해지고 계좌가 져야 할 책임이 분산되어 수정에 취약했던 문제가 해결됨

 

예제 - 생성자 오버로딩

public class Member {
    private String name;
    private String age;
    
    public Member(String name){
    	this.name = name;
    }
    public Member(String name,int age){
    	this.name = name;
    	this.age = age;
    }

• 멤버 변수가 많고 다양한 생성자를 가져야 할 경우 코드가 길어지고 가독성이 떨어지는 일이 발생, 이를 해결하기 위해 Builder 패턴을 사용

 

예제 - Builder 패턴

public class Member {
    private String name;
    private String age;
    
    @Builder
    public Member(String name, int age){
    	this.name = name;
        this.age = age;
    }

• 요구사항에 맞게 필요한 데이터만 이용하여 유연한 클래스 생성이 가능
• 전체 생성자 하나만을 가지고 있는 형태로 변경되어 유지보수 및 가독성 향상
• 객체를 생성할 때 인자 값의 순서가 상관 없다는 장점이 있음

 

 

Getter로 조건을 검사하지 말고 결과를 반환하게 하라

예제

class Customer {
    private long usages;
    private long unitPrice;
    
    public String calcMembershipGrade() {
        long charge = usages * unitPrice;
        
        if (charge >= 100000) {
            return "Gold";
        } else if (charge >= 50000) {
            return "Silver";
        } else {
            return "Bronze";
        }
    }
}
 
@Service
public class CustomerService {
    ...
    
    public void printMembershipGrade(Customer customer) {
        System.out.println(customer.calcMembershipGrade());
    }
    
    ...
}

• 코드처럼 고객 객체에게 고객 등급을 반환하라고 시킬 경우 CustomerService에서 고객의 등급을 출력하기 위해 고객의 상태를 알 필요가 없어짐
• 고객 객체에게 고객 등급을 계산해 달라고 시키기만 하면 됨

 

 

결론

무분별한 Getter와 Setter의 사용은 객체 지향의 핵심인 정보 은닉을 해치게 된다. 이로 인해 외부에서 객체의 상태를 알게 되거나 객체의 상태를 그대로 수정하게 되고, 객체의 상태가 변경되면 의도하지 않은 동작을 수행하여 문제가 발생할 수 있다.
Getter와 Setter는 꼭 필요한 경우가 아니라면 사용하지 않고, 대신 객체에 직접 요청할 수 있는 메소드를 작성해서 사용하는게 좋다.

 

 

 

프로젝트 피드백 정리

1. Setter 어노테이션 지양

Entity에 Setter 어노테이션을 사용할 경우 객체의 일관성을 보장할 수 없고, setter 메소드만 가지고 그 역할을 판단하기 힘들기 때문에 Setter 사용을 지양함 - Setter를 사용하지 않고 리펙토링 해보는 게 좋음

 

2. application properties 파일

application properties 파일은 보통 DB나 Object Storage와 같은 데이터를 저장하거나, 관리하는 서비스들의 접속 정보와 같은 민감정보를 포함함.

github와 같은 오픈된 형상관리 툴에는 업로드 하지 않거나, 암호화 시키는 편이 해킹과 같은 위험을 방지할 수 있음(gitignore 등을 사용해 업로드 하지 않는 것이 안전함)

 

3. ERD, USECASE, API 명세서

github의 Readme에 올리는 것이 좋음

 

4. 반환 타입

숫자형 반환 타입이 아닌 api 명세서에 나와있는 응답 값으로 리팩토링 하는 것이 좋음

 

5. Builder 패턴

PostResponseDto 클래스에서 생성자에 Entity 객체를 받아 Dto 필드에 매칭할 때 기존의 생성자를 통한 방법대신 Builder 패턴으로 리팩토링 해보는 것