[스프링 3팀] 스프링 입문 섹션 7~8

7. 스프링 DB 접근 기술

H2 데이터베이스 설치

 

개발이나 테스트 용도로 가볍고 편리한 DB

 

https://www.h2database.com/ 

※ 참고: 윈도우 사용자인 경우 All Platforms이 아닌, Window Installer로 설치하여야 오류없이 실행되는 것으로 보임

 

✅ 윈도우 사용자는 h2.bat로 실행하면 됨

✅ ~/test.mv.db 파일 생성 확인

✅ 이후부터는 jdbc:h2:tcp://localhost/~/test로 접근하도록 함

파일 직접 접근이 아닌 TCP 소켓을 통해 접속해야 어플리케이션과 콘솔이 동시에 접근했을 때 오류가 발생하지 않음

 

스프링 통합 테스트

스프링 컨테이너와 DB까지 연결한 통합 테스트

아래 코드와 같은 버전이지만 DB까지 연결한 테스트 코드는 어떻게 변경 되는지 확인해 봅니다.

class MemberServiceTest {
    MemberService memberService;
    MemoryMemberRepository memberRepository;

    @BeforeEach
    public void beforeEach() {
        memberRepository = new MemoryMemberRepository();
        memberService = new MemberService(memberRepository);
    }

    @AfterEach
    public void afterEach() {
        memberRepository.clearStore();
    }

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

    }

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

        assertThat(e.getMessage()).isEqualTo("이미 존재하는 회원입니다.");
//        try {
//            memberService.join(member2);
//            fail();
//        } catch (IllegalStateException e) {
//            assertThat(e.getMessage()).isEqualTo("이미 존재하는 회원입니다.");
//        }


        // then

    }

    @Test
    void findMembers() {
    }

    @Test
    void findOne() {
    }
}

 

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

 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.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertThrows;
 
 @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에 데이터가 남지 않으므로 다음 테스트에 영향을 주지 않는다. 테스트케이스에 붙었을 때만 롤백하도록 동작한다.

 

순수한 단위테스트가 훨씬 좋은 테스트일 확률이 높음. 스프링 컨테이너 없이 테스트할 수 있도록 훈련할 것.

 

스프링 Jdbc Template

순수 Jdbc와 동일한 환경설정을 하면 된다.

스프링 JdbcTemplate과 MyBatis 같은 라이브러리는 JDBC API에서 본 반복 코드를 대부분 제거해준다.

하지만 SQL은 직접 작성해야 한다.

실무에서 많이 사용된다.

 

private final JdbcTemplate jdbcTemplate;

    @Autowired
    public JdbcTemplateMemberRepository(DataSource dataSource) {
        this.jdbcTemplate = new JdbcTemplate(dataSource);
    }

 

생성자가 하나만 있으면, 스프링빈으로 등록되서 Autowired 생략해도 됨

 

아래의 전체코드 참고

public class JdbcTemplateMemberRepository implements MemberRepository {

    private final JdbcTemplate jdbcTemplate;

    @Autowired
    public JdbcTemplateMemberRepository(DataSource dataSource) {
        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());

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

 

 

JPA

JPA는 기존의 반복 코드는 물론이고, 기본적인 SQL도 JPA가 직접 만들어서 실행해준다.

JPA를 사용하면, SQL과 데이터 중심의 설계에서 객체 중심의 설계로 패러다임을 전환을 할 수 있다. JPA를 사용하면 개발 생산성을 크게 높일 수 있다.

자바 진영의 표준 인터페이스라고 볼 수 있다. 구현은 여러 업체들이 한다. 

 

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

dependencies {
//	implementation 'org.springframework.boot:spring-boot-starter-jdbc'
	implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
	runtimeOnly 'com.h2database:h2'
}

 

스프링 부트에 JPA 설정 추가

resources/application.properties
 
 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 를 사용하면 해당 기능을 끈다. 

create를 사용하면 엔티티 정보를 바탕으로 테이블도 직접 생성해준다.

 

JPA 엔티티 매핑

package hello.hello_spring.domain;

import jakarta.persistence.*;

@Entity
public class Member {

    @Id @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;    // 시스템에 저장할 때 등록되는(시스템이 정해주는)
    @Column(name = "username")
    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 회원 리포지토리

package hello.hello_spring.repository;

import hello.hello_spring.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) {
        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();
    }
}

 

조회하고, 저장하고, 업데이트하는건 SQL 짤 필요없이 자동으로 됨

 

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

import org.springframework.transaction.annotation.Transactional;

@Transactional
public class MemberService {

 

스프링은 해당 클래스의 메서드를 실행할 때 트랜잭션을 시작하고, 메서드가 정상 종료되면 트랜잭션을 커밋한다. 만약 런타임 예외가 발생하면 롤백한다.

JPA를 통한 모든 데이터 변경은 트랜잭션 안에서 실행해야 한다.

 

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

package hello.hello_spring.service;

import hello.hello_spring.repository.JpaMemberRepository;
import hello.hello_spring.repository.MemberRepository;
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 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 JpaMemberRepository(em);
    }
}

 

