[📜일지] 세이브 마이그레이션 과정 리펙토링 했음

[익명(hotkey02)]

게임을 만들다보면 수정할 일이 자주 있다

만약 출시 전이라면 이전 버전에서 저장한 세이브 데이터는 신경 쓸 필요 없지만 이미 출시 했다면?

기존 세이브 데이터로도 로딩이 가능하도록 해야 할것이다.
그래서 이전에 만들던 코드에서 세이브 파일 마이그레이션 부분을 들고왔다.

전작은 덱 빌딩 로그라이크라서 세이브 파일의 중요도가 보다 떨어지기 때문에 
해당 세이브를 파기할지 사용할지 여부도 들어가는 can_migration 함수도 있는걸 볼 수 있다.

@abstract

class_name Migration_Base

func migrate(data: Dictionary) -> Dictionary:

data.version = update_version()

return data

@abstract

func update_version() -> String

@abstract

func can_migration() -> bool

# class_name Migration_0_0_1

extends Migration_Base

# PlayerData.base_data.speed_increment 추가됨

func migrate(data: Dictionary) -> Dictionary:

# 0.0.1 -> 0.0.2

data = super.migrate(data)

data.player.base_data.speed_increment = 0.1

return data

func update_version() -> String:

return "0.0.2"

func can_migration() -> bool:

return true

지금 만드는 게임은 방치형 게임으로 아무리 못해도 4시간 이상의 플레이 타임을 보장할건데

이걸 버전 올라갔다고 처음부터 다시 하라고 하면 안된다

일단 마이그레이션 작업 전에 세이브 파일 구조부터 보자

class_name SaveLoadUtils

const SAVE_DIR_PATH := "user://save"

static func save_dict_file(dict: Dictionary, file_name: String) -> void:

if not DirAccess.dir_exists_absolute(SAVE_DIR_PATH):

var error := DirAccess.make_dir_absolute(SAVE_DIR_PATH)

if error != OK:

prints("make_dir_error", file_name, error)

return

var file_path := SAVE_DIR_PATH.path_join(file_name)

var file := FileAccess.open(file_path, FileAccess.WRITE)

if not file:

prints("file_error", file_name, FileAccess.get_open_error())

return

var bytes := var_to_bytes(dict)

file.store_buffer(bytes)

file.close()

static func load_from_file(file_name: String) -> Dictionary:

var file_path := SAVE_DIR_PATH.path_join(file_name)

if not FileAccess.file_exists(file_path):

prints("file_not_found", file_name)

return {}

var file := FileAccess.open(file_path, FileAccess.READ)

if not file:

prints("file_error", file_name, FileAccess.get_open_error())

return {}

var bytes := file.get_buffer(file.get_length())

file.close()

var data: Variant = bytes_to_var(bytes)

if typeof(data) != TYPE_DICTIONARY:

prints("invalid_save_data", file_name)

return {}

return data as Dictionary

지금 프로젝트는 위 코드로 세이브 로드를 담당하고 있다.

모든 데이터를 단일 Dictionary로 변환 후 var_to_bytes 하는 구조이다.
json 을 사용할까 했지만 어짜피 외부에서 열고 수정할 필요도 없고 json이 가지는 특별한 이점도 없어서 이런 구조를 사용했다.

세이브 가능한 모든 데이터는 아래 2가지 함수를 구현하고  GameManager 부터 시작해 to_dict를 호출해 가는 방식이다

func to_dict() -> Dictionary:

static func deserialize(dict: Dictionary) -> T:

그래서 만든 0.0.1 => 0.0.2 로 마이그레이션 하는 코드이다

extends Migration_Base

# GARBAGE_COLLECTION => BUBBLE_DESTROY 으로 변경됨
# 일부 수치 변경함

func migrate(data: Dictionary) -> Dictionary:

# 0.0.1 -> 0.0.2

data = super.migrate(data)

