JPA - QueryMethods

📖 QueryMethods?

JPA Repository에서 제공하는 Query Methods는 개발자가 데이터베이스에게 질의하기 위한 메서드를 제공합니다. QueryMethods를 사용하면 데이터베이스에 대한 쿼리를 간편하게 작성할 수 있어 개발 생산성이 향상되는 것을 기대할 수 있습니다.

QueryMethods는 메서드 이름 규칙을 이용하여 데이터베이스 쿼리를 생성합니다. 예를 들어 findBy뒤에 Id와 같은 속성을 이용하여 해당 Id를 가진 엔티티를 조회하는 쿼리를 생성할 수 있습니다.

작성 방법

repository인터페이스를 작성하여 JpaRepository를 상속받습니다. Query Methods작성은 메서드 이름을 통해 쿼리를 작성하는 방법입니다. Spring Data JPA에서는 메서드 이름에 따라 쿼리를 생성하기 때문에 적절한 이름을 작성해야 합니다.

JPA Repository

public interface UserRepository extends JpaRepository<UserData, Long> {
    UserData findByEmail(String email);

    UserData findById(int id);

    List<UserData> findAllByName(String name);
}

Test

    @Test
    void findTest() {
        UserData data1 = repository.findByEmail("dennis@naver.com");
        List<UserData> data2 = repository.findAllByName("martin");
        UserData data3 = repository.findSomethingByEmail("dennis@naver.com");
        System.out.println("data 1 : "+data1);
        System.out.println("data 2 : "+data2);
        System.out.println("data 3 : "+data3);
    }

data 1 : UserData(id=2, name=dennis, email=dennis@naver.com, createdAt=2023-02-21T15:00:13.745773, updatedAt=2023-02-21T15:00:13.745773)

data 2 : [UserData(id=1, name=martin, email=martin@naver.com, createdAt=2023-02-21T15:00:13.744833, updatedAt=2023-02-21T15:00:13.744833), UserData(id=5, name=martin, email=martin@another.com, createdAt=2023-02-21T15:00:13.746473, updatedAt=2023-02-21T15:00:13.746473)]

data 3 : UserData(id=2, name=dennis, email=dennis@naver.com, createdAt=2023-02-21T15:00:13.745773, updatedAt=2023-02-21T15:00:13.745773)

만들어진 쿼리문

data1

    select
        u1_0.id,
        u1_0.created_at,
        u1_0.email,
        u1_0.name,
        u1_0.updated_at 
    from
        user_data u1_0 
    where
        u1_0.email=?

data2

    select
        u1_0.id,
        u1_0.created_at,
        u1_0.email,
        u1_0.name,
        u1_0.updated_at 
    from
        user_data u1_0 
    where
        u1_0.name=?

data3

    select
        u1_0.id,
        u1_0.created_at,
        u1_0.email,
        u1_0.name,
        u1_0.updated_at 
    from
        user_data u1_0 
    where
        u1_0.email=?

data2의 경우 find{All}By{Name} 메서드 네임에 쿼리문을 만들고 결과값도 잘 나왔습니다.

data1, data3은 다른 메서드 네임을 가지고 있지만 동일한 결과가 나왔습니다. find{Something}By{Email}의 메서드에서 Something이 해석되지 않았습니다. 알 수 없는 의미의 단어는 무시하고 메서드를 실행하는 것을 알 수 있으며 에러를 발생시키지 않는 것을 확인할 수 있습니다.

메서드 이름은 쿼리를 생성하는데 영향을 미치기 때문에 적절하게 작성해야 합니다. 규격에는 맞게 작성하였으나 의미를 알기 힘든 메서드 네임은 위의 예시 처럼 해당 단어를 빼고 실행하고 에러를 출력하지 않습니다. 그럼 Repository에 사용하는 메서드는 에러가 나지 않는걸까요? 그렇지 않습니다.

부적절한 메서드

    @Test
    void runTimeTest() {
        UserData data = repository.findByByName("dennis");
        System.out.println("data : "+data);
    }

컴파일 오류가 아닌 대상을 찾지 못해 쿼리를 만들지 못한다는 런타임 오류가 나오게 됩니다.

이처럼 메서드 이름으로 쿼리문이 어떻게 작성되는지 확인하였습니다. 이제까지는 조건이 하나 혹은 하나의 조건에 만족하는 데이터를 모두 불러오는 것을 하였습니다. 조건이 2개인 경우 역시 동일하게 메서드 네임으로 결정합니다.

예시

    @Test
    void findAndOrTest() {
        UserData data1 = repository.findByNameAndEmail("martin", "martin@another.com");
        List<UserData> data2 = repository.findByNameOrEmail("martin", "dennis@naver.com");
        List<UserData> data3 = repository.findFirstByName("martin");
        System.out.println("data 1 : "+data1);
        System.out.println("data 2 : "+data2);
        System.out.println("data 3 : "+data3);
    }