스프링 데이터 JPA

스프링 부트와 JPA만 사용해도 개발 생산성이 정말 많이 증가하고, 개발해야할 코드도 확연히 줄어든다. 여기에 스프링 데이터 JPA까지 사용하면, 리포지터리에 구현 클래스 없이 인터페이스 만으로 개발을 완료할 수 있다. 실무에서 관계형 데이터베이스를 사용한다면 스프링 데이터 JPA는 필수!

 

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

package hello.hello_spring.repository;

import hello.hello_spring.domain.Member;
import org.springframework.data.jpa.repository.JpaRepository;

import java.util.Optional;

public interface SpringDataJpaMemberRepository extends JpaRepository<Member, Long>, MemberRepository {

    @Override
    Optional<Member> findByName(String name);
}

 

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

package hello.hello_spring.service;

import hello.hello_spring.repository.*
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@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를 스프링 빈으로 자동 등록해준다.

 

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

 

스프링 데이터 JPA에서 제공하는 각 인터페이스들은 데이터를 다루는 다양한 기능을 제공하며, 상위 인터페이스에서 하위 인터페이스로 갈수록 더 많은 기능을 포함하고 있다. 이 구조는 데이터 접근 계층에서 필요한 기능을 계층적으로 확장하여 사용할 수 있도록 한다. 기본 CRUD 작업만 필요하면 CrudRepository를, 정렬이나 페이징이 필요하면 PagingAndSortingRepository를, JPA의 고급 기능이 필요하면 JpaRepository를 구현하여 사용할 수 있다.

 

스프링 데이터 JPA 제공 기능

- 인터페이스를 통한 기본적인 CRUD

- findByName(), findByEmail() 처럼 메서드 이름 만으로 조회 기능 제공

- 페이징 기능 자동 제공

8. AOP 

관심사의 분리를 위해 사용되는 기술

애플리케이션의 핵심 비즈니스 로직과 관련 없는 부가적인 기능들을 모듈화하여 코드의 중복을 줄이고 유지보수성을 향상시키는 데에 주로 활용된다. 

 

AOP가 필요한 상황

- 모든 메소드의 호출 시간을 측정하고 싶다면?

- 공통 관심 사항(cross-cutting concern) vs 핵심 관심 사항(core concern) 회원 가입 시간

- 회원 조회 시간을 측정하고 싶다면? 특정 메서드에만 시간 측정 기능 적용

 

MemberService 회원 조회 시간 측정 추가

@Transactional
public class MemberService {

    @Autowired
    public MemberService(MemberRepository memberRepository) {
        this.memberRepository = memberRepository;
    }

    /* 회원가입 */
    public Long join(Member member) {

        long start = System.currentTimeMillis();
        
        try {
            validateDuplicateMember(member); //중복 회원 검증
            memberRepository.save(member);
            return member.getId();
        }
        finally {
            long finish = System.currentTimeMillis();
            long timeMs = finish - start;
            System.out.println("join " + timeMs + "ms");
        }
    }

    /* 전체 회원 조회 */
    public List<Member> findMembers() {
        long start = System.currentTimeMillis();
        
        try {
            return memberRepository.findAll();
        } finally {
            long finish = System.currentTimeMillis();
            long timeMs = finish - start;
            System.out.println("findMembers " + timeMs + "ms");
        }
    }

}

 

문제

- 회원가입, 회원 조회에 시간을 측정하는 기능은 핵심 관심 사항이 아니다.

- 시간을 측정하는 로직은 공통 관심 사항이다.

- 시간을 측정하는 로직과 핵심 비즈니스의 로직이 섞여서 유지보수가 어렵다.

- 시간을 측정하는 로직을 별도의 공통 로직으로 만들기 매우 어렵다.

- 시간을 측정하는 로직을 변경할 때 모든 로직을 찾아가면서 변경해야 한다.

 

AOP 적용

AOP: Aspect Oriented Programming 관점 지향 프로그래밍

공통 관심 사항(cross-cutting concern) vs 핵심 관심 사항(core concern) 분리

시간 측정 로직을 한 군데 다 모으고, 원하는 곳에 적용한다. 이걸 가능하게 하는 기술이 AOP.

 

시간 측정 AOP 등록

package hello.hello_spring.aop;

import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.springframework.stereotype.Component;

@Component
@Aspect
public class TimeTraceAop {
    @Around("execution(* hello.hellospring..*(..))")
    public Object execute(ProceedingJoinPoint joinPoint) throws Throwable {
        long start = System.currentTimeMillis();
        System.out.println("START: " + joinPoint.toString());
        try {
            return joinPoint.proceed();
        }
        finally {
            long finish = System.currentTimeMillis();
            long timeMs = finish - start;
            System.out.println("END: " + joinPoint.toString()+ " " + timeMs +
                    "ms");
        }
    }
}

 

