cmindy / json-parser

JSON 문자열 분석기

JSON

JSON: Java Script Object Notation

• 속성-값 쌍( attribute–value pairs and array data types (or any other serializable value)) 또는 "키-값 쌍"으로 이루어진 데이터 오브젝트를 전달하기 위해 인간이 읽을 수 있는 텍스트를 사용하는 개방형 표준 포맷이다.
• 인터넷에서 자료를 주고 받을 때 그 자료를 표현하는 방법이다.

STEP-1. 단순 List 분석

분석할 JSON 데이터를 입력하세요.
[ 10, "jk", 4, "314", 99, "crong", false ]
총 7개의 데이터 중에 문자열 3개, 숫자 3개, 부울 1개가 포함되어 있습니다.

🏗 전체 구조

• InputView : 입력

• Tokenizer: ,로 입력문자열을 구분
• Parser: 토큰을 JSONValueType 배열에 저장 //JSONValueType: String, Number, Bool 타입
• Converter: 토큰의 타입을 확인해서 해당 타입으로 변환
• TypeCounter: JSONValueType배열에서 타입의 개수를 카운트

• OutputView: 출력

---

STEP-2. Object 분석

분석할 JSON 데이터를 입력하세요.
{ "name" : "MINJI CHO", "alias" : "mindy", "level" : 2, "married" : false }
총 4개의 객체 데이터 중에 문자열 2개, 숫자 1개, 부울 1개가 포함되어 있습니다.

분석할 JSON 데이터를 입력하세요.
[ { "name" : "MINJI CHO", "alias" : "mindy", "level" : 2, "married" : false }, 
{ "name" : "HELLO HI", "alias" : "hi", "level" : 4, "married" : true } ]
총 2개의 배열 데이터 중에 객체 2개가 포함되어 있습니다.

🏗 전체 구조

• InputView : 입력

• JSONValueType: JSON Value가 될 수 있는 타입.

  • typeDescription으로 자신의 타입을 설명
  • TypeCountable: 컨테이너들은 element들의 총 개수와 어떤 value 타입이 각각 몇 개 있는지 알아야 함
  • JSONContainerType: JSONValueType & TypeCountable

• Tokenizer: ws, ,로 입력문자열을 구분 → 토큰화

• Parser: nextToken()으로 다음 토큰을 읽어오면서 JSONContainerType 으로 파싱 //JSONContainerType: Object, Array 타입

  • Object 타입인 경우 parseObject()
    • : 를 기준으로 key, value 로 구분해서 [String: JSONValueType] 으로 생성
  • Array 타입인 경우 parseArray()
    • Object를 만날 경우 parseObject() 한 결과를 [JSONValueType] 배열에 추가
    • 아닌 경우 makeJSONType()으로 [JSONValueType] 배열에 추가

• Converter: 토큰의 타입을 확인해서 해당 타입으로 변환 //String, Number, Bool 타입

• OutputView: 출력

JSON Lexical Structure (simply)

object
	'{' ws '}'
	'{' members '}'

members
	member
	member ',' member

member
	ws string ws ':' ws element

string
	"characters"

array
	'[' ws ']'
	'[' elements ']'

elements
	element
	element ',' element

element
	ws value ws

• JSON 객체 값(value)에 포함될 수 있는 데이터는 문자열(String), 숫자(Number), 부울 true/false(Bool) 만 있다.

• 단, JSON 배열 내부에는 객체가 포함될 수 있다고 가정한다.

Input Format Analysis

'{' ws "characters" ws ':' ws value ',' ws "characters" ws ':' ws value ws '}'
'{' ws "name" ws ':' ws "CHO MINJI" ',' ws "level" ws ':' ws 2 ws '}'

'[' ws '{' ws "characters" ws ':' ws value ',' ws "characters" ws ':' ws value ws '}' ',' ws '{' ws "characters" ws ':' ws value ',' ws "characters" ws ':' ws value ws '}' ws ']'

• ws , , 를 기준으로 JSON value가 구분된다.
  • ws , , 를 기준으로 나눠서 토큰화한다.
• 문자열의 경우 ws, , 가 포함 되어 있을 수 있다.
  • 토큰을 생성할 때, "CHO MINJI" 가 아니라 "CHO , MINJI" 와 같이 오류가 발생할 수 있다.
  • isInString 을 사용하여 " 의 짝이 맞춰질 때 까지 delimiter를 무시하고 한 토큰으로 묶는다.

분석할 JSON 데이터를 입력하세요.
{ "name" : "MINJI CHO", "alias" : "mindy", "level" : 2, "married" : false }

[
"{", 
"\"name\"", ":", "\"MINJI CHO\"", 
"\"alias\"", ":", "\"mindy\"", 
"\"level\"", ":", "2", 
"\"married\"", ":", "false", 
"}"
]

분석할 JSON 데이터를 입력하세요.
[ { "name" : "MINJI CHO", "alias" : "mindy", "level" : 2, "married" : false },{ "name" : "HELLO HI", "alias" : "hi", "level" : 4, "married" : true } ]