Query

    select
        u1_0.id,
        u1_0.created_at,
        u1_0.email,
        u1_0.name,
        u1_0.updated_at 
    from
        user_data u1_0 
    where
        u1_0.name=? 
        and u1_0.email=?

    select
        u1_0.id,
        u1_0.created_at,
        u1_0.email,
        u1_0.name,
        u1_0.updated_at 
    from
        user_data u1_0 
    where
        u1_0.name=? 
        or u1_0.email=?

    select
        u1_0.id,
        u1_0.created_at,
        u1_0.email,
        u1_0.name,
        u1_0.updated_at 
    from
        user_data u1_0 
    where
        u1_0.name=? fetch first ? rows only

실행결과

data 1 : UserData(id=5, name=martin, email=martin@another.com, createdAt=2023-02-21T15:42:19.088832, updatedAt=2023-02-21T15:42:19.088832)

data 2 : [UserData(id=1, name=martin, email=martin@naver.com, createdAt=2023-02-21T15:42:19.086632, updatedAt=2023-02-21T15:42:19.086632), UserData(id=2, name=dennis, email=dennis@naver.com, createdAt=2023-02-21T15:42:19.088095, updatedAt=2023-02-21T15:42:19.088095), UserData(id=5, name=martin, email=martin@another.com, createdAt=2023-02-21T15:42:19.088832, updatedAt=2023-02-21T15:42:19.088832)]

data 3 : [UserData(id=1, name=martin, email=martin@naver.com, createdAt=2023-02-21T15:42:19.086632, updatedAt=2023-02-21T15:42:19.086632)]

메서드 네임의 의도대로 작성된 쿼리문과 실행결과가 나오는 것을 확인할 수 있습니다.

그 밖에도 여러가지 메서드로 쿼리를 작성할 수 있으며 다양한 기능을 제공합니다.

return type

JPA Repository에서 메서드의 반환형은 다양한 형태로 지정할 수 있습니다. 가장 일반적으로 엔티티, 엔티티를 담고있는 리스트와 같은 컬렉션 타입이 있습니다. 다른 반환형으로는 프로덕션 타입이 있습니다.

프로덕션은 엔티티의 일부 속성만 선택하여 조회하고 일부 속성만 반환하여 int,long과 같은 기본형 반환할 수도 있습니다. 또한 일부 속성이 들어있는 인터페이스, 클래스로 지정할 수도 있습니다. 후자의 경우 DTO 개념을 이용하여 객체를 변환하여 사용합니다.

해당 메서드가 null 값을 반환하는 경우가 있을 때 명시적으로 처리하기 위하여 Optional객체를 사용할 수도 있습니다. 데이터를 조회할 때, 해당하는 데이터가 존재하지 않을 수 있습니다. 메서드가 null을 반환하는 경우 호출한 코드에서 이를 처리해야 합니다. Optional 객체를 사용하면 메서드가 null반환시 Optional.empty()를 반환하여 호출한 코드에서 처리하기 용이합니다.

조회 결과가 null일 가능성이 있어 Optional 객체로 감싸 반환하면 해당 객체가 null인지 아닌지 명시적으로 처리가 가능하여 안정성과 가독성이 개선될 수 있습니다. 하지만 메서드가 null을 반환하는 경우를 모두 체크하는 것은 좋지 않습니다. Wrapper클래스 이기 때문에 두개의 참조를 가지므로 생성하는데 메모리를 더 차지하게 됩니다. Optional이 필요한 부분에만 사용하면 유연한 코드를 작성할 수 있습니다.

CRUD

기본적인 CRUD의 경우 JpaRepository를 상속받게 되면 따로 적지 않아도 실행이 가능합니다. @Entity를 사용하고 JpaRepository를 상속받았으면 Create역할은 자동으로 되었습니다. 하지만 코드를 들어가서 보면 save,delete,find 와 같은 메서드만 보이게 됩니다. delete는 D, find는 R에 해당되는데 save는 insert,update를 다 해주는 걸까요?

save 예제

    @Test
    void saveTest() {
        UserData data = new UserData("name", "mail");
        repository.save(data);
        printList();
        data.setName("Chan");
        repository.save(data);
        printList();
    }

결과

UserData(id=6, name=name, email=mail, createdAt=null, updatedAt=null)
UserData(id=6, name=Chan, email=mail, createdAt=null, updatedAt=null)

첫번째는 insert, 두번째 경우에는 update가 된 것을 확인할 수 있습니다. save메서드의 코드를 보면 다음과 같이 나오게 됩니다.

	@Transactional
	@Override
	public <S extends T> S save(S entity) {

		Assert.notNull(entity, "Entity must not be null");

		if (entityInformation.isNew(entity)) {
			em.persist(entity);
			return entity;
		} else {
			return em.merge(entity);
		}
	}

