[Spring Boot - 🐱PetClinic🐶] 5. 테이블과 엔티티🗺

쑤밍·2023년 4월 13일

[Spring Boot - 🐱PetClinic🐶]

목록 보기

5/11

🔎 Pet Clinic에서 사용하는 테이블

위의 데이터베이스 다이어그램은 Pet Clinic Application에서 사용하는 데이터베이스 테이블을 도식화하여 나타낸 그림이다. 이 그림은 resources/db/mysql/schema.sql 파일의 내용을 https://dbdiagram.io/home에 입력하면 자동으로 만들어준다. 데이터베이스 종류와 상관 없이 schema를 작성하는 내용이면 되는 듯하다. 컬럼 간의 관계를 선으로 나타내주어 테이블 간의 관계를 파악하기 좋다.

다이어그램을 해석하자면 일단 pets의 id는 visits의 pet_id와 일대다 관계를 이룬다. pets의 type_id는 types의 id, owner_id는 owners의 id와 다대일 관계를 이룬다. vet_specialties의 vet_id는 vets의 id, specialty_id는 specialties의 id와 다대일 관계를 이룬다.

types 테이블과 specialties 테이블, vets 테이블의 데이터들은 정해져 있고 추가나 수정, 삭제가 안 된다. 조회만 가능하다. 추가/수정할 수 있는 것은 pets 테이블과 owners 테이블의 데이터들이다.

🔎 Pet Clinic에서 사용하는 엔티티 클래스

위의 클래스 다이어그램은 Pet Clinic Application에서 데이터베이스와 연동 시 테이블 역할을 하는 엔티티 클래스의 연관 관계를 그림으로 표현한 것이다. 클래스 다이어그램은 https://app.diagrams.net/ 에서 그릴 수 있다. 클래스 다이어그램은 UML(Unified Modeling Language)의 하나로 클래스 간의 관계를 쉽게 파악할 수 있게 한다.

가장 기초가 되는 클래스는 BaseEntity로 Integer 타입 id만을 갖고 있다. BaseEntity를 상속받은 NamedEntity와 PersonEntity, Visit이 있다. BaseEntity와 NamedEntity, PersonEntity는 @MappedSuperClass다. @MappedSuperClass란 테이블을 갖지 않으면서 @Entity가 상속받을 수 있는 클래스이다. 엔티티 클래스들이 공통으로 갖고 있어야 하는 항목들을 갖고 있어 객체 지향적인 코드 작성을 위해 사용한다. 코드의 중복을 줄여 유지보수의 편리성을 높여준다. Owner 클래스와 Vet 클래스는 Person 클래스를 상속받고, Pet, PetType, Specialty 클래스는 NamedEntity 클래스를 상속받는다. 이들의 연관관계는 다음과 같다. Owner는 List<Pet>을 포함하고 있고, Pet은 Set<Visit>과 Set<PetType>를, Vet은 Set<Specialty>를 포함하고 있다.

@MappedSuperClass를 사용할 때 주의사항은 BaseEntity의 항목을 설계할 때 id를 포함하는 것을 고려해야 한다는 점이다.(참고 링크 @MappedSuperClass 사용 시 주의사항 참고) id를 BaseEntity에 포함하면 확장성이 떨어진다고 한다. Pet Clinic은 간단한 구조이고 확장성을 고려하지 않았기 때문에 BaseEntity에 id를 사용한 것 같다.

@Entity로 사용되는 클래스는 Owner, Vet, Pet, Visit의 네 가지로 각각 owners, vets, pets, visits 테이블과 매핑된다.

🗺 Entity Mapping

Entity Mapping은 간단하게 어노테이션을 추가하는 것으로 구현할 수 있다. 클래스 선언 부 위쪽에 @Entity 어노테이션을 넣어주면 Entity로 사용한다는 뜻이고, @Table(name="table_name")을 넣어주면 Entity를 table_name 테이블로 매핑하겠다는 뜻이다. 각 컬럼으로 사용할 객체의 변수들 위에 @Column 어노테이션을 넣어주면 컬럼으로 사용할 수 있다. 옵션값으로 컬럼 이름, nullable, length 등 제한사항 등을 넣을 수 있다. 테이블 설계에 따라 작성하면 된다. 자세한 사항은 참고 링크의 Entity Mapping을 참고하면 된다.

Pet Clinic에서는 BaseEntity에서 id 변수에 @Id, @GeneratedValue(strategy = GenerationType.IDENTITY) 어노테이션을 붙였는데 이 어노테이션의 뜻은 id 변수를 PK로 지정하고 생성 전략을 데이터베이스에 위임하겠다는 의미다.

🧩 마무리

이번 글은 간단하게 Pet Clinic Application의 테이블과 엔티티를 살펴봤다. Spring Boot에서는 Entity Manager를 신경 쓸 필요 없이 어노테이션만 적절하게 넣어주면 데이터베이스와 엔티티의 매핑은 JPA가 알아서 해주니 편한 것 같다. 지금 단계는 있는 프로젝트를 분석하는 단계여서 이해하고 넘어가면 되지만 실제 프로젝트를 진행하게 되면 테이블 설계에 맞게 어노테이션으로 제한사항을 추가해야 하므로 더 자세하게 알아야 할 것 같다. 참고 링크의 Entity Mapping 설명 링크를 닳도록 드나들 것 같다.