GraphQL BatchLoader
GitLab에서 GraphQL 쿼리 실행 시 N+1 SQL 쿼리를 방지하기 위한 batch-loader Ruby gem 사용 방법을 설명합니다.
GitLab은 N+1 SQL 쿼리를 최적화하고 피하기 위해 batch-loader Ruby 젬을 사용합니다. 이러한 배치 처리의 기회를 만드는 것은 GraphQL 쿼리 트리의 특성입니다. 서로 연결되지 않은 노드가 같은 데이터를 필요로 할 수 있지만, 서로의 존재를 알 수는 없습니다. 사용 시점 # GraphQL 쿼리를 실행하는 동안에는 데이터베이스 요청을 최대한 배치로 묶는 것이 좋습니다. 뮤테이션은 직렬로 실행되므로 배치 로딩이 필요하지 않습니다. 데이터베이스 쿼리를 수행해야 하고, 비슷한(반드시 동일하지는 않은) 두 쿼리를 하나로 합칠 수 있다면 batch-loader 사용을 검토합니다. 새 엔드포인트를 구현할 때는 SQL 쿼리 수를 최소화하는 것을 목표로 삼습니다. 안정성과 확장성을 위해 쿼리가 N+1 성능 문제를 겪지 않도록 해야 합니다. 구현 # 배치 로딩은 입력 Qα, Qβ, ... Qω 에 대한 일련의 쿼리를 Q[α, β, ... ω] 라는 단일 쿼리로 합칠 수 있을 때 유용합니다. ID 조회가 그 예로, 사용자 이름으로 사용자 두 명을 찾는 비용이 한 명을 찾는 비용과 같습니다. 다만 실제 사례는 더 복잡할 수 있습니다. 결과 집합의 정렬 순서, 그룹화, 집계 등 합칠 수 없는 요소가 서로 다른 경우에는 배치 로딩이 적합하지 않습니다. 코드에서 batch-loader를 사용하는 방법은 두 가지입니다. 단순 ID 조회에는 ::Gitlab::Graphql::Loaders::BatchModelLoader.new(model, id).find 를 사용합니다. 더 복잡한 경우에는 배치 API를 직접 사용할 수 있습니다. 예를 들어 username 으로 User 를 로드하려면 다음과 같이 배치 처리를 추가할 수 있습니다. class UserResolver < BaseResolver type UserType , null: true argument :username , : :GraphQL : :Types : :String , required: true def resolve ( **args ) BatchLoader : :GraphQL . for (username).batch do | usernames, loader | User .by_username(usernames).each do | user | loader.call(user.username, user) end end end end username 은 조회하려는 사용자 이름입니다. 이름은 하나일 수도 있고 여러 개일 수도 있습니다. loader.call 은 결과를 입력 키에 다시 매핑하는 데 사용합니다(여기서는 user를 해당 username에 매핑합니다). BatchLoader::GraphQL 은 지연 객체(데이터를 가져오기 위해 보류된 프로미스)를 반환합니다. BatchLoading 메커니즘을 사용하는 방법은 예시 머지 리퀘스트 에서 확인할 수 있습니다. BatchModelLoader # ID 조회에는 BatchModelLoader 를 사용하기를 권장합니다. def proj