Go 언어를 이용한 JSON 데이터 처리 가이드

JSON 데이터 개요 및 Go 언어의 지원

JSON(JavaScript Object Notation)은 경량의 데이터 교환 형식으로, 사람에게 읽기 쉽고 기계가 파싱하기 용이합니다. 웹 서비스 및 API 통신에서 데이터 전송의 표준으로 널리 사용되고 있습니다. Go 언어는 표준 라이브러리의 encoding/json 패키지를 통해 JSON 데이터를 효율적으로 인코딩 및 디코딩할 수 있는 강력한 기능을 제공합니다.

이 문서에서는 Go 언어에서 API로부터 받은 JSON 응답을 처리하는 다양한 방법을 예제 코드를 통해 상세히 설명합니다.

예제로 사용할 JSON 데이터는 다음과 같습니다:

{
    "status_code": "00",
    "status_message": "SUCCESS",
    "description": "요청이 성공적으로 처리되었습니다.",
    "data_info": { "transaction_id": "20231026100000123456" }
}

구조체(Struct)를 이용한 JSON 파싱

JSON 데이터의 구조를 미리 알고 있다면, 해당 구조에 매칭되는 Go 언어의 구조체(struct)를 정의하여 파싱하는 것이 가장 일반적이고 효율적인 방법입니다. Go의 json.Unmarshal 함수는 JSON 데이터를 정의된 구조체 인스턴스로 변환해 줍니다.

JSON 필드와 구조체 필드 매칭 규칙

