자바에서 어노테이션은 코드사이에 사용되어 특별한 기능을 수행하도록 하는 기술입니다.

엔티티와 테이블을 매핑하기 위하여 사용하는 어노테이션에 대해 알아보겠습니다.

import javax.persistence.*;
import java.util.Date;

@Entity  // 테이블과 매핑할 클래스는 @Entity를 붙여야 JPA가 엔티티로써 관리합니다.
@Table(name = "USER") // USER 테이블과의 매핑
public class User{

		@Id
		@Column(name = "ID")
		private String id // 기본키(PK)설정, Id 객체필드를 ID컬럼에 매핑

		@Column(name = "NAME")
		private String username; // 객체 필드를 NAME 컬럼에 매핑

		private Integer age; // * Column 어노테이션을 생략시 기본값으로 매핑됩니다.
														//자세한 내용은 아래에 있습니다.

JPA는 데이터베이스 스키마를 자동으로 생성하는 기능을 지원합니다.

그래서 위 에있는 엔티티 클래스의 매핑정보를 보면 테이블의 구조를 파악 가능합니다.

@Entity

  • JPA를 사용하여 테이블과 매핑할 클래스는 Entity 어노테이션을 필수로 붙여야 JPA가 엔티티로써 관리를 할수 있습니다.
    • 속성
      • name : JPA에서 사용할 엔티티 이름을 지정하며 설정하지 않는다면 기본값인 클래스이름을 사용합니다. (보통 기본값 사용)
    • 특징
      • 기본생성자(파라미터가 없는 public, protected 생성자)는 필수로 작성해야하며 final, enum, interface, inner 클래스는 사용할수 없습니다.
      • 저장할 필드에 final을 사용해서는 안됩니다.

@Table

  • Table 어노테이션은 엔티티와 매핑할 테이블을 지정합니다, 생략시 엔티티 클래스 이름과 같은 테이블과 매핑합니다.
    • 속성
      • name : 매핑할 테이블의 이름
      • catalog : catalog 기능이 있는 데이터베이스에서 catalog를 매핑
      • schema : schema 기능이 있는 데이터베이스에서 schema를 매핑
      • uniqueConstraints : DDL(Data Definition Language) 생성시 유니크 제약조건을 만듦, 이 기능은 스키마 자동 생성 기능을 사용하여 DDL을 만들때만 사용됨

기본키 매핑

@Id

  • JPA가 객체를 관리할때 식별할 기본키를 지정합니다. (테이블 PK설정)

JPA에서 제공하는 기본키 할당 방식은 직접할당과 자동생성이 있습니다.

  • 직접 할당 : 기본키를 애플리케이션에서 직접 할당한다.(@Id만 사용)

      @Id
  @Column(name = "SSN")
  private String SSN;

  • 자동생성(추가)

    • @Id 와 @GeneratedValue을 사용하여 맵핑하며 4가지 전략이 있습니다.
    • 자동 생성 전략은 데이터베이스마다 지원하는 방식이 다르기 때문입니다.
      • IDENTITY 전략
        • 기본키 생성을 데이터베이스에게 위임하는 전략
        • 주로 MySQL, PostgreSQL, SQL Server, DB2 에서 사용함
        • 엔티티가 영속상태가 되려면 식별자 (PK)가 필요합니다. 하지만 이 전략은 엔티티를 데이터베이스에 저장해야 식별자를 알아낼수 있습니다. 그래서 영속상태로 진입할때 먼저 엔티티를 데이터베이스에 저장한 후 식별자를 조회하여 엔티티의 식별자에 할당합니다.

        Mapping Code

          @Entity
  public class User{

  	@Id
  	@GeneratedValue(strategy = GenerationType.IDENTITY) //auto_increment
  	private Long id;

  ...
      • SEQUENCE 전략
        • 유일한 값을 순서대로 생성하는 특별한 데이터베이스 오브젝트입니다.
        • 주로 Oracle, DB2, H2 데이터베이스에서 주로 사용함
        • 이 전략은 영속상태로 진입할때 먼저 데이터베이스 시퀀스를 사용하여 식별자를 조회한후 조회한 식별자를 엔티티에 할당한후에 엔티티를 영속성 컨텍스트에 저장합니다.
          @Entity
  @SequenceGenerator(
  	name = "USER_SEQ_GENERATOR", // 식별자 생성기 이름
  	sequenceName = "USER_SEQ", // 시퀀스 이름
  	initialValue = 1, allocationSize = 1) // 초기값, 할당 받을 시퀀스 수
  public class User{

