[Unity] JSON

개발단에 가입하여 베르의 게임 개발 유튜브를 후원해주세요!

베르의 게임 개발 유튜브

 

안녕하세요! 여러분들과 함께 게임 개발을 공부하는 베르입니다!

이번에는 유니티에서 JSON을 사용하는 방법에 대해서 알아봅시다.

 

사용 엔진 버전 : 2020.3

 

타임라인

0:00 인트로

0:10 JSON이란?

1:04 JSON 데이터의 기본구조

1:50 JSON 데이터 검사기

2:23 Newtonsoft JSON 라이브러리

3:15 유니티 엔진 .NET 세팅

3:56 오브젝트를 JSON 데이터로

6:50 JSON 데이터를 오브젝트로

7:45 유니티에서 JSON 사용시 주의점

10:11 유니티의 JSONUtility

11:39 Vector3 시리얼라이즈

12:44 모노비헤이비어를 상속받는 클래스의 오브젝트 시리얼라이즈

14:27 JSON 데이터 파일로 저장하기

15:47 파일로 저장한 JSON 데이터 불러오기

16:23 JSON 2 C sharp

17:16 아웃트로

 

[예제]

https://drive.google.com/file/d/1G2e87vkxyG2cFRM0YhUp9mpOATCVBkB1/view?usp=sharing

 

스크립트

인트로

안녕하세요. 여러분들과 함께 게임 개발을 공부하는 베르입니다.

이번 영상에서는 유니티에서 JSON을 사용하는 방법에 대해서 알아보도록 하겠습니다.

JSON이란?

JSON을 사용하는 방법에 대해서 알아보기 전에 JSON이 무엇인지 알아보도록 하겠습니다.

JSON은 웹이나 네트워크에서 서버와 클라이언트 사이에 데이터를 주고 받을 때 사용하는 개방형 표준 포맷입니다.

좀 더 쉽게 말해보자면 어떻게 서버와 클라이언트 사이에 데이터를 주고 받을지에 대한 약속 같은 겁니다.

이 JSON이라는 포맷은 텍스트를 사용하기 때문에 사람이 이해하기 쉽다는 장점을 가지고 있습니다.

그래서 유니티에서도 상당히 많이 사용되며, 네트워크 게임을 개발할 때 게임에 필요한 데이터를 주고 받거나, 게임 진행 상황이나 게임 설정을 저장하는 식으로 사용됩니다.

XML이라는 것도 사용 범위가 거의 일치하지만 XML은 JSON에 비해서 가독성이 떨어지고 데이터를 넣거나 꺼내기 위해서 파싱하는 과정이 까다로운데 반해서, JSON은 XML에 비해서 가독성이 좋고 직렬화와 비직렬화 함수를 통해서 오브젝트에서 JSON 데이터로, JSON 데이터에서 오브젝트로 편하게 변환할 수 있다는 장점이 있습니다.

JSON 데이터의 기본 구조

앞서 말했다시피 JSON 데이터는 텍스트로 구성되며 이런 형태의 구조를 가지고 있습니다.

찬찬히 보시면 아시겠지만 JSON의 데이터는 key와 value의 쌍으로 이루어진 데이터로 저장하는데, items와 같이 배열로 된 데이터 역시 저장이 가능하고 객체 안에 객체를 넣는 것도 가능합니다.

그리고 데이터 내용이 문자열로 되어 있기 때문에 사람이 알아보기 매우 쉽습니다.

JSON 데이터에서 중괄호는 객체를 의미하고, 대괄호는 순서가 있는 배열을 나타냅니다.

그리고 JSON은 정수, 실수, 문자열, 불리언, null 등의 데이터 타입을 지원합니다.

추가로 JSON은 주석을 지원하지 않기 때문에, JSON 파일을 사람이 읽고 수정할 수 있도록 할 계획이라면 key의 이름을 명확하게 정해서 이 값이 무엇을 의미하는지 알려주는게 좋습니다.

