[Back-end] 스프링 입문 :: 스프링 DB 접근 기술

*JPA: Java Persistence API.

          자바에서 객체를 데이터베이스에 저장하고 관리하기 위한 인터페이스와 기능을 제공하는 API.

          Jdbc > JPA로 진화하며 쿼리 없이 객체를 DB에 저장할 수 있게 됨.

 

*JPA 장점: 기존의 반복 코드는 물론이고 기본적인 SQL 도 JPA 가 직접 만들어서 실행해준다.

                  SQL과 데이터 중심의 설계에서 객체 중심의 설계로 패러다임을 전환할 수 있다.

                  개발 생산성 높이기 !

 

---

 

교육용으로 좋은 가벼운 DB를 설치해 보자.

 

1. H2 Database Engine 설치

https://www.h2database.com/html/main.html

H2 Database Engine

window 는 window 용 다운로드.

 

 

2. H2 > bin > h2.bat 실행

 

 

3. H2 Database 사용하기

파일경로를 말해줌. jdbc:h2:~/test

 

연결을 누르면 DB 화면으로 들어가게 됨.

왼쪽상단 빨간색 동그라미 2개 버튼 누르면 나가짐.

 

컴퓨터 home(user) 경로에 test.mv.db 파일이 있는지 확인하기.

 

파일로 접근하면 동시 접근시 충돌 등의 오류가 발생할 수 있다. 소켓을 통해 접근하도록 아래 경로로 접근하자.

JDBC URL: jdbc:h2:tcp://localhost/~/test

 

 

4. member 테이블 만들기.

drop table if exists member CASCADE;
create table member
(
 id bigint generated by default as identity,
 name varchar(255),
 primary key (id)
);

 

MEMBER 테이블이 만들어진 모습!

 

 

5. MEMBER 테이블 조회하기

테이블 전체 목록 조회는 select * from member; 를 입력하던가

input field 에 아무것도 없는 상태에서 MEMBER TABLE 을 클릭하면 보인다.

 

 

6. MEMBER 테이블 추가하기

insert into member(name) values('spring1')

 

---

 

JPA 사용을 위한 환경 셋팅을 해보자.

 

1. build.gradle 파일에 JPA dependency 추가

implementation 'org.springframework.boot:spring-boot-starter-data-jpa'

hibernate 2개 설치 되었는지 확인.

 

 

2. resources > application.properties 에 JPA 설정 추가.

1) spring.jpa.show-sql=true : JPA 가 날리는 SQL 을 볼 수 있음.

2) spring.jpa.hibernate.ddl-auto=none : auto 를 true 로 켜면 객체를 보고 테이블을 만들어준다. 지금은 member 테이블이 이미 만들어져 있으니 none 으로 끄고 시작하는 것.

 

 

3. Member 객체와 맵핑

ORM(Object-Relational Mapping)

package com.yoonsung.firstproject.domain;

import jakarta.persistence.*;

@Entity
public class Member {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String name;

    public Long getId(){
        return id;
    }
    public void setId(Long id){
        this.id = id;
    }
    public String getName(){
        return name;
    }
    public void setName(String name){
        this.name = name;
    }
}

1) JPA 가 관리하는 Entity라고 명시

2) PK 와 strategy 명시. 자동으로 명시되는 ID 를 Identity 전략이라고 부름.

+ Column 등의 명시도 가능.

 

 

4. JpaMemberRepository 클래스 생성

package com.yoonsung.firstproject.repository;

import com.yoonsung.firstproject.domain.Member;
import jakarta.persistence.EntityManager;
import jakarta.transaction.Transactional;

import java.util.List;
import java.util.Optional;

@Transactional
public class JpaMemberRepository implements MemberRepository {

    private final EntityManager em;

    public JpaMemberRepository(EntityManager em) {
        this.em = em;
    }

    @Override
    public Member save(Member member) {
        em.persist(member);
        return member;
    }

    @Override
    public Optional<Member> findById(Long id) {
        Member member = em.find(Member.class, id);
        return Optional.ofNullable(member);
    }

    @Override
    public Optional<Member> findByName(String name) {
        List<Member> result = em.createQuery("select m from Member m where m.name = :name", Member.class)
                .setParameter("name", name)
                .getResultList();

        return result.stream().findAny();
    }

    @Override
    public List<Member> findAll() {
        return em.createQuery("select m from Member m", Member.class).getResultList();
    }
}

