[JPA] API 생성시 Entity 를 반환하지 말자.

🎯 Goals

• Entity 는 사실상 Getter Setter 및 핵심 비즈니스 메소드만 있어야한다.
  화면 디자인과 관련된 로직을 추가해선 안된다.
• API 설계시 entity 객체를 반환하지 않아야한다.

라는 위 두 명제를 이해한다.

 

잘못된 예제

Member.java

@Entity
@Getter @Setter
public class Member {
    @Id @GeneratedValue
    @Column(name = "member_id")
    private Long id;
    private String userName;

    @Embedded
    private Address address;

    // 연관 관계의 주인이 아닌 경우 읽기 전용이 됨.
    // `member` field in order 에 의해 매핑되었다는 것을 명시.
    @OneToMany(mappedBy = "member")
    private List<Order> orders = new ArrayList();

}

이 코드처럼 별도의 화면을 건드리는 로직을 Entity 가 담아선 안된다.

Entity 내에 View 단에 의존적인 코드가 절대 생겨선 안된다.

MemberController.java

@Controller
@RequiredArgsConstructor
public class MemberController {

    private final MemberService memberService;

    @GetMapping("/members")
    public String list(Model model) {
    	// 모든 사용자를 찾아 
        List<Member> members = memberService.findMembers();
        model.addAttribute("members", members);
		
        // memberList.html 에 members 객체 전달.
        return "members/memberList";
    }
}

 

memberList.html

thymeleaf 와 연동된 SSR (Server Side Rendering) 페이지 중 일부 코드다.

      <tbody>
      <tr th:each="member : ${members}">
        <td th:text="${member.id}"></td>
        <td th:text="${member.userName}"></td>
        <td th:text="${member.address?.city}"></td>
        <td th:text="${member.address?.street}"></td>
        <td th:text="${member.address?.zipcode}"></td>
      </tr>

`member` entity 객체를 서버의 Controller 로 부터 받아오고있다.

 

잘못된 설계다.
entity 객체를 절대 API 에서 반환해선 안된다.

 

API는 스팩, 문서가 존재한다. API 상에서 entity 를 그대로 반환하게 되면

entity 의 attribute 가 추가되거나 삭제될 때마다 API 스팩과 문서 모두 업데이트가 일어나야한다.

 

따라서 Controller -> View 단으로 넘겨줄 데이터는 별도의 DTO(Data Trasnfer Object) 를 정의하여 필요한 데이터만 담아 보내는 것이 좋다.