[입문][6] 스프링 DB 접근 기술

kiteB·2021년 8월 7일
H2 DatabaseJPASpringTILjdbc template순수 Jdbc스프링 DB 접근 기술스프링 데이터 JPA
0

Spring 강의노트

목록 보기
6/24

📌 김영한 선생님의 스프링 입문 강의 강의를 들으면서 공부한 내용을 정리한 게시물입니다.

[ H2 데이터베이스 설치 ]

이전까지는 메모리에 저장을 하는 방식이었지만, 실무에서는 데이터베이스에 저장/관리한다. H2 데이터베이스를 설치하고 데이터베이스를 연결해보자!

  • H2 데이터베이스는 용량도 작고 admin 화면도 제공해주기 때문에 교육용으로 매우 좋다.

✅ H2 데이터베이스 설치

🔗 H2 database download link로 가서 다운로드하기

설치가 다 되면 terminal를 실행해서 H2가 설치된 경로로 들어간 다음, 아래의 명령어를 실행한다.

  • cd bin : /H2/bin으로 들어가야 한다.
  • h2.bat : (실행)

✅ H2 콘솔 - 처음 접속 시

  • 모든 항목을 변경하지 말고 연결 클릭

📌 만약 연결을 눌렀을 때 다음과 같은 에러가 발생했다면?

Database "C:/Users/yeonju/test" not found, either pre-create it or allow remote database creation (not recommended in secure environments) [90149-200] 90149/90149

H2 Database Engine 이 아이콘을 클릭해서 Exit를 클릭한 뒤, 다시 h2.bat을 입력해보면 아~주~ 잘된다👍

  • 접속에 성공했다면 다음과 같은 화면이 나오게 된다.

  • 터미널은 켠 뒤 홈으로 가서 dir 했을 때, test.mv.db 파일이 잘 생성되었는지를 확인해보자.

✅ H2 콘솔 - 처음을 제외하고

위에서처럼 파일로 접근하게 되면 애플리케이션과 웹 콘솔이 충돌이 날 수도 있다!

  • 그래서 처음 접속을 제외하고, 다음과 같이 JDBC URL을 jdbc:h2:tcp://localhost/~/test 이런식으로 수정하자.
  • 이 방법은 파일을 직접 접근하는 것이 아니라 소켓을 통해서 접근하게 되는 것으로, 이렇게 해야 여러 군데에서 접근할 수 있다.
  • 연결 버튼을 클릭하면 잘 접속되는지 다시 확인하기.

✅ 테이블 생성하기

create table member
(
 id bigint generated by default as identity,
 name varchar(255),
 primary key (id)
);
  • id
    • bigint: java에서는 long인데 DB에서는 bigint 타입을 사용한다.
    • generated by default as identity: 값을 세팅하지 않고 insert하면 DB가 알아서 값을 채워준다.
  • name: 문자열
  • primary key: id로 설정

📌 SQL문 실행 방법

  • 실행 버튼을 클릭
  • Ctrl + Enter

코드를 실행하면 왼쪽에 MEMBER 테이블이 생성된다.

📌 참고

select * from member 코드를 입력하면 다음과 같이 조회도 가능하다.
(왼쪽에 MEMBER 탭을 클릭하면 이 코드가 자동으로 작성된다.)


✅ 값 insert 해보기

  • 다음의 코드를 입력해서 실행시켜보자. (name에 spring을 넘겨준 것)
insert into member(name) values('spring')

  • select * from member 코드를 입력한 뒤 실행시켜보면 (조회)
  • 이렇게 member 데이터가 생성된 것을 확인할 수 있다.

📌 참고

hello-spring(프로젝트 폴더)/sql/ddl.sql 파일을 생성해서 테이블 생성 코드를 작성해주면 테이블 관리를 편리하게 할 수 있다.

[ 순수 Jdbc ]

✅ Jdbc 사용하기 위한 설정하기ㅣ

  • build.gradle에 jdbc, h2 데이터베이스 관련 라이브러리 추가하기
implementation 'org.springframework.boot:spring-boot-starter-jdbc'
runtimeOnly 'com.h2database:h2'

⭐ 입력한 다음에 오른쪽의 코끼리 아이콘을 클릭해주어야 한다! 안하면 import가 안 된다.

  • resources/application.properties에 스프링 부트 데이터베이스 연결 설정 추가하기
spring.datasource.url=jdbc:h2:tcp://localhost/~/test
spring.datasource.driver-class-name=org.h2.Driver
spring.datasource.username=sa

