[배워보자 Spring Data JPA] Spring Data JPA 의 기본과 프로젝트 생성

해당 글은 배워보자 Spring Data JPA 시리즈 입니다.
해당 시리즈의 내용이 이어지는 형태이므로 글의 내용 중에 생략되는 말들이 있을 수 있으니, 자세한 사항은 아래 링크를 참고해주세요!

• Spring Data JPA의 기본과 프로젝트 생성 :: 시리즈 학습 환경 준비
  • JPA의 기본과 Spring Data JPA
  • Springboot project 에서 JPA 설정하기
• JPA의 기본 어노테이션들 :: JPA의 시작과 동시에 끝
  • 엔티티와 테이블 매핑
  • 필드와 컬럼 매핑
• 매핑 테이블과 연관관계 매핑하기 :: RDB의 꽃, 연관 관계
  • 연관관계란?, 외래 키란?, 매핑 테이블이란?
  • 일대일, 일대다, 다대일 연관관계
• 공통 인터페이스 기능 :: 어떻게 Data JPA 는 동작할까?
  • 단건 조회 반환 타입
  • 컬렉션 조회 반환 타입
• 사용자 정의 쿼리 이용하는 방법 :: 내가 원하는 쿼리를 JPA 에서 만들어보자!
  • 메서드 이름으로 쿼리 생성하기
  • @Query 를 이용하여 메서드에 정적 쿼리 작성하기
• 페이징과 정렬 :: 게시판과 같은 페이지가 있는 서비스에서 빛을 발하는 JPA 페이징!
  • Data JPA의 페이징과 정렬
  • Web MVC 에서 JPA 페이징과 정렬
• Auditing :: 모든 요청과 응답에 누가, 언제 접근했는지 하나의 엔티티로 관리하자.
  • 순수 JPA의 Auditing
  • Spring Data JPA의 Auditing
• 배워보자 Spring Data JPA 시리즈를 마치며...
  • 시리즈를 마치며 느낀점
  • 내가 정보를 얻은 곳
  • 해당 시리즈를 완주하셨나요?

---

오늘은 JPA 에 대한 기본과 Spring Data JPA 에 대해서 알아볼 것이다.

 

우선 Spring을 통해서 JPA를 접한 사람에게는 새로울 수 있는데, Spring에서 사용하는 JPA은 JPA를 이용하여 Spring 이 만든 프로젝트이다.

 

무슨 차이일까?

 

우선 JPA에 대해서 먼저 알아보자.

JPA

JPA는 ORM 표준인데, ORM은 무엇일까?

객체 관계 매핑은 데이터베이스와 객체 지향 프로그래밍 언어 간의 호환되지 않는 데이터를 변환하는 프로그래밍 기법이다.
객체 지향 언어에서 사용할 수 있는 "가상" 객체 데이터베이스를 구축하는 방법이다.

JPA와 ORM을 이해하기 위해서는 우선 불편한 과거를 봐야 한다.

 

과거에는 SQL 중심적인 프로그래밍을 하던 시대였다.

 

거기엔 두 가지 불편함이 존재했는데,

1. SQL에 의존적인 프로그래밍
2. SQL과 객체 사이의 임피던스 불일치

라는 문제들이 있었다.

 

SQL에 의존적인 프로그래밍

JDBC API를 이용하여 db에 저장하는 여러 쿼리들은 대부분 SQL에 의존적이다라고 표현한다.

 

왜 그럴까?

 

다음과 같은 상상을 해보자.

 

우리가 User 테이블에 어떤 필드를 만들고 이를 JDBC API를 이용하여 쿼리를 날린다.

 

그럼 해당 쿼리에 맞게 ResultSet을 각각의 기능마다 세팅해야한다.

 

하지만 여기서 엔티티에 새로운 필드가 들어가게 된다면?

 

그럼 CRUD와 관련된 모든 JDBC API의 ResultSet을 수정해서 매핑을 해야한다.

 

이를 두고 SQL 에 의존적이다 라고 하는 것이다.

 

SQL과 객체 사이의 임피던스 불일치

User table이 존재한다고 해보자.

 

그리고 해당 User 테이블에는 Team 테이블과 외래 키로 매핑되어있다고 했을때, User A가 어떤 팀에 속해있는지 알기 위해서는 자바에서 어떻게 할까?

 

public static void main(String[] args) {
  DBConnection connection = new DBConnection();

  User user = connection.findUser("jang")
  Team team = user.getTeam();
  System.out.println(team.getName());
}

그럼 SQL, 즉 RDB 에서는 어떻게 해야할까?

 

SELECT T.name
FROM user U
    INNER JOIN team T
    ON T.id = T.id
WHERE U.name = "jang";

이런 식으로 하려나?

 

같은 기능 (A가 어떤 팀에 속해있는지 알기 위해서는)을 하는데, SQL과 Java 사이에서는 많은 다른 점들이 있다.

 

이를 패러다임, 임피던스 불일치라고 부른다.

 

이런 이유에 JPA가 등장했고 이들을 해결하기 시작했다.

 

