[Unreal] 델리게이트

🌟 강한 결합

• 클래스들이 서로 의존성을 가지는 경우
• Card가 없는 경우 Person이 만들어질 수 없는 경우 👉 이 때 Person은 Card에 대한 의존성을 가진다고 한다.
• 핸드폰에서도 인증할 수 있는 새로운 카드가 도입된다면?

🌟 느슨한 결합

• 실물에 의존하지 말고 추상적 설계에 의존하라 (DIP 원칙)
• 왜 Person은 Card가 필요한가? 출입을 확인해야 하기 때문
• 출입에 관련된 추상적인 설계에 의존하자.
• ICheck를 상속받은 새로운 카드 인터페이스를 선언해 해결
• 이러한 느슨한 결합 구조는 유지 보수를 손쉽게 해줌

---

🟩 느슨한 결합의 간편한 구현 - 델리게이트

함수를 오브젝트처럼 관리하면 어떨까?

 

🌟 함수를 다루는 방법

• 함수 포인터를 활용한 콜백 함수 구현
• 가능은 하나 이를 정의하고 사용하는 과정이 꽤나 복잡함
• 안정성을 스스로 검증해주어야 함
• C++17 std::bind와 std::function 활용은 느림

🌟 C#의 델리게이트 키워드

• 함수를 마치 객체처럼 다룰 수 있음
• 안정적이고 간편한선언

👉 언리얼 C++도 델리게이트를 지원함. 느슨한 결합 구조를 간편하고 안정적으로 구현할 수 있음

---

🟩 발행 구독 디자인 패턴

푸시 형태의 알림을 구현하는데 적합한 디자인 패턴

🌟 발행자와 구독자로 구분

• 콘텐츠 제작자 : 콘텐츠 생성
• 발행자 : 콘텐츠 배포
• 구독자 : 배포된 콘텐츠를 받아 소비
• 제작자와 구독자가 서로를 몰라도, 발행자를 통해 콘텐츠를 생산하고 전달할 수 있다(느슨한 결합)

🌟 발행 구독 디자인 패턴의 장점

• 제작자와 구독자는 서로를 모르기 때문에 느슨한 결합으로 구성된다.
• 유지 보수가 쉽고, 유연하게 활용될 수 있으며, 테스트가 쉬워진다.
• 시스템 스케일을 유연하게 조절할 수 있으며, 기능 확장이 용이하다.

---

🟩 예제

학교에서 진행하는 온라인 수업 활동 예시

1. 학사정보(CourseInfo)와 학생

- 학교는 학사 정보를  관리한다.

- 학사 정보가 변경되면 자동으로 학생에게 알려준다.

- 학생은 학사 정보의 알림 구독을 해지할 수 있다.

 

2. 시나리오

- 학사 정보와 3명의 학생이 있다.

- 시스템에서 학사 정보를 변경한다.

- 학사 정보가 변경되면 알림 구독한 학생들에게 변경 내용을 자동으로 전달한다.

---

🟩 언리얼 델리게이트 선언 시 고려사항

1. 어떤 데이터를 전달하고 받을 것인가? 인자의 수와 각각의 타입을 설계

- 몇 개의 인자로 전달할 것인지 / 어떤 방식으로 전달할 것인지 / 일대일로 전달 / 일대다로 전달

 

2. 프로그래밍 환경 설정

- C++ 프로그래밍에서만 사용할 것인지

- UFUNCTION으로 지정된 블루프린트 함수와 사용할 것인지

 

3. 어떤 함수와 연결할 것인지

- 클래스 외부에  설계된 C++ 함수와 연결

- 전역에 설계된 정적 함수와 연결

- 언리얼 오브젝트 멤버 함수와 연결 (대부분의 경우에 이 방식을 사용)

---

🟩 언리얼 델레게이트 선언 매크로

DECLARE_{델리게이트 유형} DELEGATE{함수정보}

 

