정의

• Java Persistence API ::= Java ORM(Object-Relational Mapping)을 위한 명세

객체지향 설계와 RDB의 설계를 둘 다 해치지 않으면서 둘 사이의 매핑을 지원 ─ 즉, 필요한 SQL을 자동으로 구성

• SQL과 유사한, 객체를 이용한 JPQL(Java Persistence Query Language) 지원
• 객체 상속 관계 사용 가능
• 객체 참조 관계 유지 가능

JPA 사용

Hibernate와 같은 JPA 구현체(JPA Provider)를 이용하거나, 직접 구현하여 이용하면 된다

Spring Data JPA

JPA에 대한 추상화된 모듈을 제공하여 보다 쉬운 사용을 가능하게 한다

예시 코드

EntityManager

@Entity

• DB 입출력 단위
• 기본 생성자 필수. @Id 최소 한 개 지정 필수
• 원활한 프록시 동작을 위해 protected 이상, non-final 클래스로 정의

↓ @Entity 예

@Table

• @Entity 클래스에 name, catalog, index, schema, UniqueConstraint 설정 추가
• name 속성만 필요하다면 @Entity에 직접 설정 가능

@Id

기본키 컬럼 명시. 기본 타입 + Wrapper 타입, Date, BigInteger, BigDecimal 타입만(should) 가능

@GeneratedValue, @SequenceGenerator, @TableGenerator

↓ 기본키 자동 설정

@Id @GeneratedValue(strategy = GenerationType.IDENTITY) private Long userId;
• strategy = GenerationType.IDENTITY

DB 설정(MySQL auto_increment, PostgreSQL serial) 그대로 이용. insert 실행 후 실제 값이 설정된다

• generator = "gen_name" : 시퀀스 또는 ID 생성 테이블 이용

↓ 1. 시퀀스

@Id @SequenceGenerator(name = "gen_name", sequenceName = "jpa_user2_user_id_seq", allocationSize = 1) @GeneratedValue(generator = "gen_name") private Long userId;

↓ 2. 테이블