JSON 데이터 검사기

이런 JSON의 단점으로는 작은 문법 오류에도 민감하게 반응한다는 점입니다.

중간에 중괄호나 대괄호, 콜론, 쉼표가 하나라도 빠지면 JSON 파일이 깨져버리고 문자열 형태인 JSON 데이터를 원하는 데이터로 변환할 수 없게 됩니다.

이런 문제 때문에 구글에서 JSON 검사기를 검색하면 JSON 데이터가 유효한지 검사해주는 웹 페이지들이 많습니다.

JSON 데이터를 작성하고 난 뒤에는, JSON 데이터 파일의 깨짐으로 인한 버그를 막기 위해서 이런 JSON 검사기로 검사하고 사용하는 것이 좋습니다.

Newtonsoft JSON 라이브러리

그럼 이제 유니티에서 JSON을 사용하는 방법을 알아보겠습니다.

유니티에서 JSON을 사용하는 방법은 여러 가지가 있는데 그 중 첫 번째는 Newtonsoft의 라이브러리를 사용하는 것입니다.

먼저 구글에서 Newtonsoft JSON을 검색하면 첫 페이지에서 Json.NET - Newtonsoft 페이지를 찾을 수 있습니다.

이 페이지에 접속하고 Download 버튼을 누른 뒤 아래 쪽에 있는 Json.NET 버튼을 클릭합니다.

그러면 Newtonsoft의 깃허브 페이지로 이동하게 됩니다.

이 릴리즈 페이지에서 최신 버전의 압축 파일을 다운로드 받아줍니다.

다운로드가 완료된 다음에는 받은 파일의 압축을 해제하고 Bin 폴더로 들어가서 이중에 필요한 .NET 버전을 선택합니다.

보통은 .NET 4.5 버전을 선택하면 됩니다.

여기 있는 DLL 파일을 JSON을 사용할 프로젝트 폴더 안으로 옮겨줍니다.

.NET 4.X 이상 세팅

단, 여기서 놓치지 말아야 할 주의 사항이 있습니다.

우리가 임포트한 DLL은 .NET 4버전 이상에서 사용되는 것인데 기본적으로 설정을 건드리지 않은 유니티 엔진은 .NET 2.0을 사용합니다.

그래서 에디터 상태에서는 DLL이 잘 동작하는데 막상 게임을 빌드하면 DLL이 동작하지 않게 됩니다.

이 문제를 수정하기 위해서는 먼저 상단 메뉴 바에서 [Edit > Project Settings] 항목을 선택해서 프로젝트 세팅 창을 열어줍니다.

그리고 Player 항목을 선택하고 Other Settings 카테고리를 보면 Api Compatibility Level 프로퍼티를 볼 수 있습니다.

이 프로퍼티를 .NET 4.X로 변경해줍니다.

오브젝트를 JSON 데이터로

모든 세팅을 마친 다음에는 본격적으로 Newtonsoft의 라이브러리를 사용해보겠습니다.

먼저 해볼 작업은 C# 클래스를 기본으로 생성된 오브젝트에 담긴 데이터를 JSON 데이터로 변환하는 것입니다.

NewtonsoftJsonExample이라는 이름으로 새 스크립트를 생성하고 스크립트 에디터로 이동합니다.

스크립트에서 Newtonsoft JSON 라이브러리를 사용하기 위해서 스크립트의 상단에 Newtonsoft.Json 네임스페이스를 using 선언해줍니다.

이제 Newtonsoft의 JSON 라이브러리를 사용할 준비가 끝났습니다.

본격적인 테스트 이전에 테스트 용도로 사용할 클래스를 하나 정의하겠습니다.

이 클래스에는 JSON에 담을 수 있는 대부분의 타입을 멤버변수로 하나씩 넣도록 하겠습니다.

