[Spring] DB 접근 기술 2 🌱

1. JDBC Template

• 순수 JDBC와 동일한 환경설정을 하면 된다.
• 스프링 JDBC Template과 MyBatis 같은 라이브러리는 JDBC API에서 본 반복 코드를 대부분 제거해준다.
  하지만 SQL은 직접 작성해야 한다.

 

JDBC Template이란??
기존의 Jdbc는 DB 연동에 필요한 Connection 객체, 쿼리 실행을 위한 PreparedStatement 객체를 생성하고 쿼리 실행 후에는 finally 블록에서 ResultSet , PreparedStatement , Connection 타입 객체들을 close() 메서드로 닫는 구조적인 반복이 존재했다.이런 구조적인 반복을 줄이기 위해서 템플릿 메서드 패턴과 전략 패턴을 함께 사용하는 API가 Jdbc Template이다.

 

스프링 JDBC Template

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

JDBC Template을 사용하도록 스프링 설정 변경

@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 JdbcMemberRepository(dataSource);
		return new JdbcTemplateMemberRepository(dataSource);
	}
}

---

2. JPA

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

JPA란??

• Java 진영에서 ORM 기술 표준으로 사용하는 인터페이스 모음
• 자바 애플리케이션에서 관계형 데이터베이스를 사용하는 방식을 정의한 인터페이스
• 인터페이스임으로 Hibernate, OpenJPA 등이 JPA를 구현함

 

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

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

spring-boot-starter-data-jpa는 내부에 JDBC 관련 라이브러리를 포함한다.

따라서 JDBC는 제거해도 된다. 

 

스프링 부트에 JPA 설정 추가

resources/application.properties

// 스프링부트 2.4부터는 "spring.datasource.username=sa"를 꼭 추가해주어야 한다.

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 엔티티 매핑

@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 회원 리포지토리

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 List<Member> findAll() {
		return em.createQuery("select m from Member m", Member.class)
							.getResultList();
	}

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

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

import org.springframework.transaction.annotation.Transactional

@Transactional
public class MemberService { ... }

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

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 MemoryMemberRepository();
		// return new JdbcMemberRepository(dataSource);
		// return new JdbcTemplateMemberRepository(dataSource);
		return new JpaMemberRepository(em);
	}
}

---

3. 스프링 데이터 JPA

 

• 스프링 데이터 JPA를 사용하면 기존의 방식을 넘어서서 인터페이스만으로 개발을 완료할 수 있게 해줍니다.
• 실무에서는 JPA와 스프링 데이터 JPA를 기본으로 사용하고, 복잡한 동적 쿼리는 Querydsl 라이브러리를 사용해 개발합니다.

스프링 데이터 JPA란?

• 스프링 프레임워크에서 JPA를 편리하게 사용할 수 있도록 지원하는 프로젝트
• CRUD 처리를 위한 공통 인터페이스 제공
• 리포지토리 개발 시 인터페이스만 작성하면 실행 시점에 스프링 데이터 JPA가 구현 객체를 동적으로 생성해서 주입해준다.

 

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

public interface SpringDataJpaMemberRepository extends JpaRepository<Member, Long>, MemberRepository {
	Optional<Member> findByName(String name);
}

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

@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
• findByName(), findByEmail() 처럼 메서드 이름 만으로 조회 기능 제공
• 페이징 기능 자동 제공

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

---

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