HOME > android > tips

안드로이드 - JSON을 파싱하는 방법

JSFollow21 Jul 2019

안드로이드에서 JSON(JavaScript Object Notation)을 파싱하는 방법에 대해서 정리하였습니다. JSON은 key-value의 쌍들로 이루어진, 사람이 읽기 쉬운 데이터 코드입니다.

JSON은 Object, Array, Key-Value 형태로 이루어져 있으며 String, Int, Long, Boolean 등의 타입을 지원합니다. JSON에 대한 기본지식을 먼저 설명하고 JSONObject 라이브러리로 JSON을 파싱하는 방법에 대해서 설명하겠습니다.

이 글의 코드는 코틀린으로 작성하였습니다.

JSON에 대해서 자세히 알고 싶으시다면 WIKI-JSON을 참고해주세요.

JSON의 기본 구성

JSON은 Object, Array, Key-Value 형태로 이루어져 있으며 String, Int, Long, Boolean 등의 타입을 지원합니다.

Object

Object{ }(curly brace)로 감싸여 있는 것을 말합니다. 예를들어 아래 JSON 코드는 1개의 Object가 있고 그 Object는 title, url, draft, star라는 4개의 key와 그에 해당하는 value를 갖고 있습니다.

{
  "title": "how to get stroage size",
  "url": "https://codechacha.com/ko/get-free-and-total-size-of-volumes-in-android/",
  "draft": false,
  "star": 10
}

Key-Value

Key-Value는 위의 title을 예로 들면, "title"이 key이고, :다음에 있는 "how to get stroage size"이 value입니다. key는 꼭 "..." 처럼 콜론으로 감싸져야 합니다. value는 String 타입인 경우 "..."으로 표현하고 Boolean이나 Integer는 그냥 쓰면 됩니다.

"title": "how to get stroage size",

Array

Array는 [ ](square bracket)으로 감싸여 있는 것을 말합니다.

아래 JSON 코드에서 key "posts"의 value는 Array입니다. 이 Array는 3개의 Object를 갖고 있습니다.({..}는 Object이기 때문에) Object는 다시 3개의 key와 3개의 value를 갖고 있는 구조입니다.

{
  "posts": [
      {
          "title": "how to get stroage size",
          "url": "https://codechacha.com/ko/get-free-and-total-size-of-volumes-in-android/",
          "draft": false
      },
      {
            "title": "Android Q, Scoped Storage",
            "url": "https://codechacha.com/ko/android-q-scoped-storage/",
            "draft": false
      },
      {
            "title": "How to parse JSON in android",
            "url": "https://codechacha.com/ko/how-to-parse-json-in-android/",
            "draft": true
      }
  ]
}

JSONObject로 JSON 파싱하기

이제 안드로이드에서 기본적으로 제공하는 JSONObject로 JSON을 파싱해보겠습니다. 3개의 다른 형태의 JSON이 있고, 이것들을 파싱하는 코드를 구현하면서 튜토리얼을 진행할 생각입니다.

1. 간단한 Key-Value만 있는 JSON

아래 코드에서 jsonString은 우리가 파싱할 JSON입니다. JSON을 먼저 분석해보면, 1개의 Object가 있고 그 Object는 4개의 key와 value를 갖고 있습니다. 코드를 보면 먼저 최상위의 Object를 가져오고 그 Object에서 알고 있는 Key값으로 Value를 가져왔습니다.

fun jsonKeyValueExample() {
    val jsonString = """
        {
            "title": "how to get stroage size",
            "url": "https://codechacha.com/ko/get-free-and-total-size-of-volumes-in-android/",
            "draft": false,
            "star": 10
        }
    """.trimIndent()

    val jObject = JSONObject(jsonString)
    val title = jObject.getString("title")
    val url = jObject.getString("url")
    val draft = jObject.getBoolean("draft")
    val star = jObject.getInt("star")
    Log.d(TAG, "title: $title")
    Log.d(TAG, "url: $url")
    Log.d(TAG, "draft: $draft")
    Log.d(TAG, "star: $star")
}

