[Spring 입문] 5. 스프링 DB 접근 기술

강은서·2022년 1월 12일
0

Spring

목록 보기
6/11
post-thumbnail

실무에서는 local DB로 사용되는 H2를 사용하여 스프링 DB 접근하는 방법이다.

1. 순수 Jdbc

다음과 같이 순수하게 JDBC API로 직접 코딩하는 것은 예전의 일이고, 지금 실무에서는 직접 코딩하지 않는다고 한다.

하지만, 나는 공부를 위해서 참고하였다.

  • Repository/JdbcMemberRepository
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();
            pstmt = conn.prepareStatement(sql,
                    Statement.RETURN_GENERATED_KEYS);
            pstmt.setString(1, member.getName());
            pstmt.executeUpdate();
            rs = pstmt.getGeneratedKeys();
            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);
        }
    }

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

코드만 봐도 복잡하고, 반복되는 코드가 많았다.

  • SpringConfig

기존에 스프링 컨테이너에 등록한 MemberRepsitory 반환값을 JdbcMemberRepository로 변경한다.


private final DataSource dataSource;
public SpringConfig(DataSource dataSource0{
	this.dataSource = dataSource;
}

@Bean
public MemberRepository memberRepository(){
	return new JdbcMemberRepoisitory(dataSource);
}
  • DataSource는 데이터베이스 커넥션을 획득할 때 사용하는 객체이다. 스프링 부트는 데이터베이스 커넥션 정보를 바탕으로 DataSource를 생성하고, 스프링 빈으로 만들어둔다.

2. 스프링 통합 테스트

앞서 만든 코드로 스프링 컨테이너와 DB까지 연결한 통합 테스트를 작성했다.
스프링 통합 테스트는 스프링 컨테이너 없이 하는 테스트인 단위 테스트 보다 시간이 오래 걸리기 때문에 실무에서는 단위 테스트틀 하는 것이 좋다고 한다.

@SpringBootTest
@Transactional
class MemberServiceintegrationTest {

    @Autowired MemberService memberService;
    @Autowired MemberRepository memberRepository;

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

        //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));

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

}
  • @SpringBootTest : 스프링 컨테이너와 테스트를 함께 실행한다는 annotation이다.
  • @Transaction을 통해서 테스트 시작 전에 transaction을 시작하고, 테스트 완료 후에 항상 롤백한다. 이로써 DB에 데이터가 남지 않으므로 다음 테스트에 영향을 주지 않는다.
    - Transaction이란?
    데이터베이스의 상태를 변화시키기 위해서 수행하는 작업의 단위이다. 
    질의어를 이용하여 데이터베이스를 접근하는데, 작업의 단위는 질의어 한문장이 아니다.
    - Transaction의 commit
     하나의 트랜잭션이 성공적으로 끝났고, 데이터베이스가 일관성이 있는 상태에 있을 때 알려주기 위해 사용하는 연산
    - Transaction의 rollback
     하나의 트랜잭션 처리가 비정상적으로 종료된 경우, 트랜잭션을 처음부터 다시 시작하거나, 트랜잭션의 부분적으로만 연산된 결과를 다시 취소한다. 

3. 스프링 Jdbc Template

앞서, Jdbc API에서 본 반복코드를 스프링 Jdbc Template을 사용하게 되면 제거해준다. 하지만, SQL은 직접 작성해야 한다.

순수 Jdbc와 달리 실무에서 많이 사용된다.

  • repository/JdbcTemplateMemberRepository
public class JdbcTemplateMemberRepository implements MemberRepository{
	private final JdbcTemplate jdbcTemplate;
    
    public JdbcTemplateMemberRepository(DataSource dataSource){
    	jdbcTemplate = new JdbcTemplate(dataSource);
    }
    
    
    @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());
        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();
    }

    @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 member = new Member();
            member.setId(rs.getLong("id"));
            member.setName(rs.getString("name"));
            return member;
        });
    }
  • SpringConfig
    마찬가지로 JdbcTemplateMemeberRepository를 사용하기 위해서 환경설정을 해준다.

