[TIL] C# - Interface , 직렬화 & 역직렬화 (2)

MINO·2024년 4월 26일

2024-04-26

어제 작성한 TIL 과 제출한 개인 프로젝트 과제의 피드백이 왔다.

둘 다 모두 긍정적인 피드백을 주셔서 뿌듯하였다.
TIL 의 피드백 중, 추가적으로 공부해보면 좋은 직렬화 내용을 추천해주셔서
오늘의 TIL 주제로 선정하게 되었다.

TIL 피드백	개인 프로젝트 피드백

다중 상속을 지원하지 않는 이유

다이아몬드 문제
- 한 클래스가 두 개 이상의 부모 클래스로부터 동일한 멤버를 상속 받을 수 있음
- 같은 이름의 멤버를 가지고 있을 때, 어떤 부모 클래스의 멤버를 사용해야 하는지 모호

클래스 간의 관계가 복잡해짐
- 어떤 클래스로부터 어떤 멤버를 상속받을지 결정해야하므로
이름 충돌과 충돌 해결의 어려움
- 여러 부모 클래스로부터 상속받은 멤버들의 이름이 충돌할 수 있음

따라서, C# 은 단일 상속을 통해 설계의 일관성과 단순성을 유지

Interface

동작을 추상화, 클래스에 대한 행동제약을 걸어준다고 생각하자.

사용하는 이유

코드의 재사용성
- 다른 클래스에서 해당 인터페이스를 구현하여 동일한 기능을 공유
다중 상속 제공
- 클래스는 단일 상속, 인터페이스는 다중 상속을 지원
- 클래스가 여러 인터페이스를 구현함으로써 여러 개의 기능을 조합
유연한 설계
- 클래스와 인터페이스 간에 느슨한 결합을 형성
- 클래스는 인터페이스를 구현하기만 하면 됨 -> 유연하고 확장 가능한 설계 가능

특징

클래스가 구현해야 하는 멤버들을 정의
클래스의 일종이 아니며, 클래스에 대한 제약 조건을 명시
클래스가 인터페이스를 구현할 경우, 모든 인터페이스 멤버를 구현해야만 함

코드

유닛의 움직임을 추상화하는 IMovable Interface

public interface IMovable
{
	void Move(int x, int y);
    void Run();
}

public class Marine : IMovable
{
	public void Move(int x,int y)
    {
		Console.WriteLine($"마린이 ({x},{y}) 위치로 이동"); 
	}
    
    public void Run()
    {
    	Console.WriteLine($"마린이 두 발로 달린다.");
    }
}

public class Zergling : IMovable
{
	public void Move(int x,int y)
    {
    	Console.WriteLine($"저글링이 ({x},{y}) 위치로 이동");
	}
    public void Run()
    {
    	Console.WriteLine($"저글링이 네 발로 달린다.");
    }
}

static void Main(string[] args)
{
	IMovable movable1 = new Player();
    IMovable movable2 = new Enemy();
    
    movable1.Move(1,5); // 마린 이동
    movable2.Move(1,5); // 저글링 이동
    
    movable1.Run(); // 마린 달리기
    movable2.Run(); // 저글링 달리기
}

결제 방법을 추상화하는 Ipay Interface

public interface IPay
{
    void Payment(int x);
}

public class Cash : IPay
{
    public void Payment(int x) { }
}

public class Card : IPay
{
    public void Payment(int x) { }
}

public class Customer
{
    public void GetPayment (IPay pay, int money)
    {
        pay.Payment(money);
    }
}
static void Main(string[] args)
{
    Customer customer = new Customer();

    customer.GetPayment(new Cash(),5);
}

아이템에 대한 행동을 추상화하는 IItemPickable, IItemDroppable
(다중상속 Interface 예시)

public interface IItemPickable
{
	void PickUp();
}

public interface IDroppable
{
	void Drop();
}

public class Item : IItemPickable, IDroppable
{
	public string Name {get; set;} // 프로퍼티 활용
    
    public void PickUp()
    {
    	Console.WriteLine($"아이템 {Name} 을 주웠습니다."};
	}
    
    public void Drop()
    {
    	Console.WriteLine($"아이템 {Name} 을 버렸습니다."};
    }
}

public class Player
{
	public void InteractWithItem(IItemPickable item)
    {
    	item.PickUp();
	}
    
    public void DropItem(IDroppable item)
    {
    	item.Drop();
	}
}

static void Main()
{
	Player player = new Player();
    Item item = new Item{ Name = "Sword" };
    
    player.InteractWithItem(item); // 아이템 주울 수 있음
    player.DropItem(item); // 아이템 버릴 수 있음
}

Interface 활용 예시

인터페이스는 협업을 위해 만들어진 기능이라 해도 과언이 아니다.

예를 들어, 스타크래프트 게임 개발자가 되었다고 생각해보자.

테란 , 저그 , 프로토스 의 클래스가 존재하고,
각 종족의 유닛은 공격(A), 이동(M), 정지(S), 순찰(H) 등의 공통 기능과 특수 스킬을 가진다.

