[Spring Data MongoDB] Auto-Increment Sequence 만들기

📎  Spring Data MongoDB Auto-Increment Sequence 만들기

안녕하세요, 이번 시간에 정리할 내용은 Spring Data MongoDB에서 데이터를 삽입할 때 마다 자동으로 증가하는 필드를 생성해보도록 하겠습니다.

해당 기능은 MySQL에서의 AUTO INCREMENT와 동일하다고 보시면 됩니다.

※ Spring Data MongoDB의 경우 처음 사용하기 때문에 틀린 내용이 있을 수 있습니다.

 

 

 

Sequence Collection 생성

---

package com.juhyun.shorturl.entity.sequence;

import lombok.Getter;
import lombok.Setter;
import org.springframework.data.annotation.Id;
import org.springframework.data.mongodb.core.mapping.Document;

@Getter
@Setter
@Document(collection = "auto_sequence")
public class AutoIncrementSequence {

    @Id
    private String id;
    private Long seq;
}

먼저 Auto Increment 속성을 저장하는 컬렉션(auto_sequence)을 생성합니다.

 

 

 

Entity - ShortUrl

---

package com.juhyun.shorturl.entity;

import com.juhyun.shorturl.controller.dto.ReadShortUrlResponse;
import lombok.AccessLevel;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.ToString;
import org.springframework.data.annotation.Id;
import org.springframework.data.annotation.Transient;
import org.springframework.data.mongodb.core.mapping.Document;

import javax.validation.constraints.NotBlank;

@Getter
@NoArgsConstructor(access = AccessLevel.PROTECTED)
@AllArgsConstructor
@Builder
@ToString
@Document(collection = "shorturl")
public class ShortUrl {

    @Transient
    public static final String SEQUENCE_NAME = "shorturl_sequence";

    @Id
    private Long _id;

    ...
}

ShortUrl Entity에서 위에서 생성한 AutoIncrementSequence를 참조할 SEQUENCE_NAME 변수를 생성합니다.
해당 변수에는 영속성 필드에서 제외하기 위해 @Transient 어노테이션을 추가합니다.

 

 

 

🤔 MongoDB _id

MongoDB는 Collection별로 document를 저장하는데, document별 _id 속성이 존재합니다.

이는 Collection에 저장된 여러 document에 대해 유니크함을 식별하기 위한 기본 key입니다.

특별한 선언이 없으면 ObjectId type을 사용하는데요, 저는 해당 값을 Long으로 선언을 해주었습니다.

 

MongoDB는 Collection별 document를 저장하는데, document별 _id 속성이 존재합니다. 이는 Collection에 저장된 여러 document에 대해 유니크한 값임을 식별하기 위한 기본 key입니다.

특별한 선언이 없으면 MongoDB에서는 ObjectId type을 사용합니다.

 

Spring Data MongoDB에서는 @Id 어노테이션으로 지정된 field가 존재하면 MongoDB의 _id로 매핑이 됩니다.

만약 @Id 어노테이션이 없다면 id란 이름의 field가 매핑이 됩니다.

 

Java Entity의 id field가 String이나 BigInteger로 선언이되면 MongoDB에는 ObjectId로 변환되어 저장이됩니다.

• String id -> Converter<String, ObjectId>
• BigInteger id -> Converter<BigInteger, ObjectId>

https://docs.mongodb.com/manual/reference/operator/aggregation/toObjectId/

 

Entity에서 id field의 타입으로 String, BigInteger, Object를 사용하는 것을 권장하는 것 같지만(?) 저는 Long 타입으로 선언을 했는데요, MongoDB에 ObjectId로 값이 저장될 경우 문자열이 추가되어서 위 Auto Increment를 추가하더라도 MongDB에는 아래 사진처럼 문자열 숫자로 저장이 됩니다.

저는 데이터베이스에서 _id 값을 기준으로 정렬을 해야하는 경우가 있었는데 문자열 숫자인 _id를 정렬할 경우 아래 사진처럼 원하는 결과를 얻을 수 없었습니다.

따라서 정렬 후 원하는 결과를 얻기위해 저는 _id값을 Long으로 선언하여 사용하였습니다.

위 관련된 문제에 대해 찾아보다보니 비슷한 문제로 MongoDB 3.4버전 이후로는 "Decimal128" 타입이 추가되어서 해당 타입으로 Converter해서 해결하는 포스팅도 보았습니다.

적용해보지는 않았지만, 다음에 기회가 된다면 적용해보겠습니다.

http://www.mytechtip.com/2018/01/sort-bigdecimal-mongodb-spring-data.html

Spring Data: How to Sort BigDecimal Fields Correctly When Using MongoDB

 

 

 

 

SequenceGeneratorService 생성

---

package com.juhyun.shorturl.entity.sequence;

import lombok.RequiredArgsConstructor;
import org.springframework.data.mongodb.core.MongoOperations;
import org.springframework.data.mongodb.core.query.Query;
import org.springframework.data.mongodb.core.query.Update;
import org.springframework.stereotype.Service;