해결

- 회원가입, 회원 조회등 핵심 관심사항과 시간을 측정하는 공통 관심 사항을 분리한다.

- 시간을 측정하는 로직을 별도의 공통 로직으로 만들었다.

- 핵심 관심 사항을 깔끔하게 유지할 수 있다.

- 변경이 필요하면 이 로직만 변경하면 된다. 원하는 적용 대상을 선택할 수 있다.

 

스프링 AOP 동작 방식 설명

 

➡️ AOP 적용 전 의존관계

 

 

➡️ AOP 적용 후 의존관계

가짜 스프링 빈 🟨 을 앞에 세워두고, jointPoint.proceed() 하고나면(가짜 스프링 빈이 끝나면), 그 때 진짜를 호출한다.

memberController가 호출하는 건 진짜 memberService가 아니라 프록시라는 기술로 발생하는 가짜 memberService

 

 

 

➡️ AOP 적용 전 전체 그림

 

 

➡️ AOP 적용 후 전체 그림

컨테이너에서 스프링 빈을 관리하면, 가짜를 만들어서 Dependency Injection 해주면 된다. DI를 해주니까 AOP가 가능한 것.

 

Blank Quiz

1. 개발이나 테스트 용도로 사용하는 가볍고 편리한 데이터베이스는 _______________이다.

2.  _______________ 는 스프링 컨테이너와 DB까지 연결한 통합 테스트이다.

3. _______________ 어노테이션을 추가하면, 스프링 컨테이너와 테스트를 함께 실행할 수 있다.

4.  _______________ 는 Java 진영에서 ORM(Object-Relational Mapping) 기술 표준으로 사용하는 인터페이스 모음이다.

5.  _______________ 는 JPA를 사용하는 애플리케이션에서 트랜잭션을 관리하기 위해 사용되는 스프링의 어노테이션이다.

6. AOP는 애플리케이션의 _______________ 과 관련 없는 부가 기능들을 모듈화하여 코드의 중복을 줄이고 유지보수성을 높이기 위한 기술이다.

7. 시간 측정과 같은 기능은 비즈니스 로직과 무관한 _______________ 사항에 해당하며, 이러한 기능은 AOP를 통해 분리하여 관리할 수 있다.

 

 

Programming Quiz

1. application.properties에서 JPA가 생성하는 SQL을 확인하고, 엔티티 정보를 기반으로 데이터베이스에 테이블을 자동으로 생성하도록 설정을 변경하려면 어떤 설정이 필요할까요?

2. 아래 코드에서 id 필드와 name 필드를 완성하세요.

• id 필드는 고유 식별자로, 자동 증가하도록 설정해야 합니다.
• name 필드는 데이터베이스의 username 컬럼과 매핑되도록 설정하세요.

@Entity
public class Member {
    // id 필드 매핑, 고유 식별자로 자동 증가
    
    // name 필드, 데이터베이스의 username 컬럼과 매핑되도록
    
    // getters, setters
}

 

---

퀴즈 답안

Blank Quiz

 

 H2 데이터베이스, 스프링 통합 테스트, @SpringBootTest, JPA, @Transactional, 핵심 비즈니스 로직, 공통 관심

Programming Quiz

1.

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

 

show-sql=true는 JPA가 생성하는 SQL을 출력하고, ddl-auto=create는 엔티티를 기반으로 테이블을 자동으로 생성합니다.

 

2.

@Entity
public class Member {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id; // 고유 식별자로 자동 증가

    @Column(name = "username")
    private String name; // 데이터베이스의 username 컬럼과 매핑

    // getters, setters
}

 

@Id와 @GeneratedValue의 역할

• @Id: 이 애너테이션은 해당 필드가 엔티티의 주 식별자(고유 식별자)라는 것을 명시합니다. 여기서는 id가 Member 객체를 고유하게 식별하는 필드가 되는 것입니다.
• @GeneratedValue(strategy = GenerationType.IDENTITY): 이 어노테이션은 id 값이 자동으로 생성되도록 지정합니다. GenerationType.IDENTITY데이터베이스의 Auto Increment 기능을 활용하여 자동 증가하도록 합니다. 예를 들어, 새로운 Member가 추가될 때 데이터베이스가 자동으로 id에 다음 값을 할당하게 됩니다.

컬럼명을 따로 지정하지 않으면, JPA는 기본적으로 필드명과 동일한 이름으로 컬럼을 매핑합니다. 하지만 name 필드를 username 컬럼과 매핑하기 위해 @Column(name = "username")을 명시적으로 추가한 것입니다.

---

[출처] 스프링 입문 - 코드로 배우는 스프링 부트, 웹 MVC, DB 접근 기술

(섹션 7 - 8  스프링 DB 접근 기술 - AOP)

 

Corner Spring 3

ⓒ Nini