# Enum.Upgrade_Type.CRITICAL_HITBOX = 1163

# Enum.Upgrade_Mod_Target.CORNER_GOLD = 1102

if data.upgrade.upgrades.has(1163) and data.upgrade.upgrades[1163].current_level > 0:

update_value(data, 1102, "critical_hitbox", Enum.Upgrade_Mod_Op.ADD, 400)

...

# Enum.Upgrade_Mod_Target.BUBBLE_GOLD_PER_SECOND = 3008

# Enum.Upgrade_Mod_Target.BUBBLE_DESTROY_GOLD = 3009

update_value(data, 3008, "default_value_placeholder", Enum.Upgrade_Mod_Op.ADD, 0.0)

update_value(data, 3009, "default_value_placeholder", Enum.Upgrade_Mod_Op.ADD, 0.0)

return data

func update_value(data: Dictionary, stat_id: int, id: String, op: Enum.Upgrade_Mod_Op, value: float) -> Dictionary:

var temp_states: Dictionary = data.upgrade.stat_states[stat_id]

for entry_dict in temp_states.get("applied_modifiers", []):

if entry_dict.source_id == id:

entry_dict.value = value

entry_dict.op = op

break

return data

func update_version() -> String:

return "0.0.2"

func can_migration() -> bool:

return true

잘 동작하나 상수 투성이고 
Upgrade_BubbleDestroy 참조가 있어 나중에 어떻게 될지 모르는 단점이 있었다

100% 확률로 나중에 한두개 빼먹어서 의도한 수치가 아닌 잘못된 값이 들어갈 환경이였다.

이런식으로 구현 할 수 밖에 없던게 업그레이드시 중앙 업그레이드 데이터를 직접 변조하는 구조라서
사용자가 이미 구매하였지만 수정된 업그레이드를 적용하려면 이게 최선이였다.

func _on_purchased() -> void:

data.current_value += level_upgrade_amounts[current_level - 1]

GameManager.upgrade.add_stat_modifier(

self,

Enum.Upgrade_Mod_Target.ALL_GOLD,

Enum.Upgrade_Mod_Op.MUL,

level_upgrade_amounts[current_level - 1]

)

이런식으로 _on_purchased에서 수정하는 방식이다

따로 외부 데이터로 뽑았으면 쉽게 가능한데 modifier 말고 다른 동작 할 경우도 있어 하드코딩 했다

그래서 구매시 동작을 수정하였다
먼저 UpgradePurchaseEffectContext를 만들었다

@abstract

class_name UpgradePurchaseEffectContext

extends RefCounted

@abstract

func add_stat_modifier(

source_upgrade: Upgrade_Base,

target: Enum.Upgrade_Mod_Target,

op: Enum.Upgrade_Mod_Op,

value: float

) -> void

그다음 업그래이드 구입시 사용할 UpgradeDataPurchaseEffectContext 를 만들었다 생성자에서 upgrade_data 받아서 쓰는식이다

class_name UpgradeDataPurchaseEffectContext

extends UpgradePurchaseEffectContext

var upgrade_data

func _init(p_upgrade_data) -> void:

upgrade_data = p_upgrade_data

func add_stat_modifier(

source_upgrade: Upgrade_Base,

target: Enum.Upgrade_Mod_Target,

op: Enum.Upgrade_Mod_Op,

value: float

) -> void:

upgrade_data.add_stat_modifier(source_upgrade, target, op, value)

그리고 이건 업그레이드 복구에 사용할거

class_name RawPurchaseEffectContext

extends UpgradePurchaseEffectContext

var modifier_entries_by_target := {}

func add_stat_modifier(

source_upgrade: Upgrade_Base,

target: Enum.Upgrade_Mod_Target,

op: Enum.Upgrade_Mod_Op,

value: float

) -> void:

if value == 0.0:

return

if not modifier_entries_by_target.has(target):