이렇게 JDBC API로 직접 코딩하는 것은 20년 전 이야기이므로, 예전에는 이렇게 개발했구나 정도만 알고 넘어가기!

[ 스프링 통합 테스트 ]

  • src/test/java/hello.hellospring/service/MemberServiceIntegrationTest.java
@SpringBootTest
@Transactional
class MemberServiceIntegrationTest {

    @Autowired MemberService memberService;
    @Autowired MemberRepository memberRepository;

    @Test
    public void 회원가입() throws Exception {

        //Given
        Member member = new Member();
        member.setName("hello");

        //When
        Long saveId = memberService.join(member);

        //Then
        Member findMember = memberRepository.findById(saveId).get();
        assertEquals(member.getName(), findMember.getName());
    }

    @Test
    public void 중복_회원_예외() throws Exception {

        //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("이미 존재하는 회원입니다.");
    }
}
  • @SpringBootTest: 스프링 컨테이너와 테스트를 함께 실행한다.
  • @Transactional: 테스트 케이스에 이 어노테이션이 있으면, 테스트 시작 전에 트랜잭션을 시작하고, 테스트 완료 후에 항상 롤백한다. 이렇게 하면 DB에 데이터가 남지 않으므로 다음 테스트에 영향을 주지 않는다.
    • 이 어노테이션이 있으므로 @AfterEach 코드도 필요 없다.

⭐ 통합 테스트도 필요하지만 단위 테스트를 잘하는 것이 매우매우 중요하다!

[ 스프링 JdbcTemplate ]

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

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

  • main/java/hello.hellospring/repository/JdbcTemplateMemberRepository.java
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 List<Member> findAll() {
        return jdbcTemplate.query("select * from member", memberRowMapper());
    }

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

    private RowMapper<Member> memberRowMapper() {
        return (rs, rowNum) -> {
            Member member = new Member();
            member.setId(rs.getLong("id"));
            member.setName(rs.getString("name"));
            return member;
        };
    }
}

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

  • main/java/hello.hellospring/SpringConfig.java 
@Configuration
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 MemoryMemberRepository();
        return new JdbcTemplateMemberRepository(dataSource);
    }
}

run해서 localhost:8080/으로 접속하면 데이터가 그대로 저장되어 있는 것을 확인할 수 있다.

📌 참고

가끔 java.lang.IllegalStateException: 이미 존재하는 회원입니다. 에러가 발생할 때가 있는데, 이럴 때는 H2 콘솔에서 DB 데이터를 지우면 된다.

[ JPA ]

✅ JPA 특징

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

✅ 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') {
		exclude group: 'org.junit.vintage', module: 'junit-vintage-engine'
	}
}
  • main/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: JPA는 테이블을 자동으로 생성하는 기능을 제공하는데 none을 사용하면 해당 기능을 끈다. (나는 이미 만들어두었으므로 none 설정을 하는 것이다.)
    • create를 사용하면 엔티티 정보를 바탕으로 테이블도 직접 생성해준다.

✅ JPA 엔티티 매핑

  • main/java/hello/hellospring/domain/Member.java
@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;
    }
}
  • JPA를 사용하려면 Entity를 매핑해주어야 한다. 이를 위해 @Entity를 붙여주자.
  • pk를 매핑하기 위해서 @Id와 @GeneratedValue를 붙여주자.

✅ JPA 회원 리포지토리

  • main/java/hello/hellospring/repository/JpaMemberRepository.java
public class JpaMemberRepository implements MemberRepository {

    private final EntityManager em;

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

    public Member save(Member member) {
        em.persist(member);
        return member;
    }

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

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

    public List<Member> findAll() {
        return em.createQuery("select m from Member m", Member.class)
                .getResultList();
    }
}

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

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

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

  • main/java/hello/hellospring/SpringConfig.java
@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 MemoryMemberRepository();
//        return new JdbcTemplateMemberRepository(dataSource);
        return new JpaMemberRepository(em);
    }
}

이제 java/hello/hellospring/service/MemberServiceIntegrationTest.java에서 회원가입 부분만 실행시키면 다음과 같이 나온다.

Hibernate: insert into member (id, name) values (null, ?) 이 부분이 DB에 저장해서 id를 자동으로 생성해주는 것이다.

h2 콘솔에서 delete from member를 입력해서 데이터를 다 지우고 MemberServiceIntegrationTest.java 전체를 다시 Run해보면 다음과 같이 나온다.

[ 스프링 데이터 JPA ]

