JSON 개발 가이드라인

GitLab에서는 많은 양의 JSON 데이터를 처리합니다. 대규모 JSON 인코딩 또는 디코딩을 처리할 때 최상의 성능을 보장하기 위해 기본 메서드 대신 고유한 JSON 클래스를 사용합니다.

Gitlab::Json

이 클래스는 기본 JSON 클래스의 모든 호출, .to_json 호출 및 유사한 호출 대신 사용해야 합니다. .parse, .generate, .dump 등 JSON에서 제공하는 대부분의 공개 메서드를 구현하며 응답에서 완전히 동일해야 합니다.

차이점은 Gitlab::Json을 통해 모든 JSON 처리를 보내면 배경에서 사용되는 젬을 변경할 수 있다는 것입니다. 따라서 우리는 json 젬 대신 C 확장을 사용하는 oj를 사용합니다. 따라서 더욱 빠릅니다.

GitLab 애플리케이션의 연식으로 인해 기본적으로 json 젬을 oj로 간단히 대체하는 것이 불가능했습니다. 이유는 다음과 같습니다.

  • 응답에 정확한 기대값을 갖는 테스트의 수
  • 서로 다른 JSON 프로세서 간의 미묘한 차이, 특히 서식에 관련된 부분

Gitlab::Json 클래스는 이 점을 고려하여 어댑터를 사용 사례에 따라 변경하고 오래된 서식 기대를 고려할 수 있습니다.

Gitlab::Json::PrecompiledJson

이 클래스는 Grape 프레임워크로의 후크에서 이미 생성된 JSON이 응답을 반환할 때 두 번째로 JSON을 생성하지 않도록 보장합니다.

Gitlab::Json::LimitedEncoder

이 클래스는 결과가 너무 크다면 오류가 발생하도록 하고 JSON을 생성할 수 있습니다. .encode 메서드의 기본 제한은 25MB이지만 메서드를 사용할 때 이를 사용자 정의할 수 있습니다.