📚 [Spring] #6. 스프링 DB 접근 기술

이가은·2024년 5월 5일
0

Spring

목록 보기
6/13
post-thumbnail

📕 H2 데이터베이스 설치

지금까지는 회원정보를 메모리에 저장했기 때문에 서버를 종료하고 다시 실행하면 데이터가 모두 사라졌다. 서버가 종료되어도 데이터를 저장할 수 있도록 하기 위해 H2 데이터베이스 사이트에 접속해서 다운로드 받았다

H2 데이터베이스는 개발이나 테스트 용도로 가볍고 편리한 DB이며 웹 화면을 제공한다

✔ 맨 처음 접속할 때는 JDBC URL을 jdbc:h2:~/test로 설정하고 연결을 클릭해 자신의 홈 디렉토리에 /test.mv.db 파일을 만들어준다.
✔ 그 다음부터는 JDBC URL을 jdbc:h2:tcp://localhost/~/test로 설정해서 접속하면 된다.

📖 테이블 생성하기

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

generated by default as identity : 값을 세팅하지 않고 insert하면 DB가 자동으로 id 값을 채워줌

insert into member(name) values('spring');
insert into member(name) values('spring2');
SELECT * FROM MEMBER;

✔ 멤버 테이블에 spring, spring2 추가

🎈 실행 화면

✔ member table을 조회해보면 spring과 spring2가 추가되어있다

📙 순수 JDBC

📖 환경 설정

✔ build.gradle 파일에 jdbc, h2 데이터베이스 관련 라이브러리 추가

//DB와 연동하기 위해 필요한 드라이버
implementation 'org.springframework.boot:spring-boot-starter-jdbc'
//DB와 붙을 때 필요한 데이터베이스가 제공하는 클라이언트
runtimeOnly 'com.h2database:h2

resources/application.properties에 스프링 부트 데이터베이스 연결 설정 추가

spring.datasource.url=jdbc:h2:tcp://localhost/~/test
spring.datasource.driver-class-name=org.h2.Driver
spring.datasource.username=sa

📖 JDBC 리포지토리 구현

🎈Jdbc 회원 리포지토리

src/main/java/hello/hellospring/repository/JdbcMemberRepository.java

package hello.hellospring.repository;

import hello.hellospring.domain.Member;
import org.springframework.jdbc.datasource.DataSourceUtils;

import javax.sql.DataSource;
import java.sql.*;
import java.util.ArrayList;
import java.util.List;
import java.util.Optional;

public class JdbcMemberRepository implements MemberRepository {
    private final DataSource dataSource; //DB에 붙기 위해서 DataSource가 필요하다

    public JdbcMemberRepository(DataSource dataSource) { //스프링을 통해 DataSource를 주입받을 수 있다
        this.dataSource = dataSource;
    }

    @Override
    public Member save(Member member) {
        String sql = "insert into member(name) values(?)";

        Connection conn = null;
        PreparedStatement pstmt = null;
        ResultSet rs = null; //ResultSet은 결과를 받는 역할이다

        try {
            conn = getConnection(); //getConnection을 통해 커넥션을 가져온다
            pstmt = conn.prepareStatement(sql, Statement.RETURN_GENERATED_KEYS); //prepareStatement에 sql과 옵션을 넘겨준다.
            //RETURN_GENERATED_KEYS : DB에 insert해야만 알 수 있는 id 값을 얻을 때 사용한다

            pstmt.setString(1, member.getName());
            //setString에서 parameterIndex 위치에 1을 넣어주면 위 String sql의 첫번째 물음표와 매칭되고 그 위치에 member.getName()으로 값을 넣는다

            pstmt.executeUpdate(); //executeUpdate를 통해 실제 DB에 쿼리가 날라간다
            rs = pstmt.getGeneratedKeys(); //getGeneratedKeys는 RETURN_GENERATED_KEYS를 통해 얻은 id값을 반환해준다

            if (rs.next()) { //만약 rs 다음 값이 있다면 getLong을 통해 값을 꺼내 id 값을 세팅한다
                member.setId(rs.getLong(1));
            } else { //없으면 Exception 처리한다
                throw new SQLException("id 조회 실패");
            }
            return member;
        } catch (Exception e) {
            throw new IllegalStateException(e);
        } finally { //할 일이 끝나면 연결 세션을 종료한다
            close(conn, pstmt, rs);
        }
    }

