[SpringBoot] JpaRepository 생성과 데이터 조회하기🔍

JpaRepository 생성하기

Repository란?

entity에 의해 생성된 db테이블에 접근하는 함수(ex: findAll, save 등)들을 사용하기 위한 인터페이스이다. CRUD를 어떻게 처리할지 정의하는 계층이다.

 

 

PlaceRepository 인터페이스를 생성하는 코드는 다음과 같다.

package com.goingto.back;

import org.springframework.data.jpa.repository.JpaRepository;
public interface PlaceRepository extends JpaRepository<Place, Integer>{

}

리포지터리로 만들기 위해 JpaRepository 인터페이스를 상속했다.

상속할 때는 제네릭스 타입으로 엔티티의 타입과 해당 엔티티의 PK 속성 타입을 지정해야 한다.

Place 엔티티는 Integer(id 값) 속성의 PK 타입을 가졌기 때문에 <Place, Integer>라고 작성했다.

 

 

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

src/test/java/com/goingto/back/BackApplicationsTests.java 파일에 테스트하고 싶은 코드를 작성해준다.

package com.goingto.back;

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

@SpringBootTest
class BackApplicationTests {

    @Autowired
    private PlaceRepository placeRepository;

    @Test
    void testJpa() {
        Place p = new Place();
        p.setName("아이슬란드");
        p.setSeason("봄");
        p.setBudget(500);
        p.setIsDomestic(false);
        p.setPrefer("휴양");
        this.placeRepository.save(p);
    }
}

위 코드는 Place 객체를 생성하여 Setter로 속성을 지정한 후 저장한다.

 

@Autowired는 스프링의 DI(Dependency Injection) 기능으로 placeRepository 객체를 자동으로 생성해준다.

실제 코드를 작성할 때에는 순환참조와 같은 문제로 생성자 혹은 Setter를 통한 객체 생성이 권장된다. 하지만 테스트 코드의 경우에는 생성자를 통한 객체 주입이 불가능하기 때문에 @Autowired를 사용했다.

 

---

 

데이터 조회하기

findAll() : 모든 데이터 조회

package com.goingto.back;

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

import java.util.List;

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

@SpringBootTest
class BackApplicationTests {

    @Autowired
    private PlaceRepository placeRepository;

    @Test
    void testJpa() {
        List<Place> all = this.placeRepository.findAll();
        assertEquals(3, all.size());//db사이즈가 3인지
    }
}

assertEquals(기댓값, 실제값)은 기댓값과 실제값이 동일한지 조사한다. 만약 동일하지 않다면 test는 실패로 처리된다.

 

findById() : Id 값으로 데이터 조회

함수의 리턴 타입이 Place가 아닌 Optional이라는 점에 주의해야한다.

 

Optional은 null 처리를 유연하게 하기 위해 사용하는 클래스로, isPresent()로 null이 아닌지 확인한 후에 get()으로 실제 Place 객체를 얻어야 한다.

package com.goingto.back;

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

import java.util.Optional;

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

@SpringBootTest
class BackApplicationTests {

    @Autowired
    private PlaceRepository placeRepository;

    @Test
    void testJpa() {
        Optional<Place> op = this.placeRepository.findById(2);
        if(op.isPresent()){
            Place p = op.get();
            assertEquals("베트남", p.getName()); 
        }
    }
}

 

findByName(), findBySeason(), findByBudget()...

위의 함수들은 엔티티에 특정된 조회 기능이다. 따라서 PlaceRepository 인터페이스에 직접 작성해줘야 사용할 수 있다.

다음과 같이 PlaceRepository.java 파일을 작성했다. 반환 값이 여러 개인 경우에는 함수의 리턴 타입을 List로 해야 한다.

package com.goingto.back;

import java.util.List;

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

public interface PlaceRepository extends JpaRepository<Place, Integer>{
    List<Place> findByBudget(Integer budget);
    Place findByImg(String img);
    List<Place> findByIsDomestic(Boolean isDomestic);
    Place findByName(String name);
    List<Place> findByPrefer(String prefer);
    List<Place> findByScenery(String scenery);
    List<Place> findBySeason(String season);
}

 

 

이제 인터페이스에 작성한 함수를 통해 원하는 특정 테이블 데이터를 조회할 수 있다!

 

나는 season 속성이 "봄"인 데이터를 조회하기 위해 다음과 같이 테스트 코드를 작성했고 테스트는 아주 잘 통과됐다.😀

package com.goingto.back;

import java.util.List;

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

@SpringBootTest
class BackApplicationTests {

    @Autowired
    private PlaceRepository placeRepository;

    @Test
    void testJpa() {
        List<Place> p= this.placeRepository.findBySeason("봄");
        for (int i=0;i<p.size();i++){
            System.out.println(p.get(i).getName());
        }
    }
}

 

만약 두 가지 속성으로 데이터를 조회하고 싶다면 findBy<속성1>And<속성2> 함수를 Repository에 추가하면 된다.

 

이와 같이 JpaRepository의 함수명은 규칙에 맞게 작성했을 때 SQL 구문의 where 조건을 결정짓는 역할을 해준다.

And 외에도 Or, Between 등으로 쉽게 원하는 데이터를 조회할 수 있다.

 

 

함수 명의 생성 규칙에 대한 자세한 내용은 공식문서를 참고하면 좋을 것 같다.

https://docs.spring.io/spring-data/jpa/docs/current/reference/html/#jpa.query-methods.query-creation

Spring Data JPA - Reference Documentation