[JPA] 필드와 컬럼 매핑 - @Column, @Enumerated, @Temporal, @Lob, @transient, @Access

🟩 필드와 컬럼 매핑

분류	매핑 어노테이션	설명
필드와 컬럼 매핑	@Column	컬럼을 매핑한다.
	@Enumerated	자바 enum 타입을 매핑한다.
	@Temporal	날짜 타입을 매핑한다.
	@Lob	BLOB, CLOB 타입을 매핑한다.
	@Transient	특정 필드를 데이터베이스에 매핑하지 않는다.
기타	@Access	JPA가 엔티티에 접근하는 방식을 지정한다.

 

 

🟩 @Column 어노테이션

• @Column : 객체 필드(field)를 테이블 컬럼(column)에 매핑한다.

 

@Column 속성 

속성	기능	기본값
name	필드와 매핑할 테이블의 컬럼 이름	객체의 필드 이름
insertable	엔티티 저장 시 이 필드도 같이 저장한다. insertable = false : 이 필드는 데이터베이스에 저장하지 않는다. (false : 읽기 전용일 때 사용한다.)	true
updatable	엔티티 수정 시 이 필드도 같이 수정한다. updatable = false : 데이터베이스에 수정하지 않는다. (false : 읽기 전용일 때 사용한다.)	true
table	하나의 엔티티를 두 개 이상의 테이블에 매핑할 때 사용. 지정한 필드를 다른 테이블에 매핑할 수 있다.	현재 클래스가 매핑된 테이블
nullable	null 값 허용 여부 설정. (false : DDL 생성 시에 not null 제약조건 추가)	true
columnDefinition	데이터베이스 컬럼 정보를 직접 준다.	필드의 자바 타입과 방언 정보를 사용해서 적절한 컬럼 타입을 생성한다.
length	문자 길이 제약조건, String 타입에만 사용한다.	255
percision, scale	BigDecimal(BigInteger) 타입에서 사용한다. percisition : 소수점을 포함한 전체 자리수 scale : 소수의 자릿수 (double, float 타입에 적용하지 않는다.)	precision = 19, scale = 2

 

@Column은 생략할 경우 기본 타입을 주의하자

기본 타입일 때 nullable 속성에 예외가 발생할 수 있다.

// @Column 생략
// 자바 기본 타입
int age1;

// @Column 생략
// 객체 타입
Integer age2;

// @Column 사용
// 자바 기본 타입
@Column
int age3;

생성된 DDL은 다음과 같다.

age1 INTEGER NOT NULL;

age2 INTEGER;

age3 INTEGER;

 

문제가 없어 보일 수 있지만 자바 기본 타입인 "age3"이 nullable하다는 속성이 기본값으로 들어가기 때문에 매핑이 안전하지 못하다.

// 생성된 DDL -> age3 INTEGER
// 테이블 컬럼은 null이 들어갈 수 있지만
// 객체 필드는 null이 들어갈 수 없다.
@Column
int age3;

 

이러한 경우는 기본 타입을 사용하지 않던가 @Column(nullable = false)로 nullable 속성을 추가해줘서 예상하지 못할 상황을 막아주자.

 

 

 

 

🟩 @Enumerated 어노테이션

• 자바 enum 타입 매핑할 때 사용한다.

속성	기능	기본값
value	EnumType.ORDINAL : enum 순서를 데이터베이스에 저장한다. EnumType.STRING : enum 이름을 데이터베이스에 저장한다.	EnumType.ORDINAL

 

 

@Enumerated 사용 예시

• @Enumerated를 사용하면 enum 타입을 데이터베이스에 편리하게 저장할 수 있다.

enum AnimalType {
    DOG,
    CAT
}

@Entity
public class MyAnimal {
    @Id
    private Long id;
    
    @Enumerated(EnumType.STRING)
    private AnimalType animalType;
}

위에서 EnumType.STRING을 이용했는데 이유는 enum의 순서가 바뀌거나 추가되어도 안전하다는 점이다.