자세히 어떤 문제에서 어떻게 해결했는지는 지금 중요하지 않으니 넘어가도록 하겠다.

 

Spring Data JPA란?

JPA는 ORM Framework 이다.

 

즉, 독립적인 하나의 프레임워크인 것이다.

 

하지만 앞서 말 했듯 Spring을 통해 JPA를 배운 사람들에게는 JPA는 Spring이 만든 것 쯤으로 알고 있는 경우가 있다.

 

Spring Data JPA는 Spring이 JPA를 Spring에서 더 쉽고 간편하게 사용하기 위해서 만든 Spring Data의 프로젝트 중 하나 이다.

 

Spring 공식 문서에서 Spring Data 프로젝트를 확인하면 많은 Data 프로젝트들이 존재한다.

 

Spring Data JPA 사용하기

Spring Data JPA를 사용하기 위해서는 당연하게 그에 맞는 의존성을 설치해야 한다.

 

Maven

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-jpa</artifactId>
    <version>2.4.4</version>
</dependency>

Gradle

implementation group: 'org.springframework.boot', name: 'spring-boot-starter-data-jpa', version: '2.4.4'

Spring Data JPA의 설정과 DB 연결

Springboot 프로젝트에서 Data JPA를 이용하기 위해서는 세 가지가 필요하다.

 

1. 데이터베이스 엔진
2. JPA 설정
3. Lombok 설정

데이터베이스 엔진

해당 시리즈에서 사용할 데이터베이스 엔진은 H2 Database이다.

 

H2는 브라우저 기반의 콘솔모드를 이용할 수 있고, 별도의 설치과정이 없이 용량도 2MB이하로 매우 저용량이다.

 

가볍기 때문에 빠르며 테스트 용도로 자주 사용하므로 이번 기회에 알아두는 것도 좋은 방법이다.

 

자세한 설치는 생략하고 Knowledge Repository 님의 블로그 h2 설치 에서 확인할 수 있다.

JPA 설정

jpa 설정은 application.properties 에서 한다.

 

우리는 yml을 이용해서 설정을 해보자.

 

resources 아래에 application.yml 파일을 생성하고 아래와 같이 적어보자.

 

spring:
  datasource:
    url: jdbc:h2:tcp://localhost/~/dbname # 본인의 db connection url
    username: name # 본인의 db username
    password: pw # 본인의 db password
    driver-class-name: org.h2.Driver

  jpa:
    hibernate:
      ddl-auto: create
    properties:
      show_sql: true
      format_sql: true

위의 명령어들을 알아보자.

• datasource
  • datasource : 데이터 소스에 대한 정보 블록이다.
    • hibernate
    • jpa 의 구현체인 hibernate를 사용할 것이므로 hibernate 설정을 바꿀 수 있다.
      • ddl-auto
        • 데이터베이스 초기화 전략이다. 5가지 전략이 존재한다.
          1. none : 아무것도 실행하지 않음
          2. create : SessionFactory가 시작될 때 기존의 테이블 삭제 후 재생성
          3. create-drop : SessionFactory 가 종료된다면 drop
          4. update : 변경된 스키마만 적용
          5. validate : 엔티티와 테이블이 정상 매핑 되었는지만 확인
  • jpa : jpa 에 대한 정보 블록이다.
    • properties
    • hibernate 기본 설정이다.
      • show_sql
        • JPA가 생성하는 쿼리를 콘솔로 출력한다.
      • format_sql
        • 콘솔로 쿼리가 출력될 때 이쁘게 포매팅된다.

자세한 사항은 hibernate 참조하면 알 수 있다.

Lombok 설정

롬복은 Getter/Setter, Constructor, ToString, Builder 등 다양한 기능을 컴파일 시점에 사용할 수 있게 해주는 플러그인인데, 자세한 사항은 검색을 해보길 바란다.

 

우리 예제에서는 Lombok 을 이용할 예정이다.

JPA 사용해보기

다음 시간에 제대로 사용해 볼 예정인데, 우선 db 설정이 잘 적용 되었는지 테스트를 해보자.

다음 3개의 파일을 만들자.

1. Member
2. MemberRepository
3. MemberRepositoryTest

Member 클래스

@Entity
@Getter @Setter @Builder
public class Member {
    @Id @GeneratedValue
    private Long id;
    private String username;
    private int age;
}

MemberRepository 인터페이스

public interface MemberRepository extends JpaRepository<Member, Long> {
}

MemberRepositoryTest 클래스

@SpringBootTest
@Transactional
@Rollback(false)
public class MemberRepositoryTest {

    @Autowired
    MemberRepository memberRepository;

    @Test
    public void saveMemberTest() {
        // given
        long id = 2L;
        String username = "Member B";
        int age = 21;

        // when
        Member member = Member.builder()
                .username(username)
                .age(age)
                .build();
        Member saveMember = memberRepository.save(member);

        // then
        Assertions.assertEquals(saveMember.getAge(), age);
        Assertions.assertEquals(saveMember.getUsername(), username);
    }
}

그럼 정상적으로 동작하는 것을 볼 수 있다.