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

23 Nov 2023

java

Protocol Buffers는 구조화된 데이터를 직렬화하고, 주로 네트워크를 통해 전송하거나 저장하는 데 사용되는 프로토콜이다. Java에서 Protocol Buffers를 사용하여 메시지 필드의 데이터 유효성을 검증하는 방법을 알아보겠다.

1. Protocol Buffers 설치하기

먼저, Protocol Buffers를 사용하기 위해 protobuf-java 라이브러리를 설치해야 한다. 아래와 같이 Maven을 사용하여 의존성을 추가할 수 있다.

<dependency>
    <groupId>com.google.protobuf</groupId>
    <artifactId>protobuf-java</artifactId>
    <version>3.18.1</version>
</dependency>

2. Protocol Buffers 메시지 정의하기

데이터 유효성을 검증하기 위해, Protocol Buffers 메시지를 정의해야 한다. 예를 들어, 다음과 같은 user.proto 파일을 만들어보자.

syntax = "proto3";

message User {
    string name = 1;
    int32 age = 2;
    string email = 3;
}

위의 예제에서는 User라는 메시지를 정의하였고, name, age, email 필드를 가지고 있다.

3. 데이터 유효성 검증하기

Protocol Buffers에서는 데이터 유효성 검증을 위한 다양한 방법을 제공한다. 다음은 몇 가지 예제이다.

3.1 필드 값의 존재 여부 확인하기

User user = User.newBuilder()
    .setName("John Doe")
    .setAge(25)
    .setEmail("johndoe@example.com")
    .build();

// name 필드가 존재하는지 확인
if (!user.hasName()) {
    throw new IllegalArgumentException("name is required");
}

// age 필드가 존재하는지 확인
if (!user.hasAge()) {
    throw new IllegalArgumentException("age is required");
}

// email 필드가 존재하는지 확인
if (!user.hasEmail()) {
    throw new IllegalArgumentException("email is required");
}

3.2 필드 값의 유효 범위 확인하기

User user = User.newBuilder()
    .setName("John Doe")
    .setAge(25)
    .setEmail("johndoe@example.com")
    .build();

// age 필드 값이 0보다 큰지 확인
if (user.getAge() <= 0) {
    throw new IllegalArgumentException("age must be greater than 0");
}

3.3 필드 값의 길이 확인하기

User user = User.newBuilder()
    .setName("John Doe")
    .setAge(25)
    .setEmail("johndoe@example.com")
    .build();

// name 필드 값의 길이가 50자를 넘지 않는지 확인
if (user.getName().length() > 50) {
    throw new IllegalArgumentException("name length must be less than or equal to 50");
}

// email 필드 값의 길이가 100자를 넘지 않는지 확인
if (user.getEmail().length() > 100) {
    throw new IllegalArgumentException("email length must be less than or equal to 100");
}

위의 예제에서는 Protocol Buffers에서 제공하는 hasXxx(), getXxx() 메서드와 일반적인 자바 코드를 사용하여 데이터 유효성을 검증한다.

결론

Java에서 Protocol Buffers를 사용하여 메시지 필드의 데이터 유효성을 검증하는 방법을 알아보았다. Protocol Buffers를 사용하면 구조화된 데이터를 쉽게 다룰 수 있으며, 데이터 유효성 검증을 통해 안전성을 확보할 수 있다.

참고 자료: