JPA 로 개발하면서 자주 사용하는 어노테이션을 정리하였다.
@Entity
해당 클래스가 엔티티임을 알리기 위해 사용한다. 애플리케이션이 실행이 될 때 엔티티 자동검색을 통하여 이 어노테이션이 선언된 클래스들은 엔티티 빈으로 등록한다.
@Table
데이터의 저장소, 테이블을 의미한다. name 값은 실제 데이터베이스의 테이블 명을 의미하며, 생략이 가능한다. 어노테이션을 생략하면 클래스의 이름을 테이블의 이름으로 자동 인식하게 된다.
@Id
엔티티빈의 기본키를 의미한다. 이 어노테이션은 하나의 엔티티에는 반드시 하나가 존재해야 한다. 복수키도 설정할 수 있다.
@GeneratedValue
데이터베이스에 의해 자동으로 생성된 값이라는 의미다. 즉, 프로그램 상에서 조작된 데이터가 아닌, 실제 데이터베이스에 데이터가 영속(저장)될 때 생성되는 값이다. 몇 가지 생성전략이 존재한다.
- IDENTITY : 기본 키 생성을 데이터베이스가 함
- SEQUENCE : 데이터베이스 시퀀스를 사용해서 기본 키 할당
- TABLE : 키 생성 테이블 생성
@Column
필드와 테이블의 컬럼을 매핑시켜 준다. 이 어노테이션은 생략이 가능하며, 생략 시 필드의 이름이 테이블의 컬럼으로 자동으로 매핑이 된다.
-
name속성(String)
필드와 매핑 될 컬럼의 이름을 명시한다. -
nullable속성(boolean)
해당 컬럼이 null값을 허용하는가 하지않는 가의 여부다. -
length속성(int)
컬럼의 길이값을 의미합니다. -
unique속성(boolean)
컬럼이 유일한 값을 가져야 하는가 아닌가의 여부다. -
insertable속성(boolean)
엔티티가 영속될 때 insert에 참여할지 말지를 결정한다. 기본값은 true -
updatable속성(boolean)
변경된 필드의 값을 테이블에도 반영할지를 결정한다. 기본값은 true
name 속성을 제외한 나머지 속성은 잘 사용되지 않을 것이라고 생각된다. nullable, length, unique는 DDL과 관련된 속성이고, insertable, updatable은 원래 잘 사용되지 않는 속성이기 때문이다.
@Temporal
java.util.Date와 java.util.Calendar 값을 매핑할 때 사용한다.
- TemporalType.Date : 년-월-일 의 date 타입 (2019-01-04)
- TemporalType.Time : 시:분:초 의 time 타입 (12:11:11)
- TemporalType.TIMESTAMP : date + time의 timestamp(datetime) 타입 (2019-01-04 12:11:11)
- 어노테이션을 사용하지 않을 경우 기본값은 timestamp 다. JPA 데이터베이스 방언에 의해, 데이터베이스의 타입에 따른 timestamp 또는 datetime은 자동으로 작성된다.
@ColumnPosition(1)
컬럼 순서 정한다.
@Enumerated
자바의 enum 타입을 매핑할 때 사용한다. 속성으로 EnumType.ORDINAL 과 EnumType.STRING 이 존재하는데 이름 그대로 ORDINAL은 순서를 STRING은 Enum의 이름을 저장한다.
@LOB
데이터베이스 BLOB, CLOB 타입과 매핑된다. CLOB(String, char[], java.sql.CLOB)은 문자, BLOB(byte[], java.sql.BLOB)은 나머지가 매핑된다.
@Transient
저장 조회에 사용되지도 않고 그냥 단순 값을 가지고 있고 싶을 때 사용한다.
@Access
데이터베이스에 엔티티에 값이 저장될 때 필드(AccessType.FIELD)의 값을 직접 접근해서 사용할 것인가 아니면 메서드에 직접(AccessType.PROPERTY) 접근할 것 인가를 설정하는 것이다.
@MappedSuperClass
어노테이션을 사용하면 부모 엔티티 접근 없이 부모 클래스의 매핑정보를 사용할 수 있다.
부모의 내용을 별도로 재정의해서 사용하고 싶은 경우에는 @AttributeOverride를 사용하여 재정의 한다. 여러 개를 한번에 정의하기 위해서는 @AttributeOverrides를 사용한다.