[스프링 부트와 JPA 활용 1] 1. 프로젝트 환경 설정
2024. 1. 23. 12:12
728x90
SMALL
📌 JPA란?
JPA(Java Persistence API)
- JAVA 애플리케이션에서 객체와 관계형 데이터베이스 간의 데이터를 관리하고 조작하기 위한 자바 표준 스펙
- 객체 지향 프로그래밍과 데이터 베이스 간의 매핑을 통해 데이터베이스 작업을 간소화하고 생산성을 높이는 데 도움을 주는 기술
⚡ Entity
- 데이터베이스 테이블과 매핑되는 자바 클래스
@Entity애노테이션으로 표시하며, JPA는 해당 클래스를 데이터베이스 테이블과 연관시킴
⚡ 기본 키(Primary Key)
- Entity 클래스의 필드 중 하나를 기본 키로 지정하여 각 레코드를 고유하게 식별
@Id애노테이션을 사용하여 Entity 클래스의 기본 키 필드를 정의
⚡ 영속성 컨텍스트 (Persistence Context)
- Entity 인스턴스를 관리하는 환경
- JPA는 Entity를 영속성 컨텍스트에서 관리하여 Entity의 상태 변화를 추적하고 데이터 베이스를 동기화함
⚡ Relationship(연관관계)
- Entity간의 관계 표현
- 일대일, 일대다, 다대다 등 다양한 연관 관계를 정의하고 매핑
⚡ JPQL(Java Persistence Query Language)
- SQL과 유사한 질의 언어
- Entity 객체에 대한 쿼리 작성 가능
- 데이터베이스 독립적인 쿼리를 지원
- 영속성 컨텍스트를 통해 Entity 객체 조직
⚡ 데이터베이스 스키마 생성
- JPA는
persistence.xml파일이나 Java 설정을 통해 데이터베이스 테이블을 자동으로 생성할 수 있음 - 객체 모델과 데이터베이스 스키마를 동기화할 수 있음
⚡ JPA 구현체
- JPA 스펙을 구현한 여러 프레임워크가 있음
- 대표적인 것으로
Hibernate- JPA 스펙을 따르면서 추가적인 기능과 성능 제공
📌 프로젝트 생성
✔ 스프링 부트 스타터(https://start.spring.io/)
- Project :
Gradle-Groovy - Language :
JAVA - Spring Boot :
3.1.2 - Project Metadata
- groupId: jpabook
- artifactId: jpashop
- Dependencies
web,thymeleaf,jpa,h2,lombok,validation
✔ lombok 설치
- plugin에서 lombok 설치 -> annotation processors -> enable annotation processing 체크
- 임의의 테스트 클래스 만들고 @Getter, @Setter 확인
📌 라이브러리 살펴보기
⚡ grdle 의존관계 보기
./gradlew dependencies —configuration compileClasspath
⚡ 스프링 부트 라이브러리
- spring-boot-start-web
- spring-boot-starter-tomcat : 톰캣(웹서버)
- spring-webmvc : 스프링 웹 MVC
- spring-boot-starter-thymeleaf : 타임리프 템플릿 엔진(View)
- spring-boot-starter-data-jpa
- spring-boot-starter-aop
- spring-boot-starter-jdbc
- HikariCP 커넥션 풀(부트 2.0 기본)
- hibernate + JPA : 하이버네이트 + JPA
- spring-data-jpa : 스프링 데이터 JPA
- spring-boot-starter(공통) : 스프링 부트 + 스프링 코어 + 로깅
- spring-boot
- spring-core
- spring-boot-starter-logging
- logback, slf4j
- spring-boot
⚡ 테스트 라이브러리
- spring-boot-starter-test
- junit : 테스트 프레임워크
- mockito : 목 라이브러리
- assertj : 테스트 코드를 좀 더 편하게 작성하게 도와주는 라이브러리
- spring-test : 스프링 통합 테스트 지원
- 핵심 라이브러리
- 스프링 MVC
- 스프링 ORM
- JPA, 하이버네이트
- 스프링 데이터, JPA
- 기타 라이브러리
- H2 데이터베이스 클라이언트
- 커넥션 풀 : 부트 기본은 HikariCP
- WEB(thymeleaf)
- 로깅 SLF4J & LogBack
- 테스트
cf) 스프링 데이터 JPA는 스프링과 JPA를 먼저 이해하고 사용해야 하는 응용기술
📌 View 환경 설정
⚡ thymeleaf 템플릿 엔진
✔ 스프링 부트 thymeleaf viewName 매핑
resources:templates/+{ViewName}+.html
✔ jpabook.jpashop.HelloController
🔶 main/java/jpabook.jpashop/HelloController
package jpabook.jpashop;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;
@Controller
public class HelloController {
@GetMapping("hello")
public String hello(Model model){
model.addAttribute("data", "hello!!!");
return "hello";
}
}
✔ @GetMapping("hello")
- hello라는 url로 오면 이 컨트롤러 호출
✔ Model : Controller에서 데이터를 실어서 View에 넘김
- model.addAttribute("data", "hello");
- key : data, value : hello
addAttribute: 스프링 MVC에서 컨트롤러에서 뷰로 데이터를 전달할 때 사용되는 메서드- 모델에 데이터를 추가하는데 사용
- 컨트롤러의 뷰 템플릿에서
${key}와 같은 방식으로 접근 가능
✔ 반환값 "hello"
hello.html
✔ thymeleaf 템플릿엔진 동작 확인(hello.html)
🔶 main/resources/templates/hello.html
<!DOCTYPE HTML>
<html xmlns:th="http://www.thymeleaf.org">
<head>
<title>Hello</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
</head>
<body>
<p th:text="'안녕하세요. ' + ${data}" >안녕하세요. 손님</p>
</body>
</html>
index.html (정적 페이지)
🔶 main/resources/static/index.html (렌더링 안하고 순수한 html 파일)
<!DOCTYPE HTML>
<html xmlns:th="http://www.thymeleaf.org">
<head>
<title>Hello</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
</head>
<body>
Hello
<a href="/hello">hello</a>
</body>
</html>
cf) spring-boot-devtools라이브러리를 추가하면, html 파일을 컴파일만 해주면 서버 재시작 없이 View 파일 변경이 가능
➡ 메뉴 build->Recompile
📌 H2 데이터베이스 설치
✔ 개발이나 테스트 용도로 가볍고 편리한 DB, 웹 화면 제공
- 다운로드 및 설치
- 데이터베이스 파일 생성 방법
- 터미널에서 h2->bin->
./h2.sh(IOS)기준 - key 값 앞부분을
localhost:8082로 변경 (key값은 유지!!) jdbc:h2:~/jpashop(최소 한 번)~/jpashop.mv.db파일 생성 확인- 터미널에서 ls -arlth ->
jpashop.mv.db확인
- 터미널에서 ls -arlth ->
- 이후부터는
jdbc:h2:tcp://localhost/~/jpashop로 접속 (네트워크 모드)
- 터미널에서 h2->bin->
✔ ./h2.sh을 항상 실행해놓고 해야 함
반응형
📌 JPA와 DB 설정, 동작확인
🔶 main/resources/application.yml
spring:
datasource:
url: jdbc:h2:tcp://localhost/~/jpashop;MVCC=TRUE
username: sa
password:
driver-class-name: org.h2.Driver
jpa:
hibernate:
ddl-auto: create
properties:
hibernate:
#show_sql: true
format_sql: true
logging:
level:
org.hibernate.SQL: debug
# org.hibernate.type: trace #스프링 부트 2.x, hibernate5
# org.hibernate.orm.jdbc.bind: trace #스프링 부트 3.x, hibernate6✔ spring.jpa.hibernate.ddl-auto: create
- 애플리케이션 실행 시점에 테이블을
drop하고 다시 실행
cf) 모든 로그 출력은 가급적 로거를 통해 남겨야 함
show_sql: 옵션은System.out에 하이버네이트 실행 SQL을 남김org.hibernate.SQL: 옵션은 logger를 통해 하이버네이트 실행 SQL을 남김
❗ 주의
application.yml같은yml파일은 띄어쓰기(스페이스) 2칸으로 계층을 만듦- 띄어쓰기 2칸 필수
- ex) 아래의
datasource는spring:하위에 있고 앞에 띄어쓰기 2칸이 있으므로spring.datasource가 됨
⚡ 실제 동작하는지 확인
회원 엔티티
🔶 main/java/jpabook/jpashop/Member
package jpabook.jpashop;
import jakarta.persistence.Entity;
import jakarta.persistence.GeneratedValue;
import jakarta.persistence.Id;
import lombok.Getter;
import lombok.Setter;
@Entity
@Getter @Setter
public class Member {
@Id
@GeneratedValue
private Long id;
private String username;
}
✔ @Entity
- 클래스를 Entity(테이블과 매핑되는 클래스)로 지정
- 클래스가 데이터베이스 테이블과 연관되는 엔터티
✔ @Getter, @Setter
Lombok라이브러리에서 제공- 클래스의 필드에 대한
Getter,Setter메서드 자동 생성 - 보일러플레이트 코드를 줄여주고 코드 가독성을 높여줌
✔ @Id
- 엔터티 클래스의 기본 키(primary key)필드를 지정할 때 사용
- 기본키 : 각 레코드를 고유하게 식별하는데 사용
✔ @GeneratedValue
- 기본 키 값이 자동으로 생성되도록 지정할 때 사용
- 주로 ID값이 자동으로 증가하거나 생성되어야 하는 경우에 활용
회원 리포지토리
🔶 main/.../jpashop/MemberRepository
package jpabook.jpashop;
import jakarta.persistence.EntityManager;
import jakarta.persistence.PersistenceContext;
import org.springframework.stereotype.Repository;
@Repository
public class MemberRepository {
@PersistenceContext
private EntityManager em;
public Long save(Member member){
em.persist(member);
return member.getId();
}
public Member find(Long id){
return em.find(Member.class, id);
}
}
✔ @Repository
- Spring Framework에서 제공하는 애노테이션
- 해당 클레스가 데이터 액세스를 위한 Repository로 사용되는 것을 표시
- 스프링 컨테이너에 해당 클래스를 빈으로 등록하며, 데이터 액세스 관련 예외를 Spring의 일반적인 예외로 변환하여 처리
✔ @PersistenceContext
- JPA에서 제공하는 애노테이션
EntityManager을 주입받는 데 사용- 주입된
EntityManager는 데이터베이스 연동을 처리하고 엔티티의 영속성 컨텍스트를 관리하는데 사용
✔EntityManager
- JPA에서 엔티티 메니저를 나타내는 인터페이스
- JPA를 통해 엔티티의 저장, 수정, 조회, 삭제 등 데이터베이스와의 상호작용 수행
✔ persist();
- 새로운 엔티티를 데이터베이스에 저장할 때 사용하는 메서드
- 엔티티를 영속성 컨텍스트에 등록하고, 트랜잭션이 커밋될 때 해당 엔티티를 데이터 베이스에 삽입
✔ find();
- 주어진 엔티티 클래스와 식별자(id)를 기반으로 데이터베이스에서 엔티티를 조회하는 메서드
- 엔티티를 데이터베이스에서 가져와서 영속성 컨텍스트에 관리하게 만듦
- 두 개의 매개변수 필요
- entityClass : 조회하려는 엔티티의 클래스 타입 전달
- primaryKey : 엔티티를 조회할 때 사용하는 기본키
테스트
🔶 test/.../jpashop/MemberRepositoryTest
package jpabook.jpashop;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit.jupiter.SpringExtension;
import org.springframework.transaction.annotation.Transactional;
import static org.junit.jupiter.api.Assertions.*;
@ExtendWith(SpringExtension.class)
@SpringBootTest
class MemberRepositoryTest {
@Autowired MemberRepository memberRepository;
@Test
@Transactional
@Rollback(false)
public void testMember() throws Exception{
//given
Member member = new Member();
member.setUsername("memberA");
//when
Long saveId = memberRepository.save(member);
Member findMember = memberRepository.find(saveId);
//then
Assertions.assertThat(findMember.getId()).isEqualTo(member.getId());
Assertions.assertThat(findMember.getUsername()).isEqualTo(member.getUsername());
Assertions.assertThat(findMember).isEqualTo(member);
}
}✔ @ExtendWith(SpringExtension.class)
- 강의에서는 Junit4를 사용해
@RunWith(SpringRunner.class)이 쓰임 - Junit5에서는
@ExtendWith(SpringExtension.class)사용 - 스프링 테스트 컨텍스트를 확장시키는 애노테이션
- 테스트 컨텍스트를 관리하고 Spring Bean을 주입받을 수 있도록 도와줌
✔ @SpringBootTest
- 스프링 부트 기반의 테스트 클래스에서 사용하는 애노테이션
- 통합 테스트용으로 스프링 애플리케이션 컨텍스트를 설정하고 초기화
- 내부적으로
@ContextConfiguration을 포함 - 주로 클래스 레벨에 선언
- 테스트 시에 실제 애플리케이션과 유사한 환경을 만들어서 테스트를 수행할 수 있도록 해줌
✔ @Autowired
- 스프링 프레임워크에서 사용되는 애노테이션
- 의존성 주입을 위해 필드, 생성자, 메서드에 사용됨
- 테스트 클래스 내에서 스프링 빈을 주입받을 때 사용
✔ @Test
Junit프레임워크에서 사용되는 애노테이션- 테스트 메서드를 선언할 때 사용
- 해당 메서드를 테스트로 실행하도록 지정
✔ throws Exception{}
- 일부 테스트 프레임워크에서 예외 처리에 대한 명시적인 요구사항이 있기 때문
✔ @Transaction
- Srping Framework에서 제공하는 애노테이션
- 메서드 레벨 또는 클래스 레벨에서 사용하여 트랜잭션 관리를 지원하는 기능을 추가할 수 있음
- Spring은 메서드의 실행을 트랜잭션 내에서 수행하며, 메서드 실행이 성공하면 커밋하고 실패하면 롤백
- 클래스 레벨에서도 사용 가능하고 메서드 레벨에서도 사용 가능
- 이 애노테이션이 테스트에 있으면 테스트가 끝나고
rollback해버림- rollback 하고싶지 않으면
@Rollback(false)
- rollback 하고싶지 않으면
- 옵션
readOnly: 읽기 전용 트랜잭션 여부- 읽기만 하는 경우 :
readOnly = true
- 읽기만 하는 경우 :
propagation: 메서드 호출 시 이미 진행중인 트랜잭션이 있는 경우 어떻게 처리할 지 결정- ex) REQUIRED. REQUIREDS_NEW 등
isolation: 트랜잭션 격리 레벨을 설정- ex) DEFAULT, READ_COMMITTED, SERIALIZABLE 등
rollbackFor,noRollbackFor: 롤백이 수행될 예외 클래스 지정 가능timeout: 트랜잭션 제한 시간을 설정
➡ Entity, Repository 동작 확인
➡ jar 빌드해서 동작 확인
cf) 스프링 부트를 통해 복잡한 설정이 다 자동화됨persistence.xml도 없고,LocalContainerEntityManagerFactoryBean도 없음
쿼리 파라미터 로그 남기기
- 로그에 다음을 추가하기 org.hibernate.orm.jdbc.bind: trace : SQL 실행 파라미터를 로그로 남김
- 외부 라이브러리 사용
- 스프링 부트를 사용하려면 이 라이브러리 추가 (스프링 부트 3.0 이상은 라이브러리 버전 1.9.0 이상 사용)
implementation 'com.github.gavlyukovskiy:p6spy-spring-boot-starter:1.9.0'
cf) 쿼리 파라미터를 로그로 남기는 외부라이브러리는 시스템 자원을 사용하므로, 개발 단계에서는 편하게 사용해도 됨
➡ but, 운영 시스템에 적용하려면 꼭 성능 테스트 하고 사용
<실전! 스프링 부트와 JPA 활용1 - 웹 애플리케이션 개발_김영한>을 수강하고 작성한 글입니다
NEXT
[스프링 부트와 JPA 활용1] 2. 도메인 분석 설계
📌 요구사항 분석 📌 기능 목록 회원 기능 회원 등록 회원 조회 상품 기능 상품 등록 상품 수정 상품 조회 주문 기능 상품 주문 주문 내역 조회 주문 취소 기타 요구사항 상품은 재고 관리가 필
nyeroni.tistory.com
728x90
LIST
'인프런 Spring 강의 정리 > 실전! 스프링 부트와 JPA 활용1 - 웹 애플리케이션 개발' 카테고리의 다른 글
| [스프링 부트와 JPA 활용 1] 6. 웹 계층 개발 (1) | 2024.01.24 |
|---|---|
| [스프링 부트와 JPA 활용 1] 5. 주문 도메인 개발 (0) | 2024.01.24 |
| [스프링 부트와 JPA 활용 1] 4. 상품 도메인 개발 (0) | 2024.01.23 |
| [스프링 부트와 JPA 활용 1] 3. 애플리케이션 구현 준비, 회원 도메인 개발 (0) | 2024.01.23 |
| [스프링 부트와 JPA 활용1] 2. 도메인 분석 설계 (2) | 2024.01.23 |