스프링 부트와 JPA만 사용해도 개발 생산성이 정말 많이 증가하고, 개발해야할 코드도 확연히 줄어든다. 그런데 여기에 스프링 데이터 JPA까지 사용한다면 리포지토리에 구현 클래스 없이 인터페이스만으로 개발을 완료할 수 있다! 게다가 지금까지 반복 개발해온 기본 CRUD 기능까지 스프링 데이터 JPA가 모두 제공한다.

스프링 부트와 JPA라는 기반 위에, 스프링 데이터 JPA라는 환상적인 프레임워크를 더하며 개발이 정말 즐거워진다고 한다!

실무에서 관계형 데이터베이스를 사용한다면 스프링 데이터 JPA는 이제 선택이 아니라 필수!

🚫 주의

스프링 데이터 JPA는 JPA를 편리하게 사용하도록 도와주는 기술이다.
그러니까 JPA를 먼저 학습한 뒤에 스프링 데이터 JPA를 학습해야 한다!

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

  • main/java/hello/hellospring/repository/SpringDataJpaMemberRepository.java
public interface SpringDataJpaMemberRepository extends JpaRepository<Member, Long>, MemberRepository {
    Optional<Member> findByName(String name);
}

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

  • main/java/hello/hellospring/SpringConfig.java
@Configuration
public class SpringConfig {

    private final MemberRepository memberRepository;

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

    @Bean
    public MemberService memberService() {
        return new MemberService(memberRepository);
    }
}
  • 스프링 데이터 JPA가 SpringDataJpaMemberRepository를 스프링 빈으로 자동 등록해준다.

이제 Test를 Run해보면 잘 실행된다.


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


✅ 스프링 데이터 JPA 제공 기능

  • 인터페이스를 통한 기본적인 CRUD
  • findByName(), findByEmail() 처럼 메소드 이름만으로 조회 기능 제공
  • 페이징 기능 자동 제공

📌참고

  • 실무에서는 JPA와 스프링 데이터 JPA를 기본으로 사용하고, 복잡한 동적 쿼리는 Querydsl이라는 라이브러리를 사용하면 된다.
  • Querydsl을 사용하면 쿼리도 자바 코드로 안전하게 작성할 수 있고, 동적 쿼리도 편리하게 작성할 수 있다.
  • 이 조합으로 해결하기 어려운 쿼리는 JPA가 제공하는 네이티브 쿼리를 사용하거나 앞서 학습한 스프링 JdbcTemplate를 사용하면 된다.

[ 📘 오늘의 TIL 정리 ]

  • H2 데이터베이스는 용량도 작고 admin 화면도 제공해주기 때문에 교육용으로 매우 좋다.
  • H2 콘솔 JDBC URL
    • 처음: jdbc:h2:~/[설정이름] → jdbc:h2:~/test
    • 이후: jdbc:h2:tcp://localhost/~/[설정이름] → jdbc:h2:tcp://localhost/~/test
  • sql문 예시
    • 데이터 생성: insert into member(name) values('spring')
    • 데이터 조회: select * from member
  • 스프링 통합 테스트
    • @SpringBootTest: 스프링 컨테이너와 테스트를 함께 실행한다.
    • @Transacional: 테스트 시작 전에 트랜잭션을 시작하고, 테스트 완료 후에 항상 롤백한다.
      • 이 어노테이션으로 인해 DB에 데이터가 남지 않으므로 다음 테스트에 영향을 주지 않는다.
      • 그러므로 @AfterEach 어노테이션이 필요 없다.
  • JPA
    • 기존의 반복 코드는 물론이고, 기본적인 SQL도 JPA가 직접 만들어서 실행해준다.
    • JPA를 이용하면 SQL과 데이터 중심의 설계에서 객체 중심의 설계로 패러다임을 전환할 수 있다.
    • 개발 생산성을 크게 높일 수 있다.
    • JPA를 사용하려면 Entity를 매핑해주어야 한다.
    • JPA를 통한 모든 데이터 변경은 트랜잭션 안에서 실행해야 한다.
  • 스프링 데이터 JPA
    • 리포지토리에 구현 클래스없이 인터페이스만으로 개발을 완료할 수 있다.
    • 기본 CRUD 기능까지 제공한다.
    • 하지만 스프링 데이터 JPA는 JPA를 편리하게 사용하도록 도와주는 기술이므로 JPA를 먼저 학습한 뒤 스프링 데이터 JPA를 학습해야 한다.
profile
kiteB
🚧 https://coji.tistory.com/ 🏠
이전 포스트

[입문][5] 회원 관리 예제 - 웹 MVC 개발

다음 포스트

[입문][7] AOP

0개의 댓글