[Mongo] 몽고에서 Criteria 빼고 Qclass 사용하기

🪴 0. 들어가기 전

 

MongoDB는 스키마가 없는 비관계형 데이터베이스로, ORM처럼 관계를 매핑하는 방식이 아닙니다.

따라서 SQL이 아닌 JSON 기반 쿼리를 사용하며, 이를 객체로 다루기 위해 Criteria를 사용합니다.

 

그러나 Criteria를 사용했을 때, 필드명을 실수로 잘못 작성하더라도 컴파일 시 에러를 확인할 수 없다는 단점이 있습니다.

 

이번 포스팅에서는 MongoDB에서 Criteria를 사용하지 않고, Qclass 와 QueryDSL을 적용한 방법에 대해 다뤄보겠습니다.

---

🪴 1. 기존의 Criteria 코드

 

Criteria 는 JSON 기반의 쿼리를 객체로 작성하기 위해 사용하는 방식입니다. 

비교를 위해 먼저 Criteria로 작성된 예제 코드를 보여드리도록 하겠습니다.

@Slf4j
@Primary
@RequiredArgsConstructor
public class MemberRepositoryCustomImpl implements MemberRepositoryCustom {
    private final ReactiveMongoOperations mongoOperations;

    @Override
    public Mono<Boolean> updateMemberPassword(String email, String newPassword, ServerWebExchange exchange) {
        Query query = new Query(Criteria.where("email").is(email));
        Update update = new Update()
                .set("password", newPassword)
                .set("updatedAt", LocalDateTime.now());

        return mongoOperations.updateFirst(query, update, Member.class)
                .map(updateResult -> updateResult.getModifiedCount() > 0)
                .defaultIfEmpty(false);
    }
}

 

위의 코드는 비밀번호를 업데이트하는 간단한 예제 코드입니다.

 

이 코드에서 "email" 을 문자열로 작성했기 때문에, 실제 필드명과 다르게 작성하더라도

컴파일 과정에서는 발견할 수 없다는 치명적인 문제점이 있습니다.

---

🪴 2. Criteria 빼고 Qclass + QueryDSL 적용하기

 

현재 개발 환경은 아래와 같습니다.

JDK 21, Spring Boot 3.2.2, MongoDB driver 4.11.2

프로젝트 환경에 맞는 QueryDSL버전으로 설정하는 것이 중요합니다. 

아래의 설정파일을 참고하여 자신의 개발환경에 맞도록 여러 설정을 추가해줍니다.

plugins {
	id 'java'
	id 'org.springframework.boot' version '3.2.2'
	id 'io.spring.dependency-management' version '1.1.4'
}

java {
	toolchain {
		languageVersion = JavaLanguageVersion.of(21)
	}
}

ext {
	queryDslVersion = "5.0.0"
}

dependencies {
	// QueryDSL
	implementation "com.querydsl:querydsl-mongodb:${queryDslVersion}"
	implementation "com.querydsl:querydsl-apt:${queryDslVersion}"
	annotationProcessor "com.querydsl:querydsl-apt:${queryDslVersion}"
    
	// MongoDB
	implementation 'org.mongodb:mongodb-driver-reactivestreams:4.11.2'
	implementation 'org.mongodb:mongodb-driver-core:4.11.2'
	configurations.all {
		exclude group: "org.mongodb", module: "mongo-java-driver" // 기존 MongoDB Java 드라이버를 제거(충돌 방지)
	}
}

// QueryDSL이 생성한 코드의 출력 디렉터리 설정(Qclass 생성 경로)
def querydslDir = "${buildDir}/generated/querydsl" 

// 어노테이션 프로세서 설정(추가 설명 예정)
tasks.withType(JavaCompile).configureEach {
	options.annotationProcessorPath = configurations.annotationProcessor
}

// QueryDSL 코드 생성을 위한 JavaCompile Task
task generateQueryDSL(type: JavaCompile, group: 'build') {
	source = sourceSets.main.java
	classpath = configurations.compileClasspath
	destinationDirectory = file(querydslDir)
	options.annotationProcessorPath = configurations.annotationProcessor
	options.compilerArgs = [
			"-proc:only"
	]
}