public class SpringConfig{
	private final DataSource dataSource;
    
    public SpringConfig(DataSource dataSource){
    	this.dataSource = dataSource;
    }
    @Bean
    public MemberService memberService(){
  		return new MemberService(memberRepository());
    }
    @Bean
    public MemberRepository memberRepository(){
    	return new JdbcTemplateMemberRepsitory(dataSource);
    }

코드를 보면, 중복되는 코드가 많이 삭제됨을 알 수 있다. 하지만, template을 사용하면 SQL은 직접 작성해야 한다.

4. JPA

기존의 반복코드는 물론이고, 기본적인 SQL도 JPA가 직접 만들어서 설명해준다.
SQL과 데이터 중심의 설계에서 객체 중심의 설계로 패러다임을 전환할 수 있다.

  • build.gradle
    기존에 있었던 jdbc는 JPA에 포함되어 있기 때문에 주석 처리한다.
//implementation 'org.springframework.boot:spring-boot-starter-jdbc'
implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
  • resources/application.properties
    스프링 부트에 JPA 설정을 추가한다.
spring.datasource.url=jdbc:h2:tcp://localhost/~/test
spring.datasource.driver-class-name=org.h2.Driver
spring.datasource.username=sa

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

show-sql은 JPA가 생성하는 SQL을 출력한다.
ddl-auto = none을 통해서 JPA에서 제공하는 테이블을 자동으로 생성하는 기능을 끈다. ddl-auto = create을 통해서 테이블을 자동으로 생성할 수 있다.

  • domain.Member
    JPA entity mapping
    ORM(Object-Relational Mappin)객체와 관계형 데이터베이스를 매핑한다.
//JPA가 관리해주는 Entity
@Entity
public class Member {


//Pk = Id
    @Id  @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id; //시스템이 저장하는 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;
    }
}
  • repository/JpaMemberRepository
public class JpaMemberRepository implements MemberRepository{

    private final EntityManager em;

	//JPA는 EntityManager에 의해서 실행되며, Spring Boot는 현재 데이터베이스와 연결하여 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();
                
    }
}

select m from Member
m(entity)객체 자체를 select 한다.

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

  • SpringConfig
    JPA를 사용하도록 스프링 관련 설정을 변경한다.

@Configuration
public class SpringConfig{
	private final DataSource dataSource;
	    private final EntityManager em;
	
	    public SpringConfig(DataSource dataSource, EntityManager em){
	        this.dataSource = dataSource;
	        this.em = em;
	    }
	
	    @Bean
	    public MemberService memberService() {
	        return new MemberService(memberRepository());
	    }
	

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

5. 스프링 데이터 JPA

구현 클래스를 작성할 필요 없이 interface 만으로도 개발할 수 있으며, 반복 개발해온 기본 CRUD(Create, Read, Update, Delete) 기능도 스프링 데이터 JPA가 모두 제공한다.

  • SpringDataJpaMemberRepository
public interface SpringDataJpaMemberRepository implements JpaRepository<Member, Long>, MemberRepository {
	//SpringDataJpa가 구현체를 자동으로 생성해주어 Spring Bean에 등록한다.
	Opional<Member> findbyName(String name);
}
  • SpringConfig
public class SpringConfig{
	//SpringDataJpa가 만들어 놓은 구현체가 등로고딘다. 
	private final MemberRepository memberRepository;
    public SpringConfig(MemberRepository memberRepository){
    	this.memberRepository = memberRepository;
    }
    
    @Bean
    public MemberService memberService(){
    	return new MemberService(memberRepository);
    }
}

다음 글은 인프런 김영한 강사님의 스프링 강의 복습용입니다 :)

1개의 댓글

comment-user-thumbnail
2022년 1월 20일

응원해요^^

답글 달기