YAML ??

🔆 YAML 은 구조를 가진 데이터 표현 양식 의 한 종류이다.

데이터는 다양한 형태로 표현될 수 있는데 일반적으로 사용하는 JSON 이나 XML도 표현 양식의 한 종류이다.

데이터를 형식에 맞춰 사용한는 이유는 데이터를 주고 받을 때 서로 이해하게 하기 위해서 이다.

YAML 은 최근 들어 많이 활용되고 있는 데이터 형식이며, 사람이 읽고 이해하기 쉬운 형태를 가지고 있다. DevOps 직군에서는 다양한 설정 파일들을 YAML 형식으로 작성하는 경우가 많다. 이때 파일 확장자는 .yml 또는 .yaml 을 사용한다.

YAML 문법

1. 데이터 정의

YAML 은 기본적으로 데이터를 정의 할 때, key: value 형태로 데이터를 정의한다. 이 때 콜론 : 뒤에는 키와 값을 구분하기 위해 ❗️반드시 공백문자(whitespace)❗️가 있어야 한다.

사용 가능한 데이터 타입으로는 Number, String, Boolean이 있으며, 문자열(String)에 \n , @ 등의 특수 문자가 포함된 경우에만 따옴표(" ")를 사용하여 작성한다.

#주석
Fruit: Apple
Quantity: 5
Origin: Chungju

그 뿐만 아니라 YAML 파일에서 주석을 작성해야 할 때는 해당 줄의 맨 앞에 # 을 입력한다.

2. Array / Lists

배열이나 리스트 구조의 데이터를 표현하고 싶을 때는 - 을 사용한다. - 는 배열의 한 요소를 가리킨다.

이 때 각 👉 요소들의 순서가 중요한데 아래의 내용에 1번과 2번은 각기 다른 YAML 파일이다.

또한 - 를 이용하요 Array/List 를 표현할 수 도 있지만, 같은 의미로 [ ] 도 사용된다. [ ] 가 사용된 경우, 대괄호 안의 요소가 문자열(String) 라면 " " 를 사용한다.

3. Dictionary / Map

계층 구조를 표현하고 싶은 경우, 기본적으로 2칸 혹은 4칸의 들여쓰기를 사용한다. 들여쓰기를 사용할 때, 각 아이템에 대해서 꼭 같은 수의 공백문자를 사용하여 들여쓰기를 해야한다. 위의 Array/List 형식과는 다르게 요소들의 순서가 중요하지 않다.

Fruits:
    Name: Apple
    Quantity: 5
    Origin: Chungju

Vegetables: 
    Name: Lettuces
    Quantity: 10
    Origin: Daekwan

위의 예시에서 Name, Quantity, Origin 은 같은 수만큼의 들여쓰기를 했기 때문에 같은 계층으로 각각 Fruits 와 Vegetables 에 속한다.

이와 같이 들여쓰기를 통해 어떤 계층에 속하는지 달라지기 때문에 들여쓰기를 주의해야 한다.

4. Advanced

위의 데이터 구조를 섞어서 사용할 수도 있다. 아래의 예시는 Dictionary 구조를 포함하고 있는 배열의 형태를 표현하고 있다. 더불어 YAML로 작성된 것을 JSON 으로 작성한 것과 비교해보면 가독성 면에서 데이터를 쉽게 표현할 수 있는 방법이 무엇인지 알 수 있다.

📍 YAML

Fruits: 
	- Banana:
    	Calories: 105
        Fat: 0.4g
        carbs: 27g
    
    - Grape:
    	Calories: 62
        Fat: 0.3g
        Carbs: 15g

📍 JSON

  "Fruits": [
    {
      "Banana": {
        "Calories": 105,
        "Fat": "0.4g",
        "Carbs": "27g"
      }
    },
    {
      "Grape": {
        "Caloreis": 62,
        "Fat": "0.3g",
        "Carbs": "15g"
      }
    }
  ]
}

5. Multi-lines

값으로 여러 행의 문장을 작성할 때 기본적으로 \n 을 사용한다.