EnumType.ORDINAL은 순서대로 "0, 1, 2, .." 저장되기 때문에 enum의 순서가 바뀌면 번호에 대한 의미가 달라지므로 위험하다.

 

 

 

 

🟩 @Temporal 어노테이션

• 날짜 타입을 매핑할 때 사용한다. (Date, Calendar)

속성	기능	기본값
value	TemporalType.DATE : 날짜, 데이터베이스 date 타입과 매핑 (2023-06-14) TemporalType.TIME : 시간, 데이터베이스 time 타입과 매핑 (23:21:29) TemporalType.TIMESTAMP : 날짜와 시간, 데이터베이스 timestamp 타입과 매핑 (2023-06-14 23:21:29)	TemporalType은 필수로 지정해줘야 한다.

 

@Temporal 사용 예시

@Entity
public class TemporalEntity {
	@Id
    private Long id;
    
    @Temporal(TemporalType.DATE)
    private Date date;
    
    @Temporal(TemporalType.TIME)
    private Date time;
    
    @Temporal(TemporalType.TIMESTAMP)
    private Date timeStamp;
}

 

@Temporal 어노테이션 생략할 경우

자바의 Date와 유사한 timestamp로 정의된다.

 

 

 

🟩 @Lob 어노테이션

• 데이터베이스 BLOB, CLOB 타입을 매핑한다.
• CLOB 매핑하는 경우 : String, char[], java.sql.CLOB
• BLOB 매핑하는 경우 : byte[], java.sql.BLOB

@Lob 사용 예시

@Entity
public class LobEntity {
    @Id;
    private Long id;
    
    @Lob
    private String lobString;
    
    @Lob
    private byte[] lobByte;
}

 

 

 

🟩 @Transient 어노테이션

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

@Transient 사용 예시

@Entity
public class TransientEntity {
    @Id
    private Long id;
    
    @Transient
    private Integer temp;
}

 

 

 

🟩 @Access

• JPA가 엔티티 데이터 접근하는 방식을 지정한다.

필드 접근 : @Access(AccessType.FIELD)

• 필드에 직접 접근한다.
• 필드 접근 권한이 private 이어도 접근할 수 있다.

 

@Access를 설정하지 않았을 경우 @Id의 위치를 기준으로 접근 방식을 설정한다.

@Access(AccessType.FIELD)
@Entity
public class Member {
    @Id
    private String id;
    
    private String data1;
    private String data2;
}

@Entity
public class Member {
    // @Id 어노테이션이 필드에 있으므로 @Access(AccessType.FIELD) 설정한 것과 같다.
    @Id
    private String id;
    
    private String data1;
    private String data2;
}

프로퍼티 접근 : @Access(AccessType.PROPERTY)

• 접근자(getter)를 사용한다.

@Access(AccessType.PROPERTY)
@Entity
public class Member {
    private String id;
    
    private String data1;
    private String data2;
    
    @Id
    public Long getId() {
    	return id;
    }
}

@Entity
public class Member {
    private String id;
    
    private String data1;
    private String data2;

    // @Id 어노테이션이 접근자에 있으므로 @Access(AccessType.PROPERTY) 설정한 것과 같다.
    @Id
    public Long getId() {
    	return id;
    }
}

 

 필드 접근 방식 + 프로퍼티 접근 방식

• @Id 어노테이션이 필드에 있으므로 기본으로 필드 접근 방식을 이용한다.
• 회원 엔티티를 저장할 경우 회원 테이블의 fullname 컬럼에는 "firstName + lastName"의 결과가 저장된다.

@Entity
public class Member {
    @Id
    private Long id;
    
    @Transient
    private String firstName;
    
    @Transient
    private String lastName;
    
    @Access(AccessType.PROPERTY)
    public String getFullName() {
    	return firstName + lastName;
    }
}

 

 

 

 

🔗 참고

자바 ORM 표준 JPA 프로그래밍 - YES24