JAVA | JPA Repository의 사용법과 메서드

JPA가 무엇일까 ?

---

JPA는 이전에 정리해보았으니 이번에는 JPA Repository에 대해 알아보고자 한다.

 

▼ JPA 정리글

 

JAVA | JPA 알아보기 (JPA, JDBC, Hibernate & JPA)

 

---

JPA Repository

---

• Java 언어를 사용하여 데이터베이스와 상호 작용하는 데 도움을 주는 인터페이스
• 애플리케이션에서 데이터베이스와 상호 작용하기 위해 사용되며, 데이터베이스 테이블에 대한 CRUD(Create, Read, Update, Delete) 작업을 수행

예시를 들자면, 객체에 있는 데이터를 조회하거나 수정, 저장, 삭제 등의 작업을 수행할 때 Spring JPA에서 제공하는 Repository라는 인터페이스를 정의해 해당 Entity의 데이터를 사용할 수 있도록 도와주는 역할을 한다.

 

JPA Repository는 내부적으로 EntityManager가 직접 대상 Entity의 데이터를 관리하기 때문에 Repository 인터페이스를 정의하지 않고도 직접 EntityManger를 사용해 Persistance Layer를 구현 할 수 있지만 Spring JPA에서 Repository의 내부 구현체를 자동으로 생성시켜 주기 때문에 별도의 구현체를 따로 생성하지 않아도 된다.

 

* persistance layer : 프로그램의 아키텍처에서, 데이터에 영속성을 부여해주는 계층

 

📌 repository를 사용하는 이유

 

• 객체와 데이터베이스 간의 매핑 관리 : JPA 리포지토리는 ORM(Object-Relational Mapping)을 통해 객체와 데이터베이스 간의 매핑을 처리하므로, 객체 지향적인 프로그래밍 모델을 사용하여 데이터베이스를 조작할 수 있다.

 

• CRUD 작업 간소화 : JPA 리포지토리는 데이터베이스의 CRUD(Create, Read, Update, Delete) 작업을 메서드 호출을 통해 간단하게 수행할 수 있도록 돕는다. JPA는 쿼리 메서드를 사용하여 메서드 이름에 따라 데이터베이스 조회를 자동으로 생성하고 실행할 수 있어 개발자는 SQL 쿼리 작성에 신경쓰지 않고도 데이터베이스 작업을 수행할 수 있다.

 

• 유연한 검색 기능 : JPA 리포지토리는 쿼리 메서드와 @Query 어노테이션을 사용하여 동적인 검색 기능을 제공한다.개발자는 메서드 시그니처를 조합하여 복잡한 쿼리를 작성하고 실행할 수 있다. 이를 통해 필요한 검색 조건에 맞게 데이터를 조회하고 필터링할 수 있다.

 

• 트랜잭션 관리 : JPA 리포지토리는 트랜잭션을 관리하여 데이터베이스 작업의 일관성과 안전성을 보장한다. 트랜잭션 내에서 JPA 리포지토리 메서드를 호출하면, 변경된 데이터는 트랜잭션이 커밋될 때까지 영속성 컨텍스트에 저장되며, 롤백이 발생하면 변경 사항도 롤백된다. 이를 통해 데이터 일관성을 유지하고 데이터 조작을 방지할 수 있다.

 

• 코드 재사용과 유지보수성 : JPA 리포지토리를 사용하면 데이터베이스 작업과 관련된 로직을 별도의 리포지토리 클래스로 분리할 수 있다. 이를 통해 코드 재사용성이 향상되고, 데이터베이스 관련 로직을 중앙 집중화하여 유지보수성을 향상시킬 수 있다.

 

JPA Repository는 데이터베이스 작업을 추상화하고, 객체 지향적인 프로그래밍 모델을 사용하여 데이터베이스와 상호 작용할 수 있는 편리한 방법을 제공한다. 이를 통해 개발자는 더 간편하고 생산적으로 데이터베이스를 다룰 수 있으며, 코드의 가독성과 유지보수성도 향상시킬 수 있다.

 

---

1. JpaRepository 생성 규칙

 

package com.mysite.sbb;

import org.springframework.data.jpa.repository.JpaRepository;

public interface QuestionRepository extends JpaRepository<Question, Integer> {

}

 

예시로 QuestionRepository를 생성하였을 때, 리포지터리를 만들기 위해 JpaRepository 인터페이스를 상속하였다. JpaRepository를 상속할 때는 제네릭스 타입으로 <Question, Integer> 처럼 리포지터리의 대상이 되는 엔티티의 타입(Question)과 해당 엔티티의 PK의 속성 타입(Integer)을 지정해야 한다. 이것은 JpaRepository를 생성하기 위한 규칙이다.

 

pulibc interface [Repository 이름] extends JpaRepository<[객체 타입], [객체 PK 속성 타입]> {}

 

---

2. 데이터 저장하기 - save()

 

