[JPA] 여러 컬럼에 대한 UNIQUE 제약조건 설정하기

 

 

 

 

 

🧐 여러 컬럼에 대한 UNIQUE 제약조건 설정하기

@Table의 uniqueConstraints 속성을 사용하여 설정할 수 있습니다.

 

 

 

 

 

 

사용 예시

@Table(
    name="테이블 이름",
    
    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을 만든다면 해당 기능들은 사용할 이유가 없습니다.

 

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

 

 

 

 

 

 

 

🧐 Embbeded Class의 경우

@Entity
@Builder
@AllArgsConstructor
@NoArgsConstructor(access = PROTECTED)
@Table(name = "oauth_member",
        uniqueConstraints = {
                @UniqueConstraint(
                        name = "oauth_id_unique",
                        columnNames = {
                                "oauth_server_id",
                                "oauth_server"
                        }
                ),
        }
)
public class OauthMember extends BaseEntity {

    @Embedded
    private OauthId oauthId;
    private String nickname;
    private String profileImagePath;

    public OauthId oauthId() {
        return oauthId;
    }

    public String nickname() {
        return nickname;
    }

    public String profileImagePath() {
        return profileImagePath;
    }
}


@Embeddable
@AllArgsConstructor
@NoArgsConstructor(access = PROTECTED)
public class OauthId {

    private String oauthServerId;

    @Enumerated(STRING)
    private OauthServer oauthServer;

    public String oauthServerId() {
        return oauthServerId;
    }

    public OauthServer oauthServer() {
        return oauthServer;
    }
}

위와 같은 코드는 오류가 발생하는데요, 이를 해결하기 위해서는 @Embeddable 클래스에 @Column 애너테이션을 사용하거나, @UniqueConstraint의 columnNames을 카멜케이스로 작성하는 방법이 있습니다.

 

 

첫번째 예시만 살펴보면 다음과 같습니다.

@Entity
@Builder
@AllArgsConstructor
@NoArgsConstructor(access = PROTECTED)
@Table(name = "oauth_member",
        uniqueConstraints = {
                @UniqueConstraint(
                        name = "oauth_id_unique",
                        columnNames = {
                                "oauth_server_id",
                                "oauth_server"
                        }
                ),
        }
)
public class OauthMember extends BaseEntity {

    @Embedded
    private OauthId oauthId;
    private String nickname;
    private String profileImagePath;

    public OauthId oauthId() {
        return oauthId;
    }

    public String nickname() {
        return nickname;
    }

    public String profileImagePath() {
        return profileImagePath;
    }
}


@Embeddable
@AllArgsConstructor
@NoArgsConstructor(access = PROTECTED)
public class OauthId {

    @Column(nullable = false, name = "oauth_server_id")
    private String oauthServerId;

    @Enumerated(STRING)
    @Column(nullable = false, name = "oauth_server")
    private OauthServer oauthServer;

    public String oauthServerId() {
        return oauthServerId;
    }

    public OauthServer oauthServer() {
        return oauthServer;
    }
}