Protocol Buffers enum 타입 이름 규칙 점검

enum 타입 이름은 대문자로 시작하는 TitleCase를 사용하세요.

설명

Protocol Buffers 스타일 가이드는 enum 타입 이름에 JobStatus 같은 TitleCase를 권장합니다. 이는 코드 일관성을 위한 규칙이며, 이름 형식만으로 보안 취약점이 생기는 것은 아닙니다.

잠재적 영향

이름 규칙이 일관되지 않으면 생성된 코드와 문서를 읽고 유지보수하기 어려울 수 있습니다.

해결 방법

enum 타입 이름을 TitleCase로 작성하세요. 기존 이름을 바꾸기 전에는 생성된 API를 사용하는 코드의 참조도 확인하고 함께 수정하세요.

예시

타입 이름만 JobStatus로 바꾸며 enum 값과 숫자는 유지합니다. 두 코드는 각각 독립된 예시입니다.

변경 전

proto
syntax = "proto3";

enum NOT_CAMEL_CASE {
  UNKNOWN = 0;
  STARTED = 1;
  RUNNING = 2;
}

변경 후

proto
syntax = "proto3";

enum JobStatus {
  UNKNOWN = 0;
  STARTED = 1;
  RUNNING = 2;
}

참조