유니티에서 JSON 사용하기(Newtonsoft JSON)
작성 기준 버전 :: 2018.3.1f1
JSON은 웹이나 네트워크에서 서버와 클라이언트 사이에서 데이터를 주고 받을 때 사용하는 개방형 표준 포멧으로, 텍스트를 사용하기 때문에 사람이 이해하기 쉽다는 장점이 있다.
이런 JSON 포멧을 유니티에서도 많이 사용하는 편이다. 네트워크 게임을 개발할 때 게임에 필요한 데이터를 주고 받거나, 게임 진행 상황을 저장하거나, 게임 설정을 저장하는 방식으로도 사용할 수 있다.
유니티에서 XML을 사용하는 것과 사용 범위가 거의 일치하는데, XML은 가독성이 매우 떨어지고 데이터를 넣거나 꺼내기 위해 파싱(Parsing)하는 과정이 까다로운데 반해서, JSON은 XML에 비해서 가독성이 좋고 직렬화(Serialize)와 비직렬화(Deserialize) 함수를 통해서 데이터에서 JSON 데이터로, JSON 데이터에서 데이터로 편하게 변환할 수 있다는 장점을 가지고 있다.
Newtonsoft의 JSON 라이브러리는 다양한 전체 기능을 제공하는 라이브러리로 시리얼라이즈 및 디시리얼라이즈하는 컴팩트한 기능만을 사용하기를 원한다면 유니티 엔진에 내장된 JsonUtility를 사용할 것을 권장한다.
JSON 라이브러리 다운로드 및 프로젝트에 임포트(Download JSON & Import JSON to project)
우선 JSON 라이브러리를 다운로드받기 위해 아래 링크에 접속한다.
그리고 릴리즈된 애셋 중에 원하는 버전의 Json(버전).zip 파일을 다운로드받는다.
다운로드 받은 파일을 압축을 해제하고 폴더를 열어보면 위와 같은 폴더와 파일들이 보일텐데 그 중에서 Bin 폴더를 연다.
Bin 폴더 안에는 사용하는 .NET 버전에 따라 라이브러리 파일들이 폴더에 나눠져 담겨있는데, 일반적으로는 net35 폴더 안에 있는 dll을 사용하면 되지만, 유니티에서 .NET 4.x 기능을 사용하거나 최신 버전의 기능이 필요하다면 net45 폴더 안에 있는 dll을 사용해도 된다. 이번 섹션에서는 간단하게 JSON 사용법을 익힐 것이기 때문에 net35 버전을 사용한다.
net35 폴더 안에서 Newtonsoft.Json.dll 파일을 프로젝트 창에 드래그해서 프로젝트에 포함시킨다.
JSON의 기본구조
기본적인 JSON 데이터의 구조는 다음과 같다.
{
"id":"wergia",
"level":10,
"exp":33.3,
"hp":400,
"items":
[
"Sword",
"Armor",
"Hp Potion",
"Hp Potion",
"Hp Potion"
]
}
JSON의 데이터는 키(Key)와 값(Value) 쌍(Pair)로 이루어진 데이터를 저장하는데, items와 같이 배열로 된 데이터 역시 저장이 가능하고 객체 안에 객체를 넣는 것도 가능하며 위의 데이터 내용이 문자열로 이루어져 있기 때문에 사람이 알아보기가 매우 쉽다.
JSON 데이터에서 { } 는 객체를 의미하고, [ ] 는 순서가 있는 배열을 나타낸다. 그리고 JSON은 정수, 실수, 문자열, 불리언, null 타입의 데이터 타입을 지원한다.
JSON은 주석을 지원하지 않기 때문에, JSON 파일을 사람이 읽고 수정할 수 있도록 할 예정이라면, 키의 이름을 명확하게 정해서 이 값이 무엇을 의미하는지 확실히 표현하는게 좋다.
JSON의 단점은 작은 문법 오류에도 매우 민감하다는 점이다. 중간에 중괄호나 대괄호, 콜론, 쉼표가 하나라도 빠지면 JSON 파일이 깨져버리고 파일을 읽어들일 수 없게 된다. 이런 문제 때문에 구글에서 JSON 검사기를 검색하면 JSON 데이터가 유효한지 검사해주는 웹페이지들이 많다. JSON 데이터를 작성하고 난 뒤에는 JSON 데이터 파일의 깨짐으로 인한 버그를 막기 위해서 이런 JSON 검사기로 검사하고 사용하는 것이 좋다.
유니티에서 JSON 사용하기
JSON에 대해서 간단하게 알아보았으니 이제 유니티에서 JSON을 사용하는 방법에 대해서 알아보자.
기본적인 JSON <-> Object 변환하기
우선 Json 예제를 작성할 JsonExample 클래스를 하나 생성한다.
using System.Collections;
using System.Collections.Generic;
using UnityEngine;
public class JsonExample : MonoBehaviour
{
// Start is called before the first frame update
void Start()
{
}
// Update is called once per frame
void Update()
{
}
}
JSON과 관련된 기능을 사용하기 위해서 상단의 using 지시문 파트에 다음 using 지시문을 추가한다.
using Newtonsoft.Json;
using 지시문을 추가하지 않아도 기능을 사용할 수는 있지만, 그렇게 하면 Newtonsoft.Json 네임스페이스를 계속해서 타이핑해야하기 때문에 using 지시문을 추가한다.
그리고 JSON 데이터와 오브젝트 간에 시리얼라이즈, 디시리얼라이즈 테스트를 위해 다음과 같은 클래스를 정의한다.
public class JTestClass
{
public int i;
public float f;
public bool b;
public string str;
public int[] iArray;
public List<int> iList = new List<int>();
public Dictionary<string, float> fDictionary = new Dictionary<string, float>();
public JTestClass() { }
public JTestClass(bool isSet)
{if (isSet)
{
i = 10;
f = 99.9f;
b = true;
str = "JSON Test String";
iArray = new int[] { 1, 1, 3, 5, 8, 13, 21, 34, 55 };
for (int idx = 0; idx < 5; idx++)
{
iList.Add(2 * idx);
}
fDictionary.Add("PIE", Mathf.PI);
fDictionary.Add("Epsilon", Mathf.Epsilon);
fDictionary.Add("Sqrt(2)", Mathf.Sqrt(2));}
}
public void Print()
{
Debug.Log("i = " + i);
Debug.Log("f = " + f);
Debug.Log("b = " + b);
Debug.Log("str = " + str);
for (int idx = 0; idx < iArray.Length; idx++)
{
Debug.Log(string.Format("iArray[{0}] = {1}", idx, iArray[idx]));
}
for (int idx = 0; idx < iList.Count; idx++)
{
Debug.Log(string.Format("iList[{0}] = {1}", idx, iList[idx]));
}
foreach(var data in fDictionary)
{
Debug.Log(string.Format("iDictionary[{0}] = {1}", data.Key, data.Value));
}
}
}
여러 가지 타입과 배열, 리스트, 딕셔너리를 가지고 있는 클래스이기 때문에 오브젝트를 JSON 데이터로 변환하기에 좋은 클래스이다.
JSON 테스트용 클래스를 모두 작성했으면 JsonExample 클래스에 다음 함수 두 개를 구현한다.
string ObjectToJson(object obj)
{
return JsonConvert.SerializeObject(obj);
}
T JsonToOject<T>(string jsonData)
{
return JsonConvert.DeserializeObject<T>(jsonData);
}
ObjectToJson() 함수는 JsonConvert 클래스의 SerializeObject() 함수를 이용해서 오브젝트를 문자열로 된 JSON 데이터로 변환하여 반환하는 처리를 하고 JsonToObject() 함수는 DeserializeObject() 함수를 이용해서 문자열로 된 JSON 데이터를 받아서 원하는 타입의 객체로 반환하는 처리를 한다.
함수들을 모두 작성했다면 Start() 함수에 우선 ObjectToJson() 함수를 테스트하는 코드를 작성한다.
void Start()
{
JTestClass jtc = new JTestClass(true);
string jsonData = ObjectToJson(jtc);
Debug.Log(jsonData);
}
코드를 저장한 뒤 에디터로 돌아가서 JsonExample을 게임 오브젝트에 붙이고 플레이 버튼을 눌러보면 JTestClass 객체가 JSON 데이터로 변환되어 로그로 출력되는 것을 확인할 수 있다.
그 다음에는 Start() 함수 아래에 JsonToObject() 함수를 테스트하는 다음 코드를 작성한다.
var jtc2 = JsonToOject<JTestClass>(jsonData);
jtc2.Print();
그리고 코드를 저장하고 에디터로 가서 플레이 버튼을 눌러보면 문자열인 JSON 데이터가 JTestClass 객체로 변환되어 정상적으로 작동하는 것을 확인할 수 있다.
JSON 데이터 파일로 저장하고 불러오기
JSON 데이터를 파일로 저장하거나 파일에 저장된 JSON 데이터 파일을 불러올 일이 있을 수 있다. 이번에는 이것에 대해서 배워보자.
우선은 문자열로 만든 JSON 데이터를 파일로 저장하는 코드의 예시는 다음과 같다.
void CreateJsonFile(string createPath, string fileName, string jsonData)
{
FileStream fileStream = new FileStream(string.Format("{0}/{1}.json", createPath, fileName), FileMode.Create);
byte[] data = Encoding.UTF8.GetBytes(jsonData);
fileStream.Write(data, 0, data.Length);
fileStream.Close();
}
CreateJsonFile() 함수를 작성한 뒤 Start() 함수를 아래와 같이 CreateJsonFile() 함수를 호출하도록 수정한다.
void Start()
{
JTestClass jtc = new JTestClass(true);
string jsonData = ObjectToJson(jtc);
CreateJsonFile(Application.dataPath, "JTestClass", jsonData);
}
코드를 저장하고 에디터에서 플레이 해보면 dataPath인 Assets 폴더 안에 JTestClass.json 파일이 생성되고 그 내용이 제대로 쓰여져 있는 것을 확인할 수 있다.
이번에는 방금 저장한 JSON 파일을 읽어들여서 오브젝트로 변환하는 코드를 작성한다. 예시 코드는 아래와 같다.
T LoadJsonFile<T>(string loadPath, string fileName)
{
FileStream fileStream = new FileStream(string.Format("{0}/{1}.json", loadPath, fileName), FileMode.Open);
byte[] data = new byte[fileStream.Length];
fileStream.Read(data, 0, data.Length);
fileStream.Close();
string jsonData = Encoding.UTF8.GetString(data);
return JsonConvert.DeserializeObject<T>(jsonData);
}
LoadJsonFile() 함수를 모두 작성했으면 Start() 함수를 다음과 같이 수정한다.
void Start()
{
var jtc2 = LoadJsonFile<JTestClass>(Application.dataPath, "JTestClass");
jtc2.Print();
}
코드를 저장하고 에디터에서 플레이해보면 정상적으로 파일의 JSON 데이터가 로드되어서 오브젝트로 변환되어 로그가 출력된 것을 확인할 수 있다.
유니티에서 JSON 사용시 주의점
유니티에서 JSON을 사용할 때, 몇가지 주의점이 있다.
우선 유니티에서 클래스를 만들 때, 일반적으로 대다수의 클래스는 모노비헤이비어(Monobehaviour)를 상속받는다.
public class JsonExample : MonoBehaviour
{
void Start()
{
GameObject obj = new GameObject();
obj.AddComponent<TestMono>();
Debug.Log(JsonConvert.SerializeObject(obj.GetComponent<TestMono>()));
}}
위의 예시 코드에 TestMono 클래스는 int 타입 변수 하나를 가지고 모노비헤이비어를 상속받는 클래스이다. 빈 게임 오브젝트에 TestMono 클래스를 컴포넌트로 붙여서 JSON데이터로 시리얼라이즈해서 로그로 출력하는 테스트인데 이를 플레이해서 테스트해보면 아래와 같이 에러가 발생한다.
이 예외는 gameObject에서 gameObject를 호출할 수 있는 순환구조 때문에 생기는 것인데 이것을 해결할 수는 있지만, 이후에도 다른 예외를 많이 발생시키기고 몇몇 문제는 해결책이 없기 때문에 Newtonsoft의 JSON 라이브러리로는 모노비헤이비어를 상속받는 클래스의 오브젝트를 JSON 데이터로 시리얼라이즈할 수는 없다. 그렇기 때문에 모노비헤이비어를 상속받는 클래스의 오브젝트를 시리얼라이즈하는 대신에 스크립트가 가지고 있는 프로퍼티를 클래스로 묶어서 해당 클래스만 시리얼라이즈하거나 유니티가 제공하는 JsonUntility 기능을 사용해서 시리얼라이즈하는 것을 추천한다.
다음은 Vector3를 시리얼라이즈하는 문제인데, Vector3를 그냥 시리얼라이즈 하려고 하면 모노비헤이비어를 시리얼라이즈하려고 할 때처럼 Self referencing loop 문제가 발생한다. 이것은 Vector3의 프로퍼티인 normalized에서 다시 normalized를 호출할 수 있기 때문에 발생하는 문제이다.
public class UJsonTester
{
public Vector3 v3;
public UJsonTester() { }
public UJsonTester(float f)
{
v3 = new Vector3(f, f, f);
}
}
public class JsonExample : MonoBehaviour
{
void Start()
{
JsonSerializerSettings setting = new JsonSerializerSettings(); ;
setting.Formatting = Formatting.Indented;
setting.ReferenceLoopHandling = ReferenceLoopHandling.Ignore;
UJsonTester jt = new UJsonTester(3f);
Debug.Log(JsonConvert.SerializeObject(jt, setting));
}}
이를 해결하기 위해서는 위의 코드처럼 JsonSerializerSetting을 만들어서 ReferenceLoopHandling을 Ignore로 설정하고 시리얼라이즈를 해야한다.
하지만 이런 방식으로 레퍼런스 반복을 무시하게 만들어도 normalized 벡터나 벡터의 길이 등의 불필요한 값들이 시리얼라이즈되기 때문에, 불필요하게 JSON 데이터의 길이가 늘어나는 문제가 발생한다.
public class JVector3
{
[JsonProperty("x")]
public float x;
[JsonProperty("y")]
public float y;
[JsonProperty("z")]
public float z;
public JVector3()
{
x = y = z = 0f;
}
public JVector3(Vector3 v)
{
x = v.x;
y = v.y;
z = v.z;
}
public JVector3(float f)
{
x = y = z = f;
}
}
public class UJsonTester
{
public JVector3 v3;
public UJsonTester() { }
public UJsonTester(float f)
{
v3 = new JVector3(f);
}
public UJsonTester(Vector3 v)
{
v3 = new JVector3(v);
}
}
public class JsonExample : MonoBehaviour
{
void Start()
{
UJsonTester jt = new UJsonTester(transform.position);
Debug.Log(JsonConvert.SerializeObject(jt));
}}
외부 라이브러리를 이용해서 Vector3 중에서 x, y, z 좌표값만을 JSON 데이터로 시리얼라이즈하기를 원한다면 위의 예시 코드와 같이 별도의 시리얼라이즈용 Vector 클래스를 만들어서 시리얼라이즈를 해야한다.
이러한 번거로운 과정이 불편하다면, 유니티가 기본 제공하는 JsonUtility를 혼용해서 사용하는 방법도 있다. 유니티가 제공하는 JsonUtility로 Vector3를 시리얼라이즈하면 x, y, z 좌표값만을 JSON 데이터로 변환한다.
[유니티 어필리에이트 프로그램]
아래의 링크를 통해 에셋을 구매하시거나 유니티를 구독하시면 수익의 일부가 베르에게 수수료로 지급되어 채널의 운영에 도움이 됩니다.
에셋스토어
여러분의 작업에 필요한 베스트 에셋을 찾아보세요. 유니티 에셋스토어가 2D, 3D 모델, SDK, 템플릿, 툴 등 여러분의 콘텐츠 제작에 날개를 달아줄 다양한 에셋을 제공합니다.
assetstore.unity.com
Easy 2D, 3D, VR, & AR software for cross-platform development of games and mobile apps. - Unity Store
Have a 2D, 3D, VR, or AR project that needs cross-platform functionality? We can help. Take a look at the easy-to-use Unity Plus real-time dev platform!
store.unity.com
Create 2D & 3D Experiences With Unity's Game Engine | Unity Pro - Unity Store
Unity Pro software is a real-time 3D platform for teams who want to design cross-platform, 2D, 3D, VR, AR & mobile experiences with a full suite of advanced tools.
store.unity.com
[투네이션]
-
toon.at
[Patreon]
WER's GAME DEVELOP CHANNEL님이 Game making class videos 창작 중 | Patreon
WER's GAME DEVELOP CHANNEL의 후원자가 되어보세요. 아티스트와 크리에이터를 위한 세계 최대의 멤버십 플랫폼에서 멤버십 전용 콘텐츠와 체험을 즐길 수 있습니다.
www.patreon.com
[디스코드 채널]
Join the 베르의 게임 개발 채널 Discord Server!
Check out the 베르의 게임 개발 채널 community on Discord - hang out with 399 other members and enjoy free voice and text chat.
discord.com
'Unity3D > Programming' 카테고리의 다른 글
| [Unity3D] Programming - static 키워드를 파일 경로와 URL 표현에 사용하기 (0) | 2019.10.20 |
|---|---|
| [Unity3D] 당신을 고통에 빠뜨릴 문제 (1) - 코루틴과 Instantiate 그리고 Start (0) | 2019.03.14 |
| [Unity3D] 유니티에서 JSON 사용하기(Unity JSON Utility) (11) | 2019.01.24 |
| [Unity3D] 로그(Log) 출력시 스택 트레이스(Stack trace) 관리하기 (0) | 2018.10.15 |
| [Unity3D] Input - 마우스 입력 총정리 (2017.3.0f3) (0) | 2018.09.21 |