POJO 사용자 지정

클래스 모델

ClassModel 0} 인스턴스는 특정 POJO 클래스에 대한 데이터 변환 정보를 저장합니다. 여기에는 POJO의 속성 필드를 설명하는 PropertyModel 인스턴스 목록, 필드 변환 여부, 선택 사항으로 필드를 변환할 Codecs 가 포함되어 있습니다.

ClassModel 0}에는 다음 필드가 포함되어 있습니다:

이 클래스에 대한 자세한 내용은 ClassModel API 문서를 참조하세요.

ClassModel0}을 ClassModel.builder() 인스턴스화하려면 메서드를 사용하고 POJO 클래스를 지정하세요. 빌더는 리플렉션을 사용하여 필요한 메타데이터를 생성합니다.

ClassModel<Flower> classModel = ClassModel.builder(Flower.class).build();

속성 모델

PropertyModel 는 문서의 특정 필드를 직렬화/역직렬화하는 방법에 대한 정보를 저장합니다.

PropertyModel 0}에는 다음 정보가 포함되어 있습니다:

0}을 만들려면 메서드를 호출하여 PropertyModel 인스턴스화할 PropertyModelBuilder 수 있는 을 사용합니다.PropertyModel.builder()

이 클래스에 대한 자세한 내용은 PropertyModel.Builder API 설명서를 참조하세요.

BsonExtraElements 예제

@BsonExtraElements 주석을 사용하면 해당 POJO 필드 매핑이 없는 MongoDB 문서에서 데이터를 역직렬화하는 필드를 지정할 수 있습니다. 이는 애플리케이션이 부분적으로 정의된 스키마의 데이터로 작업해야 할 때 유용합니다. 이 주석을 사용하여 POJO의 필드에 해당하지 않는 모든 필드의 데이터에 액세스할 수 있습니다.

이전 예시의 제품 POJO를 사용하여 온라인 스토어에 대한 데이터를 저장하고 검색하는 상황을 생각해 보겠습니다. 스토어에 다양한 제품을 제공할수록 해당 제품을 설명하는 추가 필드가 필요하다는 것을 알게 됩니다. 각 추가 필드를 POJO에 매핑하는 대신 다음 코드 예시와 같이 @BsonExtraElements 주석이 달린 단일 필드에서 해당 필드에 액세스할 수 있습니다.