1) JPA 는 EntityManager로 동작한다. Spring Boot 가 EntityManager를 만들어줘서 우린 이걸 Dependency Injection 만 하면 된다.

2) em.persist() 함수로 테이블에 넣어준다.

3) em.find() 함수로 조회 가능.

4) createQuery() 함수 안에 쿼리 작성. entity를 대상으로 조회가능. m !

5) Spring Data JPA 사용하면 findByName(), findAll()도 삭제 가능. 추후 배움.

6) 데이터를 변경은 Transaction 이 필요하다. Transaction 안에서 실행되어야 한다.

 

 

5. SpringConfig 파일에 연결

package com.yoonsung.firstproject;

import com.yoonsung.firstproject.repository.JpaMemberRepository;
import com.yoonsung.firstproject.repository.MemberRepository;
import com.yoonsung.firstproject.service.MemberService;
import jakarta.persistence.EntityManager;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;


@Configuration
public class SpringConfig {

    private EntityManager em;

    @Autowired
    public SpringConfig(EntityManager em){
        this.em = em;
    }

    @Bean
    public MemberService memberService(){return new MemberService(memberRepository());}

    @Bean
    public MemberRepository memberRepository() {
        return new JpaMemberRepository(em);
    }
}

SpringConfig 클래스에 memberRepository()를 호출했을 때 JpaMemberRepository 를 반환하도록 추가 변경.

 

 

6. Test 코드 실행

package com.yoonsung.firstproject.service;

import com.yoonsung.firstproject.domain.Member;
import com.yoonsung.firstproject.repository.MemberRepository;
import jakarta.transaction.Transactional;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

import static org.assertj.core.api.Assertions.assertThat;
import static org.junit.jupiter.api.Assertions.assertThrows;


@SpringBootTest
@Transactional
class MemberServiceIntegrationTest {

    @Autowired MemberService memberService;
    @Autowired MemberRepository memberRepository;

    @Test
    void 회원가입(){
        //given
        Member member = new Member();
        member.setName("spring");

        //when
        Long saveId = memberService.join(member);

        //then
        Member findMember = memberService.findOne(saveId).get();
        assertThat(member.getName()).isEqualTo(findMember.getName());
    }

    @Test
    public void 중복_회원_예외(){
        //given
        Member member1 = new Member();
        member1.setName("spring");

        Member member2 = new Member();
        member2.setName("spring");

        //when
        memberService.join(member1);
        IllegalStateException e = assertThrows(IllegalStateException.class, () -> memberService.join(member2));

        //then
        assertThat(e.getMessage()).isEqualTo("이미 존재하는 회원입니다.");
    }
}

 

---

 

Spring Data JPA

: JPA 를 더 쉽게 사용하기 위한 Spring Data 프레임워크. 

 

1. SpringDataJpaMemberRepository 인터페이스 생성

import com.yoonsung.firstproject.domain.Member;
import org.springframework.data.jpa.repository.JpaRepository;

import java.util.Optional;

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

    @Override
    Optional<Member> findByName(String name);
}

interface 만 만들어 놓고 JpaRepository 를 상속받아 놓으면 Spring Data JPA 가 SpringDataJpaMemberRepository 를 스프링 빈으로 자동 등록해준다. 

 

인터페이스 안의 이름만 특정 규칙을 맞춰주면 된다.

findByName 은 아래와 같은 의미가 숨겨져 있다. 

select m from Member m where m.name = ?

ex. findByEmail(), findByNameAndId(String name, Long id) 처럼 메서드 이름 만으로 조회 기능이 제공된다.

 

JpaRepository 클래스가 기본 CRUD 를 제공해서 다른 함수도 필요 없다.

 

 

2. SpringConfig 수정

import com.yoonsung.firstproject.repository.MemberRepository;
import com.yoonsung.firstproject.service.MemberService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class SpringConfig {

    private final MemberRepository memberRepository;

    @Autowired
    public SpringConfig(MemberRepository memberRepository){
        this.memberRepository = memberRepository;
    }

    @Bean
    public MemberService memberService(){
        return new MemberService(memberRepository);
    }

//    @Bean
//    public MemberRepository memberRepository() {
//        return new JpaMemberRepository(em);
//    }
}

Spring Config 파일에 EntityManager 지우고 MemberRepository 로 수정해놓자.