📘[Flask] json관련 모듈

Flask JSON관련 모듈

아래 명령어를 코드 맨위에 선언해서 모듈을 가져온다.

import json

get_json()

플라스크에서 기본적으로 제공하는 메서드임.
REST API에서는 POST로 데이터를 전달할 때 json 형태 body를 통해서 파라미터를 전달하는 경우가 많음.
이 때, request.get_json()으로 파이썬 데이터 형식으로 가져올 수 있음.

[예시]

{
  "user_id": "test01",
  "user_name": "테스트01",
}

@user_bp.route('/create', methods=['POST'])
def create():
    print(request.is_json)
    params = request.get_json()
    print(params['user_id'])
    return 'ok'

True
{'user_id': 'test01', 'user_name': '테스트01'}
test01

jsonify()

사용자가 json data를 내보내도록 제공하는 flask의 함수임.
jsonify()는 json response를 보내기 위해 이미 content-type header가 ‘application/json’로 되어 있는 flask.Response() 객체를 리턴한다. jsonify는 json.dump를 사용하기 때문에 아스키 이스케이프 인코딩을 적용.
프론트엔드에서는 다시 이 코드포인트들을 문자열로 변환해야 한다는 문제가 있음.

정리

content-type : application/json

json.dumps(): Python 객체를 json 문자열로 변환

MIME type header를 추가해주어야 하는 encoded string을 리턴하는 메서드임.
flask가 알아서 판단해 response를 자동으로 보내주도록 사용하기 때문에 직접적으로 사용할 수 있다. 다만 reponse header fields는 디폴트(text/html; charset=utf-8)로 처리된다.

정리

content-type : text/html; charset=utf-8

jsonify보다 더 다양한 type을 받을 수 있음.

MIME Type이란?

MIME Type은, “Multipurpose Internet Mail Extensions”의 약자로, 간단히 파일 변환을 뜻한다. 일반적으로 MIME Type은 Type/Subtype의 형태를 가진다.
‘/’문자로 구분된 두 개의 타입으로 파일의 타입을 명시하고, 타입 이름에는 공백이 허용되지 않음.
타입은 카테고리, 서브타입은 개별 혹은 멀티파트 타입이 될 수 있다.

[예시]

타입	설명	서브타입
text	텍스트로 표현되는 모든 문서를 나타내며 인간이 읽을 수 있는 데이터를 의미한다	text/plain, text/html, text/css, text/javascript …
image	텍스트로 표현되는 모든 문서를 나타내며 인간이 읽을 수 있는 데이터를 의미한다	image/jpeg, image/png, image/gif …
application	모든 종류의 바이너리 데이터를 나타냄	application/xml, application/json, application/xhtml+xml, application/pdf …

• 일반적으로 특정 서브타입이 없으면 text/plain으로 사용함.
• 특정 타입이 없는 바이너리 데이터의 경우 application/octet-stream으로 사용함.

json.loads(): json 문자열을 Python 객체로 변환

json.dumps()가 json -> Python 이었다면, json.loads()는 반대로 변환해준다.

어떻게 변환해줄까?
json 형식의 문자열을 입력으로 받아들이고, Python 딕셔너리 자료형으로 변환해줌!
이렇게 문자열을 객체로 변환하는 과정을 역직렬화 라고 한다.

[예시]

import json

json_string = '''{
    "id": 1,
    "username": "Bret"
    }
}'''

assert json_object['id'] == 1
assert json_object['username'] == "Bret"

일반적으로 파일에 저장되어 있는 JSON 문자열을 읽거나, HTTP 요청의 전문(body)을 읽을 때 자주 사용된다.

참고자료

json.loads()
json.dumps()