[JPA] 엔티티 매핑 - @Entity, @Table

 

 

 

 

@Entity

JPA에서 엔티티란 쉽게 생각하면, DB 테이블에 대응하는 하나의 클래스라고 생각할 수 있습니다.

 

@Entity가 붙은 클래스는 JPA가 관리해주며, JPA를 사용해서 DB 테이블과 매핑할 클래스는 @Entity를 꼭 붙여야만 매핑이 가능합니다.

 

@Entity를 사용할 때는 몇가지 주의사항이 있습니다.

 

 

 

 

 

주의사항

• 접근 제어자가 public 혹은 protected 인 기본 생성자가 필수입니다.
  • 구현체에 따라 되는 것도 있으나, 스펙상 사용하지 못하도록 해두었기 때문에 사용하지 않는 것이 좋습니다.
• final 클래스, enum, interface, inner 클래스에는 사용이 불가능합니다
• 저장하려는 속성은 final이면 안됩니다.
  • 구현체에 따라 되는 것도 있으나, 스펙상 사용하지 못하도록 해두었기 때문에 사용하지 않는 것이 좋습니다.

 

 

 

 

 

속성 

속성	기능	기본값
name	JPA에서 사용할 엔티티의 이름을 지정한다. 보통은 기본값인 클래스 이름을 사용하지만, 다른 패키지에 이름이 같은 엔티티 클래스가 있다면 이름을 지정해서 충돌하지 않도록 해야한다.	클래스 이름을 그대로 사용(예 : Member)

@Entity(name = "Member")

같은 클래스 이름이 없으면 가급적 기본값을 사용하는게 좋습니다.

 

 

 

 

 

 

 

엔티티의 이름을 언제 사용하나?

JPA는 JPQL이라는 SQL을 추상화한 객체지향 쿼리 언어를 지원합니다.

JPQL은 테이블이 아닌 엔티티를 대상으로 쿼리를 수행하는데, 이때 이 쿼리에 엔티티의 이름이 사용됩니다.

 

 

 

예시를 보도록 하겠습니다.

select m from Member m where m.age > 18

여기서 Member가 엔티티의 이름입니다.

 

만약 Member 클래스가 다음과 같이 구성되었다면

@NoArgsConstructor(access = AccessLevel.PROTECTED)
@Entity(name = "ShinDongHun")
@Setter
@Getter
public class Member{

    @Id @GeneratedValue
    @Column(name = "MEMBER_ID")
    private Long id;

    private String username;
    private int age;
}

 

 

JPQL은 다음과 같이 쓰여집니다.

select m from ShinDongHun m where m.age > 18

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

@Table

엔티티와 매핑할 테이블을 지정합니다.

 

속성

속성	기능	기본값
name	매핑할 테이블 이름을 지정한다.	엔티티 이름을 사용한다.
catalog	catelog 기능이 있는 데이터베이스에서 catalog를 매핑한다.
schema	schema 기능이 있는 데이터베이스에서 schema를 매핑한다
uniqueConstraints (DDL)	DDL 생성 시에 유니크 제약조건을 만든다. 스키마 자동 생성 기능을 사용해서 DDL을 만들 때만 사용된다.
indexes	테이블의 인덱스를 지정하는 것 같다. 인덱스 테이블을 사용할 때 사용하는 것 같으나 잘 모르겠다. 설명은 다음과 같다. (Optional) Indexes for the table. These are only used if table generation is in effect. Note that it is not necessary to specify an index for a primary key, as the primary key index will be created automatically.

 

 

 

 

예시

name

@Table(name = "MEMBER_TABLE")

 

 

 

 

 

uniqueConstrains - 유니크 제약조건 설정

uniqueConstraints={
    @UniqueConstraint(
         name = "unique 제약조건 이름",
         columnNames = {
            "포함할 컬럼이름 1",
            "포함할 컬럼이름 2"
        }
  ),
    ...
}

 

 

columnNames는 필드가 아닌 컬럼명과 일치해야 합니다.

 

 

@Table( 
    uniqueConstraints={
		@UniqueConstraint( columnNames={"column1"})
    }
)
       
@Table(
    uniqueConstraints = {
   	@UniqueConstraint(name = "UniqueNumberAndStatus", columnNames = {"personNumber", "isActive"}),
   	@UniqueConstraint(name = "UniqueSecurityAndDepartment", columnNames = {"securityNumber", "departmentCode"})
   }
)

 

 

 

 

 

 

 

참고: uniqueConstrains 에 대해서

@Table의 uniqueConstrains와 더불어, @Column의 unique, length 등의 제약조건을 추가해주는 속성들이 있습니다.

 

해당 속성들은 단지 DDL을 자동으로 생성할 때만 사용되고, JPA의 실행 로직에는 아무런 영향을 주지 않습니다.

 

따라서 스키마 자동 생성 기능('spring.jpa.hibernate.ddl-auto=create' 등)을 사용하지 않고 직접 DDL을 만든다면 해당 기능들은 사용할 이유가 없습니다.

 

그러나 해당 기능을 사용하면 애플리케이션 개발자가 엔티티만 보고도 손쉽게 다양한 제약조건을 파악할 수 있다는 장점이 있습니다.

 

 

 

 

 

 

 

 

 

 

 

📔 Reference

자바 ORM 표준 JPA 프로그래밍 - 기본편 - 인프런 | 강의

https://www.baeldung.com/jpa-unique-constraints

[자바 ORM 표준 JPA 프로그래밍 - 김영한]

 

@Table의 uniqueConstrains

JPA 컬럼 두개이상 UNIQUE 설정하기 - 가리사니

 

[JPA] 두개 이상 컬럼 UNIQUE 조건 설정

 

 

 

https://www.inflearn.com/questions/164425

왜 final 을 사용하면 안될까요!? - 인프런 | 질문 & 답변

https://www.inflearn.com/questions/105043

기본 생성자에 관해 질문드립니다. - 인프런 | 질문 & 답변