[
"[", 
"{",
"\"name\"", ":", "\"MINJI CHO\"", 
"\"alias\"", ":", "\"mindy\"", 
"\"level\"", ":", "2", 
"\"married\"", ":", "false", 
"}", 
"{", 
"\"name\"", ":", "\"HELLO HI\"", 
"\"alias\"", ":", "\"hi\"", 
"\"level\"", ":", "4", 
"\"married\"", ":", "true", 
"}", 
"]"
]

• 배열과 객체를 구분해서 출력해야 한다.
  • 배열 키워드 ([, ]) : LeftSquareBracket, RightSquareBracket
  • 객체 키워드 ({, }): LeftCurlyBracket, RightCurlyBracket
  • 두 컨테이너를 구분하기 위해 Bracket도 Token화 한다.

Dictionary 란?

데이터를 키와 값의 쌍으로 담아두는 컬렉션타입

Dictionary 기본 사용법 정리

subscript(_:default:)

Accesses the value with the given key. If the dictionary doesn’t contain the given key, accesses the provided default value as if the key and default value existed in the dictionary.

지정된 키를 사용하여 값에 액세스한다. 사전에 제공된 키가 딕셔너리에 없을 때도 마치 키와 값이 딕셔너리에 있는 것처럼 지정한 default 값에 접근한다.

var countDescription: [String: Int] {
        var counts: [String: Int] = [:]
        for (key, value) in self {
            counts[value.typeDescription, default: 0] += 1
        }
        return counts
    }

STEP-3. 규칙 검사하기

🏗 추가된 기능

• GrammerChecker: 사용자가 입력한 문자열이 JSON 표준 문법에 맞는지 정규식을 이용해 검사한다.
  • 문법 형식이 일치하면 Parsing을 진행한다.
  • 문법 형식이 일치하지 않으면 "지원하지 않는 형식입니다." 라는 메세지를 띄우고 종료한다.
• 사용한 패턴

let array = "\\[(\\s*(((true|false)|[0-9]+|\"[^\"]+\")|\\{((\\s*\"[^\"]+\"\\s*:\\s*([0-9]+|\"[^\"]+\"|(true|false))*\\s*,?)?\\s*)*\\})?\\s*,?)*\\]"

//"\[(\s*(((true|false)|[0-9]+|\"[^\"]+\")|\{((\s*\"[^\"]+\"\s*:\s*([0-9]+|\"[^\"]+\"|(true|false))*\s*,?)?\s*)*\})?\s*,?)*\]"

let object = "\\{((\\s*\"[^\"]+\"\\s*:\\s*([0-9]+|\"[^\"]+\"|(true|false))*\\s*,?)?\\s*)*\\}"

//"\\{((\\s*\"[^\"]+\"\\s*:\\s*([0-9]+|\"[^\"]+\"|(true|false))*\\s*,?)?\\s*)*\\}"

• Swift 에서는 string interpolation을 사용해서 보기 쉽게 표현

static let object = "\\{((\(keyValue))?\(whiteSpace))*\\}"
static let array = "\\[(\(whiteSpace)\(valueWithObject)?\(whiteSpace),?)*\\]"

Regular Expression

정규 표현식 (regex)은 패턴을 지정하는 문자열 또는 문자 시퀀스이다. 문자열을 검색하기 위해 사용한다.

패턴 매칭을 위해 사용되는 캐릭터 키워드들

• [ and ]
• ( and )
• \
• *
• +
• ?
• { and }
• ^
• $
• .
• | (pipe)
• /

이 키워드들은 정규 표현식의 패턴을 매칭할 때 사용되는 문자들이다. 따라서 캐릭터들을 사용하기 위해서는 \ 백슬래시를 한 번 더 써줘야 한다. 예를 들어서 문장 끝의 마침표를 찾고 싶으면 . 이 아니라 \. 으로 사용해야 한다.

Regex 사용

Capturing Paraenthesis

• 괄호를 사용하면 일치하는 내용을 캡처하고 정규 표현식의 다른 위치에서 참조 할 수 있게 해주기 때문에 "capturing"이라고 한다.
• 3(pm|am) -> "3pm" | "3am"

Character Classes

• [ , ] 대괄호를 사용한다.
• [aeiou] -> "a" | "e" | "i" |"o" | "u"
• [a-f] -> "a" | "b" | "c" | "d" | "e" | "f"
• t[^o] : o를 제외한 것 (==to를 제외한 것)

기타

• .: 모든 것
  • p.p -> "pop", "p@p", "pup", ..
• \w: word-like 캐릭터, 숫자, 문자, 밑줄 포함 (구두점이나 다른 기호들은 포함되어 있지 않음)
• \d: 숫자
• \s: whiteSpace, 공백, 탭, 뉴라인
• \b: word boundary characters, 구두점, 공백 등
  • to\b -> "to", "to the moon", "to!"
  • "tomorrow" (X)