    @Override
    public Optional<Member> findById(Long id) {
        String sql = "select * from member where id = ?";

        Connection conn = null;
        PreparedStatement pstmt = null;
        ResultSet rs = null;

        try {
            conn = getConnection();
            pstmt = conn.prepareStatement(sql);
            pstmt.setLong(1, id);

            rs = pstmt.executeQuery(); //executeQuery를 통해 result 값을 받아온다

            if (rs.next()) { //값이 있으면 멤버 객체를 만들고 반환을 해준다
                Member member = new Member();
                member.setId(rs.getLong("id"));
                member.setName(rs.getString("name"));
                return Optional.of(member);
            } else {
                return Optional.empty();
            }
        } catch (Exception e) {
            throw new IllegalStateException(e);
        } finally {
            close(conn, pstmt, rs);
        }
    }

    @Override
    public List<Member> findAll() {
        String sql = "select * from member";

        Connection conn = null;
        PreparedStatement pstmt = null;
        ResultSet rs = null;

        try {
            conn = getConnection();
            pstmt = conn.prepareStatement(sql);

            rs = pstmt.executeQuery();

            List<Member> members = new ArrayList<>(); //리스트를 사용한다

            while (rs.next()) { //루프를 돌면서 add를 통해 멤버를 담은 후 반환한다
                Member member = new Member();
                member.setId(rs.getLong("id"));
                member.setName(rs.getString("name"));
                members.add(member);
            }
            return members;
        } catch (Exception e) {
            throw new IllegalStateException(e);
        } finally {
            close(conn, pstmt, rs);
        }
    }

    @Override
    public Optional<Member> findByName(String name) {
        String sql = "select * from member where name = ?";

        Connection conn = null;
        PreparedStatement pstmt = null;
        ResultSet rs = null;

        try {
            conn = getConnection();
            pstmt = conn.prepareStatement(sql);
            pstmt.setString(1, name);

            rs = pstmt.executeQuery();

            if (rs.next()) { //값이 있으면 객체를 생성한다
                Member member = new Member();
                member.setId(rs.getLong("id"));
                member.setName(rs.getString("name"));
                return Optional.of(member);
            }
            return Optional.empty();
        } catch (Exception e) {
            throw new IllegalStateException(e);
        } finally {
            close(conn, pstmt, rs);
        }
    }

    private Connection getConnection() {
        //DataSourceUtils를 사용하면 DB 트랜잭션에 걸렸을 때 DB 커넥션을 똑같이 유지시켜 준다
        return DataSourceUtils.getConnection(dataSource);
    }

    private void close(Connection conn, PreparedStatement pstmt, ResultSet rs) {
        try {
            if (rs != null) {
                rs.close();
            }
        } catch (SQLException e) {
            e.printStackTrace();
        }
        try {
            if (pstmt != null) {
                pstmt.close();
            }
        } catch (SQLException e) {
            e.printStackTrace();
        }
        try {
            if (conn != null) {
                close(conn);
            }
        } catch (SQLException e) {
            e.printStackTrace();
        }
    }

    private void close(Connection conn) throws SQLException {
        DataSourceUtils.releaseConnection(conn, dataSource);
    }
}

🎈스프링 설정 변경

src/main/java/hello/hellospring/SpringConfig.java

@Configuration
public class SpringConfig {

    private DataSource dataSource;

    @Autowired
    public SpringConfig(DataSource dataSource) {
        this.dataSource = dataSource;
    }

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

    @Bean
    public MemberRepository memberRepository() {
        //return new MemoryMemberRepository();
        return new JdbcMemberRepository(dataSource);
    }
}

✔ DataSource는 데이터베이스 커넥션을 획득할 때 사용하는 객체다
✔ 스프링 부트는 데이터베이스 커넥션 정보를 바탕으로 DataSource를 생성하고 스프링 빈으로 만들어둔다. 그래서 DI(의존성)을 주입받을 수 있다

🎈 실행 화면

✔ 회원 가입 기능을 통해 jpa 회원을 등록하면 h2 데이터베이스에 jpa 회원이 추가되었음을 확인할 수 있다

📖 스프링 설정 이미지

✔ 개방-폐쇄 원칙(OCP, Open-Closed Principle) : 확장에는 열려있고, 수정, 변경에는 닫혀있다
✔ 스프링의 DI(Dependencies Injection)을 사용하면 기존 코드를 전혀 손대지 않고, 설정만으로 구현 클래스를 변경할 수 있다
✔ 데이터를 DB에 저장하므로 스프링 서버를 다시 실행해도 데이터가 안전하게 저장된다

📒 스프링 통합 테스트

✔ 스프링 컨테이너와 DB를 연결한 통합 테스트를 진행한다
✔ 데이터베이스를 사용하므로 스프링을 통한 테스트가 필요하다

📖 회원 서비스 스프링 통합 테스트

@SpringBootTest : 스프링 컨테이너와 테스트를 함께 실행한다
@Transactional : 테스트 케이스에 이 어노테이션이 있으면 테스트 시작 전에 트랜잭션을 시작하고, 테스트 완료 후에 항상 롤백한다. 이렇게 하면 DB에 데이터가 남지 않으므로 다음 테스트에 영향을 주지 않는다

