05 스프링 DB 접근 기술

수갱22·2023년 5월 3일
0

spring

목록 보기
5/14

1. H2 데이터베이스 설치

-데이터베이스 파일 생성해야 함.
-JDBC URL: 파일 경로
-파일 생성 후 '~/test.mv.db' 존재하는지 확인

-이후에는 파일 접근 시 파일 충돌 이슈로 인해 'jdbc:h2:tcp://localhost/~/test'로 소켓으로 연결

테이블 생성하기

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

-id: java에서 Long 타입->DB에서는 bigint 타입
-'generated by default as identity': 값을 세팅하지 않고 insert 시에 자동으로 id 값 채워줌
-name: 가변 문자열
-primary key: 기본키는 id로 설정

Insert

insert  into member(name) values('spring')
insert  into member(name) values('spring2')

-ID 값 DB가 자동생성
+hello-spring/sql(directory)/ddl.sql에 sql문 저장해서 관리

2.순수 Jdbc

  • 앞에서는 DB에 저장 후, 서버를 내리면 데이터가 모두 사라짐, 이를 해결하기 위해 DB연동 진행=> 순수 Jdbc 방식으로 진행

hello-spring/src/build.gradle에 dependencies에 해당 문장 추가

implementation 'org.springframework.boot:spring-boot-starter-jdbc' //java는 db랑 붙으려면 jdbc 필요
runtimeOnly 'com.h2database:h2' //db랑 붙을 때 db가 제공하는 클라이언트 필요(h2database)

접속 정보 추가(스프링 부트 데이터베이스 연결 설정 추가)

src/main/resources/application.properties


->스프링이 필요한 데이터소스를 DB랑 연결하는 작업을 해줌
+build.gradle에 import
+아이디, 비밀번호 등 적어야 하지만 h2 데이터베이스는 생략해도 됨

Jdbc 리포지토리 구현

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

public class JdbcMemberRepostiory implements MemberRepository{


    private final DataSource dataSource; //DB에 붙이려며 데이터소스 필요

    public JdbcMemberRepostiory(DataSource dataSource) {
        this.dataSource = dataSource;

    } //나중에 스프링한테 dataSource 주입받아야 함(스프링이 만들어놓음)
    @Override
    public Member save(Member member) {
        String sql="insert into member(name) values(?)";
        
        Connection conn=dataSource.getConnection();//db connection 가져옴

        PreparedStatement pstmt= conn.prepareStatement(sql);
        pstmt.setString(1, member.getName());
        getName()으로 member 가져옴
        pstmt.executeupdate();

        return null;
    }

전체코드

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;
    public JdbcMemberRepository(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; //결과 받기
        try {
            conn = getConnection();//connection 가져옴
            pstmt = conn.prepareStatement(sql,
                    Statement.RETURN_GENERATED_KEYS); //sql 삽입
            pstmt.setString(1, member.getName());
            //parameterIndex: 1은 위 ?에 매칭, name 넣음

            pstmt.executeUpdate();//db에 실제 쿼리가 날라감("insert into~")
            rs = pstmt.getGeneratedKeys();//위에 RETURN~가 매칭돼서 키 반환해줌
            //(여기서는 ID)

            if (rs.next()) {
                member.setId(rs.getLong(1));
                //값이 있으면 꺼내서 세팅해줌
            } else {
                throw new SQLException("id 조회 실패");
            } //값이 있으면 꺼내줌
            return member;
        } catch (Exception e) {
            throw new IllegalStateException(e);
        } finally {
            close(conn, pstmt, rs);
            //쓴 자원 release->외부와의 연결이었기 때문에(아니면 계속 connection 쌓임) 바로 
            //리소스 반환해야함

        }
    }
    @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()임