int, float, bool, string처럼 가장 기본적인 데이터 타입부터 배열, 리스트, 딕셔너리같은 컨테이너 타입, 그리고 사용자가 직접 정의한 클래스 형식도 한 클래스에 묶어서 JSON 데이터로 만들 수 있습니다.

멤버 변수 선언이 끝난 다음에는 생성자에서 각 값을 자동으로 초기화하게 만들어주고 Print 함수를 만들어서 모든 값을 하나씩 출력하는 코드도 작성해줍니다.

JsonTestClass 작성이 끝난 다음에는 NewtonsoftJsonExample클래스의 Start 함수로 이동합니다.

먼저 JsonTestClass의 오브젝트를 생성해서 JSON 데이터로 만들어보겠습니다.

하나의 오브젝트를 문자열인 JSON 데이터로 만드는 과정은 아주 간단합니다.

JsonConvert의 SerializeObject 함수를 호출해서 오브젝트를 매개변수로 넣어주기만 하면 됩니다.

이 과정을 직렬화라고 부릅니다.

이렇게 JSON 데이터로 바뀐 문자열을 출력하게 만든 뒤 코드를 저장하고 에디터로 돌아가서 테스트해보겠습니다.

에디터로 돌아와서는 새 게임 오브젝트를 하나 만들고 방금 만든 컴포넌트를 붙여줍니다.

그리고 게임을 플레이시켜보면 우리가 만든 JsonTestClass의 오브젝트가 문자열로 바뀐 것을 볼 수 있습니다.

문자열로 바뀐 JSON 데이터를 찬찬히 뜯어보면 우리가 클래스의 멤버 변수로 선언해주고 값으로 넣어준 것들이 제대로 문자열로 바뀌어 담긴 것을 확인할 수 있습니다.

JSON 데이터를 오브젝트로

그럼 이제 반대로 문자열로 된 JSON 데이터를 오브젝트로 변환해보겠습니다.

다시 NewtonsoftJsonExample의 Start 함수로 돌아가서 jTest2 변수를 만들고 JsonConvert의 DeserializeObject 함수를 호출해줍니다.

JSON 데이터를 다시 오브젝트로 바꿀 때는 JSON 데이터를 어떤 오브젝트로 변환하는지 명시적으로 함수에 알려줘야합니다.

만약 JSON 데이터가 가진 구조가 함수에 알려준 클래스의 구조와 다르다면 변환 도중에 에러가 발생하기 때문에 잘 확인하고 진행해야 합니다.

JSON 데이터를 다시 오브젝트로 만든 다음에는 변환 확인을 위해서 jTest2의 Print 함수를 호출해줍니다.

코드 작성이 끝나면 코드를 저장하고 에디터로 돌아갑니다.

그리고 게임을 플레이시켜보면 JSON 데이터로 바뀌었던 jTest1의 내용이 정상적으로 JsonTestClass로 바뀌어서 출력되는 것을 볼 수 있습니다.

유니티에서 JSON 사용시 주의점

이번에는 유니티에서 JSON을 사용할 때 주의해야 할 점을 알아보겠습니다.

에디터에서 TestMono라는 이름으로 C# 스크립트를 생성하고 스크립트를 열어줍니다.

그리고 int 타입 멤버 변수만 하나 만들어주고 NewtonsoftJsonExample스크립트로 이동합니다.

이렇게 새 게임 오브젝트를 생성하고 여기에 TestMono를 붙인 다음, 이 TestMono를 가져와서 JSON 데이터로 변환해서 출력하는 코드를 작성합니다.

이 코드의 기본 의도는 클래스에 들어있는 int 타입의 i를 JSON 데이터로 만들어서 저장하려는 것입니다.

하지만 이 코드를 저장하고 에디터로 돌아가서 플레이해보면 전혀 의도대로 동작하지 않고 JsonSerializationException을 발생시킵니다.

로그를 읽어보면 Self Referencing loop, 즉 자기 참조 루프에 빠진 것을 알 수 있습니다.

