JSON 메시지

JSON(JavaScript Object Notation) 메시지는 경량 데이터 교환 형식을 사용하는 텍스트 기반 메시지입니다. JSON 형식은 사람이 읽고 작성하기 쉽고, 시스템 간 데이터 교환에 적합합니다.

JSON 메시지는 주로 다음과 같은 환경에서 사용됩니다.

  • HTTP API 통신

  • 웹 서비스 연동

  • 마이크로서비스 간 통신

message json form

다음은 JSON 메시지의 설정 정보입니다.

항목 설명

객체 이름

JSON 루트 객체의 키 이름입니다. 미지정 시 메시지 클래스 이름을 사용합니다.

빈 값 대응

null 값의 처리 방식을 지정합니다. NULL만 선택 가능합니다.

알 수 없는 값 무시

역직렬화 시 매핑되지 않은 JSON 필드를 무시할지 여부를 선택합니다.

다음은 JSON 메시지에서 사용할 수 있는 필드 속성입니다. 메시지 타입과 관계없이 공통으로 사용하는 필드 속성은 메시지 필드 정의를 참고합니다.

항목 설명

JSON Key

JSON에서 사용할 키 이름입니다. 미지정 시 필드 이름을 사용합니다.

다음은 JSON Key 설정 예시입니다.

{
  "customer_name": "홍길동"   // JSON Key: customer_name
}

Field Id와 JSON Key를 다르게 설정하면 내부 필드 이름과 JSON 키 이름을 구분하여 사용할 수 있습니다. 예를 들어 내부에서는 camelCase 형식의 이름(orderId)을 사용하고, 외부 API와 통신할 때는 snake_case 형식의 JSON 키(order_id)를 사용할 수 있습니다.

다음은 아래 설정값을 적용하여 구성한 JSON 메시지 예제입니다.

  • 객체 이름: order

  • 빈 값 대응: NULL

  • 알 수 없는 값 무시: true

{
  "order": {
    "orderId": "ORD001",
    "customerName": "홍길동",
    "totalAmount": 50000,
    "item": {
      "productId": "P001",
      "quantity": 2
    }
  }
}

다음은 예제에 사용된 필드 정의입니다.

Field Id Field Type JSON Key 설명

orderId

STRING

orderId

주문 고유 식별자

customerName

STRING

customerName

고객명

totalAmount

LONG

totalAmount

총 금액

itemInfo

OBJECT

item

주문 항목 정보