1. 델리게이트 유형 : 어떤 유형의 델리게이트인지 구상한다.

- 일대일 형태로 C++만 지원한다면 유형은 공란 👉 DECLARE_DELEGATE

- 일대다 형태로 C++만 지원한다면 MULTICAST👉 DECLARE_MULTICAST

- 일대일 형태로 블루프린트를 지원한다면 DYNAMIC 👉 DECLARE_DYNAMIC

- 일대다 형태로 블루프린트를 지원한다면 DYNAMIC, MULTICAST 👉 DECLARE_DYNAMIC_MULTICAST

 

2. 함수 정보 : 연동될 함수 형태를 지정한다. (예시들)

- 인자가 없고 반환값도 없으면 공란 👉 DECLARE_DELEGATE

- 인자가 하나고 반환값이 없으면 OneParam으로 지정 👉 DECLARE_DELEGATE_OneParam

- 인자가 3개고 반환값이 있으면 RetVal_ThreeParams로 지정한다 👉 DECLARE_DELEGATE_RetVal_ThreeParams (MULTICAST는 반환값을 지원하지 않음)

- 최대 9개까지 지원함

 

(EX) 매크로 선정 예시

1. 학사 정보가 변경되면 알림 주체와 내용을 학생에게 전달한다. 👉 2개의 인자를 가짐

2. 변경된 학사 정보는 다수 인원을 대상으로 발송한다. 👉 MULTICAST 사용

3. 오직 C++ 프로그래밍에서만 사용한다. 👉 DYNAMIC 사용하지 않음

 

👉 DECLARE_MULTICAST_DELEGATE_TwoParams 매크로 사용

---

🟩 언리얼 델리게이트의 설계

학사 정보 클래스와 학생 클래스의 상호 의존성을 최대한 없앤다.

- 하나의 클래스는 하나의 작업에만 집중하도록 설계

- 학사 정보 클래스는 델리게이트를 선언하고 알림에만 집중

- 학생 클래스는 알림을 수신하는데만 집중

- 직원도 알림을 받을 수 있도록 유연하게 설계

- 학사 정보와 학생은 서로 헤더를 참조하지 않도록 신경쓸 것

 

👉 이를 위해 발행과 구독을 컨트롤하는 주체를 설정

학사 정보에서 선언한 델리게이트를 중심으로 구독과 알림을 컨트롤하는 주체 설정 = MyGameInstance

---

🟩 예제 코드

🌟 CourseInfo(h, cpp) : 학사 정

// Fill out your copyright notice in the Description page of Project Settings.

#pragma once

#include "CoreMinimal.h"
#include "UObject/NoExportTypes.h"
#include "CourseInfo.generated.h"

DECLARE_MULTICAST_DELEGATE_TwoParams(FCourseInfoOnChangedSignature, const FString&, const FString&);

/**
 * 
 */
UCLASS()
class UNREALDELEGATE_API UCourseInfo : public UObject
{
	GENERATED_BODY()
	
public:
	UCourseInfo();

	FCourseInfoOnChangedSignature OnChanged;

	void ChangeCourseInfo(const FString& InSchoolName, const FString& InNewContents);

private:
	FString Contents;

};

// Fill out your copyright notice in the Description page of Project Settings.


#include "CourseInfo.h"

UCourseInfo::UCourseInfo()
{
	Contents = TEXT("기존 학사 정보");
}

void UCourseInfo::ChangeCourseInfo(const FString& InSchoolName, const FString& InNewContents)
{
	Contents = InNewContents;
	UE_LOG(LogTemp, Log, TEXT("[CourseInfo] 학사 정보가 변경되어 알림을 발송합니다."));
	OnChanged.Broadcast(InSchoolName, Contents);
}

 

🌟 MyGameInstance (h, cpp) : 학사 정보와 학생을 연결

// Fill out your copyright notice in the Description page of Project Settings.

#pragma once

#include "CoreMinimal.h"
#include "Engine/GameInstance.h"
#include "MyGameInstance.generated.h"

