이 글은 김영한 님의 스프링 입문 강좌 수강 후에 정리한 글입니다.
(https://www.inflearn.com/course/스프링-입문-스프링부트/dashboard)
스프링 DB 접근 기술
● H2 데이터베이스 설치
H2 DB는 개발 및 테스트 용도로 사용하며, 가볍고 편리한 DB이다. 웹 화면도 제공한다.
다운로드 : https://www.h2database.com
H2 Database Engine (redirect)
H2 Database Engine Welcome to H2, the free SQL database. The main feature of H2 are: It is free to use for everybody, source code is included Written in Java, but also available as native executable JDBC and (partial) ODBC API Embedded and client/server mo
www.h2database.com
1. 테이블 생성하기
drop table if exists member CASCADE;
create table member
(
id bigint generated by default as identity,
name varchar(255),
primary key (id)
);
H2 데이터 베이스에 접근하여 member 테이블을 생성한다.
Member는 ID와 name을 가지고 있는 객체였으므로, 테이블에도 id와 name을 포함하여야 한다.
bigint는 long과 똑같다. generated by default as identify는 굳이 값을 입력하지 않아도, H2 데이터베이스가 알아서 넣어주라는 뜻이다.
2. 테이블에 데이터 삽입하기
insert into member(name) values('spring');
insert를 활용하여 데이터를 테이블에 삽입할 수 있다.
spring이라는 이름을 가진 member를 테이블에 넣어주는 것이고, id는 위 설정값에 따라 DB가 알아서 값을 넣어줄 것으로 예측할 수 있다.
3. 테이블에서 데이터 불러오기
select * from member
select를 활용하여 테이블의 데이터를 불러올 수 있다.
*는 모든 테이블의 요소를 뜻하는 것이므로 member 테이블의 모든 요소(줄), 즉 id와 name 둘 다 불러올 것으로 예측할 수 있다.
결과 화면은 다음과 같으며 예상한 대로 id를 넣어주지 않았지만 DB에서 알아서 처리하여 1이라는 값을 테이블에 넣어주었음을 확인할 수 있다.
또한 member 테이블의 요소인 id, name 모두 결과에서 확인할 수 있다.
프로젝트 폴더 상에 sql이라는 폴더를 만들어서 ddl.sql을 만들고, 그 파일에 테이블을 만들었던 SQl문을 저장하여 둔다.
Git을 사용하면 프로젝트와 함께 관리하게 되면서 변경 내역 확인이 편해지고, DB 구조 파악도 편해진다.
● 순수 JDBC
1. 환경 설정
build.gradle에 jdbc, h2 데이터 베이스 관련 라이브러리 추가
implementation 'org.springframework.boot:spring-boot-starter-jdbc' //jdbc 라이브러리
runtimeOnly 'com.h2database:h2' //h2 라이브러리
스프링 부트 데이터베이스 연결 설정 추가
spring.datasource.url=jdbc:h2:tcp://localhost/~/test
spring.datasource.driver-class-name=org.h2.Driver
spring.datasource.username=sa
resources/application.properties에 위의 내용을 추가한다.
2. JDBC 리포지토리 구현
위의 두 단계를 통해 JDBC를 활용하여 H2 데이터베이스를 활용할 준비를 마쳤다면, 직접 JdbcMemberService를 구현하면 된다. 하지만 고대의 개발자들이 이렇게 구현했을 뿐, 지금은 이렇게 복잡하게 구현할 필요가 없다.
코드가 너무 복잡하고 길기 때문에 설명은 생략하였다.
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();
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 void clearStore() {
}
@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);
}
}
3. 스프링 설정 변경
package hello.hellospring.service;
import hello.hellospring.repository.JdbcMemberRepository;
import hello.hellospring.repository.MemberRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import javax.sql.DataSource;
@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는 DB Connection을 획득할 때 사용하는 객체이다. 스프링 부트는 DB Connection 정보를 바탕으로 DataSouce를 생성한 후, 스프링 빈으로 만들어준다. 그리고 이를 JdbcMemberRepository에 주입함으로써 DI를 받을 수 있다.
스프링의 DI (Dependencies Injection)를 사용하면 기존 코드를 전혀 손대지 않고, 설정만으로 구현 클래스를 변경할 수 있다.
※ 개방-폐쇄 원칙(OCP, Open-Closed Principle) : 확장에는 열려있고, 수정, 변경에는 닫혀있다. 구체적으로 설명하면 기능 변경과 확장할 수 있으면서, 사용하는 코드는 수정하지 않는다.
(출처: https://koseungbin.gitbook.io/wiki/books/undefined/part-2.-di/solid/open-closed-principle)
● 스프링 통합 테스트
스프링 컨테이너와 DB까지 연결한 통합 테스트를 진행해 볼 것이다.
회원 서비스 스프링 통합 테스트
@SpringBootTest
@Transactional
class MemberServiceIntegrationTest {
...
}
이전에 진행했던 MemberServiceTest를 그대로 복사하여 MemberServiceIntegrationTest라는 클래스 파일을 만든 후에 @SpringBootTest, @Transactional을 추가한다.
※ @SpringBootTest : 스프링 컨테이너와 테스트를 함께 실행해주는 애노테이션이다.
※ @Transactional : 테스트 케이스에 이 애노테이션이 있으면, 테스트 시작 전에 트랜잭션을 시작하고,
테스트 완료 후에 항상 롤백한다. 이렇게 하면 DB에 데이터가 남지 않으므로 다음 테스트에 영향을 주지
않는다.
※ 단위 테스트 vs 통합 테스트 (출처 : https://newwisdom.tistory.com/41)
단위 테스트
- WebApplication 관련된 Bean들만 등록하기 때문에 통합 테스트보다 빠르다.
- 통합 테스트를 진행하기 어려운 테스트를 진행 가능하다.
- 요청부터 응답까지 모든 테스트를 Mock 기반으로 테스트하기 때문에 실제 환경에서는 제대로 동작하지 않을 수 있다.
통합 테스트
- 스프링 부트 컨테이너를 띄워 테스트하기 때문에 운영환경과 가장 유사한 테스트가 가능하다.
- 전체적인 Flow를 쉽게 테스트할 수 있다.
- 애플리케이션의 설정, 모든 Bean을 로드하기 때문에 시간이 오래 걸리고 무겁다.
- 테스트 단위가 커 디버깅이 어렵다.
● 스프링 JdbcTemplate
위에서 진행한 순수 Jdbc와 환경 설정은 동일하다. JDBC API의 반복 코드를 대부분 제거해주기 때문에 코드가 순수 Jdbc에 비해 매우 짧아진다. 하지만 SQL문은 개발자가 직접 작성해주어야 한다. 실무에서도 많이 쓰인다고 한다.
1. 스프링 JdbcTemplate 회원 리포지토리
package hello.hellospring.repository;
import hello.hellospring.domain.Member;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.jdbc.core.RowMapper;
import org.springframework.jdbc.core.namedparam.MapSqlParameterSource;
import org.springframework.jdbc.core.simple.SimpleJdbcInsert;
import javax.sql.DataSource;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
public class JdbcTemplateMemberRepository implements MemberRepository{
private final JdbcTemplate jdbcTemplate;
@Autowired //생성자가 하나이면 생략 가능
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;
};
}
}
위에서 말한 대로 순수 Jdbc에 비해 코드의 길이가 매우 짧아졌다.
jdbcTemplate의 query 메소드와 SQL문, 그리고 RowMapper를 통해 select문의 반환 값을 받아 findById, findByName, findAll 기능을 구현하였다.
save 메소드는 jdbcInsert, 테이블명, 키 등을 사용하여 구현하였는데 이는 JdbcTemplate의 기능 중 하나라고 한다.
2. JdbcTemplate을 사용하도록 스프링 설정 변경
package hello.hellospring.service;
import hello.hellospring.repository.JdbcTemplateMemberRepository;
import hello.hellospring.repository.MemberRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import javax.sql.DataSource;
@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);
return new JdbcTemplateMemberRepository(dataSource);
}
}
MemberRepository를 JdbcTemplateMemberRepository와 연결하고, JdbcTemplateMemberRepository에 dataSource를 주입함으로써 DI를 받는다.
● JPA
JPA를 사용하게 되면 기존의 반복 코드뿐만 아니라, 기본적인 SQL문도 직접 만들어서 실행시켜준다.
또한 기존의 SQL과 데이터 중심 설계에서 객체 중심의 설계로 패러다임을 전환할 수 있으며, 이로 인해 개발 생산성을 크게 높일 수 있다.
JPA는 ORM(Object-Relational Database-Mapping) 기술이다.
※ ORM(Object Relational Model)은 사물을 추상화시켜 이해하려는 OOP적 사고방식과 DataModel을 정형화하여 관리하려는 RDB 사이를 연결할 계층의 역할로 제시된 패러다임으로 RDB의 모델을 OOP에 Entity 형태로 투영시키는 방식을 사용한다. (출처 : https://jins-dev.tistory.com/entry/ORMObject-Relational-Mapping이란-ORM-패러다임의-개념)
1. build.gradle 파일에 관련 라이브러리 추가
implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
spring-boot-starter-data-jpa 는 내부에 jdbc 관련 라이브러리를 포함한다. 따라서 jdbc는 제거해도
된다.
2. 스프링 부트에 JPA 설정 추가
spring.jpa.show-sql=true
spring.jpa.hibernate.ddl-auto=none
show-sql은 JPA가 생성하는 SQL을 출력하여 준다.
ddl-auto는 JPA가 자동으로 테이블을 생성하는 기능을 끄거나 킬 수 있게 해 준다. (킬 때는 none 대신 create 사용)
3. JPA 엔티티 매핑
package hello.hellospring.domain;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
@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;
}
}
@Entity를 추가하여 Member 클래스를 JPA가 관리하는 Entity로 삼는다.
@Id, @GeneratedValue(strategy = GenerationType.IDENTITY)를 추가하여 id를 Primary Key로 매핑해준다.
strategy = GenerationType.IDENTITY는 DB에 데이터가 들어갈 때 id가 자동적으로 생성되게 한다.
4. JPA 회원 리포지토리
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;
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();
}
}
JPA는 EntityManger를 통해 많은 기능을 수행한다.
save 기능을 em.persist()로 구현하였으며, findById 기능은 em.find()로 구현하였다.
findByName, findAll은 em.createQuery()와 쿼리문과 비슷한 JPQL이라는 객체지향 쿼리문을 만들어서 구현하였다.
findById와 findByName의 구현 방식이 다른 이유는 id는 Primary Key이기 때문에 따로 쿼리문이 필요 없다.
저장, PK기반 조회, 업데이트는 쿼리문 작성이 필요 없다고 한다.
5. 서비스 계층에 트랜잭션 추가
import org.springframework.transaction.annotation.Transactional
@Transactional
public class MemberService {
...
}
JPA를 사용하여 데이터를 변경하는 경우에는 반드시 트랜잭션 안에서 실행되어야만 한다.
그래서 @Transactional을 MemberService 계층에 추가해준 것이다.
6. JPA를 사용하도록 스프링 설정 변경
package hello.hellospring.service;
import hello.hellospring.repository.JpaMemberRepository;
import hello.hellospring.repository.MemberRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import javax.persistence.EntityManager;
@Configuration
public class SpringConfig {
//EntityManager는 dataSource의 기능을 포함하고 있기에 삭제한다.
// private DataSource dataSource;
// @Autowired
// public SpringConfig(DataSource dataSource){
// this.dataSource = dataSource;
// }
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 MemoryMemberRepository();
// return new JdbcMemberRepository(dataSource);
// return new JdbcTemplateMemberRepository(dataSource);
return new JpaMemberRepository(em);
}
}
MemberRepository를 JpaMemberRepository와 연결하고, JpaMemberRepository에 EntityManager를 주입함으로써 DI를 받는다.
● 스프링 데이터 JPA
이전에 구현한 Repository에 구현체 없이 Interface만으로도 개발을 완료할 수 있다. 그리고 반복 개발해온 기본 CRUD 기능도 제공한다. 따라서 단순 반복된 코드들을 확연하게 줄일 수 있기 때문에 개발자가 핵심 비즈니스 로직을 개발하는 데에만 온전히 집중할 수 있게 해 준다.
1. 스프링 데이터 JPA 리포지토리
package hello.hellospring.repository;
import hello.hellospring.domain.Member;
import org.springframework.data.jpa.repository.JpaRepository;
import java.util.Optional;
public interface SpringDataJpaRepository extends JpaRepository<Member, Long>, MemberRepository {
//JPQL : select m from Member m where m.name = ?
@Override
Optional<Member> findByName(String name);
}
Interface가 Interface를 상속하였을 때는 extends를 사용하며, 다중 상속도 가능하다.
스프링 데이터 JPA는 JpaRepository를 상속받아 사용하는 Interface를 찾게 되면, 알아서 구현체를 만들어서 스프링 빈에 등록한다. 이를 개발자는 SpringConfig를 통해 가져다 사용하면 된다.
※ JpaRepository<Member, Long> : Member는 JpaRepository에서 사용하는 Entity를 뜻하며, Long은 Entity의 Primary Key, 즉 id를 뜻한다.
2. 스프링 데이터 JPA 회원 리포지토리를 사용하도록 스프링 설정 변경
package hello.hellospring.service;
import hello.hellospring.repository.MemberRepository;
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);
}
}
위의 과정을 통해 스프링 데이터 JPA가 만든 구현체들이 등록된다. memberService에 memberRepository를 주입함으로써 DI를 만든다.
3. 스프링 데이터 JPA 제공 클래스
스프링 데이터 JPA가 제공하는 클래스들은 위 그림들과 같다.
4. 스프링 데이터 JPA 제공 기능
인터페이스를 통한 기본적인 CRUD 기능, findByName() , findByEmail()처럼 메서드 이름 만으로 조회를 가능하게 하는 기능, 페이징 기능을 제공한다.
※ 실무에서는 JPA와 스프링 데이터 JPA를 기본으로 사용하고, 복잡한 동적 쿼리들을 Querydsl이라는 라이브러리로 처리한다. 위의 조합을 모두 사용하여도 해결하기 어려운 쿼리들은 JPA가 제공하는 네이티브 쿼리나 스프링 JdbcTemplate를 사용하면 된다.
'개발 > 스프링 입문' 카테고리의 다른 글
| (스프링 입문) 7. AOP (0) | 2022.09.25 |
|---|---|
| (스프링 입문) 5. 회원 관리 예제 (웹 MVC 개발) (0) | 2022.09.24 |
| (스프링 입문) 4. 스프링 빈과 의존관계 (0) | 2022.09.24 |
| (스프링 입문) 3. 회원 관리 예제 (0) | 2022.09.24 |
| (스프링 입문) 2. 스프링 웹 개발 기초 (0) | 2022.09.24 |