compileJava {
	dependsOn clean
}

clean {
	delete file(querydslDir)
}

 

설정을 마친 후에, Document 를 정의한 곳에 아래처럼 @QueryEntity 를 추가로 선언해주시면 됩니다.

위의 설정에서 어노테이션 프로세서(annotation processor)를 설정해주지 않는다면 @QueryEntity를 작성해도 Qclass가 생성되지 않습니다. 

import com.querydsl.core.annotations.QueryEntity;

@QueryEntity //추가해야 할 어노테이션
@Document
public record Member(

){}

 

그리고 빌드를 하게되면 위에서 설정했던 경로에 Qclass가 자동으로 생성된 것을 확인할 수 있습니다.

 

---

🪴 3.  어떻게 사용할까?

 

먼저, QueryPathResolver 클래스를 생성해줍니다.

import com.querydsl.core.types.Path;
import org.springframework.stereotype.Component;

@Component
public class QueryPathResolver {
    public static String get(Path<?> path) {
        return path.getMetadata().getName();
    }
}

 

 

그리고, 1번의 기존 코드를 아래처럼 변경할 수 있습니다. 

"email" -> QueryPathResolver.get(MEMBER.email)

@Slf4j
@Primary
@RequiredArgsConstructor
public class MemberRepositoryCustomImpl implements MemberRepositoryCustom {
    private final ReactiveMongoOperations mongoOperations;
    private final QMember MEMBER = QMember.member; //추가


    @Override
    public Mono<Boolean> updateMemberPassword(String email, String newPassword, ServerWebExchange exchange) {
        Query query = new Query(Criteria.where(QueryPathResolver.get(MEMBER.email)).is(email));
        Update update = new Update()
                .set(QueryPathResolver.get(MEMBER.password), newPassword)
                .set(QueryPathResolver.get(MEMBER.updatedAt), LocalDateTime.now());

        return mongoOperations.updateFirst(query, update, Member.class)
                .map(updateResult -> updateResult.getModifiedCount() > 0)
                .defaultIfEmpty(false);
    }
}

 

 

굳이 QueryPathResolver 클래스를 만들어서 사용한 이유는

QueryDSL에서 QMember.email 같은 필드는 직접적으로 문자열이 아니라, Path 객체로 표현되기 때문입니다.

 

아래의 Qclass 를 실제로 확인해보면 String 타입이 아닌 Path 객체로 표현하고 있는 것을 확인할 수 있습니다.

public class QMember extends EntityPathBase<Member> {
    public static final QMember member = new QMember("member");
    public final StringPath email = createString("email");
    public final StringPath password = createString("password");
}

 

---

🪴 4. 마무리

이번 포스팅은 '컴파일 에러 방지'와 '코드 일관성'을 유지할 수 있다는 장점이 있기는 하지만,

솔직히 MongoDB에서 queryDSL을 적용하면 장점이 많지는 않습니다.

 

MongoDB에서는 중첩 객체를 사용하기도 하는데 queryDSL은 이런 부분을 완벽하게 지원해주지 않아서 직접 경로를 설정해야 합니다. 

(아래 예시코드처럼 상위경로 + "." + 하위경로 의 형태로 작성을 해야합니다.)

Member member = mongoOperations.findOne(
                query(where(QueryPathResolver.get(Member.groupMemberInfoList) + "." + QueryPathResolver.get(MEMBER_INFO.memberId)).is(memberId).and(QueryPathResolver.get(Member.id)).is(meberId)),
                Member.class
        );

 

그리고 queryDSL은 SQL에 최적화가 되어있어서 MongoDB처럼 Aggregation Framework를 사용할 때에는

$lookup, $unwind, $group 와 같은 복잡한 기능들은 지원 받을 수 없습니다. 

 

따라서 Qclass + MongoDB 방식은 휴먼 에러로 인한 컴파일 에러를 방지하고 싶은 분들에게 추천드립니다.