JpaRepository의 save를 호출하게되면 CrudRepository에서 save를 호출하고 구현된 메서드는 SimpleJpaRepository에서 구현됩니다. 해당 메서드를 살펴보면 Entity가 null이 아닌경우에 사용이 가능하며 isNew(entity) 를 호출하여 true인 경우 insert, false인 경우 update로 진행되는거 같이 보입니다. 좀 더 상세히 확인해보겠습니다.

isNew(entity)

	public boolean isNew(T entity) {

		ID id = getId(entity);
		Class<ID> idType = getIdType();

		if (!idType.isPrimitive()) {
			return id == null;
		}

		if (id instanceof Number) {
			return ((Number) id).longValue() == 0L;
		}

		throw new IllegalArgumentException(String.format("Unsupported primitive id type %s", idType));
	}

해당 엔티티의 id가 null 또는 0인지 판단하여 해당되는 경우에 새로운 엔티티임을 boolean타입으로 알려줍니다.

이 과정을 거쳐 persist() 호출 후 entity반환 혹은 merge()를 호출 후 entity 반환하게 됩니다. 해당 메서드들은 EntityManager에 속하여 있습니다. JPA는 EntityManager, 영속성 컨텍스트를 통해 데이터 상태 변화를 감지하고 필요한 쿼리를 자동으로 수행합니다. Application이 시작될 때 해당 클래스를 자동으로 bean에 등록합니다.

EntityManager는 Entity의 생명 주기와 트랜잭션 등을 관리하며 영속성 컨텍스트(엔티티를 영구 저장하는 환경)에 접근하는 객체입니다.

영속성 컨텍스트는 애플리케이션과 데이터베이스 사이에 객체를 보관하는 가상의 데이터베이스 같은 역할을 합니다. 엔티티 매니저를 생성할 때 하나 만들어지며 엔티티 매니저를 통해 접근 및 관리가 가능합니다.

이러한 영속성 컨텍스트, EntityManager에서 관리되면 Entity에는 생명 주기가 존재합니다.

Entity 생명주기

• 비영속(new/transient) : 영속성 컨텍스트와 현재 관계가 없는 상태
• 삭제(removed) : 삭제된 상태
• 영속(persisted) : 영속성 컨텍스트에 저장된 상태
• 준영속(detached) : 영속성 컨텍스트에 저장되었다가 분리된 상태 -> 값을 가지고 있지만 영속성 컨텍스트에서 제공하는 기능에 동작하지 않는 상태

다시 돌아와서 persist(), merge()에 대해 알아보겠습니다. Entity를 처음 생성하면 비영속 상태이기 때문에 save -> TRANSIENT 상태 확인 -> persist()를 호출하여 영속상태로 만들어 줍니다.

동일한 Entity를 가지고 save를 호출한다면 해당 엔티티의 상태가 비영속 상태가 아닌 것을 확인합니다. 이 때 영속성 컨텍스트에서 나왔기 때문에 Detached상태 입니다. 1차 캐시에 해당 엔티티의 식별자가 있으면 db조회를 하지 않고 없는 경우 db조회를 하여 입력받은 객체를 복사합니다. 복사한 객체를 db에 반영합니다. 즉, merge() -> select 이후 insert가 실행되는 형식입니다.

🤔 사용해야 하는 이유는?

QueryMethods를 이용하여 쿼리를 작성하는데 필요한 복잡한 코드를 줄일 수 있으며, 개발 생산성을 향상시킬 수 있습니다. QueryMethods는 메서드 이름에 따라 다양한 파라미터 타입을 제공하여 적절하게 원하는 데이터를 가져올 수 있습니다. 이러한 장점은 데이터베이스와 연동되는 어플리케이션을 쉽고 빠르게 개발하는데 도움을 줍니다.

❌ 문제가 되는 경우 -> 제약 사항

1. 메서드 네이밍

QueryMethod를 사용하면 메서드명으로 쿼리를 만들기 때문에 복잡해질 수 있으며 가독성이 떨어질 수 있습니다.

2. 쿼리문의 제약

JPA Repository에서 제공하는 메서드로 쿼리를 생성하기 때문에 복잡한 쿼리는 직접 작성해야하는 제약이 생길 수 있습니다.

3. 유연성 문제

메서드 시그니처를 변경하지 않고는 쿼리를 수정할 수 없습니다. 쿼리 변경을 위해서는 새로운 메서드를 추가해야 하며 복잡한 쿼리문의 경우 직접 작성하는 것이 더 나을 수도 있습니다.

이러한 제약사항들을 해결하기 위해 ORM에 대한 이해를 높이고 적절한 쿼리 메서드를 사용하여 최적화를 해야합니다.

✅ 요약

• JPA QueryMethods는 데이터베이스에 접근하기위한 질의문을 SpringFramework에서 메서드로 제공해준다.
• 메서드명으로 쿼리문을 만들기 때문에 따로 쿼리문을 작성하지 않아도 된다.
• 기본적인 CRUD는 메서드 작성없이도 제공한다.
• 복잡한 쿼리문은 직접 작성해야 하거나, 직접 작성하는 것이 더 나을수도 있다.