종족별, 종족 안의 유닛별로 개발자들끼리 기능 구현을 분업하기 위해서는
종족에 대한 클래스 구현이 끝나야만, 유닛을 담당하는 개발자가 작업을 시작할 수 있다.

그러나, Interface 를 활용하여 공통 기능이나 특수 스킬에 대한 추상적인 동작을 정의하면,
유닛을 담당하는 개발자는 기다릴 필요 없이 유닛에 적합하게 인터페이스를 구현하기만 하면 된다.

시즈 탱크	벌쳐

직렬화에 대한 추가적인 고민

Dictionary 같은 컨테이너들도 직렬화 가능?

지난 [TIL] C# - 직렬화 에서는 클래스 (Player) 를 json 으로 변환할 때, Newtonsoft.json패키지를 설치하였다.

닷넷에서 기본적으로 제공해주는 직렬화 기능은 Json 라이브러리(JsonUtility) 를 통해 수행된다.

Player player = new Player();
// 직렬화
string saveData = JsonUtility.ToJson(player);
File.WriteAllText(path + FILE_NAME, saveData);

// 역직렬화
string loadData = File.ReadAllText(path + FILE_NAME);
player = JsonUtility.FromJson<Player>(loadData)

그러나, JsonUtility 는 Dictionary 로 저장한 데이터를 json 으로 저장하지 못한다.

Newtonsoft.Json 패키지

JsonUtility 가 아닌, Newtonsoft.Json 의 JsonConvert 를 사용하면 Dictionary 도 직렬화할 수 있다.

using System.Collections.Generic; // Dictionary 사용을 위해
using Newtonsoft.Json; // JsonConvert 사용을 위해

Dictioanry<string,Player> dic = new Dictionary<stiring,Player>();

// 직렬화
string saveData = JsonConvert.SerializeObject<Dictionary<string,Player>>,Formatting.Indented);
File.WriteAllText(path + FILE_NAME, saveData);

// 역직렬화
string loadData = File.ReadAllText(path + FILE_NAME);
dic = JsonConvert.DeserializeObject<Dictionary<string, Player>>(loadData);

외부적으로 누군가 json 을 수정한다면?

누군가 세이브 파일을 건드려 부적절한 방법으로 게임을 진행할 수도 있다.
json 파일을 수정하여 Gold 를 9999999 G 로 바꾼다거나, 공격력과 방어력 스탯을 조작할 수 있다는 것이다.

이러한 꼼수의 처리 방법을 도입할 필요가 있어보인다.

( 암호화 전 - playerStatData.json 파일 )

json 파일을 암호화하기

위 이미지로 볼 수 있듯이 유저가 json 파일에 접근할 수 있다면, "gold" : 900 을 99999 로 바꿀 수 있다.

Player 의 멤버 변수명과 할당된 값이 보기 쉽게 표시되어 있기 때문이다.

유저가 임의로 json 파일에 접근하여, 할당된 값을 바꾸지 못하게 하기 위해 암호화를 해주자.

암호화 (데이터 -> 암호)
1-0. 객체를 json 형태의 문자열로 직렬화
1-1. json 형태의 문자열을 암호화
1-2. 암호화한 문자열을 파일에 저장하기
복호화 (암호 -> 데이터)
1-0. 암호화된 문자열을 파일로부터 불러오기
1-1. 암호화된 문자열을 복호화
1-2. json 형태의 복호화된 문자열을 객체로 역직렬화

암호화와 복호화의 순서는 역순

ProtectedData 에 빨간줄이 생성되어, Newtonsoft.Json 패키지를 추가한 것처럼 관련 패키지를 추가해주었다.

주의해야 할 점

using System.Collections.Generic; // Dictionary 사용을 위해
using Newtonsoft.Json; // JsonConvert 사용을 위해
using System.Security.Cryptography; // 암호화, 복호화를 위해

public class ProtectedDataTest // Pro
{
	public static string Protect(string origin)
	{
		var PasswordProtect = Convert.ToBase64String(ProtectedData.Protect(Encoding.UTF8.GetBytes(origin), null, DataProtectionScope.CurrentUser));
			return PasswordProtect;
	}

	public static string Unprotect(string origin)
	{
		var PasswordUnprotect = Encoding.UTF8.GetString(ProtectedData.Unprotect(Convert.FromBase64String(origin), null, DataProtectionScope.CurrentUser));
			return PasswordUnprotect;
	}
}


// static void SaveData() - 직렬화 -> 암호화 -> 파일 저장
string playerJson = JsonConvert.SerializeObject(player, Formatting.Indented);
playerJson = ProtectedDataTest.Protect(playerJson); // 암호화
File.WriteAllText(playerDataPath, playerJson);

// static void LoadDat() - 파일 읽기 -> 복호화 -> 역직렬화 
string playerJson = File.ReadAllText(playerDataPath);
playerJson = ProtectedDataTest.Unprotect(playerJson);
player = JsonConvert.DeserializeObject<Player>(playerJson);