[Spring Intro] Section 06. 스프링 DB 접근 기술
강의: 김영한의 스프링 입문
# 들어가기 전
- 이전 포스팅까지는 회원 정보를 메모리에 저장했기 때문에 서버를 껐다 켜면 데이터가 메모리에서 모두 사라졌다
- 실무에서는 이런 일이 발생하면 안 되기 때문에 데이터베이스를 통해 저장하고 관리해야 한다
- 이를 위해 H2 데이터베이스를 설치하고, 데이터베이스의 SQL을 통해 애플리케이션 서버와 DB를 연결해 볼 것이다
- 연결할 때 필요한 것이 바로 Jdbc 기술이며, 오랜 전의 개발자들이 어떻게 개발했는지 순수한 Jdbc로 경험을 해보고 중복을 제거하여 애플리케이션에서 DB로 바로 SQL를 보낼 수 있는 스프링 Jdbc Template를 사용해 볼 것이다
- 더 나아가서 JPA라는 기술을 활용하여 SQL(등록/수정/삭제) 쿼리를 날릴 수 있는 기술을 배울 것이다
- 이 기술은 객체를 쿼리 없이 바로 DB에 저장하고 관리할 수 있다
- 이 JPA를 스프링에서 아주 편리하게 쓸 수 있도록 감싼 기술이 스프링 데이터 JPA이다
# H2 데이터베이스 설치
1. 설치
- H2 데이터 베이스는 개발이나 테스트 용도로 가볍고 편리한 DB이며 웹 화면을 제공한다
- H2 데이터 베이스는 다음 링크에 들어가서 1.4.200 버전을 설치한다
- 최신 버전을 설치하면 일부 기능이 정상 동작하지 않을 수 있다
만약 이미 설치하고 실행까지 했다면 다시 설치한 이후에 ~/test.mv.db 파일을 꼭 삭제해야 한다
그렇지 않으면 다음 오류가 발생하면서 접속되지 않는다
General error: "The write format 1 is smaller than the supported format 2 [2.0.206/5]" [50000-202] HY000/50000
- https://www.h2database.com/html/download-archive.html
- MAC 사용자라면 Platform-Independent.ZIP을 다운로드하면 된다
2. 실행
- 설치가 완료되었다면 zip 파일을 원하는 폴더에서 압축해제하고 터미널에서 h2 디렉터리 아래 bin 디렉터리로 이동한다
$ cd [h2 디렉토리의 위치]
$ cd h2
$ cd bin- 맥 사용자는 h2.sh에 대해 권한을 부여한다
$ chmod 755 h2.sh- h2.sh 파일을 실행한다 (윈도우 사용자는 h2.bat를 실행한다)
$ ./h2.sh- 명령어를 실행하면 다음과 같은 화면이 뜬다
- 다음과 같은 화면에서 최초 접속 시에는 JDBC URL을 jdbc:h2:~/test
- 이후 접속부터는 JDBC URL을 jdbc:h2:tcp://localhost/~/test으로 접속하여 소켓으로 연결한다
- 콘솔창에서 Connection을 눌러 다음과 같은 화면이 나오면 연결에 성공한 것이다
- 홈 디렉토리에서 test.mv.db가 생성되었는지 확인한다
- ls 명령어를 통해 찾는 방법이 강의에 나와있지만 필자는 파일이 너무 많아 find 명령어를 통해 확인했다
- 문제가 있다면 rm test.mv.db 명령어를 통해 삭제 후 설치부터 다시 진행한다
3. 테이블 생성하기
- 테이블을 관리하기 위해 프로젝트 루트에 sql 디렉터리를 생성하고 ddl.sql 파일을 다음과 같이 생성한다
- ddl.sql의 내용은 다음 코드와 같다
generated by default as identity: 값을 세팅하지 않고 insert 하면 db가 자동으로 id 값을 채워준다
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 table에 현재 아무런 데이터도 저장되어 있지 않음을 확인할 수 있다
4. 오류 해결
- 아래와 같은 오류 메시지가 나오며 H2 데이터 베이스가 정상 생성되지 않는 경우도 있다
Database "/Users/[username]/test" not found, either pre-create it or allow remote database creation (not recommended in secure environments) [90149-200] 90149/90149
- 위의 오류를 해결하기 위해서는 H2 데이터베이스를 종료하고, 다시 시작한다
- 그 다음 웹 브라우저가 자동 실행되면 주소창이 다음과 같이 앞부분에 임의의 IP 주소가 나올 것이다
- 다음과 같이 앞부분(IP 부분)만 localhost로 변경하고 enter를 눌러 새로고침한다
- 이때, 뒷부분은 절대로 변경되면 안 되며 jsessionid 뒷부분이 변경되지 않도록 유의한다
- 데이터베이스 파일을 생성하면(jdbc:h2:~/test), 데이터베이스가 정상 생성되며 위에서 마주했던 오류를 해결할 수 있다
5. 테스트
- 멤버 테이블에 spring1, spring2를 추가한다
insert into member(name) values('spring');
insert into member(name) values('spring2');- member table을 조회해보면 이전과 다르게 spring, spring2가 추가되어 있음을 확인할 수 있다
# 순수 JDBC
1. 환경 설정
- jdbc, h2 데이터베이스 관련 라이브러리
// DB와 연동하기 위해 필요한 드라이버
implementation 'org.springframework.boot:spring-boot-starter-jdbc'
// DB와 붙을 때 필요한 데이터베이스가 제공하는 클라이언트
runtimeOnly 'com.h2database:h2'- 다음과 같이 build.gradle 파일에 위의 내용을 추가한다
- 내용을 추가한 이후 gradle을 reload 해주어야 한다
- 스프링부트 데이트벵이스 연결 설정 추가를 위해서는 아래 코드가 필요하다
spring.datasource.url = jdbc:h2:tcp://localhost/~/test
spring.datasource.driver-class-name=org.h2.Driver
spring.datasource.username = sa- 위의 코드는 src/main/resource/application.properties에 추가한다
스프링부트 2.4부터는 spring.datasource.username = sa를 꼭 추가해주어야 한다
그러지 않으면 Wrong user name or password 오류가 발생한다
또한 다음과 같이 마지막에 공백이 들어가면 같은 오류가 발생한다
spring.datasource.username=sa " " <- " "로 표시된 공간에 공백이 존재하면 안 됨
공백은 모두 제거해주어야 한다
2. JDBC 리포지토리 구현
이렇게 JDBC API로 직접 코딩하는 것은 20년 전의 이야기이므로 고대 개발자들이 이렇게 고생하면서 코딩했구나 참고만 하고 가볍게 보도록 한다
- 회원을 저장하는 역할은 MemberRepository가 하지만, 구현을 메모리에 할 것인지 DB와 연동해서 할 것인지 대해서 차이가 있다
- 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에 붙기 위해서 필요하다
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의 name을 넣는다
pstmt.executeUpdate(); // executeupdate를 통해 실제 DB에 쿼리가 날라간다
rs = pstmt.getGeneratedKeys(); // getGeneratedKeys는 prepareStatement에서 사용했던 옵션을 통해 방금 생성된 키의 id를 반환해준다
if (rs.next()) { // 만약 rs 다음 값이 있다면 getLong을 통해 값을 꺼내 id 값을 세팅한다
member.setId(rs.getLong(1));
} else { // 없다면 Exceeption 처리한다
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;
/*
위와 비슷한 방식
executeQuery를 통해 result 값을 받아옴
멤버가 있으면 쭉 만들고 반환
*/
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;
/*
위와 비슷한 방식
리스트 사용, 멤버가 있다면 루프 돌면서 add를 통해 멤버를 담은 후 반환한다
*/
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() {
// 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);
}
}
3. 스프링 설정 변경 및 결과
- DataSource는 데이터 베이스 커넥션을 획득할 때 사용하는 객체다
- 스프링 부트는 데이터베이스 커넥션 정보를 바탕으로 DataSource를 생성하고 스프링 빈으로 만들어 두면 DI를 받을 수 있다
- 이를 적용하여 이전에 작성한 src/main/java.hellospring/SpringConfig.java를 다음과 같이 변경한다
package hello.hellospring;
import hello.hellospring.repository.JdbcMemberRepository;
import hello.hellospring.repository.MemberRepository;
import hello.hellospring.repository.MemoryMemberRepository;
import hello.hellospring.service.MemberService;
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);
}
}- 설정을 변경해 주었으면 터미널에서 h2.sh가 실행되고 있는 상태에서 프로젝트를 실행해 보자
- localhost:8080에 접속한 후 회원 목록 기능을 클릭해 보면 h2 데이터베이스에 저장했던 spring, spring2가 정상적으로 출력되는 것을 확인할 수 있다
- 회원 가입 기능을 통해 jpa 회원을 등록하면 h2 데이터베이스에 jpa 회원이 추가되었음을 확인할 수 있다
4. 구현 클래스 추가 이미지
- MemberService가 MemberRepository에 의존하고 있다
- MemberRepository는 구현체로 MemoryMemberRepository와 JdbcMemberRepository를 가지고 있다
5. 스프링 설정 이미지
- 스프링 빈에서 MemoryMemberRepository와의 연결을 끊고 JdbcMemberRepository로 등록한다
- 이렇게 하면 구현체가 바뀌어 JdbcMember Repository로 돌아가게 된다
- 개방-폐쇄 원칙(OCP, Open-Closed Principle): 확장에는 열려있고, 수정, 변경에는 닫혀있다
- 스프링의 DI(Dependencies Injection)을 사용하면 기존 코드를 전혀 손대지 않고, 설정만으로 구현 클래스를 변경할 수 있다
- 데이터를 DB에 저장하므로 스프링 서버를 다시 실행해도 데이터가 안전하게 저장된다
- 스프링을 사용하는 이유
> 객체지향적인 설계가 다형성을 활용할 수 있기 때문이다. 예를 들어 하나의 인터페이스를 두고 구현체의 교체가 가능하다
> DI와
다형성을 잘 활용하면 일부 기능의 추가를 위해 전체 애플리케이션을 수정하지 않아도 된다
> 이 기능들을 편리하게 이용할 수 있도록 스프링 컨테이너가 지원해 주는 것이 스프링의 장점이다
# 스프링 통합 테스트
- 스프링 컨테이너와 DB를 연결한 통합 테스트를 진행한다
- 이전에는 스프링과 별개로 순수한 자바 코드에 대해서 진행하는 단위 테스트를 배웠다
- 그러나 현재는 데이터베이스까지 사용하므로 스프링을 통한 테스트가 필요하다
1. 회원 서비스 스프링 통합 테스트
- src/test/java/hello.hellospring/service/MemberServiceIntegrationTest.java를 다음과 같이 작성한다
- @SpringBootTest: 스프링 컨테이너와 테스트를 함께 실행한다
- @Transactional: 테스트케이스에 이 annotation이 있으면, 테스트 시작 전에 트랜잭션을 시작하고, 테스트 완료 후에 항상 롤백한다. 이렇게 하면 DB에 데이터가 남지 않으므로 다음 테스트에 영향을 주지 않는다
package hello.hellospring.service;
import hello.hellospring.domain.Member;
import hello.hellospring.repository.MemberRepository;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.transaction.annotation.Transactional;
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("hello");
//when
Long saveId = memberService.join(member);
//then
Member findMember = memberService.findOne(saveId).get();
assertThat(member.getName()).isEqualTo(findMember.getName());
}
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() {
}
}
2. 결과
insert query 이후 commit까지 진행해야 DB에 반영된다
보통은 Auto commit mode로 설정되어 있다
- 위의 MemberServiceIntegrationTest에서 @Transactional annotation을 주석처리하고 회원 가입하는 이름을 "spring"으로 변경한 후 회원가입 method만 먼저 실행해 본다
- 에러가 발생하는 것을 확인할 수 있다
- 이는 h2 데이터베이스에 이미 spring이라는 회원이 DB에 존재하는데 테스트에서 동일한 이름의 회원을 등록하려고 했기 때문이다
- 아래 구문을 통해 MEMBER table 내의 내용을 지워주면 정상적으로 테스트가 진행된다
- 보통은 테스트 전용 DB를 구축하거나 로컬 PC의 DB에서 테스트한다
delete from member;
- 하지만 한번 더 실행하면 DB 중복 데이터로 인해 다시 오류가 발생할 것이다
- 이전에는 이런 문제를 해결하기 위해서 @AfterEach를 사용했지만 데이터베이스를 연결한 지금에는 @Transactional을 사용하면 좋다
- 위에서도 설명했듯이 @Transactional은 테스트 케이스 완료 후 롤백해 주는 역할을 하며 실제 서비스에서는 롤백하지 않는다
- @Transactional을 사용하면 테스트 실행 후에도 데이터가 남지 않는다
DB까지 올리는 통합 테스트보다는 단위 테스트가 더 좋은 테스트인 경우가 많으므로 쪼개서 테스트할 수 있다면 단위 테스트를 보통 선택하는 것이 좋다
# 스프링 JdbcTemplate
- 순수 Jdbc와 동일한 환경설정을 하면 된다
- 스프링 JdbcTemplate과 MyBatis 같은 라이브러리는 JDBC API에서 본 반복 코드를 대부분 제거해 준다
- 그러나 SQL은 직접 작성해야 한다
- 실무에서도 JdbcTemplate를 많이 사용한다
- 이름에 Template이 들어가는 이유는 템플릿 method 패턴이 많이 사용되기 때문이다
1. 스프링 Jdbc Template 회원 리포지토리
- src/main/java/hello.hellospring/repository/JdbcTemplateMemberRepoistory.java를 다음과 같이 작성한다
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 // 해당 클래스가 스프링 빈으로 등록되는 경우에서 생성자가 하나라면 Autowired는 생략할 수 있다
public JdbcTemplateMemberRepository(DataSource dataSource) { // dataSource를 injection 받는다
this.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());
// 여기까지는 insert 구문을 대체하는 코드이다
// 여기서부터는 데이터베이스에 저장된 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);
// 반환 타입이 list이다
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;
};
}
}
2. JdbcTemplate을 사용하도록 스프링 설정 변경
- src/main/java/hello.hellospring/SpringConfig.java에서 MemberRepository method를 다음과 같이 변경한다
package hello.hellospring;
import hello.hellospring.repository.JdbcMemberRepository;
import hello.hellospring.repository.MemberRepository;
import hello.hellospring.repository.MemoryMemberRepository;
import hello.hellospring.service.MemberService;
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 JdbcMemberRepository(dataSource);
}
}- 코드를 수정한 후 테스트가 잘 되는지 확인한다
# JPA
- JPA는 기존의 반복 코드는 물론이고, 기본적인 SQL도 JPA가 직접 만들어서 실행해 준다
- JPA를 사용하면, SQL과 데이터 중심의 설계에서 객체 중심의 설계로 패러다임을 전환할 수 있다
- JPA를 사용하면 개발 생산성을 크게 높일 수 있다
1. 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') {
exclude group: 'org.junit.vintage', module: 'junit-vintage-engine'
}
}- gradle refresh 이후 라이브러리를 살펴보면 hibernate가 존재함을 확인할 수 있다
- jpa는 인터페이스고 import 된 라이브러리인 hibernate(벤더)는 구현체이다
2. 스프링 부트에 JPA 설정 추가
- src/main/resorces/application.properties에 다음과 같이 JPA 설정을 추가해 준다
- spring.jpa.show-sql: jpa에서 생성하는 SQL을 확인할 수 있게 해 주는 옵션이다
- spring.jpa.hibernate.ddl-auto: JPA는 자동으로 테이블을 생성하는 기능을 제공하는데 현재는 member table이 이미 생성되어 있으므로 설정을 꺼준다
- none이 아닌 create를 사용하면 객체(entity) 정보를 바탕으로 테이블을 직접 생성한다
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
ORM: 객체(Object)와 관계형(Relational) 데이터베이스를 mapping 하는 것이다
3. JPA 엔티티 매핑
- src/main/java/hello.hellospring/domain/Member.java를 다음과 같이 변경한다
- IDENTITY: 쿼리에 ID를 넣는 게 아닌 DB에 값을 넣었을 때 생성되는 key를 ID로 사용하는 것이다
- @(annotation)들을 가지고 DB와 매핑하면 INSERT, UPDATE, DELETE 문 등을 만드는 방식으로 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;
}
}
4. JPA 회원 리포지토리
JPA는 엔티티 매니저로 모든 것이 동작된다
build.gradle에서 받은 data-jpa 라이브러리를 통해 스프링 부트에서는 자동으로 엔티티 매니저를 생성한다
엔티티 매니저는 내부적으로 데이터 소스를 가지고 있어 DB와의 통신을 내부에서 처리할 수 있다
- src/main/java/hello.hellospring/repository/JpaMemberRepository.java에 다음과 같이 코드를 작성한다
package hello.hellospring.repository;
import hello.hellospring.domain.Member;
import jakarta.persistence.EntityManager;
import java.util.List;
import java.util.Optional;
public class JpaMemberRepository implements MemberRepository {
private final EntityManager em;
public JpaMemberRepository(EntityManager em) { // spring boot에서 만들어준 EntityManager를 Injection 받으면 된다
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 List<Member> findAll() {
return em.createQuery("select m from Member m", Member.class).getResultList();
}
@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와 jpsql에 대해서
- jpsql: JPA에서 객체(entity)에 대해 sql을 날리는 것이다
- 저장, 조회, 수정에 대해서는 이러한 jpsql을 작성할 필요가 없다
- pk 기반이 아닌 기능은 jpql을 통해 쿼리를 작성해 구현해야 한다
- select m form Member (as가 생략된다) m: 여기에서 m은 Member 객체를 의미한다
5. 서비스 계층에 트랜잭션 추가
- src/main/java/hello.hellospring/service/MemberService.java에 다음 코드를 추가한다
- org.springframework.transaction.annotation.Transactioanl를 import 한다
import org.springframework.transaction.annotation.Transactional
@Transactional
public class MemberService {}
스프링은 해당 클래스의 메서드를 실행할 때 트랜잭션을 시작하고, method가 정상 종료되면 트랜잭션을 커밋한다.
만약 런타임 예외가 발생하면 롤백한다.
JPA를 통한 모든 데이터 변경은 트랜잭션 안에서 실행해야 한다.
6. JPA를 사용하도록 스프링 설정 변경
- src/main/java/hello.hellospring/SpringConfig.java를 다음과 같이 변경한다
package hello.hellospring;
import hello.hellospring.repository.JpaMemberRepository;
import hello.hellospring.repository.MemberRepository;
import hello.hellospring.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;
import javax.sql.DataSource;
@Configuration
public class SpringConfig {
//private DataSource dataSource;
private final EntityManager em;
@Autowired
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 MemoryMemberRepository();
//return new JdbcMemberRepository(dataSource);
//return new JdbcMemberRepository(dataSource);
return new JpaMemberRepository(em);
}
}- 코드를 수정한 후 테스트가 잘 되는지 확인한다
- 아까 설정해 주었던 jpa가 생성한 SQL도 확인할 수 있다
# 스프링 데이터 JPA
스프링 부트와 JPA만 사용해도 개발 생산성이 정말 많이 증가하고, 개발해야 할 코드도 확연히 줄어듭니다.
여기에 스프링 데이터 JPA를 사용하면, 기존의 한계를 넘어 마치 마법처럼, 리포지토리에 구현 클래스 없이 인터페이스 만으로 개발을 완료할 수 있습니다.
그리고 반복 개발해 온 기본 CRUD 기능도 스프링 데이터 JPA가 모두 제공합니다.
스프링 부트와 JPA라는 기반 위에, 스프링 데이터 JPA라는 환상적인 프레임워크를 더하면 정말 즐거워집니다.
지금까지 조금이라도 단순하고 반복이라 생각했던 개발 코드들이 확연하게 줄어듭니다.
따라서 개발자는 핵심 비지니스 로직을 개발하는데 집중할 수 있습니다.
실무에서 관계형 데이터베이스를 사용한다면 스프링 데이터 JPA 이제 선택이 아니라 필수입니다.
- 김영한의 스프링 입문
주의사항
스프링 데이터 JPA는 JPA를 편리하게 사용하도록 도와주는 기술이다.
따라서 JPA를 먼저 학습한 후에 스프링 데이터 JPA를 학습해야 한다.
- 스프링 데이터 JPA 사용 시 앞에서 사용한 JPA 설정을 그대로 사용한다
1. 스프링 데이터 JPA 회원 리포지토리
- src/main/java/hello.hellospring/repository/SpringDataJpaMemberRepository.java를 다음과 같이 작성한다
- 개발 시 공통적으로 사용된다고 생각되는 기능은 스프링 데이터 jpa에서 자동적으로 제공한다
- 멤버의 이름을 name으로 찾고 싶은지, username으로 찾고 싶은지 등등은 비지니스마다 모두 다르기 때문에 공통 클래스로 제공하는 것이 불가능하다
- 따라서 SpringDataJpaMemberRepository에 findByName과 같이 우리 비지니스에서 필요한 기능을 명시한 것이다
- 이렇게 인터페이스 이름만으로도 개발을 할 수 있는 것이 Spring Data JPA이다
package hello.hellospring.repository;
import hello.hellospring.domain.Member;
import org.springframework.data.jpa.repository.JpaRepository;
import java.util.Optional;
// T = Member, ID = Long(이때 ID는 데이터베이스에서 pk로 사용되고 있다)
public interface SpringDataJpaMemberRepository extends JpaRepository<Member, Long>, MemberRepository {
// select m from Member m where m.name = ?
@Override
Optional<Member> findByName(String name);
}
spring data jpa에서는 findByName을 보고 select m from Member m where m.name = ? 과 같은 쿼리를 자동으로 생성한다
2. 스프링 데이터 JPA 회원 리포지토리를 사용하도록 스프링 설정 변경
- src/main/java/hello.hellospring/SpringConfig.java를 다음과 같이 변경한다
- 스프링 데이터 JPA가 SpringDataJpaMemberRepository를 보고 스프링 빈을 자동으로 만든다
- 프록시라는 기술로 객체(구현체)를 생성해서 컨테이너에 올려주므로 우리는 그것을 injection 해서 바로 사용한 것이다
package hello.hellospring;
import hello.hellospring.repository.MemberRepository;
import hello.hellospring.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 MemoryMemberRepository();
// return new JdbcMemberRepository(dataSource);
// return new JdbcTemplateMemberRepository(dataSource);
// return new JpaMemberRepository(em);
// }
}- 코드를 수정한 후 테스트가 잘 되는지 확인한다
3. 스프링 데이터 JPA 제공 클래스
- 실제 우리가 앞에서 직접 구현했던 기능들이 포함되어 있는 것을 확인할 수 있다
4. 스프링 데이터 JPA 제공 기능
- 인터페이스를 통한 기본적인 CRUD
- findByName(), findByEmail()처럼 메서드 이름만으로 조회 기능 제공
- 페이징 기능 자동 제공
실무에서는 JPA와 스프링 데이터 JPA를 기본으로 사용하고, 복잡한 동적 쿼리는 Querydsl이라는 라이브러리를 사용하면 된다.
Querydsl을 사용하면 쿼리도 자바 코드로 안전하게 작성할 수 있고, 동적 쿼리도 편리하게 작성할 수 있다.
이 조합으로 해결하기 어려운 쿼리는 JPA가 제공하는 네이티브 쿼리를 사용하거나, 앞서 학습한 스프링 JdbcTemplate를 사용하면 된다.
'Study > Backend Note' 카테고리의 다른 글
| [SOPT] 파이썬과 Mysql 그리고 구글스프레드 시트를 연동하여 기획이랑 소통하는 법 (0) | 2023.07.21 |
|---|---|
| [Spring Intro] Section 07. AOP (0) | 2023.03.07 |
| [Spring Intro] Section 05. 회원 관리 예제 - 웹 MVC 개발 (0) | 2023.03.04 |
| [Spring Intro] Section 04. 스프링 빈과 의존관계 (0) | 2023.02.28 |
| [Spring Intro] Section 03. 회원 관리 예제 - 백엔드 개발 (0) | 2023.02.28 |