public class Product {
    @BsonProperty("modelName")
    private String name;
    @BsonId()
    @BsonRepresentation(BsonType.OBJECT_ID)
    private String serialNumber;
    @BsonIgnore
    private List<Product> relatedItems;
    @BsonExtraElements
    private Document additionalInfo;
    // ...

누군가가 제품 데이터에 dimensions 및 weight 필드를 추가하여 문서에 다음 정보가 포함되었다고 가정해 보겠습니다.

{
  "name": "MDB0123",
  "serialNumber": "62e2...",
  "dimensions": "3x4x5",
  "weight": "256g"
}

Product POJO를 사용하여 검색된 이전 문서에는 다음 데이터가 포함되어 있습니다.

ProductWithBsonExtraElements [
  name=MDB0123,
  serialNumber=62eb...,
  relatedItems=null,
  additionalInfo=Document{{dimensions=3x4x5, weight=256g}}
]

속성의 추상 또는 인터페이스 형식Abstract or Interface Types in Properties

추상 클래스 또는 인터페이스 유형 속성을 포함하는 POJO를 직렬화하려면 해당 유형과 모든 해당 하위 유형 또는 구현에 대한 판별자를 지정해야 합니다.

필드 중 하나에서 추상 클래스 User를 참조하는 POJO를 다음과 같이 정의했다고 가정해 보겠습니다.

public class UserRecordPojo {
     private User user;
     // ...
}

User 추상 클래스에 하위 클래스 FreeUser 및 SubscriberUser가 있는 경우 다음과 같이 POJO 및 추상 클래스를 CodecRegistry에 추가할 수 있습니다.

ClassModel<UserRecordPojo> userRecordPojo = ClassModel.builder(UserRecordPojo.class).enableDiscriminator(true).build();
ClassModel<User> userModel = ClassModel.builder(User.class).enableDiscriminator(true).build();
ClassModel<FreeUser> freeUserModel = ClassModel.builder(FreeUser.class).enableDiscriminator(true).build();
ClassModel<SubscriberUser> subscriberUserModel = ClassModel.builder(SubscriberUser.class).enableDiscriminator(true).build();
PojoCodecProvider pojoCodecProvider = PojoCodecProvider.builder().register(userRecordPojo, userModel, freeUserModel, subscriberUserModel).build();
CodecRegistry pojoCodecRegistry = fromRegistries(getDefaultCodecRegistry(), fromProviders(pojoCodecProvider));

판별자 지정에 대한 자세한 내용은 이 가이드의 판별자 섹션을 참조하세요 .

인수가 없는 생성자가 없는 POJO

POJO Codecs는 기본적으로 인수가 없는 빈 생성자를 호출합니다. 다른 생성자를 지정하려면 POJO에서 다음을 수행해야 합니다.

• ANNOTATION_CONVENTION 설정을 ClassModelBuilder에 전달합니다.

• BsonCreator 주석을 사용하여 생성자를 식별합니다.

ANNOTATION_CONVENTION 설정에 대한 예시는 ANNOTATION_CONVENTION 예시를 참조하세요. BsonCreator 어노테이션 예시는 어노테이션 코드가 있는 POJO 예시를 참조하세요.

직렬화 사용자 지정

기본적으로 ClassModelBuilder는 POJO에서 null이 아닌 모든 속성을 직렬화하려고 시도합니다. 속성 값이 null인 경우 기본 PropertySerialization 구현에서는 해당 필드를 건너뜁니다.

다음 중 하나를 수행하여 POJO 직렬화 동작을 사용자 정의할 수 있습니다.

• 직렬화를 항상 건너뛰려면 속성에 @BsonIgnore 주석을 사용합니다. 적절한 규칙을 사용하여 주석을 활성화해야 합니다.

• PropertySerialization 인터페이스의 shouldSerialize() 메서드를 재정의하는 맞춤 클래스를 만듭니다. ClassModelBuilder에서 액세스할 수 있는 PropertyModelBuilder 에 사용자 정의 구현을 지정합니다.

POJO에서 @BsonIgnore 어노테이션을 사용하는 방법에 대한 자세한 내용은 이 가이드의 어노테이션 섹션을 참조하세요.

다음 샘플 코드는 필드 직렬화 여부를 결정하는 기본 조건을 재정의하기 위해 PropertySerialization 인터페이스를 구현하는 맞춤 클래스를 보여줍니다.

public class CourteousAgeSerialization implements PropertySerialization<Integer> {
    @Override
    public boolean shouldSerialize(Integer value) {
        return (value < 30);
    }
}

위 클래스는 29보다 큰 정수는 직렬화되지 않으므로 MongoDB 문서에 포함되지 않도록 지정합니다. 이 사용자 지정 직렬화 동작을 다음 샘플 POJO에 적용했다고 가정해 보겠습니다.

public class BirthdayInvitation {
    private String name;
    private Integer age;
    private LocalDateTime eventDateTime;
    // ...
}

다음 코드를 사용하여 age 필드와 연결된 ClassModel 속성에서 PropertyModelBuilder에 CourteousAgeSerialization 인스턴스를 추가하여 사용자 지정 직렬화를 지정할 수 있습니다.

ClassModelBuilder<BirthdayInvitation> classModel = ClassModel.builder(BirthdayInvitation.class);
((PropertyModelBuilder<Integer>) classModel.getProperty("age"))
        .propertySerialization(new CourteousAgeSerialization());
PojoCodecProvider pojoCodecProvider = PojoCodecProvider.builder().register(classModel.build()).build();
CodecRegistry pojoCodecRegistry = fromRegistries(getDefaultCodecRegistry(), fromProviders(pojoCodecProvider));

age 필드에 29보다 큰 값이 포함된 POJO를 삽입하면 직렬화된 문서는 이를 생략합니다. POJO 선언 및 결과 문서는 다음과 같을 수 있습니다.

// constructor with parameters for name, age, and eventDateTime, respectively
BirthdayInvitation invitation = new BirthdayInvitation(
        "Galadriel",
        7582,
        LocalDateTime.of(2021, Month.JANUARY, 18, 30, 0)
    );

age 필드 값이 29보다 크므로 직렬화된 문서는 다음과 같아야 합니다.

{ "_id" : ObjectId("..."), "eventDateTime" : ..., "name" : "Galadriel" }

public class ApplicationUser {
    private Optional<Address> optionalAddress;
    private Optional<Subscription> optionalSubscription;
    // ...
}

public class OptionalPropertyCodecProvider implements PropertyCodecProvider {
    @Override
    @SuppressWarnings({"rawtypes", "unchecked"})
    public <T> Codec<T> get(final TypeWithTypeParameters<T> type, final PropertyCodecRegistry registry) {
        // Check the main type and number of generic parameters
        if (Optional.class.isAssignableFrom(type.getType()) && type.getTypeParameters().size() == 1) {
            // Get the codec for the concrete type of the Optional, as its declared in the POJO.
            Codec<?> valueCodec = registry.get(type.getTypeParameters().get(0));
            return new OptionalCodec(type.getType(), valueCodec);
        } else {
            return null;
        }
    }
    private static final class OptionalCodec<T> implements Codec<Optional<T>> {
        private final Class<Optional<T>> encoderClass;
        private final Codec<T> codec;
        private OptionalCodec(final Class<Optional<T>> encoderClass, final Codec<T> codec) {
            this.encoderClass = encoderClass;
            this.codec = codec;
        }
        @Override
        public void encode(final BsonWriter writer, final Optional<T> optionalValue, final EncoderContext encoderContext) {
            if (optionalValue != null && optionalValue.isPresent()) {
                codec.encode(writer, optionalValue.get(), encoderContext);
            } else {
                writer.writeNull();
            }
        }
        @Override
        public Optional<T> decode(final BsonReader reader, final DecoderContext context) {
            return Optional.of(codec.decode(reader, context));
        }
        @Override
        public Class<Optional<T>> getEncoderClass() {
            return encoderClass;
        }
    }
}

CodecProvider pojoCodecProvider = PojoCodecProvider.builder()
        .register("org.example.pojos")
        .register(new OptionalPropertyCodecProvider())
        .build();