modifier_entries_by_target[target] = []

var modifier_entries: Array = modifier_entries_by_target[target]

for entry_dict in modifier_entries:

if entry_dict["source_id"] == source_upgrade.id and entry_dict["op"] == op:

entry_dict["value"] = float(entry_dict["value"]) + value

return

modifier_entries.append({

"source_id": source_upgrade.id,

"source_name": source_upgrade.upgrade_name,

"op": op,

"value": value,

})

그다음은 구매시 동작을 수정하자

func _apply_purchase_effect(context: UpgradePurchaseEffectContext, level: int) -> void:

data.current_value += level_upgrade_amounts[level - 1]

context.add_stat_modifier(

self,

Enum.Upgrade_Mod_Target.ALL_GOLD,

Enum.Upgrade_Mod_Op.MUL,

level_upgrade_amounts[level - 1]

)

context를 받아서 동작하도록 수정했음
이러면 다른 context를 전달해서 뭐가 수정되었는지 알 수 있다

무조건 구입에만 동작하고 다시 로딩하면 안되는건 이걸 만들어서 돌리기로 했음

func _on_purchased_side_effect() -> void:

pass

그럼 로직을 이런식으로 수정 할 수 있음

Upgrade_BubbleDestroy는 class 이름이 변경된 경우인데 이건 자주 있진 않을것 같아서 그냥 뽑아서 넣는식으로 처리함

extends Migration_Base

func migrate(data: Dictionary) -> Dictionary:

# 0.0.1 -> 0.0.2

data = super.migrate(data)

# Enum.Upgrade_Type.ZERO_PIXEL = 1042

# Enum.Upgrade_Mod_Target.CORNER_GOLD = 1102

if data.upgrade.upgrades.has(1042):

mark_purchase_effect_dirty(data, 1042)

...

# Enum.Upgrade_Type.CRITICAL_HITBOX = 1163

# Enum.Upgrade_Mod_Target.CORNER_GOLD = 1102

if data.upgrade.upgrades.has(1163):

mark_purchase_effect_dirty(data, 1163)

# Enum.Upgrade_Mod_Target.BUBBLE_GOLD_PER_SECOND = 3008

# Enum.Upgrade_Mod_Target.BUBBLE_DESTROY_GOLD = 3009

update_value(data, 3008, "default_value_placeholder", Enum.Upgrade_Mod_Op.ADD, 0.0)

update_value(data, 3009, "default_value_placeholder", Enum.Upgrade_Mod_Op.ADD, 0.0)

return data

func update_version() -> String:

return "0.0.2"

func can_migration() -> bool:

return true

최종적으로 마이그레이션에선 업데이트 된 것들 더티 플래그만 설정하면 
알아서 다시 불러오도록 해서 수치 번경에는 대응 할 수 있도록 하였다

이러면 상수 사용을 줄여서 휴먼에러를 감소시킬 수 있을것이다

혹시 값 잘못 입력하는게 아니라 빼먹는 경우는 마이그레이션 코드 작성을 AI에 위임하는 식으로 해결했다.

git diff 확인하고 알아서 작성해줌

extends Migration_Base

# 분석 범위: f75ece8a24772e0de99864a34e3beb722e0c1706 -> 현재 HEAD/작업 상태

# 변경 요약:

# - FEVER_CHARGE_DURATION(2201)을 FEVER_CHARGE_PER_SECOND(2201) 의미로 전환

func migrate(data: Dictionary) -> Dictionary:

# 0.0.2 -> 0.0.3

data = super.migrate(data)

# Enum.Upgrade_Type.FEVER_TIME = 1122

# Enum.Upgrade_Mod_Target.FEVER_CHARGE_PER_SECOND = 2201

# source_id: fever_time

if data.upgrade.upgrades.has(1122):

mark_purchase_effect_dirty(data, 1122)

...

[엔록(whale0407)]

[211214(tomatoss)]