[📚정보] [C#]데이터가 바뀌면 UI도 바뀌는 데이터바인딩 코드 공유

[Ms.Yoon..(pianist9736)]

[서론]

안녕?

오늘은 C#에서 초간단 데이터 바인딩 코드를 공유해볼까 해.

Unity 뿐만 아니라 C#을 사용하는 곳이면 어디든 사용 가능함.

이것을 이용하면 데이터가 바뀔 때마다 귀찮게 따로 UI에 값을 설정하거나 호출해주는 번거로움을 제거할 수 있어.

즉, 데이터가 바뀌면 그와 관련된 이벤트들이 자동으로 수행되는거지.

예를 들어서 게임 중에 적을 해쳐서 Score(점수)가 올라갈 때 보통은

Score += 10;

ScoreLabel.text = $"점수: {Score}";

뭐 이런식으로 하잖아?

지금은 큰 문제 없어보이지만 나중에 코드가 길어지고 복잡해지다 보면 결국은 데이터는 데이터대로, UI는 UI대로 관리해야 할 필요성이 생길거야.

그럼 그 때 저 둘을 나누다보면 여러 에로사항이 생겨. Score를 관리하는 A Class와 UI를 관리하는 B Class가 있다면, 이 A Class가 B Class를 참조해서

B b = somewhere.getB();

b.ScoreLabel.text = $"점수: {Score}";

뭐 이런식으로 나누는 의미가 없어질 수도 있다는거지. 결국 똑같이 복잡해지니깐.

여튼 초기에 설정만 잘해 두면 저 두 코드 영역들이 서로 간섭할 필요가 없어지는게 바로 바인딩을 하는 가장 큰 이유가 아닐까 싶어.(뭐 바인딩 말고도 여러 기법들이 있을 수 있겠지만... )

[본론]

데이터 바인딩을 구현하는 방법은 여러가지가 있고, Github에도 관련 라이브러리들이 많이 있어. 나는 데이터가 바뀌면 관련된 이벤트들이 동작하는 간단한 기능만 원했기에 직접 구현해봤어.

C#에서는 이를 위해 문법적으로 delegate 와 event 키워드를 제공하고, 나는 거기에 좀 더 안정성을 추구해서 WeakReference Class도 사용했어.

WeakReference는 약한 참조를 가지기 때문에 GC에 의해 참조하고 있는 객체가 해제되는 특성이 있어서 메모리 누수로부터 안전할 수 있어.

여튼 아래 구현 코드가 있으니깐 CCCV 해서 사용하면 돼.

using System;

using System.Collections.Generic;

using System.Runtime.CompilerServices;

using System.Collections.Immutable;

internal class TGDataBinder<A> : IDisposable, IComparable<TGDataBinder<A>>, IEquatable<TGDataBinder<A>> where A : IComparable<A> {

private sealed class WeakEventManager<T> {

// 등록한 콜백함수가 저장되는 변수

private ImmutableList<WeakReference<Action<T>>> handlers = ImmutableList<WeakReference<Action<T>>>.Empty;

// lambda 함수가 바로 GC 되는 것을 방지하기 위한 장치

private readonly ConditionalWeakTable<object, List<object>> delegateKeepAlive = new();

public void AddHandler(Action<T> handler) {

if (handler == null)

return;

var weakReference = new WeakReference<Action<T>>(handler);

handlers = handlers.Add(weakReference);

if (handler.Target != null) {

delegateKeepAlive.GetOrCreateValue(handler.Target).Add(handler);

}

}

public void RemoveHandler(Action<T> handler) {

if (handler == null)

return;

handlers = handlers.RemoveAll(wr => !wr.TryGetTarget(out var target) || handler.Equals(target));

if (handler.Target != null && delegateKeepAlive.TryGetValue(handler.Target, out var weakReference)) {

weakReference.Remove(handler);

}

}

public void Raise(T data) {

foreach (var maybeHandler in handlers) {

if (maybeHandler.TryGetTarget(out var handler)) {

handler(data);

} else {

handlers = handlers.Remove(maybeHandler);

}

}

}

public void ClearHandlers() {

handlers.Clear();

delegateKeepAlive.Clear();

}

}

private A data;

private readonly WeakEventManager<A> weakEventManager;

// 이 event 프로퍼티를 통해서도 콜백함수 추가 or 삭제 가능

public event Action<A> OnDataChanged {

add => weakEventManager.AddHandler(value);

remove => weakEventManager.RemoveHandler(value);

}

// 실제 관리할 데이터 프로퍼티

public A Data {

get => data;

set {

data = value;

weakEventManager.Raise(data); // <- 이부분이 실제 바인딩 되는 코드

}

}

public TGDataBinder() { weakEventManager = new(); }

// 원하는 콜백 함수를 등록

public void AddHandler(Action<A> handler) {

OnDataChanged += handler;

}

// 수동으로 해제할 때 호출

public void Dispose() {

weakEventManager.ClearHandlers();

}

public int CompareTo(TGDataBinder<A> obj) => Data.CompareTo(obj.Data);

public bool Equals(TGDataBinder<A> other) => Data.Equals(other.Data);

public override int GetHashCode() => Data.GetHashCode();

public override bool Equals(object obj) {

if (!(obj is TGDataBinder<A>)) {

return false;

} else {

return Equals((TGDataBinder<A>)obj);

}

}

public static bool operator >(TGDataBinder<A> n1, TGDataBinder<A> n2) => n1.CompareTo(n2) > 0;

public static bool operator <(TGDataBinder<A> n1, TGDataBinder<A> n2) => n1.CompareTo(n2) < 0;

public static bool operator ==(TGDataBinder<A> n1, TGDataBinder<A> n2) => n1.Equals(n2);

public static bool operator !=(TGDataBinder<A> n1, TGDataBinder<A> n2) => !(n1 == n2);

}

빨간색 글자는 아마 기본 패키지에서 지원 안할 수 있으니 기본 List 자료구조로 바꾸거나 아니면 Nuget 을 통해서 설치하면돼.

파란색 글자는 선택사항이라 원하지 않으면 삭제해도 무방해.

진한 글자는 실제 사용되는 생성자, 프로퍼티, 메소드야. 클래스 이름도 원하는 걸로 바꿔서 사용하면돼.

이제 사용예를 보자.

이렇게 PlayerRepository클래스에 멤버변수로 선언 및 생성해주고,

UIManager클래스에서는 UI Text 변경용 메소드를 작성해주고.

GameManager클래스에서 PlayerRepository와 UIManager를 참조하고 PlayerRepository의 각 변수 내부의 데이터들이 바뀔 때마다 호출해줄 콜백함수들을 UIManager로부터 가져와서 지정해주었어.

PlayerRepository를 참조하고있는 GameManager클래스나 혹은 다른 클래스에서 AddScore같은 메소드를 호출하면, 데이터를 변경함과 동시에 내부적으로 등록된 콜백함수를 호출해서 UI를 변경할거야. 데이터를 변경했다고 해서 UIManager의 SetScore() 메소드를 따로 호출해줄 필요가 없단 소리지.

즉, PlayerRepository와 UIManager는 서로의 관계로부터 분리되었다고 볼 수 있지.

PlayerRepository 와 그 내부에 있는 TGDataBinder 모두 UIManager가 무슨일을 하는지 알 필요가 없다는 소리야. 그저 자신한테 등록된 콜백함수만 호출해주면되니깐. 또한 UIManager도 마찬가지로 외부 데이터들이 어떤식으로 관리되는지 알 필요 없고.

그리고 메모리 누수 검사를 위해 프로파일러로 테스트를 해봤어.

위 스샷은 유니티 Memory Profiler로 TGDataBinder에 강제 부하를 주고 Dispose 시켰을 때 내부적에서 제대로 메모리 해제가 되는지 각각 메모리를 캡쳐 한 후 비교 테스트 해본 결과야.(A는 100001개였을 때 캡쳐한 메모리고, B는 Dispose 후 캡쳐한 메모리야)

생성된 콜백함수가 총 100001인데 이건 TGDataBinder 생성하면서 최초 콜백함수 1개 추가하고, 이후 10만개를 (테스트하고자) 일부러 더 추가했기 때문에 이렇게 표시된거야.

즉, 제대로 동작한다는 걸 알 수 있지. DI에서 메모리 관리를 하면 Release나 Dispose 되는 시점에 같이 Dispose 메소드 호출해주면 되고, 굳이 관리 안하더라도 GC가 호출하는 시점에 해당 DataBinder도 같이 정리될거야.

[결론]

사실 내가 간단하게 사용하려고 만든거다 보니 한계도 존재해.

1. 간단한 동작과 메모리 테스트만 해봤기 때문에 다른 버그가 발생할 위험이 있음.

2. int, float, string 같은 Primitive Type들 위주로 사용할 목적이기 때문에 만약 Data Type이 Class나 Struct 인 경우는 고려해봐야 함.

3. 서론에서 말했다시피 Github나 오픈소스로 더 좋은 라이브러리들이 많이 존재하니깐 더 많은 기능이나 안정성을 원하면 찾아보는 것도 나쁘지 않음.

나는 외부 자료구조를 사용해서 원래 코드는 좀 많이 달랐기 때문에 최대한 의존성없이 범용성있게 수정한다고 시간이 많이 걸렸어.

그리고 글 쓰면서 괜히 글썼나? 생각도 들고... 아까 쓰다가 한번 날려먹어서리 ㅠ.ㅠ 어차피 더 좋은 lib 들도 많은데... 하면서.

질문있으면 댓글주고, 어쨌든 도움이 되었길 바라!

끝!

source:

https://www.meziantou.net/weak-events-in-csharp.htm

[ㅇㅇ 1(112.146)]

rx써라 게이야...

[Ms.YoonHee(pianist9736)]

맞어 RX류도 좋은 선택이지. 필요해지면 쓸지도 모르겠다.

[불타는키보드(1bnmaker)]

오 이거 궁금했는데 ㄱㅅㄱㅅ - dc App