[Spring Boot - 🐱PetClinic🐶] 11. Repository 분석🔍

쑤밍·2023년 4월 25일

[Spring Boot - 🐱PetClinic🐶]

목록 보기

11/11

🗒 Repository

이전 글에서 정리했듯 Repository는 Spring에서 제공하는 모듈인 Spring Data Jpa의 인터페이스다. 개발자는 이 Repository 인터페이스를 상속받아 메서드 이름만 잘 작성하면 JPA가 이를 토대로 쿼리문을 만들어 데이터베이스 작업을 수행한다.

쿼리문이 복잡하거나 JPA가 자동 생성하는 쿼리문과 다른 쿼리문을 사용하고 싶은 경우 @Query 어노테이션을 통해 쿼리문을 직접 작성한다. 메서드 이름 위에 추가하면 된다.

@Transactional 어노테이션을 통해 ACID 관련 설정을 변경할 수 있다. 여기서 ACID란 Atomicity, Consistency, Isolation, Durability의 앞 글자를 딴 것으로 원자성, 일관성, 격리성, 지속성을 뜻한다. 더 자세하게 설명하자면 다음과 같다.

Atomicity(원자성): 데이터베이스 시스템에서 한 트랜잭션 내의 작업은 중간에 멈춤이 없이(작업이 쪼개지지 않음) 한 번에 이루어져야 한다. 이것을 더 이상 쪼개질 수 없는 원자에 빗대어 표현한 것이다.
Consistency(일관성): 트랜잭션은 일관성 있는 결과를 가져온다.
Isolation(격리성): 동시에 실행되는 트랜잭션은 서로에게 영향을 주지 않고 격리되어 있다.
Durability(지속성): 트랜잭션을 성공적으로 수행했을 때 결과는 항상 저장돼야 한다.

@Transactional 어노테이션으로 변경 할 수 있는 설정들은 많지만 Pet Clinic에서 사용하는 것은 readOnly 관련 설정뿐이다. readOnly 설정을 true로 할 경우 read 외의 insert, update, delete 작업 실행 시 예외를 발생시킨다.

@Cacheable 어노테이션을 통해 캐시 설정을 한다. 데이터베이스에서 읽어오는 값이 변하지 않을 경우(수정이 안될 경우) 캐시 설정을 하는 것이 유리하다.

🐶 Pet Clinic의 Repository

Pet Clinic에는 Repository가 두 개 존재한다. 하나는 owner에 관한 Repository이고, 나머지 하나는 veterinarian에 관한 Repository다.

👼🏻 OwnerRepository

OwnerRepository는 owner는 물론 owner가 가진 pet들과 각 pet의 방문 기록 관련 쿼리를 모두 처리한다. OwnerRepository의 메서드는 다음과 같다.

- findPetType()

@Query("SELECT ptype FROM PetType ptype ORDER BY ptype.name")
@Transactional(readOnly = true)
List<PetType> findPetTypes();

데이터베이스에서 PetType를 가져온다. 결과는 List<PetType> 타입으로 반환된다. @Query 어노테이션을 통해 직접 쿼리문을 작성하고 있다. @Transactional에 readOnly 속성을 주어 읽기 전용으로 설정한다.

- findByLastName(lastName, pageable)

@Query("SELECT DISTINCT owner FROM Owner owner left join  owner.pets 
										WHERE owner.lastName LIKE :lastName% ")
@Transactional(readOnly = true)
Page<Owner> findByLastName(@Param("lastName") String lastName, Pageable pageable);

데이터베이스에서 lastName이 일치하는 owner를 찾는다. 결과는 Page<Owner> 타입으로 반환된다. 목록 페이지 렌더링에 사용된다. @Query 어노테이션을 통해 직접 쿼리문을 작성하고 있다. @Transactional에 readOnly 속성을 주어 읽기 전용으로 설정한다.

- findById(id)

@Query("SELECT owner FROM Owner owner left join fetch owner.pets WHERE owner.id =:id")
@Transactional(readOnly = true)
Owner findById(@Param("id") Integer id);

데이터베이스에서 id가 일치하는 Owner를 찾는다. 결과는 Owner 타입으로 반환된다. @Query 어노테이션을 통해 직접 쿼리문을 작성하고 있다. @Transactional에 readOnly 속성을 주어 읽기 전용으로 설정한다.

- save(owner)

void save(Owner owner);

데이터베이스에 owner를 저장한다. 쿼리문의 생성을 JPA에게 맡기고 있다.

- findAll(pageable)

@Query("SELECT owner FROM Owner owner")
@Transactional(readOnly = true)
Page<Owner> findAll(Pageable pageable);

데이터베이스에서 모든 Owner를 찾는다. 결과는 Page<Owner> 타입으로 반환된다. 목록 페이지 렌더링에 사용된다. @Query 어노테이션을 통해 직접 쿼리문을 작성하고 있다. @Transactional에 readOnly 속성을 주어 읽기 전용으로 설정한다.

🧑🏻‍⚕️ VetRepository

VetRepository는 Veterinarian의 목록을 불러오는 메서드만을 가지고 있다. OwnerRepository에 비해 메서드의 수가 적다. 두 가지밖에 없다. 이 둘의 차이점은 파라미터의 유무와 그에 따른 반환 타입이 다르다는 점이다.

- findAll()

@Transactional(readOnly = true)
@Cacheable("vets")
Collection<Vet> findAll() throws DataAccessException;

데이터베이스에서 모든 Vet을 찾는다. 결과는 Collection<Vet> 타입으로 반환된다. @Transactional에 readOnly 속성을 주어 읽기 전용으로 설정한다. @Cacheable 어노테이션을 통해 캐시 설정을 한다. Pet Clinic에서 Vet의 목록은 수정할 수 없기 때문에 캐시 설정을 하는 것이 유리하다. (Vet 목록을 바꿀 수 있게 코드를 수정하면 이 어노테이션은 제거하는 편이 좋다.) DataAccessException이 발생할 경우 throw 한다. (다른 메소드에게 처리 위임)

- findAll(pageable)

@Transactional(readOnly = true)
@Cacheable("vets")
Page<Vet> findAll(Pageable pageable) throws DataAccessException;

데이터베이스에서 모든 Vet을 찾는다. 결과는 Page<Vet> 타입으로 반환된다. 목록 페이지 렌더링에 사용된다. @Transactional에 readOnly 속성을 주어 읽기 전용으로 설정한다. @Cacheable 어노테이션을 통해 캐시설정을 한다. DataAccessException이 발생할 경우 throw 한다.

🗒 Repository의 naming convention

Repository의 메서드 naming convention은 기본적으로 read 작업의 경우 findBy{찾을대상}(대상 특정 정보)으로 한다. 대상의 모든 목록을 필요로할 경우 findAll으로 한다. 데이터 저장(create, update 등)의 경우 save(저장 대상)으로 한다. 자세한 사항은 아래의 참고 링크를 활용하면 된다.

🧩 마무리

길고 길었던 Pet Clinic의 분석이 끝났다. 막판에는 이걸 왜 하고 있는가에 대한 현타가 왔지만, 어쨌든 간에 이 분석한 내용을 토대로 실제 프로젝트에 적용해 보는 것이 실력 향상을 위한 길이겠지.. 일단 뭐를 해야 할지 고민이지만 얼른 정해서 프로젝트를 진행할 예정이다. 끝까지 포기하지 않고 진행하는 것이 목표다..! 화이팅~!!