/**
 * 
 */
UCLASS()
class UNREALDELEGATE_API UMyGameInstance : public UGameInstance
{
	GENERATED_BODY()
	
public:
	UMyGameInstance();
	virtual void Init() override;

private:
	UPROPERTY()
	TObjectPtr<class UCourseInfo> CourseInfo;

	UPROPERTY();
	FString SchoolName;
};

// Fill out your copyright notice in the Description page of Project Settings.

#include "MyGameInstance.h"
#include "Student.h"
#include "Teacher.h"
#include "Staff.h"
#include "Card.h"
#include "CourseInfo.h"

UMyGameInstance::UMyGameInstance()
{
	SchoolName = TEXT("학교");
}

void UMyGameInstance::Init()
{
	Super::Init();

	CourseInfo = NewObject<UCourseInfo>(this);

	UE_LOG(LogTemp, Log, TEXT("=========="));
	
	UStudent* Student1 = NewObject<UStudent>();
	Student1->SetName(TEXT("학생1"));
	UStudent* Student2 = NewObject<UStudent>();
	Student2->SetName(TEXT("학생2"));
	UStudent* Student3 = NewObject<UStudent>();
	Student3->SetName(TEXT("학생3"));

	CourseInfo->OnChanged.AddUObject(Student1, &UStudent::GetNotification);
	CourseInfo->OnChanged.AddUObject(Student2, &UStudent::GetNotification);
	CourseInfo->OnChanged.AddUObject(Student3, &UStudent::GetNotification);

	CourseInfo->ChangeCourseInfo(SchoolName, TEXT("변경된 학사 정보"));

	UE_LOG(LogTemp, Log, TEXT("=========="));
}

🌟 Student(h, cpp)

// Fill out your copyright notice in the Description page of Project Settings.

#pragma once

#include "CoreMinimal.h"
#include "Person.h"
#include "LessonInterface.h"
#include "Student.generated.h"

/**
 * 
 */
UCLASS()
class UNREALDELEGATE_API UStudent : public UPerson, public ILessonInterface
{
	GENERATED_BODY()
	
public:
	UStudent();

	virtual void DoLesson() override;

	void GetNotification(const FString& School, const FString& NewCourseInfo);
};

// Fill out your copyright notice in the Description page of Project Settings.


#include "Student.h"
#include "Card.h"

UStudent::UStudent()
{
	Name = TEXT("이학생");
	Card->SetCardType(ECardType::Student);
}

void UStudent::DoLesson()
{
	// 상속받는 것이 Person이기 때문에 Super 키워드를 사용하지 못한다.
	ILessonInterface::DoLesson();
	UE_LOG(LogTemp, Log, TEXT("%s님은 공부합니다."), *Name);
}

void UStudent::GetNotification(const FString& School, const FString& NewCourseInfo)
{
	UE_LOG(LogTemp, Log, TEXT("[Student] %s님이 %s로부터 받은 메시지 : %s"), *Name, *School, *NewCourseInfo);
}

---

🟩 정리

1. 느슨한 결합이 가지는 장점 : 향후 시스템 변경 사항에 대해 손쉽게 대처 가능

2. 느슨한 결합으로 구현된 발행 구독 모델의 장점

- 클래스는 자신이 해야 할 작업에만 집중 가능

- 외부에서 발생한 변경 사항에 대해 영향받지 않음

- 자신의 기능을 확장하더라도 다른 모듈에 영향을 주지 않음

3. 언리얼 C++의 델리게이트의 선언 방법과 활용

- 몇 개의 인자를 가지는가?

- 어떤 방식으로 동작하는가? (MULTICAST 사용 유무 결정)

- 언리얼 에디터와 함께 연동할 것인가? (DYNAMIC 사용 유무 결정)

- 이를 조합해 적합한 매크로 선택

 

👉 데이터 기반의 디자인 패턴을 설계할 때 유용