@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();
        assertEquals(member.getName(), 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)); //예외가 발생해야 함
        assertThat(e.getMessage()).isEqualTo("이미 존재하는 회원입니다."); //에러 메시지로 상태 검증
    }

    @Test
    void findMembers() {
    }

    @Test
    void findOne() {
    }
}

✔ 테스트 실행 전에 delete from member를 통해 멤버 테이블 내의 내용을 지워줘야 한다
@Transactional을 사용하면 테스트 실행 후에도 데이터가 남지 않는다

📗 스프링 JdbcTemplate

✔ 순수 Jdbc와 동일한 환경설정을 하면 된다.
✔ 스프링 JdbcTemplate과 MyBatis 같은 라이브러리는 JDBC API에서 본 반복 코드를 대부분 제거해준다.
✔ 하지만 SQL은 직접 작성해야 한다.
✔ 실무에서도 JdbcTemplate을 많이 사용한다
✔ 이름에 Template이 들어가는 이유는 템플릿 method 패턴이 많이 사용되기 때문이다

🎈 스프링 JdbcTemplate 회원 리포지토리

src/main/java/hello/hellospring/repository/JdbcTemplateMemberRepository.java

public class JdbcTemplateMemberRepository implements MemberRepository {

    private final JdbcTemplate jdbcTemplate;

    @Autowired //해당 클래스가 스프링 빈으로 등록되는 경우에서 생성자가 하나일 때 @Autowired 생략 가능
    public JdbcTemplateMemberRepository(DataSource dataSource) { //dataSource를 injection 받는다
        jdbcTemplate = new JdbcTemplate(dataSource);
    }

    @Override
    public Member save(Member member) {
        //insert 구문을 대체하는 코드
        SimpleJdbcInsert jdbcInsert = new SimpleJdbcInsert(jdbcTemplate);
        jdbcInsert.withTableName("member").usingGeneratedKeyColumns("id");

        Map<String, Object> parameters = new HashMap<>();
        parameters.put("name", member.getName());

        //데이터베이스에 저장된 member에 대한 key를 가져와서 id로 세팅하는 코드
        Number key = jdbcInsert.executeAndReturnKey(new MapSqlParameterSource(parameters));
        member.setId(key.longValue());
        return member;
    }

    @Override
    public Optional<Member> findById(Long id) {
        List<Member> result = jdbcTemplate.query("select * from member where id = ?", memberRowMapper(), id);
        return result.stream().findAny(); //list 중 해당되는 것이 하나라도 있다면 반환한다
    }

    @Override
    public Optional<Member> findByName(String name) {
        List<Member> result = jdbcTemplate.query("select * from member where name = ?", memberRowMapper(), name);
        return result.stream().findAny();
    }

    @Override
    public List<Member> findAll() {
        return jdbcTemplate.query("select * from member", memberRowMapper());
    }

    private RowMapper<Member> memberRowMapper() {
        return (rs, rowNum) -> { //결과를 가져와서 member 형태로 setting해서 반환한다, lamda 문법 사용
            Member member = new Member();
            member.setId(rs.getLong("id"));
            member.setName(rs.getString("name"));
            return member;
        };
    }
}

🎈 JdbcTemplate을 사용하도록 스프링 설정 변경

src/main/java/hello/hellospring/SpringConfig.java

@Bean
public MemberRepository memberRepository() {
	return new JdbcTemplateMemberRepository(dataSource);
}

📘 JPA

✔ Java 진영에서 ORM 기술 표준으로 사용하는 인터페이스 모음
✔ JPA는 기존의 반복 코드는 물론이고, 기본적인 SQL도 JPA가 직접 만들어서 실행해준다.
✔ JPA를 사용하면, SQL과 데이터 중심의 설계에서 객체 중심의 설계로 패러다임을 전환을 할 수 있다.
✔ JPA를 사용하면 개발 생산성을 크게 높일 수 있다.

🎈 build.gradle 파일에 JPA, h2 데이터베이스 관련 라이브러리 추가
spring-boot-starter-data-jpa는 내부에 jdbc 관련 라이브러리를 포함한다. 따라서 jdbc는 제거해도 된다.

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'
    implementation 'org.springframework.boot:spring-boot-starter-web'
    //implementation 'org.springframework.boot:spring-boot-starter-jdbc'
    implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
    runtimeOnly 'com.h2database:h2'
    testImplementation 'org.springframework.boot:spring-boot-starter-test'
}

🎈 스프링 부트에 JPA 설정 추가