• ^: line의 시작
  • ^Hello -> "Hello there"
• $: line의 끝
  • the end$ -> "It was the end"
• *: 이전에 매치된게 0개 혹은 그 이상
  • 12*3 -> 13, 123, 1223, 122223, 1222222223
• +: 이전에 매치된게 1개 혹은 그 이상
  • 12+3 -> 123, 1223, 122223, 1222222223,
  • 13 (X)
• ?: 있을수도 있고 없을 수도 있음

Swift에서 Regex 패턴 입력하기

백슬래시를 두 번 쓰자.

Objective-C와 Swift는 리터럴 문자열에서 특수 문자를 사용하기 위해서는 (\) 를 사용해서 특수 문자를 이스케이프 시킨다. (백 슬래시 \ 문자로 시작하는 것들). 그러나 백 슬래시 자체도 이스케이프가 필요한 특수 문자이다. 정규 표현식을 만드는 데 사용 되는 패턴도 문자열이기 때문에 String 및 NSRegularExpression으로 작업 할 때 백 슬래시 문자를 이스케이프 처리해야한다. 따라서 표준 regex에서 \. 로 표시되는 것들을 스위프트(또는 Objective-C)에서는 \\. 로 사용해야 한다.

Swift에서 Regex 사용하기

NSRegularExpression 정리

STEP-4. 중첩(Nested) 구조 분석

• JSON 객체 내에 배열이나 객체가 한단계 포함(Nested)된 경우를 지원한다.
• JSON 배열 내에 배열이 한단계 포함(Nested)된 경우도 지원한다.

🏗 수정된 기능

• regex 패턴을 확장시켜 중첩된 경우도 GrammerChecker 에서 검사할 수 있도록 한다.

• 사용한 패턴

  let object = "(\\{((\\s*\"[^\"]+\"\\s*:\\s*((true|false)|[0-9]+|\"[^\"]+\")*\\s*,?)?\\s*)*\\})"
  
  let array = "(\\[(\\s*((true|false)|[0-9]+|\"[^\"]+\")?\\s*,?)*\\])"
  
  let nestedObject = 
  "\\{((\\s*\"[^\"]+\"\\s*:\\s*(((true|false)|[0-9]+|\"[^\"]+\")|(\\{((\\s*\"[^\"]+\"\\s*:\\s*((true|false)|[0-9]+|\"[^\"]+\")*\\s*,?)?\\s*)*\\})|(\\[(\\s*((true|false)|[0-9]+|\"[^\"]+\")?\\s*,?)*\\]))*\\s*,?)?\\s*)*\\}"
  
  let nestedArray = 
  "\\[(\\s*(((true|false)|[0-9]+|\"[^\"]+\")|(\\{((\\s*\"[^\"]+\"\\s*:\\s*((true|false)|[0-9]+|\"[^\"]+\")*\\s*,?)?\\s*)*\\})|(\\[(\\s*((true|false)|[0-9]+|\"[^\"]+\")?\\s*,?)*\\]))?\\s*,?)*\\]"

• swift에서는 string interpolation을 사용해서 보기 쉽게 표현

  static let object = "(\\{((\(keyValue))?\(whiteSpace))*\\})"
          static let array = "(\\[(\(whiteSpace)\(value)?\(whiteSpace),?)*\\])"
          
          static let valueWithContainer = "(\(value)|\(object)|\(array))"
          static let keyValueWithContainer = "\(whiteSpace)\(string)\(whiteSpace):\(whiteSpace)\(valueWithContainer)*\(whiteSpace),?"
          static let nestedObject = "\\{((\(keyValueWithContainer))?\(whiteSpace))*\\}"
          static let nestedArray = "\\[(\(whiteSpace)\(valueWithContainer)?\(whiteSpace),?)*\\]"

Regex Pattern Visualize

• Object

• Array

STEP-5. JSON 문자열 생성

• JSON 배열이나 객체를 스위프트 배열이나 사전으로 바꾼 데이터를 기준으로 JSON 문법 검사 사이트 처럼 출력한다.
• Array는 한 줄로 붙여서 출력한다.
• Array인 경우 Element로 Container가 포함되어 있으면 다음 줄로 내려서 표현한다.
• Object는 key-value를 다음줄로 내려서 표현한다.

🏗 추가된 기능

• JSONValueType 을 확장해서 예쁜 JSON 문자열을 생성한다.
  • Container가 중첩될수록 indent를 늘려가면서 prettyFormat(with indent: Int) -> String 을 재귀적으로 호출한다.
  • prettyFormat()은 value나 element를 JSONContainerType으로 캐스팅한다.
  • 캐스팅이 성공하면 prettyFormat(indent + 1)을 한다.
  • 캐스팅이 실패하면 기본 value나 element를 리턴한다.

---

Reference

https://json.org

https://developer.apple.com/documentation/swift/dictionary/2885650-subscript