  	@Id
  	@GeneratedValue(strategy = GenerationType.SEQUENCE,
  									generator = "USER_SEQ_GENERATOR") // 실별자 생성기 선택
  	private Long id;

  ...
        • @SequenceGenerator
          • name : 식별자 생성기 이름 (필수)
          • sequenceName : 데이터베이스에 등록되어있는 시퀀스 이름 (기본값 : hibernate_sequence)
          • initialValue : 시퀀스 DDL을 생성할때 처음 시작되는 수 (기본값 : 1)
          • allocationValue : 시퀀스 한번 호출에 증가하는수(성능 최적화에 사용됨)(기본값 : 50)
          • catalog, schema : 데이터베이스 catalog, schema 이름
      • TABLE 전략
        • 키 생성 전용 테이블을 만들고 여기에 이름과 값으로 사용할 컬럼을 만들어 SEQUENCE를 흉내내는 전략입니다.
        • 이 전략은 테이블을 사용하므로 모든 데이터베이스에 적용 가능합니다.
        • 또한 값을 조회하고 증가시키기 위하여 SELECT쿼리와 UPDATE쿼리 총 두번의 통신을 하기때문에 성능상 문제가 있습니다.
      • AUTO 전략
        • 기본적으로 @GeneratedValue의 기본값은 AUTO입니다.
        • AUTO 전략은 위에서 언급한 전략을 데이터베이스에 따라 자동으로 선택해줍니다. MySQL을 선택시 IDENTITY를 ORACLE을 선택시 SEQUENCE을 사용합니다.
        • @GeneratedValue.strategy의 기본값은 AUTO이기 때문에 @GeneratedValue만 사용하여도 결과는 같습니다.
          @Entity
  public class User{
  	@Id
  	@GeneratedValue(strategy = GenerationType.AUTO) //@GeneratedValue만
  	private Long id;                                //사용해도 결과는 같음

필드와 컬럼 매핑

@Column

  • 객체 필드와 테이블의 컬럼을 매핑합니다.
    • 속성
      • name : 맵핑할 테이블의 컬럼 이름을 정합니다.
      • nullable : NULL을 허용할지 정합니다.(속성 값을 false로 지정하면 DDL에 not null 제약조건을 추가할수 있습니다.)
      • length : 문자의 크기를 지정합니다. 기본값으로는 255가 입력됩니다.
      • unique : 제약조건을 걸때 사용합니다.
      • insertable : 엔티티 저장시 선언된 필드도 같이 저장합니다.

@Enumerated

  • 자바의 enum 타입을 매핑한다.
    • 속성
      • EnumType.ORDINAL : enum 순서를 데이터베이스에 저장(enum에 저장된 순서가 값이 되어 데이터베이스에 저장됩니다.)(기본값)
      • EnumType.STRING : enum 이름을 데이터베이스에 저장(이름 그대로 문자열 자체가 데이터베이스에 저장됩니다.)
    • 기본값이 ORIDNAL으로 사용할때 데이터베이스에 저장되는 데이터 크기가 작지만 enum의 순서를 바꾸게 되면 문제가 생기기 때문에 enum의 순서를 변경할수 없습니다.

@Temporal

  • 날짜 타입의 컬럼을 매핑할때 사용합니다.(데이터베이스에는 date(날짜), time(시간), timestamp(날짜와시간) 세가지 타입이 존재합니다.)
    • 속성
      • TemporalType.DATE : 날짜, 데이터베이스 date 타입과 매핑 (2022-01-09)
      • TemporalType.TIME : 시간, 데이터베이스 time 타입과 매핑( 10:11:12)
      • TemporalType.TIMESTAMP : 날짜와 시간, 데이터베이스 timestamp 타입과 매핑 (2022-01-09 10:11:12)

@Lob

  • 데이터베이스 BLOB, CLOB 타입과 매핑합니다. (대용량 데이터 타입)
    • 속성
      • 매핑하는 필드 타입이 문자열이라면 CLOB(Character large object)로 매핑합니다. String, char[], java.sql.CLOB
      • 나머지는 BLOB(Binary large object)로 매핑합니다.

@Transient

  • 이 필드는 매핑하지 않습니다. 데이터베이스에 저장하지 않고 조회하지 않습니다. 객체에 임시로 어떤값을 보관하고 싶을때 사용합니다.

Reference

  • 자바 ORM 표준 JPA 프로그래밍