좀 더 자세히 설명하면, 아래 코드로 JSON의 최상위 Object를 파싱할 수 있습니다.

val jObject: JSONObject = JSONObject(jsonString)

아래 코드는 JSONObject 객체에서 하위의 key-value를 파싱하는 코드입니다. key와 타입을 알고 있다는 전제하에, String은 JSONObject.getString(), Booelan은 JSONObject.getBoolean(), Int는 JSONObject.getInt()로 value를 가져올 수 있습니다.

val title = jObject.getString("title")
val url = jObject.getString("url")
val draft = jObject.getBoolean("draft")
val star = jObject.getInt("star")

그래서, 코드 실행 결과는 다음과 같습니다.

title: how to get stroage size
url: https://codechacha.com/ko/get-free-and-total-size-of-volumes-in-android/
draft: false
star: 10

2. 하위에 여러 Object가 있는 JSON

이번에 파싱할 JSON은 아래 코드에서 jsonString입니다. 최상위 Object는 하위에 post1과 post2라는 두개의 Object를 갖고 있는 구조입니다. 코드를 보면, 먼저 최상위 Object를 파싱하고, 그 다음 하위의 2개 Object를 파싱합니다. 그리고 위에서 파싱한 것처럼 key와 value를 파싱하였습니다.

fun jsonObjectsExample() {
    val jsonString = """
        {
          "post1": {
              "title": "how to get stroage size",
              "url": "https://codechacha.com/ko/get-free-and-total-size-of-volumes-in-android/",
              "draft": false
          },
          "post2": {
                "title": "Android Q, Scoped Storage",
                "url": "https://codechacha.com/ko/android-q-scoped-storage/",
                "draft": false
          }
        }
    """.trimIndent()

    val jObject = JSONObject(jsonString)
    val post1Object = jObject.getJSONObject("post1")
    Log.d(TAG, post1Object.toString())

    var title = post1Object.getString("title")
    var url = post1Object.getString("url")
    var draft = post1Object.getBoolean("draft")
    Log.d(TAG, "title(post1): $title")
    Log.d(TAG, "url(post1): $url")
    Log.d(TAG, "draft(post1): $draft")

    val post2Object = jObject.getJSONObject("post2")
    Log.d(TAG, post2Object.toString())
    title = post2Object.getString("title")
    url = post2Object.getString("url")
    draft = post2Object.getBoolean("draft")
    Log.d(TAG, "title(post2): $title")
    Log.d(TAG, "url(post2): $url")
    Log.d(TAG, "draft(post2): $draft")
}

좀 더 자세히 설명하면 아래 코드는 최상위 Object를 파싱하고, jObject.getJSONObject(key값)로 하위 Object를 가져왔습니다.

val jObject = JSONObject(jsonString)
val post1Object = jObject.getJSONObject("post1")
Log.d(TAG, post1Object.toString())

post1Object를 로그로 출력해보면 다음과 같이 내부의 모든 key-value를 포함하고 있습니다.

{"title":"how to get stroage size","url":"https:\/\/codechacha.com\/ko\/get-free-and-total-size-of-volumes-in-android\/","draft":false}

아래 코드는 post1Object에서 key-value를 파싱하는 부분입니다.

var title = post1Object.getString("title")
var url = post1Object.getString("url")
var draft = post1Object.getBoolean("draft")

그래서, 실행 결과는 다음과 같습니다.

{"title":"how to get stroage size","url":"https:\/\/codechacha.com\/ko\/get-free-and-total-size-of-volumes-in-android\/","draft":false}
title(post1): how to get stroage size
url(post1): https://codechacha.com/ko/get-free-and-total-size-of-volumes-in-android/
draft(post1): false
{"title":"Android Q, Scoped Storage","url":"https:\/\/codechacha.com\/ko\/android-q-scoped-storage\/","draft":false}
title(post2): Android Q, Scoped Storage
url(post2): https://codechacha.com/ko/android-q-scoped-storage/
draft(post2): false