작성한 repository를 테스트 하기 위해 JUnit 기반의 스프링부트의 테스트 프레임워크를 사용한다.

 

import java.time.LocalDateTime;

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;


@SpringBootTest
class SbbApplicationTests {

    @Autowired
    private QuestionRepository questionRepository;

    @Test
    void testJpa() {        
        Question q1 = new Question();
        q1.setSubject("sbb가 무엇인가요?");
        q1.setContent("sbb에 대해서 알고 싶습니다.");
        q1.setCreateDate(LocalDateTime.now());
        this.questionRepository.save(q1);  // 첫번째 질문 저장

        Question q2 = new Question();
        q2.setSubject("스프링부트 모델 질문입니다.");
        q2.setContent("id는 자동으로 생성되나요?");
        q2.setCreateDate(LocalDateTime.now());
        this.questionRepository.save(q2);  // 두번째 질문 저장
    }
}

 

위의 메서드는 q1, q2 라는 Question 엔티티 객체를 생성하고, QuestionRepository를 이용하여 그 값을 데이터베이스에 저장하는 코드이다.

 

Line 20을 보면, save() 메서드를 사용하여 엔티티를 저장한 것을 알 수 있다. insert()와 update() 기능을 구현하고자 할 때 사용한다.

 

@Autowired 애너테이션: 스프링의 DI 기능으로 questionRepository 객체를 스프링이 자동으로 생성해 준다.
@Test 애너테이션 :  testJpa 메서드가 테스트 메서드임을 나타낸다. 위 클래스를 JUnit으로 실행하면 @Test 애너테이션이 붙은 메서드가 실행된다.

@Autowired
객체를 주입하기 위해 사용하는 스프링의 애너테이션이다. 객체를 주입하는 방식에는 @Autowired 외에 Setter 또는 생성자를 사용하는 방식이 있다. 순환참조 문제와 같은 이유로 @Autowired 보다는 생성자를 통한 객체 주입방식이 권장된다. 하지만 테스트 코드의 경우에는 생성자를 통한 객체의 주입이 불가능하므로 테스트 코드 작성시에만 @Autowired를 사용하고 실제 코드 작성시에는 생성자를 통한 객체 주입방식을 사용하겠다.

 

* DI(Dependency Injection) - 스프링이 객체를 대신 생성하여 주입한다.

 

---

3. 데이터 조회하기 - findAll()

 

이번에는 데이터베이스에 저장된 데이터를 조회해 보자.

 

import static org.junit.jupiter.api.Assertions.assertEquals;

import java.util.List;

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;


@SpringBootTest
class SbbApplicationTests {

    @Autowired
    private QuestionRepository questionRepository;

    @Test
    void testJpa() {
        List<Question> all = this.questionRepository.findAll();
        assertEquals(2, all.size()); // JUnit method
      

        Question q = all.get(0);
        assertEquals("sbb가 무엇인가요?", q.getSubject());
    }
}

 

question 테이블에 저장된 모든 데이터를 조회하기 위해서 리포지터리의 findAll 메서드를 사용했다.

 

findAll : DB에서 전체값을 list로 불러옴

 

JUnit & 메서드 설명

>> 총 2건의 데이터를 저장했기 때문에 데이터의 사이즈는 2가 되어야 한다. 데이터 사이즈가 2인지 확인하기 위해 JUnit의 assertEquals 메서드를 사용했다. assertEquals는 assertEquals(기대값, 실제값)와 같이 사용하고 기대값과 실제값이 동일한지를 조사한다. 만약 기대값과 실제값이 동일하지 않다면 테스트는 실패로 처리된다. 그리고 저장한 첫번째 데이터의 제목이 "sbb가 무엇인가요?"와 일치하는지도 테스트했다.

 

findBy__()

 

이번에는 Question 엔티티의 Id값으로 데이터를 조회해 보자.

 

import static org.junit.jupiter.api.Assertions.assertEquals;

import java.util.Optional;

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;


@SpringBootTest
class SbbApplicationTests {

    @Autowired
    private QuestionRepository questionRepository;

    @Test
    void testJpa() {
        Optional<Question> oq = this.questionRepository.findById(1);
        if(oq.isPresent()) {
            Question q = oq.get();
            assertEquals("sbb가 무엇인가요?", q.getSubject());
        }
    }
}

 

id 값으로 데이터를 조회하기 위해서는 리포지터리의 findById 메서드를 사용한다. 하지만 findById의 리턴 타입은 Question이 아닌 Optional임에 주의하자. Optional은 null 처리를 유연하게 처리하기 위해 사용하는 클래스로 위와 같이 isPresent로 null이 아닌지를 확인한 후에 get으로 실제 Question 객체 값을 얻어야 한다.

 

다음과 같이 findBy__에서 뒷부분에 정의한 Entity 이름을 붙이면 특정 entity의 데이터를 조회할 수 있다.
ex) findByProductId()

 