show-sql : JPA가 생성하는 SQL을 출력한다
ddl-auto : JPA는 테이블을 자동으로 생성하는 기능을 제공하는데 none를 사용하면 해당 기능을 끈다. create를 사용하면 엔티티 정보를 바탕으로 테이블도 직접 생성해준다
ORM : Object Relational Mapping의 약자로, 객체와 관계형 데이터베이스의 데이터를 자동으로 mapping해주는 것이다

resources/application.properties

spring.datasource.username=sa
spring.jpa.show-sql=true
spring.jpa.hibernate.ddl-auto=none

🎈 JPA 엔티티 매핑

✔ @Entity 어노테이션을 작성해줌으로써 JPA가 매핑하는 엔티티가 된다
IDENTITY : 쿼리에 ID를 넣는게 아닌 DB에 값을 넣었을 때 자동으로 생성되는 key를 ID로 사용하는 것
src/main/java/hello/hellospring/domain/Member.java

@Entity
public class Member {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id; //임의의 값, 데이터를 구분하기 위해 시스템이 저장하는 id
    private String name; //이름

    //@Column(name = "username") //만약 DB에 컬럼명이 username이면 저렇게 작성하면 매핑이 된다
    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;
    }
}

🎈 JPA 회원 리포지토리

✔ JPA는 Entity Manager로 모든 것이 동작한다
✔ build.gradle에서 받은 data-jpa 라이브러리를 통해 스프링 부트에서는 자동으로 Entity Manager를 생성한다
✔ Entity Manager는 내부적으로 데이터 소스를 가지고 있어 DB와의 통신을 내부에서 처리할 수 있다

public class JpaMemberRepository implements MemberRepository {
    private final EntityManager em;

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

    //pk값인 id와 관련된 회원 등록과 id에 따른 회원 탐색 기능의 경우, EntityManager에서 제공하는 메서드를 사용해서 구현할 수 있음
    @Override
    public Member save(Member member) {
        em.persist(member); //persist는 영구 저장
        return member;
    }

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

    //pk 기반이 아닌 findByName, findAll은 JPQL이라는 객체지향 쿼리문으로 작성, 엔티티를 대상으로 쿼리를 날림
    @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();
    }
}

🎈 서비스 계층에 트랜잭션 추가

✔ 스프링은 해당 클래스의 메서드를 실행할 때 트랜잭션을 시작하고, 메서드가 정상 종료되면 트랜잭션을 커밋한다
✔ 만약 런타임 예외가 발생하면 롤백한다
✔ JPA를 통한 모든 데이터 변경은 트랜잭션 안에서 실행해야 한다

import org.springframework.transaction.annotation.Transactional

@Transactional
public class MemberService {}

🎈 JPA를 사용하도록 스프링 설정 변경

@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);
    }
}

📔 스프링 데이터 JPA

✔ 스프링 부트와 JPA만 사용해도 개발 생산성이 정말 많이 증가하고, 개발해야 할 코드도 확연히 줄어든다
✔ 여기에 스프링 데이터 JPA를 사용하면, 기존의 한계를 넘어서서 리포지토리에 구현 클래스 없이 인터페이스 만으로 개발을 완료할 수 있다

🎈 스프링 데이터 JPA
✔ JPA를 편리하게 사용하도록 도와주는 기술이다
✔ CRUD 처리를 위한 공통 인터페이스 제공한다
✔ 리포지토리 개발 시 인터페이스만 작성하면 실행 시점에 스프링 데이터 JPA가 구현 객체를 동적으로 생성해서 주입해준다

🎈 스프링 데이터 JPA 회원 리포지토리

//T = Member, ID = Long
public interface SpringDataJpaMemberRepository extends JpaRepository<Member, Long>, MemberRepository {
    //JPQL select m from Member m where m.name = ?
    @Override
    Optional<Member> findByName(String name);
}

✔ interface가 interface를 상속받을 때는 extends를 사용한다
✔ 개발 시 공통적으로 사용된다고 생각되는 기능은 스프링 데이터 JPA에서 자동적으로 제공한다
✔ 스프링 데이터 JPA에서는 findByName(), findByEmail()처럼 메서드 이름만으로도 조회가 가능하다
✔ findByName을 보고 select m from Member m where m.name = ?과 같은 쿼리를 자동으로 생성한다

🎈 스프링 데이터 JPA 회원 리포지토리를 사용하도록 스프링 설정 변경

@Configuration
public class SpringConfig {
    private final MemberRepository memberRepository;

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

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

✔ 스프링 데이터 JPA가 SpringDataJpaMemberRepository 를 스프링 빈으로 자동 등록해준다

🎈 스프링 데이터 JPA 제공 클래스

📚 참고자료

스프링 입문 - 코드로 배우는 스프링 부트, 웹 MVC, DB 접근 기술

profile
가뿡이의 공부 상자📦

0개의 댓글