3. Array가 있는 JSON

이번에 파싱할 JSON은 아래 코드에서 jsonString입니다. 최상위 Object는 1개의 Array를 갖고 있습니다. 그 Array는 3개의 Object를 갖고 있습니다. 아래 코드를 보시면, Array를 가져와서 for문으로 내부의 모든 key-value를 출력하고 있습니다.

fun jsonArrayExample() {
    val jsonString = """
        {
          "posts": [
            {
                "title": "how to get stroage size",
                "url": "https://codechacha.com/ko/get-free-and-total-size-of-volumes-in-android/",
                "draft": false
            },
            {
                  "title": "Android Q, Scoped Storage",
                  "url": "https://codechacha.com/ko/android-q-scoped-storage/",
                  "draft": false
            },
            {
                  "title": "How to parse JSON in android",
                  "url": "https://codechacha.com/ko/how-to-parse-json-in-android/",
                  "draft": true
            }
          ]
        }
    """.trimIndent()

    val jObject = JSONObject(jsonString)
    val jArray = jObject.getJSONArray("posts")

    for (i in 0 until jArray.length()) {
        val obj = jArray.getJSONObject(i)
        val title = obj.getString("title")
        val url = obj.getString("url")
        val draft = obj.getBoolean("draft")
        Log.d(TAG, "title($i): $title")
        Log.d(TAG, "url($i): $url")
        Log.d(TAG, "draft($i): $draft")
    }
}

좀 더 자세히 설명하면, jObject.getJSONArray(key값)은 하위의 Array 객체를 리턴합니다.

val jObject = JSONObject(jsonString)
val jArray = jObject.getJSONArray("posts")

jArray.length()은 Array의 길이를 리턴하며, 이 예제에서는 3을 리턴할 것입니다. for문을 이용하여 모든 객체들을 탐색하면서 내부에 있는 key-value를 파싱하고 있습니다.

for (i in 0 until jArray.length()) {
    val obj = jArray.getJSONObject(i)
    val title = obj.getString("title")
    val url = obj.getString("url")
    val draft = obj.getBoolean("draft")
}

그래서, 실행 결과는 다음과 같습니다.

title(0): how to get stroage size
url(0): https://codechacha.com/ko/get-free-and-total-size-of-volumes-in-android/
draft(0): false
title(1): Android Q, Scoped Storage
url(1): https://codechacha.com/ko/android-q-scoped-storage/
draft(1): false
title(2): How to parse JSON in android
url(2): https://codechacha.com/ko/how-to-parse-json-in-android/
draft(2): true

JSONObject 라이브러리

간단히 JSONObject의 API들을 정리하였습니다.

  • getJSONArray(String name) : 인자로 전달된 key에 대한 Array를 JSONArray 타입으로 리턴
  • getJSONObject(String name) : 인자로 전달된 key에 대한 Object를 JSONObject 타입으로 리턴
  • get(String name) : 인자로 전달된 key에 대한 객체를 Object 타입으로 리턴
  • getString(String name) : 인자로 전달된 key에 대한 객체를 String 타입으로 리턴
  • getInt(String name) : 인자로 전달된 key에 대한 객체를 Int 타입으로 리턴
  • getLong(String name) : 인자로 전달된 key에 대한 객체를 Long 타입으로 리턴
  • getDouble(String name) : 인자로 전달된 key에 대한 객체를 Double 타입으로 리턴
  • getBoolean(String name) : 인자로 전달된 key에 대한 객체를 Boolean 타입으로 리턴

정리

JSON이 무엇으로 구성되었는지 간단히 알아보았고, 3개의 JSON 케이스를 파싱하는 코드를 구현해보았습니다.

참고