Spring ORM (Hibernate) 설명 과 사용법

build.gradle 설정

gradle 설정 설정은 다음과 같다.

1. buildscript : buildscript에는 SpringBoot Version 정보, Maven Repository 정보, Dependency 모듈을 지정하여 스프링 부트 플러그인을 사용할 수 있는 기본 바탕을 정의합니다.

2. apply : 플러그인을 적용합니다.

• apply plugin: 'java' → java용 웹 프로젝트를 생성합니다. sourceCompatibility = '1.8' 호환 버전을 지정하여 java 웹 프로젝트에서 사용할 java를 명시합니다.

• apply plugin: 'io.spring.dependency-management' → Spring IO Platform의 Gradle Plugin인 dependency-management를 사용합니다. 스프링 부트 1.x에서는 디폴트로 사용되었지만 2.x에서는 명시적으로 선언해 주어야 합니다.

1. dependencies : 프로젝트에서 사용할 디펜던시 모듈을 정의합니다.

• compile → 먼저 compile 시점에 필요한 디펜던시 라이브러리들을 compile로 정의합니다.

• runtime → 런타임 시에 참조할 라이브러리를 정의합니다. 기본적으로 compile 라이브러리를 포함합니다.

• compileOnly → 컴파일 시점에만 사용하고 런타임에는 필요 없는 라이브러리를 정의합니다.

• testCompile → 프로젝트의 테스트를 위한 디펜던시 라이브러리를 정의합니다. 기본적으로 Compile 된 클래스와 compile 라이브러리를 포함합니다.

수정이 완료되면 다음과 같이 gradle → Refresh Gradle Project를 선택하여 라이브러리를 업데이트합니다.

 

jpa(Hibernate, queryDSL, Spring Data JPA)

Hibernate 이란

Hibernate는 JPA의 구현체이다. ... 그럼 여기서 또 JPA는 무엇인가라는 의문이 생긴다. JPA는 Java Persistence API의 약자로, 자바 애플리케이션에서 관계형 데이터베이스를 사용하는 방식을 정의한 인터페이스이다. 라고 해당 블로그에서 설명하고있다.(https://suhwan.dev/2019/02/24/jpa-vs-hibernate-vs-spring-data-jpa) 내가 설명하는 것도 좋지만 좀 더 잘 설명된 내용이 있어 참조한다. 해당 설명을 읽고 Hibernate는, JPA의 계념을 잡을 수 있었다.

Hibernate Gradle 설정

build.gradle

해당 모듈을 build.gradle 정의한다.

dependencies { 
// Hibernate 
compile("org.springframework.boot:spring-boot-starter-data-jpa")
compile("mysql:mysql-connector-java") 
}

 

해당 설정을 application.yml 정의한다.

spring:
  profiles:
    active: local
---
spring:
  profiles: local
  datasource:
    url: jdbc:mysql://<host>:<port>/<dbname>
    username: <username>
    password: <password>
  jpa:
    hibernate:
      ddl-auto: update # 운영시에는 validate 추천
    show-sql: true

 

• spring.jpa.hibernate.ddl-auto: sessionFactory가 올라갈 때, DBMS의 스키마를 자동으로 수정하거나 검증하는 설정 값. (none/create/create-drop/update/validate)
• show-sql: console에 JPA 실행 SQL Log 유무. true/false

용어 정리

@Entity : DB 테이블에 대응하는 하나의 클래스를 정의

• name : Entity들 간의 충돌이 될 때나 이름을 설정해준다. 설정을 안 하면 default는 Class명으로 설정된다.

(기본 생성자 필수, final, enum, interface, inner 클래스 사용 못함, 저장 필드에 final 사용 못함)

@Table : Entity와 매핑할 DB Table을 지정한다.

• name : 매핑할 table 이름, 기본은 Entity 이름을 사용한다.
• catalog : catalog 기능이 있는 DB에서 catalog를 매핑
• schema : schema 기능이 있는 DB에서 schema를 매핑
• uniqueConstraints : DDL 생성 시에 유니크 제약조건을 만든다.

Spring Data JPA

jpa를 편하게 쓰기 위해서 만들어진 기능이다. JpaRepository<Entity, ID TPYPE> extends 하여 interface를 정의하면 save, findAll, finOne .... 등의 함수를 편하게 쓸 수 있다. 상세한 내용은 여기서 확인 할 수 있다.

public interface UserRepository extends JpaRepository<User, Long>  {
}

And	findByLastnameAndFirstname	… where x.lastname = ?1 and x.firstname = ?2
Or	findByLastnameOrFirstname	… where x.lastname = ?1 or x.firstname = ?2
Is,Equals	findByFirstname,findByFirstnameIs,findByFirstnameEquals	… where x.firstname = ?1
Between	findByStartDateBetween	… where x.startDate between ?1 and ?2
LessThan	findByAgeLessThan	… where x.age < ?1
LessThanEqual	findByAgeLessThanEqual	… where x.age ⇐ ?1
GreaterThan	findByAgeGreaterThan	… where x.age > ?1
GreaterThanEqual	findByAgeGreaterThanEqual	… where x.age >= ?1
After	findByStartDateAfter	… where x.startDate > ?1
Before	findByStartDateBefore	… where x.startDate < ?1
IsNull	findByAgeIsNull	… where x.age is null
IsNotNull,NotNull	findByAge(Is)NotNull	… where x.age not null
Like	findByFirstnameLike	… where x.firstname like ?1
NotLike	findByFirstnameNotLike	… where x.firstname not like ?1
StartingWith	findByFirstnameStartingWith	… where x.firstname like ?1 (parameter bound with appended %)
EndingWith	findByFirstnameEndingWith	… where x.firstname like ?1 (parameter bound with prepended %)
Containing	findByFirstnameContaining	… where x.firstname like ?1 (parameter bound wrapped in %)
OrderBy	findByAgeOrderByLastnameDesc	… where x.age = ?1 order by x.lastname desc
Not	findByLastnameNot	… where x.lastname <> ?1
In	findByAgeIn(Collection ages)	… where x.age in ?1
NotIn	findByAgeNotIn(Collection age)	… where x.age not in ?1
True	findByActiveTrue()	… where x.active = true
False	findByActiveFalse()	… where x.active = false
IgnoreCase	findByFirstnameIgnoreCase	… where UPPER(x.firstame) = UPPER(?1)

queryDSL

Document 를 참고하였습니다.

1. 문자가 아닌 코드로 작성하자
2. 컴파일 시점에 문법 오류를 발견하자.
3. 코드 자동완성(IDE 도움)
4. 동적 쿼리

1번

"select * from table" 로하던 문자 query를 query.selectFrom(m).where(m.age.gt(18)) 처럼 코드로 작성할 수 있다.

2번

query가 문자로 되어있으면 오타 ("selectt * from table") 되어이으면 컴파일 시점에서는 알 수가 없다. 서버가 실행되고 해당 query를 요청하는 api가 요청이 있기전까지는 하지만 queryDSL을 이용하면 코드 형식이기때문에 오류를 알 수 있게된다.

3번

query에 쓰는 형식의 코드들 (where, join, orderBy 등)이 이미 정의 되어있기때문에 쉽게 코드를 작성가능하다.

4번

문자 형식이 아닌 코드 형식이기 때문에 조건에 맞게 동적으로(유동적으로) 쿼리를 만들 수 있다.