json.Unmarshal은 다음과 같은 우선순위로 JSON 키와 구조체 필드를 매칭합니다:

  1. json:"key" 태그: 가장 높은 우선순위로, 구조체 필드 옆에 붙은 백틱(`) 내의 json:"json_key_name" 태그를 먼저 찾습니다. 예를 들어, StatusCode string `json:"status_code"`는 JSON의 status_code 필드와 매칭됩니다.
  2. 필드 이름: 태그가 없으면, JSON 키와 동일한 이름을 가진 내보내기 가능한(exported, 첫 글자가 대문자) 필드를 찾습니다.
  3. 대소문자 불감증: 필드 이름 매칭 시 첫 글자를 제외한 나머지 부분은 대소문자에 덜 민감하게 동작합니다 (예: Code, CODE, code 등).

중요: JSON 데이터를 할당받을 수 있는 구조체 필드는 반드시 내보내기 가능한 필드(Exported Field)여야 합니다. 즉, 필드의 첫 글자는 대문자여야 합니다. 또한, Go 언어의 구조체에 정의되지 않은 JSON 필드는 파싱 과정에서 자동으로 무시됩니다.

예제 코드: 구조체로 파싱하기

package main

import (
	"encoding/json"
	"fmt"
)

// Example JSON payload for consistent use
const apiJSONPayload = `{
    "status_code": "00",
    "status_message": "SUCCESS",
    "description": "요청이 성공적으로 처리되었습니다.",
    "data_info": { "transaction_id": "20231026100000123456" }
}`

// DataInfo는 중첩된 JSON 객체를 나타내는 구조체입니다.
type DataInfo struct {
	TransactionID string `json:"transaction_id"`
}

// APIResponse는 전체 JSON 응답을 나타내는 구조체입니다.
type APIResponse struct {
	StatusCode    string   `json:"status_code"`
	StatusMessage string   `json:"status_message"`
	Description   string   `json:"description"`
	DataInfo      DataInfo `json:"data_info"`
}

func ParseJSONToStruct() {
	var responseData APIResponse
	
	// JSON 문자열을 바이트 슬라이스로 변환하여 Unmarshal 함수에 전달합니다.
	err := json.Unmarshal([]byte(apiJSONPayload), &responseData)
	if err != nil {
		fmt.Printf("구조체로 JSON 파싱 중 오류 발생: %v\n", err)
		return
	}

	fmt.Println("--- 구조체(Struct)를 이용한 JSON 파싱 ---")
	fmt.Printf("상태 코드: %s\n", responseData.StatusCode)
	fmt.Printf("메시지: %s\n", responseData.StatusMessage)
	fmt.Printf("설명: %s\n", responseData.Description)
	fmt.Printf("트랜잭션 ID: %s\n", responseData.DataInfo.TransactionID)
}

func main() {
	ParseJSONToStruct()
}

interface{}를 이용한 동적 JSON 파싱

만약 파싱하려는 JSON 데이터의 정확한 구조를 미리 알 수 없거나, 유연하게 데이터를 처리해야 할 경우 Go의 빈 인터페이스인 interface{}를 활용할 수 있습니다. json.Unmarshal은 interface{}로 파싱할 때 다음과 같은 Go 기본 타입으로 JSON 값을 변환합니다.

Go 타입과 JSON 타입 매핑

Go 타입 JSON 타입
bool JSON 불리언 (true/false)
float64 JSON 숫자
string JSON 문자열
nil JSON null
[]interface{} JSON 배열
map[string]interface{} JSON 객체

예제 코드: interface{}로 파싱하기

package main

import (
	"encoding/json"
	"fmt"
)

// Example JSON payload
const apiJSONPayloadForInterface = `{
    "status_code": "00",
    "status_message": "SUCCESS",
    "description": "요청이 성공적으로 처리되었습니다.",
    "data_info": { "transaction_id": "20231026100000123456" },
    "additional_items": ["item1", 123, true]
}`

func ParseJSONToInterface() {
	var rawParsedData interface{}

	err := json.Unmarshal([]byte(apiJSONPayloadForInterface), &rawParsedData)
	if err != nil {
		fmt.Printf("interface{}로 JSON 파싱 중 오류 발생: %v\n", err)
		return
	}

	fmt.Println("\n--- interface{}를 이용한 JSON 파싱 ---")

	// 파싱된 데이터는 map[string]interface{} 타입일 것으로 예상됩니다.
	if dataMap, ok := rawParsedData.(map[string]interface{}); ok {
		for key, value := range dataMap {
			switch v := value.(type) {
			case string:
				fmt.Printf("키: %s, 타입: 문자열, 값: %s\n", key, v)
			case float64:
				fmt.Printf("키: %s, 타입: 숫자, 값: %f\n", key, v)
			case bool:
				fmt.Printf("키: %s, 타입: 불리언, 값: %t\n", key, v)
			case []interface{}:
				fmt.Printf("키: %s, 타입: 배열 (요소 수: %d)\n", key, len(v))
				for i, elem := range v {
					fmt.Printf("  -> 인덱스 %d: %v\n", i, elem)
				}
			case map[string]interface{}:
				fmt.Printf("키: %s, 타입: 객체(map)\n", key)
				for subKey, subVal := range v {
					fmt.Printf("  -> 서브 키: %s, 값: %v\n", subKey, subVal)
				}
			default:
				fmt.Printf("키: %s, 타입: 알 수 없음, 값: %v\n", key, v)
			}
		}
	} else {
		fmt.Println("파싱된 최상위 데이터가 map[string]interface{} 형식이 아닙니다.")
	}
}

func main() {
	ParseJSONToStruct()
	ParseJSONToInterface()
}

go-simplejson 라이브러리 활용

encoding/json 패키지는 강력하지만, 복잡하게 중첩된 JSON 구조에서 특정 필드에 접근하거나 유연하게 데이터를 다룰 때 코드가 길어질 수 있습니다. 이때 github.com/bitly/go-simplejson과 같은 서드파티 라이브러리가 유용합니다. 이 라이브러리는 체이닝(chaining) 메서드 호출을 통해 JSON 데이터에 쉽게 접근할 수 있도록 돕습니다.

라이브러리 설치

터미널에서 다음 명령어를 실행하여 go-simplejson 라이브러리를 설치합니다:

go get github.com/bitly/go-simplejson

예제 코드: go-simplejson으로 파싱하기

package main

import (
	"fmt"
	"log"
	"github.com/bitly/go-simplejson" // go get github.com/bitly/go-simplejson
)

// Example JSON payload for simplejson
const apiJSONPayloadForSimpleJSON = `{
    "status_code": "00",
    "status_message": "SUCCESS",
    "description": "요청이 성공적으로 처리되었습니다.",
    "data_info": { "transaction_id": "20231026100000123456" }
}`

func ParseJSONWithSimplejson() {
	// JSON 문자열을 바이트 슬라이스로 변환하여 NewJson 함수에 전달합니다.
	jsonObj, err := simplejson.NewJson([]byte(apiJSONPayloadForSimpleJSON))
	if err != nil {
		log.Fatalf("go-simplejson 객체 생성 중 오류 발생: %v\n", err)
	}

	fmt.Println("\n--- go-simplejson 라이브러리를 이용한 JSON 파싱 ---")

	// Get 메서드를 체이닝하여 중첩된 필드에 접근합니다.
	transactionID, err := jsonObj.Get("data_info").Get("transaction_id").String()
	if err != nil {
		fmt.Printf("트랜잭션 ID 조회 중 오류 발생: %v\n", err)
	} else {
		fmt.Printf("트랜잭션 ID (Get 체이닝): %s\n", transactionID)
	}

	// 최상위 문자열 필드에 접근합니다.
	statusCodeStr, err := jsonObj.Get("status_code").String()
	if err != nil {
		fmt.Printf("상태 코드 (문자열) 조회 중 오류 발생: %v\n", err)
	} else {
		fmt.Printf("상태 코드 (문자열): %s\n", statusCodeStr)
	}

	// 숫자 타입으로 변환을 시도합니다. "00"은 정수로 변환되지 않으므로 오류가 발생합니다.
	statusCodeInt, err := jsonObj.Get("status_code").Int()
	if err != nil {
		fmt.Printf("상태 코드 (정수) 변환 시도: 오류 발생 - %v (기본값: %d)\n", err, statusCodeInt)
	} else {
		fmt.Printf("상태 코드 (정수): %d\n", statusCodeInt)
	}

	// GetPath 메서드를 사용하여 경로를 한 번에 지정할 수 있습니다.
	txnIDWithPath, err := jsonObj.GetPath("data_info", "transaction_id").String()
	if err != nil {
		fmt.Printf("트랜잭션 ID (GetPath) 조회 중 오류 발생: %v\n", err)
	} else {
		fmt.Printf("트랜잭션 ID (GetPath): %s\n", txnIDWithPath)
	}

	// 전체 중첩 객체를 JSON 문자열로 가져올 수도 있습니다.
	dataInfoObject := jsonObj.Get("data_info")
	if dataInfoObject != nil {
		fmt.Printf("data_info 객체 (JSON): %s\n", dataInfoObject.MustString())
	}
}

func main() {
	ParseJSONToStruct()
	ParseJSONToInterface()
	ParseJSONWithSimplejson()
}

go-simplejson 라이브러리의 Get 메서드는 항상 *Json 타입을 반환하며, 이는 포인터로 다음 메서드 호출에 전달됩니다. 덕분에 .Get("key1").Get("key2").String()와 같이 편리하게 메서드를 체이닝하여 깊은 곳에 있는 값에 접근하고 원하는 타입으로 변환할 수 있습니다. String(), Int(), Bool() 등 다양한 타입 변환 메서드를 제공하며, 변환 실패 시에는 오류와 함께 기본값을 반환합니다.

태그: go Golang JSON API Parsing Data Unmarshalling

11월 15일 08:14에 게시됨