하지만 \n 을 사용하지 않고 |, > 를 사용하여 줄바꿈을 할 수도 있다.

> : 이 문자는 한 줄을 모두 비웠을 때만 줄바꿈으로 인식을 
하고, 그냥 줄바꿈을 할 때에는 공백문자로 인식한다.

| : 이 문자는 모든 줄바꿈을 인식하며, 마지막 문장의 끝도 
마찬가지로 줄바꿈으로 인식한다.

JSON ??

JSON의 탄생

JSON은 JavaScript Object Notation 의 줄임말로, 데이터 교환을 위해 만들어진 객체 형태의 포맷 이다. 네트워크를 통해, 어떤 객체 내용을 다른 프로그램에게 전송한다고 가정할 때 이 객체 내용을 일종의 메신저 혹은 채팅 프로그램에서 쓰는 하나의 메시지라고 한다면, 다음 객체를 어떻게 전송할까?

const message = {
  sender: "김코딩",
  receiver: "박해커",
  message: "해커야 오늘 저녁 같이 먹을래?",
  createdAt: "2021-01-12 10:10:10"
}

메시지 객체가 전송 가능하려면, 메시지를 보내는 발신자와 메시지를 받는 수신자가 같은 프로그램을 사용하거나, 문자열처럼 범용적으로 읽을 수 있는 형태여야 한다.

전송 가능한 조건(transferable condition)

• 수신자(reciever)와 발신자(sender)가 같은 프로그램을 사용.
• 또는, 문자열 처럼 범용적으로 읽을 수 있어야 한다.

객체는 타입 변환을 이용 String 으로 변환할 경우 객체 내용을 포함하지 않는다. JavaScript 에서 객체의 메소드(message.toString()) 나 형변환(String(message)) 을 시도하면, [object object] 라는 결과를 리턴한다.

❓이 문제를 해결하는 방법은 객체를 JSON 형태로 변환하거나 JSON 객체의 형태로 변환하는 방법이다.

• JSON.stringify : Object type을 JSON으로 변환
• JSON.parse : JSON을 Object type으로 변환

let transferableMessage = JSON.stringify(message)
console.log(transferableMessage)  // `{"sender":"김코딩","receiver":"박해커","message":"해커야 오늘 저녁 같이 먹을래?","createdAt":"2021-01-12 10:10:10"}`
console.log(typeof(transferableMessage)) // `string`
            
[코드] message 객체를 JSON으로 변환하는 메소드 
            JSON.stringify

stringify하는 이 과정을 직렬화(serialize)한다고 한다.

JSON 으로 변환된 객체의 타입은 문자열이다. 발신자는 객체를 직렬화한 문자열을 누군가에게 객체의 내용을 보낼 수 있다. 그렇다면 수신자는 이 문자열 메시지를 어떻게 다시 객체의 형태로 만들 수 있을까?

let packet = `{"sender":"김코딩","receiver":"박해커","message":"해커야 오늘 저녁 같이 먹을래?","createdAt":"2021-01-12 10:10:10"}`

let obj = JSON.parse(packet)
console.log(obj)
/*
 * {
 * sender: "김코딩",
 * receiver: "박해커",
 * message: "해커야 오늘 저녁 같이 먹을래?",
 * createdAt: "2021-01-12 10:10:10"
 * }
 */
 console.log(typeof(obj))
 // `object`

[코드] 직렬화된 JSON에 메소드 JSON.parse 를 적용하면 다시 객체의 형태로 변환할 수 있다.

JSON.parse를 적용하는 이 과정을 역직렬화(deserialize)한다고 한다.

이처럼, JSON 은 서로 다른 프로그램 사이에서 데이터를 교환하기 위한 포맷. 그리고 JSON 포맷은 자바스크립트를 포함한 많은 언어에서 범용적으로 사용하는 유명한 포맷이다.

JSON의 기본 규칙

JSON을 얼핏 보기에 자바스크립트의 객체와 별반 다를 바가 없어 보이지만, 자바스크립트의 객체와는 미묘하게 다른 규칙이 있다.