이 예외는 gameObject에서 gameObject를 호출할 수 있는 순환구조 때문에 생기는 것인데, 이 문제를 해결할 방법은 있지만, 이후에도 다른 예외가 많이 발생하고 몇몇 문제는 해결책이 없기 때문에 Newtonsoft의 JSON 라이브러리로는 모노비헤이비어를 상속받는 클래스의 오브젝트를 JSON 데이터로 시리얼라이즈할 수는 없습니다.

그렇기 때문에 모노비헤이비어를 상속받는 클래스의 오브젝트를 시리얼라이즈하는 대신에 스크립트가 가지고 있는 프로퍼티 중에서 필요한 프로퍼티를 클래스로 묶어서 해당 클래스만 시리얼라이즈 하거나 뒤에서 설명할 유니티가 기본 제공하는 JsonUtility 기능을 사용해서 시리얼라이즈하는 것을 추천합니다.

다음 문제는 Vector3를 시리얼라이즈 하는 문제입니다.

Vector3 역시 간단한 벡터를 담은 클래스를 만들고 시리얼라이즈 하려고 하면 모노비헤이비어를 상속 받은 클래스의 오브젝트를 시리얼라이즈하려고 할 때처럼 Self Referencing loop 문제가 발생합니다.

이것 역시 Vector3의 프로퍼티인 normalized에서 다시 normalized를 호출할 수 있기 때문에 발생하는 문제입니다.

이 문제를 해결하기 위해서는 이렇게 JsonSerializerSetting 오브젝트를 만들고 ReferenceLoopHandling을 Ignore로 설정하고 시리얼라이즈를 해야합니다.

하지만 이런 식으로 레퍼런스 반복을 무시하게 만들어도 normalized 벡터나 벡터의 길이 등의 불필요한 값들이 시리얼라이즈되기 때문에 쓸데없이 JSON 데이터의 길이나 용량이 늘어나는 문제가 생깁니다.

외부 라이브러리를 이용해서 Vector3에서 좌표 값만을 JSON 데이터로 시리얼라이즈하기를 원한다면 이렇게 별도의 시리얼라이즈용 Vector 클래스를 만들어서 시리얼라이즈해야 할 겁니다.

유니티의 JsonUtility

외부 라이브러리인 Newtonsoft의 Json 라이브러리를 알아보았으니 이제 유니티에서 기본 제공되는 JsonUtility를 알아보겠습니다.

그리고 시리얼라이즈와 디시리얼라이즈에 대해서는 앞에서 다 설명했으니 여기서는 한꺼번에 가겠습니다.

먼저 JsonUtilityExample이라는 이름으로 새 C# 스크립트를 생성합니다.

그리고 아까 전에 만들어둔 JsonTestClass 클래스를 이용해서 오브젝트에서 JSON 데이터로 만들겠습니다.

JsonUtility의 ToJson 함수를 사용하면 됩니다.

반대로 JSON 데이터에서 오브젝트로 만들 때는 JsonUtility의 FromJson 함수를 사용하면 됩니다.

나머지는 전부 동일합니다.

다만 JsonUtility의 단점은 기본적인 데이터 타입과 배열, 리스트에 대한 시리얼라이즈만 지원합니다.

그래서 JSON 데이터로 변경된 결과물을 보면 데이터 내에 딕셔너리와 직접 생성한 클래스가 보이지 않는 것을 알 수 있습니다.

직접 생성한 클래스의 경우에는 [System.Serializable] 어트리뷰트를 붙여줘야만 JSON 데이터로 함께 변환되며, 딕셔너리는 아예 지원하지 않습니다.

때문에 딕셔너리를 시리얼라이즈하려면 외부 라이브러리를 사용해야 합니다.

Vector3 시리얼라이즈

이제 유니티의 JsonUtility가 제공하는 특수 기능을 알아보겠습니다.