findBySubject

 

기본적으로 제공하지 않는 메서드를 사용하기 위해서는 다음과 같이 QuestionRepository 인터페이스를 변경해야 한다.

 

public interface QuestionRepository extends JpaRepository<Question, Integer> {
    Question findBySubject(String subject);
}

 

그러면 다음처럼 제목으로 테이블 데이터를 조회할 수 있다.

 

import static org.junit.jupiter.api.Assertions.assertEquals;

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;


@SpringBootTest
class SbbApplicationTests {

    @Autowired
    private QuestionRepository questionRepository;

    @Test
    void testJpa() {
        Question q = this.questionRepository.findBySubject("sbb가 무엇인가요?");
        assertEquals(1, q.getId());
    }
}

 

이러한 코드를 작성하고 테스트를 진행하면 테스트는 잘 통과된다. 그런데 코드를 보다보면 "인터페이스에 findBySubject 라는 메서드를 선언만 하고 구현은 하지 않았는데 도대체 어떻게 실행이 되는 거지?"라는 의문이 생긴다. 

 

이는 JpaRepository를 상속한 QuestionRepository 객체 때문에 가능한 일이다. (DI에 의해 스프링이 자동으로 QuestionRepository 객체를 생성한다. 이 때 프록시 패턴이 사용된다고 한다.) 리포지터리 객체의 메서드가 실행될때 JPA가 해당 메서드명을 분석하여 쿼리를 만들고 실행한다.

 

즉, findBy + 엔티티의 속성명(예:findBySubject)과 같은 리포지터리 메서드를 작성하면 해당 속성의 값으로 데이터를 조회할수 있다. findBySubject 메서드를 호출할때 실제로 실행되는 쿼리는 다음과 같다.

 

이미지 출처 : 위키 독스

 

이외에도 쿼리의 조건을 변경하여 데이터를 조회할 수도 있는데, 이러한 메서드의 명명법은 다음과 같이 정리할 수 있다.

 

항목	설명	예제
And	여러 컬럼을 and 조건으로 검색	findBySubjectAndContetnt(Stringsubject, String content)
Or	여러 컬럼을 or 조건으로 검색	findBySubjectOrContent(Stringsubject, String content)
Between	컬럼을 between으로 검색	findByCreateDateBetween(LocalDateTime fromData, LocalDateTime toDate)
LessThan	작은 항목 검색	findByIdLessThan(Integer id)
GreaterThanEqual	크거나 같은 항목 검색	findByIdGreaterThanEqual(Integer id)
Like	like 검색	findBySubjectLike(String subject)
In	여러 값 중에 하나인 항목 검색	findBySubjectIn(String[] subjects)
OrderBy	검색 결과를 정렬하여 전달	findBySubjectOrderByCreateDateAsc(String subject)

 

---

4. 데이터 수정하기

 

이번에는 질문 데이터를 수정하는 테스트 코드를 작성해 보자.

 

import static org.junit.jupiter.api.Assertions.assertTrue;

import java.util.Optional;

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;


@SpringBootTest
class SbbApplicationTests {

    @Autowired
    private QuestionRepository questionRepository;

    @Test
    void testJpa() {
        Optional<Question> oq = this.questionRepository.findById(1);
        assertTrue(oq.isPresent());
        Question q = oq.get();
        q.setSubject("수정된 제목");
        this.questionRepository.save(q);
    }
}

 

 

질문 데이터를 조회(findById)한 다음 subject를 "수정된 제목" 이라는 값으로 수정했다. 변경된 Question 데이터를 저장하기 위해서는 this.questionRepository.save(q) 처럼 리포지터리의 save 메서드를 사용한다. (저장과 동일)

 

---

5. 데이터 삭제하기

 

이어서 데이터를 삭제하는 것도 실습해 보자.

 

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertTrue;

import java.util.Optional;

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;


@SpringBootTest
class SbbApplicationTests {

    @Autowired
    private QuestionRepository questionRepository;

    @Test
    void testJpa() {
        assertEquals(2, this.questionRepository.count());
        Optional<Question> oq = this.questionRepository.findById(1);
        assertTrue(oq.isPresent());
        Question q = oq.get();
        this.questionRepository.delete(q);
        assertEquals(1, this.questionRepository.count());
    }
}

 

리포지터리의 count() 메서드는 해당 리포지터리의 총 데이터건수를 리턴한다.

 

Question 리포지터리의 delete 메서드를 사용하여 데이터를 삭제했다. 삭제하기 전에는 데이터 건수가 2, 삭제한 후에는 데이터 건수가 1인지를 테스트한다. 

 

(파란색 표시 : 공부해야할 부분)

 

---

참고자료

---

https://akdl911215.tistory.com/307

JPA Repository를 사용하는 이유

https://wikidocs.net/160890#_1

2-05 리포지터리

https://zara49.tistory.com/130

[JPA] JPA Repository 메서드 명명규칙