import java.util.Objects;

import static org.springframework.data.mongodb.core.FindAndModifyOptions.options;
import static org.springframework.data.mongodb.core.query.Criteria.where;

@RequiredArgsConstructor
@Service
public class SequenceGeneratorService {

    private final MongoOperations mongoOperations;

    public Long generateSequence(String seqName) {
        AutoIncrementSequence counter = mongoOperations.findAndModify(Query.query(where("_id").is(seqName)),
                new Update().inc("seq", 1), options().returnNew(true).upsert(true), AutoIncrementSequence.class);

        //return BigInteger.valueOf(!Objects.isNull(counter) ? counter.getSeq() : 1);
        return !Objects.isNull(counter) ? counter.getSeq() : 1;
    }

}

Entity의 id로 사용될 수 있도록 자동으로 증가하는 SequenceGeneratorService 클래스를 작성합니다.

 

 

 

 

 

Listener 작성

---

package com.juhyun.shorturl.entity.sequence;

import com.juhyun.shorturl.entity.ShortUrl;
import lombok.RequiredArgsConstructor;
import org.springframework.data.mongodb.core.mapping.event.AbstractMongoEventListener;
import org.springframework.data.mongodb.core.mapping.event.BeforeConvertEvent;
import org.springframework.stereotype.Component;

@RequiredArgsConstructor
@Component
public class ShortUrlListener extends AbstractMongoEventListener<ShortUrl> {

    private final SequenceGeneratorService generatorService;

    @Override
    public void onBeforeConvert(BeforeConvertEvent<ShortUrl> event) {
        event.getSource().setId(generatorService.generateSequence(ShortUrl.SEQUENCE_NAME));
    }
}

마지막으로 새로운 Entitry가 추가될 때마다 id값이 자동으로 증가하도록 AbstractMongoEventListener 추상 클래스를 상속받는 ShortUrlListener 클래스를 작성하고, onBeforeConvert() 메소드를 오버라이드 해서 구현합니다.

 

AbstractMongoEventListener 추상 클래스는 어플리케이션 이벤트 리스너인 ApplicationListener 인터페이스를 구현합니다.

 

onBeforeConvert() 메소드에 최초 진입을 할 때는 _id = null 인 상태로 들어오게 됩니다.

그 후 setId() 메소드를 통해 위에서 생성한 Service의 negerateSequence 메소드를 호출합니다.

 

 

매개변수의 seqName은 Entity에 존재하는 static 변수인 SEQUENCE_NAME 의 값입니다.

 

 

위 코드는 MongoOperations 클래스의 findAndModify() 메소드는 여러 메소드가 오버로딩이 되어있는데 SequenceGeneratorService 클래스에서 사용하는 메소드는 위와 같이 4개의 매개변수를 받고 있습니다.

 

위 코드는 MongoOperations 인터페이스의 구현체인 MongoTemplate 클래스의 findAndModify() 의 다양한 메소드들입니다.

서비스에서 사용하고 있는 메소드는 위 사진처럼 4개의 인자를 받고 있습니다.

Query: Query.query(where("_id").is(seqName))
UpdateDefinition: new Update().inc("seq", 1)
FindAndModifyOptions: options().returnNew(true).upsert(true)
Class<T>: AutoIncrementSequence.class

• Query: MongoDB의 Query Object를 의미합니다.
• UpdateDefinition: 인터페이스로 Update가 구현체입니다. 매칭되는 documents에 업데이트합니다.
• FindAndModifyOptions: 이름 그대로 Find & Modify을 수행하는 클래스 입니다.
• Class<T>: 파라미터 타입입니다.

 

위 클래스를 빠져나오면 counter의 seq 값은 Auto Increment 되는 값으로 변경이 됩니다.

 

 

SequenceGeneratorService 클래스의 generateSequence()의 값을 가져온 뒤 Listener에서 setId() 메소드를 통해 _id의 value를 설정합니다.

 

 

 

 

정리

---

이상으로 Spring Data MongoDB에서 Auto Increment를 적용하는 방법에 대해 알아보았습니다.

위 내용을 간단하게 정리하면 다음과 같습니다.

• Sequence Collection 생성
• Entity 작성(참조할 시퀀스 변수 선언)
• SequenceGeneratorService 생성
• Listener 작성

처음 사용하다보니 꽤 많은 삽질이 있었는데요 😭 아직도 어렵네요.. 그치만 처음사용하다보니 재밌기도 하고 당분간은 꽤 사용할 것 같습니다.

 

 

 

 

References

• https://www.baeldung.com/spring-boot-mongodb-auto-generated-field
• https://ozofweird.tistory.com/entry/Spring-Boot-MongoDB%EB%A5%BC-%EC%9D%B4%EC%9A%A9%ED%95%9C-%EA%B0%84%EB%8B%A8%ED%95%9C-API-%EC%A0%9C%EC%9E%91
• https://luvstudy.tistory.com/62
• https://www.mongodb.com/