💾유니티 - JSON 파일로 게임 저장하기 1-2 (저장 기능 만들어보기)

지난 글에서 JSON 형식에 대해 알아보았다.
이번에는 본격적으로 JSON 파일을 이용해서 게임 저장 기능을 만들어보자. 코드만 참고하고 싶으면 맨 밑으로 내리면 된다.

---

1. JSON으로 저장할 데이터는?

일단 저장기능을 구현하기 전에, 우리는 무슨 데이터를 JSON으로 저장해야할까? 데이터야 여러가지가 있지만 보통 다음과 같은 예시가 있을 것이다.

플레이어의 정보, 게임 설정, 현재까지의 진행 상황...

이제 우린 이런 데이터들을 JSON 형식으로 저장해야한다. 앞선 글에서 나왔던 것처럼, JSON 파일은 키와 값 쌍의 형태로 이뤄져 있다는걸 기억하자. 위의 예시에서 언급된 데이터를 JSON으로 나타낸다면 다음과 같이 나타낼 수 있다.

{
  "player": {
    "name": "Player1",
    "level": 5,
    "items": ["sword", "shield"],
    "currentStage": {
      "id": 3,
      "name": "Forest of Shadows",
      "progress": 45
    },
    "clearedStages": [
      {
        "id": 1,
        "name": "Plains of Beginning",
        "time": "00:12:34"
      },
      {
        "id": 2,
        "name": "Cave of Echoes",
        "time": "00:24:56"
      }
    ]
  },
  "settings": {
    "volume": 70,
    "difficulty": "normal"
  }
}

이외에도 다양한 데이터들이 포함될 수도 있다.

---

2. JSON으로 데이터 저장하기

자, 어떻게 데이터를 JSON 형식으로 저장할지도 고민해봤으니 이제 JSON으로 데이터를 저장해보자.

먼저 우리는 파일을 저장할 위치를 정해야한다. 파일을 아무런 위치에다 저장해놓으면 나중에 찾기도 힘들고 관리하기도 버겁다.

이럴 때를 위해 유니티에서 제공하는 경로인 Application.persistentDataPath 가 있다.

이 프로퍼티는 각 플랫폼 별로 적절한 디렉터리를 제공하기에 번거롭게 경로를 일일히 정해줄 필요가 없다.

• Windows: C:\Users\<사용자이름>\AppData\LocalLow\<회사이름>\<프로젝트이름>
• macOS: ~/Library/Application Support/<회사이름>/<프로젝트이름>
• Android: /data/data/<패키지이름>/files
• iOS: <앱 샌드박스 디렉토리>/Documents

만약 실제 경로가 맞는지 확인하려면 아래의 코드를 실행시켜보면 된다.

Debug.Log("Save Path: " + Application.persistentDataPath);

그리고 사용자가 앱을 삭제하지 않는 한 데이터는 영구적으로 유지되기에 사용자의 데이터를 저장하기에 적합하다.

다만 파일 변조가 가능하기에, 중요하거나 개인적인 정보를 암호화하지 않은 상태로 Application.persistentDataPath 에 저장하는 것은 추천되지 않는다.

🤔 dataPath? // streamingAssetsPath?

Application 클래스의 프로퍼티를 살펴보면, 경로에 대한 여러 프로퍼티를 찾을 수 있다.

이중에서 몇 가지만 살펴보면

---

• Application.dataPath
  • 에디터 상에선 유니티 프로젝트의 Assets 폴더 경로를,
    빌드된 앱에선 앱의 Data 폴더 경로를 반환.
  • 읽기 전용
  • 이 프로퍼티를 통해 게임 데이터를 저장하면 안됨.

Asset 폴더 안의 내용은 빌드 시, 특정 형식으로 패키징 되기에 경로 기반 접근이 불가능하다.
다만 Resources 폴더에 접근할 때는 아래 예시처럼 경로 기반이 아닌 Resources.Load 를 사용해 접근할 수 있다.
그리고 밑에서 얘기할 StreamingAssets 폴더의 경우에만 예외적으로 경로 기반 접근이 가능하다.

// Resources/myFile.txt 파일을 읽기
TextAsset textAsset = Resources.Load<TextAsset>("myFile"); // 확장자 제외

---

• Application.streamingAssetsPath
  • StreamingAssets 폴더의 경로 반환
  • StreamingAssets 폴더는 해당 내용 그대로 패키징 되기에 빌드 후에도 경로 기반 접근이 가능
  • 읽기 전용

---

이 외에도 임시적인 캐시 파일을 저장하는 경로인, Application.temporaryCachePath

