[java] Java에서 Protocol Buffers를 사용하여 메시지 필드 유효성 검사하기

23 Nov 2023

java

Protocol Buffers는 데이터 직렬화를 위한 언어 및 플랫폼 중립적인 형식입니다. Java에서 Protocol Buffers를 사용하여 메시지를 생성하고 유효성을 검사하는 방법을 알아보겠습니다.

Protocol Buffers와 Java

Protocol Buffers는 .proto 확장자를 가진 텍스트 파일로 정의됩니다. 이 파일은 메시지의 필드와 유효성 검사 규칙을 정의하는 데 사용됩니다. 이 파일을 사용하여 Java 클래스를 생성하고, 메시지를 직렬화하거나 역직렬화할 수 있습니다.

메시지 필드 유효성 검사하기

Protocol Buffers에서는 각 필드에 대한 유효성 검사 규칙을 지정할 수 있습니다. 예를 들어, 필드가 반드시 채워져야 하는지, 최소값이나 최대값이 있는지 등의 규칙을 설정할 수 있습니다.

먼저, .proto 파일에서 유효성 검사 규칙을 정의합니다.

syntax = "proto3";

message ExampleMessage {
  string name = 1 [(validate.rules) = {required: true}];
  int32 age = 2 [(validate.rules) = {min: 18, max: 100}];
}

위의 예제에서는 ExampleMessage라는 이름과 나이를 나타내는 name과 age 필드를 정의합니다. name은 필수적으로 채워져야 하며, age는 18 이상 100 이하여야 합니다.

Java 코드에서 Protocol Buffers 메시지를 생성하고 유효성을 검사하는 방법은 다음과 같습니다.

import com.google.protobuf.InvalidProtocolBufferException;
import com.google.protobuf.util.JsonFormat;
import com.example.protobuf.ExampleMessage;

public class Main {
  public static void main(String[] args) throws InvalidProtocolBufferException {
    ExampleMessage.Builder builder = ExampleMessage.newBuilder();
    builder.setName("John Doe");
    builder.setAge(25);

    ExampleMessage message = builder.build();

    // JSON 형식으로 직렬화하여 출력
    String json = JsonFormat.printer().preservingProtoFieldNames().print(message);
    System.out.println(json);

    // 유효성 검사
    boolean isValid = message.isInitialized();
    System.out.println("Message is valid: " + isValid);
  }
}

위의 예제에서는 ExampleMessage 객체를 생성하고, setName과 setAge 메서드를 사용하여 필드 값을 설정합니다. 그리고 build 메서드를 호출하여 메시지를 완성시킵니다.

JsonFormat.printer().preservingProtoFieldNames().print(message)를 사용하면 Protocol Buffers 메시지를 JSON 형식으로 직렬화할 수 있습니다.

마지막으로, message.isInitialized()를 통해 메시지가 유효한지 검사할 수 있습니다.

결론

Java에서 Protocol Buffers를 사용하여 메시지 필드 유효성을 검사하는 방법을 알아보았습니다. 이를 통해 보다 안정적이고 정확한 데이터 교환을 위해 필드 유효성 규칙을 적용할 수 있습니다. Protocol Buffers를 사용하면 데이터의 유효성을 간편하게 확인할 수 있으며, 개발자들 사이에서 표준화된 데이터 교환 형식으로 널리 사용되고 있는 기술입니다.

Protocol Buffers와 Java

메시지 필드 유효성 검사하기

결론

참고 자료