            if(rs.next()) {
                Member member = new Member();
                member.setId(rs.getLong("id"));
                member.setName(rs.getString("name"));
                return Optional.of(member);
                //값이 있으면 rs 받아와서 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<>();//전체 조회여서 List로 생성

            while(rs.next()) {
                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() {
    //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.hello-spring/service/SpringConfig.java

@Configuration
public class SpringConfig {
    private DataSource dataSource; //스프링이 자체적으로 dataSource 생성하고 주입해줌
    @Autowired
    public SpringConfig(DataSource dataSource){
        this.dataSource=dataSource;
    }
@Bean
 public MemberRepository memberRepository() {
// return new MemoryMemberRepository();
return new JdbcMemberRepository(dataSource);
 }

-DataSource는 데이터베이스 커넥션을 획득할 때 사용하는 객체이다.
스프링 부트는 데이터베이스 커넥션 정보를 바탕으로 DataSource를 생성하고 스프링 빈으로 만들어두어서 DI를 받을 수 있음.


=>db 통한 회원 조회 가능, 닫아도 계속 저장되어 있는 것을 확인할 수 있음.

다형성 활용

: 인터페이스를 두고 구현체만 바꿀 수 있음(DI 덕분에)

-MemberService는 MemberRepository를 의존하고 있음, MemberRepository는 구현체로 MemoryMemberRepository와 JdbcMemeberRepository 있음

->기존에 memory가 아닌 jdbc로 연결로 바꿈

-개방-폐쇄 원칙(OCP, Open-Closed Principle)

  • 확장에는 열려있고, 수정, 변경에는 닫혀있다.=>기능을 변경해도 애플리케이션 동작 시 필요한 코드를 고치지 않아도 된다.

-스프링의 DI (Dependencies Injection)을 사용하면 기존 코드를 전혀 손대지 않고, 설정만으로 구현클래스를 변경할 수 있다.

-회원을 등록하고 DB에 결과가 잘 입력되는지 확인해보면 데이터를 DB에 저장하므로 스프링 서버를 다시 실행해도 데이터가 안전하게 저장된다.

3. 스프링 통합 테스트

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

@SpringBootTest
@Transactional

-스프링부트테스트 위해서 추가

  • @SpringBootTest : 스프링 컨테이너와 테스트를 함께 실행한다.

-편리함을 위해 테스트케이스는 객체생성보다 생성자 이용함.

+'delete from member': db의 데이터 지움
실행하면 SpringConfig에 configuration 올라오고 test 실행하고 끝나면 스프링이 내려감

@Transactional: 테스트 실행할 때, 트랜잭션을 먼저 실행하고 db data 쿼리 처리한 후 테스트가 끝나면 롤백함=>넣었던 데이트가 다 지워짐(실제 데이터 반영x). 즉, 다음 테스트 계속 반복 실행 가능(영향을 주지 않음)

-코드 실행시킨 뒤에도 db에 없는 것을 확인할 수 있음.

  • 단위 테스트: 순수한 자바 코드를 통해 최소한의 코드
  • 통합 테스트: 스프링 컨테이너 올린 테스트
    ->스프링 의존하는 것보다 단위 테스트로 진행하는 것이 더 좋다?!

4. 스프링 JdbcTemplate

  • 스프링 JdbcTemplate과 MyBatis 같은 라이브러리는 JDBC API에서 본 반복 코드를 대부분 제거해준다. 하지만 SQL은 직접 작성해야 함.

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

public class JdbcTemplateMemberRepository implements MemberRepository{
    private final JdbcTemplate jdbcTemplate;

    @Autowired
    public JdbcTemplateMemberRepository(DataSource dataSource){
        //스프링이 dataSource 자동으로 injection
        this.jdbcTemplate=new JdbcTemplate(dataSource);
    }

+생성자가 딱 하나만 있으면 스프링 빈 등록 시에 '@Autowired' 생략 가능

findById 구현

@Override
    public Optional<Member> findById(Long id) {
        List<Member> result=jdbcTemplate.query("select * from member where id = ?", memberRowMapper(),id);
        return result.stream().findAny();
        //List로 나온 result Optional로 반환
        //Jdbc에서 쿼리 날리고, RowMapper 통해서 매핑한 후 반환해줌
    }
    
    ...
    
 private RowMapper<Member> memberRowMapper(){
        return (rs, rowNum) -> {
            Member member=new Member();
            member.setId(rs.getLong("id"));
            member.setName(rs.getString("name"));
            return member;
        };

-Jdbc와 비교해서 매우 단순->JdbcTemplate library

save 구현

 @Override
    public Member save(Member member) {
        SimpleJdbcInsert jdbcInsert = new SimpleJdbcInsert(jdbcTemplate);
        jdbcInsert.withTableName("member").usingGeneratedKeyColumns("id");

        Map<String, Object> parameters = new HashMap<>();
        parameters.put("name", member.getName());//여기까지 insert문 구현했다고 보면 됨

        Number key = jdbcInsert.executeAndReturnKey(new
                MapSqlParameterSource(parameters));
        member.setId(key.longValue());
        return member;
    }

findByname, findAll

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

    }
    //findById와 동일
    
 @Override
    public List<Member> findAll() {
        return jdbcTemplate.query("select * from member", memberRowMapper());
        //RowMapper 통해서 넘어옴
    }

SpringConfig 'return new JdbcTemplateMemberRepository(dataSource);'로 바꾼 후 실행해보기

-테스트케이스 생성했었으니 이용해서 MemberServiceIntegrationTest.java 실행

->JdbcTemplate으로 db 연동 성공!

5.JPA

: 인터페이스 제공됨, 자바 표준 인터페이스

  • JPA는 기존의 반복 코드는 물론이고, 기본적인 SQL도 JPA가 직접 만들어서 실행
  • JPA가 중간에서 sql query도 JPA가 자동생성, DB에서 데이터 가져옴->JPA를 사용하면, SQL과 데이터 중심의 설계에서 객체 중심의 설계로 패러다임을 전환
  • 개발 생산성을 크게 높일 수 있음

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

build.gradle

	implementation ("org.springframework.boot:spring-boot-starter-data-jpa")

스프링 부트에 JPA 설정 추가

src/main/resources/templates/application.properties

spring.jpa.show-sql=true
spring.jpa.hibernate.ddl-auto=none
#show-sql : jpa가 만든 sql을 출력
#jpa는 자동으로 객체 통해서 테이블 생성함(create), 지금은 끄고 시작
  • JPA 쓰려면 엔티티 매핑해야 함, O:object R:relational Mapping=>객체와 관계형 데이터베이스 테이블을 매핑한다는 의미
  • create 를 사용하면 엔티티 정보를 바탕으로 테이블도 직접 생성

JPA 엔티티 매핑

@Entity
public class Member {
    @Id @GeneratedValue(strategy=GenerationType.IDENTITY)
    //PK 생성, IDENTITY는 DB가 PK 자동생성해줌
    private Long id; //임의의 값, 시스템이 정한 id
//    @Column(name="username") Column 이름 username으로 매핑
  • 매핑은 annotaion 통해서 진행

JPA 회원 리포지토리 생성

hello.hellospring/repository/JPAMemberRepository.java

package hello.hellospring.repository;

import hello.hellospring.domain.Member;

import javax.persistence.EntityManager;
import java.util.List;
import java.util.Optional;

public class JPAMemberRepository implements MemberRepository{
    private final EntityManager em; //jpa는 entitymanager 통해서 모든게 동작(db 통신 등)
    //build.gradle에서 생성해주면 entitymanager 주입받아서 사용하면 됨.
    public JPAMemberRepository(EntityManager em){
        this.em=em;
    }
    @Override
    public Member save(Member member) {
        em.persist(member);//쿼리 생성해 db 저장, setid 등 모두 함
        return member;
    }

    @Override
    public Optional<Member> findById(Long id) {
        Member member=em.find(Member.class, id);
        //find(조회할 타입, 식별자)
        return Optional.ofNullable(member);
    }


    @Override
    public List<Member> findAll() {
        return em.createQuery("select m from Member m", Member.class)
                .getResultList();
        //객체지향 sql 쿼리(객체 대상으로 쿼리를 보냄->sql로 번역됨)
        //여기서 m=>매핑까지 됨.
    }

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

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

java/hello.hellospring/service/SpringConfig

@Configuration
public class SpringConfig {

    private EntityManager em;

    @Autowired
    public SpringConfig(EntityManager em){
        this.em=em;}
  • 항상 트랜잭션이 필요하기 때문에 'MemberService.java'에 @Transactional 추가: JPA는 join 시 트랜잭션 내에서..

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

6. 스프링 데이터 JPA

  • 스프링 데이터 JPA를 사용하면, 리포지토리에 구현 클래스 없이 인터페이스 만으로 개발을 완료할 수 있습니다. 그리고 반복 개발해온 기본 CRUD 기능도 스프링 데이터 JPA가 모두 제공합니다.지금까지 조금이라도 단순하고 반복이라 생각했던 개발 코드들이 확연하게 줄어듭니다. 따라서 개발자는 핵심 비즈니스 로직을 개발하는데, 집중할 수 있습니다.
@Configuration
public class SpringConfig {

    private final MemberRepository memberRepository;
    public SpringConfig(MemberRepository memberRepository) {
        this.memberRepository = memberRepository;

    }
    @Bean //스프링 빈에 등록하라는 거
    public MemberService memberService(){
        return new MemberService(memberRepository);
    }

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

스프링 데이터 JPA 제공 기능

-JpaRepository, crudRepository에서 기본적인 메서드 제공(인터페이스 통해)
-findByName() , findByEmail() 처럼 메서드 이름 만으로 조회 기능 제공
: 공통적으로 할 수 없는 메서드는 위와 같이 하면 JPQL select m from Member m where m.name=? 쿼리문 짜줌.
-페이징 기능 자동 제공
+참고: 실무에서는 JPA와 스프링 데이터 JPA를 기본으로 사용하고, 복잡한 동적 쿼리는 Querydsl이라는 라이브러리를 사용하면 된다. Querydsl을 사용하면 쿼리도 자바 코드로 안전하게 작성할 수 있고, 동적 쿼리도 편리하게 작성할 수 있다. 이 조합으로 해결하기 어려운 쿼리는 JPA가 제공하는 네이티브 쿼리를 사용하거나, 앞서 학습한 스프링 JdbcTemplate를 사용하면 된다.

출처: 김영한 '스프링 입문 - 코드로 배우는 스프링 부트, 웹 MVC, DB 접근 기술' 강의

profile
Cyber Security

0개의 댓글