콘솔 로그에 대한 경로를 반환하는,
Application.consoleLogPath 가 있다.

3. JSON 직렬화(Serialization)

자 이제 게임 데이터를 JSON으로 변환해보자. UNITY는 이런 직렬화 과정을 위해 JsonUtility를 기본적으로 제공하며, 이 외의 다양한 기능이 필요할 경우 Newtonsoft의 JSON 라이브러리를 사용할 수도 있다.

우리는 유니티에서 기본적으로 제공하는 JsonUtility를 통해서 직렬화를 해보자.

먼저 게임 데이터를 저장해주는 클래스를 만들자.

[System.Serializable] // 직렬화를 하겠다는 어트리뷰트(Attribute)
public class PlayerData
{
    public string name;
    public int level;
    public string[] items;
}

이제 SaveManager 스크립트를 만들어주고 다음과 같이 적어주자.

using System.IO;
using UnityEngine;

public class SaveManager : MonoBehaviour
{
    public void SaveData(PlayerData data)
    {
        // 경로 설정
        string path = Path.Combine(Application.persistentDataPath, "playerData.json");

        // JSON으로 직렬화
        string jsonData = JsonUtility.ToJson(data, true); // true는 읽기 쉽게 포맷팅
        Debug.Log("JSON Data : \n" + jsonData);

        // 파일로 저장
        File.WriteAllText(path, jsonData);

        Debug.Log("Data saved to " + path);
    }
}

• Path.Combine : 두 개 이상의 문자열을 매개변수로 받고 올바른 디렉터리 경로를 반환.
• JsonUtility.ToJson : 매개변수로 직렬화할 객체를 받고, 만약 두 번째 매개변수에 true 넣는다면 읽기 쉽게 변환.
• File.WriteAllText : 해당 경로에 텍스트 파일을 저장.

이제 아래의 예제를 실행시켜보고 방금 얘기한 디렉터리를 살펴보면 파일이 생성된걸 확인할 수 있다.

using System.Collections;
using System.Collections.Generic;
using UnityEngine;

public class TestJson : MonoBehaviour
{
    void Start()
    {
        PlayerData player = new PlayerData // 데이터 객체 생성
        {
            name = "Player1",
            level = 5,
            items = new string[] { "sword", "shield" }
        };

        SaveManager saveManager = new SaveManager(); // SaveManager 객체 생성
        saveManager.SaveData(player); // 세이브 시작
    }
}

JSON 파일로 직렬화 된 모습

파일이 저장된 위치

저장된 파일과 내용

---

4. 오류 케이스 처리하기

이걸로 저장 기능을 구현했다! 하지만 이 코드는 파일 저장 과정에서 생길 수 있는 오류를 처리하지 못한다. 마지막으로 예외 처리 로직까지 짜보자.

---

1. 파일 경로 체크
   • 만약 저장할 경로가 존재하지 않을 때 문제가 발생할 수 있다.
   • 다음의 코드를 통해, 파일의 경로가 존재하는지 체크하고 만약 존재하지 않는다면 디렉터리를 생성하게 할 수 있다.

if (!Directory.Exists(Application.persistentDataPath))
{
    Directory.CreateDirectory(Application.persistentDataPath);
}

• Directory.CreateDirectory : 매개변수로 넣은 경로를 생성

---

2. 예외 처리
   • try-catch 문으로 저장 과정 중에 예상치 못하게 생기는 오류를 확인할 수 있다.

try
{
    File.WriteAllText(path, jsonData);
    Debug.Log("Data saved successfully.");
}
catch (Exception e)
{
    Debug.LogError("Failed to save data: " + e.Message);
}

---

이 예외 처리를 포함한 전체적인 저장 코드는 다음과 같다.

public class SaveManager : MonoBehaviour
{
    public void SaveData(PlayerData data)
    {
    	// 저장 경로 설정
        string path = Path.Combine(Application.persistentDataPath, "playerData.json");

        try
        {
            // JSON 직렬화
            string jsonData = JsonUtility.ToJson(data, true);
        	Debug.Log("JSON Data : \n" + jsonData);
        
            // 경로 확인 및 생성
            if (!Directory.Exists(Application.persistentDataPath))
            {
                Directory.CreateDirectory(Application.persistentDataPath);
            }

            // JSON 데이터 저장
            File.WriteAllText(path, jsonData);
            Debug.Log("Data saved to " + path);
        }
        catch (Exception e)
        {
            Debug.LogError("Failed to save data: " + e.Message);
        }
    }
}

---

이렇게 해서 저장 기능을 구현해봤다.
다음 글에선 이 저장한 파일을 어떻게 불러와야 하는지 알아보자.