앞에서도 보았다시피 외부 라이브러리로는 유니티 내장 클래스를 시리얼라이즈할 때 자기 참조 문제가 발생해서 시리얼라이즈가 제대로 이루어지지 않습니다.

특히 Vector3 타입은 유니티에 내장된 클래스로써 위치나 방향을 표시하는데 자주 쓰입니다

그렇기 때문에 이전에 접속한 캐릭터의 마지막 위치 같은 데이터로 저장될 수 있습니다.

하지만 Vector3는 유니티의 JsonUtility나 유니티의 특성에 맞춘 라이브러리가 아닌 일반 JSON 라이브러리를 사용해서 시리얼라이즈를 하면 normalized 프로퍼티로 인해서 Self Reference loop 문제를 발생시킵니다.

이 문제를 해결해도 저장하려고한 좌표값 외에 벡터의 길이와, 제곱 그리고 정규화된 벡터와 그 길이같은 필요하지 않은 정보를 많이 포함하게 됩니다.

하지만 JsonUtility를 사용해서 앞에서 만든 벡터를 담은 클래스로 테스트 해보면 불필요한 값을 제외하고 필요한 좌표만 저장되는 것을 확인할 수 있습니다.

모노비헤이비어를 상속받는 클래스의 오브젝트 시리얼라이즈

그리고 유니티의 JsonUtility를 사용하면 모노비헤이비어를 상속받는 클래스의 오브젝트 역시 시리얼라이즈가 가능합니다.

앞에서 사용한 TestMono 클래스에 간단하게 Vector3 타입의 멤버 변수를 추가하고 JsonUtilityExample의 Start 함수에서 새 게임 오브젝트를 생성하고 거기에 TestMono 컴포넌트를 붙인 뒤 JsonUtility로 시리얼라이즈하는 코드를 작성합니다.

여기서 주의할 점은 모노비헤이비어를 상속받는 클래스의 오브젝트를 시리얼라이즈 할 때는 클래스가 컴포넌트로 붙어있는 게임 오브젝트가 아니라 GetComponent등으로 직접 가져온 클래스의 오브젝트로 시리얼라이즈해야 합니다.

코드를 저장하고 에디터로 돌아가서 테스트해보면 JsonUtility로 모노비헤이비어를 상속받는 클래스의 오브젝트를 시리얼라이즈 했을 때 문제 없이 깔끔하게 오브젝트가 JSON 데이터로 변환되는 모습을 볼 수 있습니다.

그럼 다시 이 데이터를 오브젝트로 변환해보겠습니다.

코드로 돌아가서 FromJson 함수를 사용해서 디시리얼라이즈하는 코드를 작성하고 테스트합니다.

그러면 이렇게 새로운 인스턴스를 생성하지 못했다고 에러가 발생하고 디시리얼라이즈에 실패합니다.

이 문제를 해결하기 위해서는 FromJson 함수 대신에 FromJsonOvewrite 함수를 사용해야 합니다.

이 함수는 JSON 데이터를 오브젝트로 변환할 때 새로운 오브젝트를 만들지 않고 기존에 있는 오브젝트에 클래스의 변수 값을 덮어씌우는 처리를 합니다.

한 마디로 모노비헤이비어를 상속받는 오브젝트의 JSON 데이터를 다시 오브젝트로 만들려면 같은 형태를 가진 오브젝트를 미리 생성한 뒤에 디시리얼라이즈해야 한다는 뜻입니다.

이 기능을 이용하면 게임 내의 오브젝트를 JSON 데이터로 저장해서 게임 진행 상황을 저장하고 다시 불러와서 게임 진행 상황을 원래대로 세팅하는 세이브&로드 기능을 구현할 수 있습니다.

JSON 데이터 파일로 저장하기

그럼 일종의 세이브 파일을 만들기 위해 JSON 데이터로 변환된 정보를 파일로 저장하는 방법을 알아봅시다.