@Id @TableGenerator( name = "gen_name", table = "jpa_id", // 테이블 이름 pkColumnName = "id_name", // 테이블 기본키 pkColumnValue = "jpa_user2_user_id", // 기준 행을 찾기 위한 기본키 값 valueColumnName = "next_id", // id로 사용할 컬럼 이름 initialValue = 0, // 테이블에 행이 없는 경우 초기값으로 이용 allocationSize = 1 ) @GeneratedValue(generator = "gen_name") private Long userId;

@Temporal

date, time, timestamp 컬럼 명시. 각각 java.sql.Date, java.sql.Time, java.sql.Timestamp에 매핑

@Column

필드 또는 getter 메서드에 대해 컬럼 명시
• name : 컬럼 이름
• unique : 이 컬럼만으로 unique key인 경우
• length : 텍스트 길이
• precision, scale : decimal 정밀도
• insertable : insert 포함 여부
• updatable : update 포함 여부

↓ java

@Temporal(TemporalType.TIMESTAMP) @Column(insertable = false, updatable = false) // ↑ false면 쿼리 실행 후 컬럼 값이 변경되도 객체에 반영되지 않음 private Date addDate;

@Transient 또는 transient 한정자

해당 필드는 persistence 대상에서 제외

@Enumerated

enum 매핑 : EnumType.ORDINAL, STRING 2가지만 가능

@Convert, @Converter

커스텀 컨버터 지정 ApiLog.javaApiResultCode.java

@DynamicInsert, @DynamicUpdate

• Non-null 컬럼만 insert, update 시 이용
• 세션 당 최초 1번만 적용된다
• 쿼리 실행 후 생략된 컬럼 값이 변경되더라도, 객체에 설정되지 않는다
UserDaoTests.javaUser1.java

다른 엔티티/값 포함

클래스 상속과 테이블 매핑

트랜잭션

하이버네이트 관련 추가 기록

• 지연 로딩된 프록시 인스턴스의 실제 클래스 반환

↓ java

HibernateProxyHelper.getClassWithoutInitializingProxy(proxy)
• 쿼리 생성 설정

DBMS 버전에 맞춰 설정 필요

↓ ini

spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.PostgreSQL10Dialect
• 로깅 관련 설정

↓ application.properties

spring.jpa.properties.hibernate.show_sql=true # 실행 sql 출력 spring.jpa.properties.hibernate.format_sql=true # sql 보기 좋게 출력 spring.jpa.properties.hibernate.use_sql_comments=true # sql 주석 출력 logging.level.org.hibernate.type.descriptor.sql=trace # 컬럼 값 출력
• @Subselect

쿼리 결과를 엔티티로 사용할 수 있게 해준다

↓ java

@Entity @Immutable // 읽기 전용 @Subselect("select ...") @Synchronize({"Entity1", "Entity2"}) // Subselect 실행 전에 Entity1, Entity2 타입 엔티티 중 변경이 있는 것은 DB에 반영 public class ClassName {}

JPQL; JPA Query Language

• SQL과 유사한 쿼리 언어로, 테이블-컬럼 대신 엔티티-속성 이름을 이용한다

↓ sql

SELECT ... FROM ... [WHERE ...] [GROUP BY ... [HAVING ...]] [ORDER BY ...]
• 엔티티 이름 ::= @Entity 적용한 클래스 이름. name 속성을 이용한 경우 해당 값

↓ java

query = entityManager.createQuery(query[, ResultType.class]); result = query.getResultList(); result = query.getSingleResult(); // 결과가 1개임이 보장되는 경우
• 일반적인 SQL 문도 사용할 수 있다

↓ java

query = entityManager.createNativeQuery("insert into t_user_12 (id, name) values (?, ?)"); query.setParameter(1, 123).setParameter(2, "name"); query.executeUpdate();
• JPQL은 항상 실행되며, 결과 엔티티가 이미 컨텍스트에 존재하면 버려진다
• update, delete는 기존 영속 컨텍스트에 반영 안 됨

↓ java

query = entityManager.createQuery("update User set level = level + 1"); query.executeUpdate();

Criteria

• 문자열 대신 Java API로 쿼리 동적 생성

↓ java

var builder = entityManager.getCriteriaBuilder(); var cQuery = builder.createQuery([ResultType.class]) var root = cQuery.from(RootType.class); cQuery.select(root); var query = entityManager.createQuery(cQuery);
• Single selection

↓ java

// select distinct name from Card cQuery.select(root.get("name")).distinct(true)
• Multi selection

↓ java

// select name, some.extra from Card // return type == Object[] cQuery.select(builder.array(root.get("name"), root.get("some").get("extra"))) cQuery.multiselect(root.get("name"), root.get("some").get("extra")) // return type == Tuple cQuery.select(builder.tuple(root.get("name"), root.get("some").get("extra"))) // return type == ResultType cQuery.select(builder.construct(ResultType.class, root.get("name"), root.get("some").get("extra")))
• Join

↓ java

// select g, o from Gacha g left join g.odds o var g = cQuery.from(Gacha.class); var o = g.join("odds", JoinType.LEFT); // join fetch를 원한다면 g.fetch(...) cQuery.multiselect(g, o);
• Where

↓ java

// select c from Card where id > :x var c = cQuery.from(Card.class); cQuery.where(builder.gt(c.get("id"), x));
• Group by

↓ java

var c = cQuery.from(Country.class); cQuery.multiselect(c.get("currency"), builder.sum(c.get("population"))); cQuery.where(builder.isMember("Europe", c.get("continents"))); cQuery.groupBy(c.get("currency")); g.having(builder.gt(builder.count(c), 1)); // builder::count, max, min, avg, asum, sumAsLong, sumAsDouble
• Order by

↓ java

var c = cQuery.from(Country.class); cQuery.orderBy(builder.asc(c.get("currency")), builder.desc(c.get("population")))
• Literal

↓ java

builder.literal(...);
• Type

↓ java

builder.equal(expression.type(), builder.literal(TargetType.class));
• Expressions

↓ java

builder::and, or, not, isTrue builder::gt, greaterThan, lt, lessThan, equal, between, isNull builder::sum, diff, prod, quot(/), mod, abs, neg, sqrt builder::like, notLike, length, locate, lower, upper, trim, concat, substring builder::isEmpty, isMember, in, size builder::currentDate, currentTime, currentTimestamp

JpaRepository<Entity, ID>

• 이 인터페이스를 상속하면 findAll, findById, save, delete, flush 등의 메서드를 자동으로 구성한다

JpaRepository -> PagingAndSortingRepository -> CrudRepository

• 명명규칙에 맞는 새 메서드들을 자동으로 구현한다

출처 : jpa.query-methods.query-creation

Keyword	Sample	JPQL snippet
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, Null	findByAge(Is)Null	… 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<Age> ages)	… where x.age in ?1
NotIn	findByAgeNotIn(Collection<Age> ages)	… 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)

JPQL

↓ java

페이징

• Pageable

↓ java

@Query("...") public Page<ReturnType> methodName(..., Pageable pageable);
• findFirst, findTop, findFirstN, findTopN 명명규칙 이용

↓ java

public List<Card> findFirst10(); public List<Card> findFirst10ByName();

Specification을 이용한 검색 조건 조합

1. Specification을 인자로 받는 검색 메서드 정의

↓ java

@Repository public interface ItemDao extends JpaRepository<Item, Long> { public List<Item> findAll(Specification<Item> spec); }
2. Specification 정의

↓ java

public class ItemSpecs { public static Specification<Item> nameLike(String name) { return (root, criteriaQuery, criteriaBuilder) -> criteriaBuilder.like(root.get("name"), '%' + name + '%'); } }
3. Specification static 메서드를 이용한 새 조건 생성
• not(Specification<T>)
• where(Specification<T>)
• and(Specification<T>)
• or(Specification<T>)