먼저 JsonSaveLoader라는 이름으로 C# 스크립트를 생성합니다.

스크립트 생성이 완료되고 나면 파일 입출력과 문자열 처리를 하기 위해서 스크립트의 상단에 System.IO 네임스페이스와 System.Text 네임스페이스를 using 선언해줍니다.

그리고 Json 기능을 사용하기 위해서 Newtonsoft.Json 네임스페이스도 using 선언합니다.

그리고 Start 함수에서 파일을 저장할 경로와 파일 이름으로 FileStream을 만들어 줍니다.

보통 json 파일은 .json이라는 확장자를 가집니다.

그 다음 문자열인 JSON 데이터를 Encoding.UTF8의 GetBytes 함수로 byte 배열로 만들어줍니다.

그리고 이렇게 만든 데이터를 fileStream에 써줍니다.

코드 작성을 마친 후에 저장하고 에디터로 돌아가서 플레이해보면 지정한 경로에 json 파일이 생성되고 그 내용이 정상적으로 저장된 모습을 볼 수 있습니다.

파일로 저장한 JSON 데이터 불러오기

그 다음은 이렇게 저장한 json 파일을 읽어 들일 차례입니다.

역시 이번에도 FileStream을 생성하되 이번에는 FileMode를 Open으로 설정합니다.

그리고 생성된 fileStream에서 Read로 데이터를 읽어들인 다음, 읽은 데이터를 반대로 string으로 인코딩 해줍니다.

그 다음에 이 문자열을 디시리얼라이즈 해줍니다.

코드를 저장하고 에디터에서 플레이해보면 정상적으로 파일의 JSON 데이터가 로드되어서 오브젝트로 변환되고 오브젝트의 내용이 로그로 출력되는 것을 볼 수 있습니다.

JSON 2 C Sharp

마지막으로 유용한 사이트를 하나 더 추천해드리겠습니다.

보통 서버 단 작업을 하는 개발자와 협업을 하다보면 보통 주고 받는 데이터 타입을 테이블이나 표로 만들어서 주고 받겠지만, 작업이 빠르게 진행되어야 하는 경우에는 그냥 JSON 데이터로 던지고 클라이언트에서 이 JSON 데이터의 구조만 보고 직접 클래스를 짜야하는 경우도 왕왕 발생합니다.

물론 받은 JSON 데이터를 일일이 분석해서 클래스를 짜도 되겠지만 훨씬 간단하고 원터치로 JSON데이터를 클래스로 만드는 방법이 있습니다.

구글에서 JSON 2 C sharp이라고 검색하면 JSON을 바로 C# 클래스로 변환해주는 사이트들이 나옵니다.

이중에서 적당한 사이트를 골라서 접속하고 JSON 데이터를 입력한 뒤 Convert 버튼을 눌러주면 JSON 데이터 구조를 분석해서 자동으로 C# 클래스로 만들어줍니다.

이 코드를 복사해서 클래스 이름만 원하는 대로 바꿔서 사용하면 됩니다.

아웃트로

이번 영상에서는 유니티에서 JSON을 다루는 방법을 알아보았습니다.

이 강좌는 시청자 여러분들의 시청과 후원으로 제작되었습니다.

이상 베르의 게임 개발 유튜브였습니다. 감사합니다.

 

[유니티 어필리에이트 프로그램]

아래의 링크를 통해 에셋을 구매하시거나 유니티를 구독하시면 수익의 일부가 베르에게 수수료로 지급되어 채널의 운영에 도움이 됩니다.

에셋스토어

Easy 2D, 3D, VR, & AR software for cross-platform development of games and mobile apps. - Unity Store

Create 2D & 3D Experiences With Unity's Game Engine | Unity Pro - Unity Store

[투네이션]

-

[Patreon]

WER's GAME DEVELOP CHANNEL님이 Game making class videos 창작 중 | Patreon

[디스코드 채널]

Join the 베르의 게임 개발 채널 Discord Server!