🐸

리플렉션이 뭔지 처음 알았던 때

위의 글에서 Actor를 생성하면 generated.h가 기본적으로 추가되어있다고 했다.
해당 헤더는 리플렉션기능이 가능하도록 리플렉션 데이터를 다룬다.

그 리플렉션이 뭔지 정확히 알아보자

4가지의 글을 참고하였다.

• 1. Unreal Engine
     https://www.unrealengine.com/ko/blog/unreal-property-system-reflection
• 2. https://hyo-ue4study.tistory.com/182
• 3. https://upbo.tistory.com/79
• 4. 강의 영상
     https://www.youtube.com/watch?v=VpEe9DbcZIs

---

1. Reflection

1-1. Reflection이란

리플렉션은 프로그램이 실행시간에(RunTime) 자기 자신을 조사하는 기능이라고 한다.
(언리얼 공식 사이트)

위처럼 컴파일타임에는 실제 타입을 모르는 객체가 주어져도
런타임에 해당 객체의 메소드를 호출하고 접근할 수 있다.
(C#용 코드이고, Object는 최상위클래스라서 어떤객체인지 모르는 것과 같다)

• 리플렉션은 그래픽쪽의 용어로도 쓰여서, 혼동을 피하기 위해
  프로퍼티 시스템으로 부르기도 한다.
• CPP는 리플렉션을 지원하지 않는다.
  리플렉션이란 것이 엄청나게 유용하기 때문에
  UE에서 UObject에 대하여 리플렉션 기능을 제공하는 것이다.
• 실제로 리플렉션은
  에디터의 디테일 패널, 시리얼라이제이션, 가비지 콜렉션, 네트워크 리플리케이션, 블루프린트/C++ 커뮤니케이션 등
  다수의 시스템에 탑재되었다.

게임에는 여러 모듈로 구성되는데 컴파일타임에는 해당 모듈의 존재를 서로 알 수 없으므로,
동적인 타입을 사용하면 링커나 런타임시에 해당 클래스가 무엇인지 확인할 수 있게 된다.

A. UObject

• Java나 C#의 Object처럼 최상위 추상클래스
• 언리얼은 모든 객체가 해당 UObject를 상속받을 필요는 없지만,
  UObject를 상속한 클래스에 대해서 편리한 기능들을 제공한다.

1-2. Reflection 기능을 사용하려면

내가 적은글을 참고
https://velog.io/write?id=1251400e-46a4-4c5c-b193-d9955cc503e3

• 리플렉션이 있는 유형으로 마킹을 하려면
  파일 상단에 generated.h를 추가해서 마킹해준다.

• 그러면 다른 generated.h가 붙은
  리플렉션이 있는 유형은 해당 파일을 고려해야하는 것과
  시스템 구현에도 필요함을 UHT에 알려준다.
  (unreal header tool)

• generated.h가 추가되었으니,
  UENUM(), UCLASS(), USTRUCT(), UFUNCTION(), UPROPERTY()
  를 사용할 수 있게 된다.

#include "StrategyChar.generated.h"


UCLASS(Abstract)
class AStrategyChar : public ACharacter, public IStrategyTeamInterface

{

    GENERATED_UCLASS_BODY()

    UPROPERTY(EditAnywhere, Category = Pawn)
    int32 ResourcesToGather;
    
    uint8 MyTeamNum;
}

간단한 예시를 가져왔다.

• generated.h
  • generated.h가 사용되어 리플렉션이 있는 유형으로 명시적으로 알린다.
  • generated.h가 사용되어 UCLASS와 같은 키워드를 사용할 수 있게 된다.
• 리플렉션 키워드
  • UCLASS를 사용하여 ACharacter를 상속받은 AStrategyChar를 리플렉션 되었음을 명시한다.
  • 리플렉션 키워드가 붙지않은 MyTeamNum의 경우,
    리플렉션 시스템이 의존하는 시스템 전부에 보이지 않는다.
    • 리플렉션이 의존하는 시스템
      • Blueprint
      • UnrealEngine Editor
  • generated의 함수에는 StaticClass() / StaticStruct() 같은 것이 포함되어 있어,
    유형에 대한 리플렉션 데이터를 구하는 것이 쉬워진다
• GENERATED_UCLASS_BODY()
  • generated에 정의된 매크로
  • UCLASS 내의 UFUNCTION / UPROPERTY .. 등등
    리플렉션 키워드가 붙은 함수, 변수들을 리플렉션 데이터로 등록하는 기능이다.
  • 따라서 UCLASS가 붙은 CLASS내에 UFUNCTION만 사용한다고 리플렉션이 되는 것이 아니다.
    UCLASS()가 사용된다면 GENERATED_UCLASS_BODY()가 들어가는게 필수
    들어가지 않는다면 리플렉션을 쓰겠다고 선언은 했는데 실제로 리플렉션을 하지 않는 꼴이 된다
  • 해당 키워드가 붙은 함수/변수를 실제로 리플렉션에 등록하는건 GENERATED_UCLASS_BODY()

결론

generated.h를 사용하여 리플렉션이 있는 유형임을 알린다.

generated.h를 사용하여 리플렉션 키워드를 사용할 수 있게 되고,
UObject를 상속받는 CLASS에
UCLASS()와 GENERATED_UCLASS_BODY()를 사용하여
UCLASS()된 리플렉션된 클래스 내부의 리플렉션 키워드가 붙은
멤버함수, 변수들을 리플렉션 데이터에 넣는다.

최종적으로 BP와 UE editor에서 사용할 수 있게 된다.

정말 가장 중요한 것은..
UObject객체라면, 무조건 generated.h / UCLASS / 그리고 U접두사 / UObject의 상속 / GENERATED_BODY()
이 5개가 무조건 포함되어있어야 하므로,
UObject는 무조건 리플렉션이 된다고 보는것이 맞다.

+ Enum / Struct

• UObject가 아니지만 리플렉션을 제공한다.
• 추가로 언리얼은 CPP와 달리 구조체와 클래스가 다르고,
  USTRUCT 내에 UFUNCTION같은 키워드를 넣을 수 없다.
• 추가로 UENUM과 USTRUCT는 주로 값으로 취급하고
  리플렉션 키워드(매크로)를 붙였음에도 GC의 대상이 되지 않는다.
  

그러면 키워드를 왜 붙이는걸까

• 그저 EDITOR나 BP에서 관리하기 편하기 위함인듯 싶다.

1-3. Reflection 동작 원리

• Unreal Build Tool(UBT)와 Unreal Header Tool (UHT)가 함께하여
  실행시간 리플렉션을 강화시키는 데 필요한 데이터를 생성한다

1 -UBT(Unreal Build Tool)는 헤더를 스캔한 다음
리플렉션된 유형이 최소 하나 있는 헤더가 들어있는 모듈을 기억.

2 -그 헤더 중 이전 컴파일 이후 변경되었다면, UHT를 실행하여 리플렉션 데이터를 수집하고 업데이트.

3 -UHT 는 리플렉션 데이터가 들어있는 C++ 코드를 생성

4 -빌드 시 해당 코드와 같이 컴파일

[공식사이트의 글을 요약한 글 - 리플렉션 작동 원리]

결론
음... 그냥 그런가보다 하고 넘어간다.

중요한건 UBT와 UHT가 리플렉션 유형이 있는 헤더를 감시하고,
리플렉션 데이터를 업데이트 하는 것이다

2. Garbage Collection

• CPP에선 자동으로 Delete를 해서 메모리를 해제해야만 했는데
  언리얼에선 UObject에 대해 Reflection기능을 바탕으로 GC를 제공한다.

• UCLASS의 멤버 변수들은 UPROPERTY를 사용하여 리플렉션을 적용시키고,
  GC를 적용시키게 되는데
  언리얼이 기본적으로 제공하는 자료구조나 자료형이 아닌,
  UHT가 모르는 자료형을 사용하거나, 중첩배열을 사용하는 경우
  UPROPERTY를 붙이면 에러가 발생한다.
  

2-1.AddReferencedObject

그런 경우, AddReferencedObject 함수를 생성하고,
GC에게 직접 해당 포인터의 주소값을 넘겨주게 된다.

해당 함수는 GC사이클마다 호출이 된다고 함.

C++ 객체 내에 UObject 포인터가 존재하면,
해당 객체가 FGCObject를 상속하게끔 한다.

그러면 AddReferencedObject를 사용할 수 있게 되고,
UObject포인터를 GC에게 알려줄 수 있게 된다.

그런데, UObject가 아닌 사용자 정의 객체라면..
AddRefer~함수를 통해서 GC에 알려줘야 한다고 방금봤는데
모순되는 말 아닌가..?

흠...

리플렉션된 UObject Raw 포인터는 강한 참조?
강한 참조는 포인터가 가리키는 동안 객체가 해제되지 않음
(불필요하게 살리고 싶지 않은 경우 TWeakObjectPtr를 사용)

이를 원치 않는 경우에는 TWeakObjectPtr을 제공한다고 함
TWeakPtr이랑 다르다고 함
(순환참조를 없애기 위한 용도가아님?)

IsValid()를 통해 객체가 해제되었는지 확인하는 기능.

일단 요약만 해본다..
언리얼 앤진은 Mark & Sweep으로 관리되는 UObject객체와
New Delete / 참조카운터 방식으로 관리되는 NativeCPP객체
2가지가 혼용되기 때문에 유의해야만 한다고 함.

서로 참조할 때는 위의 요소를 참고하고,

UObject가 NativeCPP 객체를 참조할 때 주의사항은
UObject가 NativeCPP를 소유하는 개념이 되어서
계속 살아있게 된다고 함

NativeCPP이 UObject를 참조할 때
잠깐동안 Root Set이 되는 효과가 있어서
내가 해제하면(누수하면) 참조한 다른 객체들까지 누수될 수 있다는 것에 주의

결론
https://www.youtube.com/watch?v=VpEe9DbcZIs
일단 영상을 봤고, 요약을 했는데,
TWeakObjectPtr , Raw Ptr이런
처음보는 포인터 개념이 나와서 이해가 전혀 되지 않았다.

먼저 포인터부터 공부한 후에 GC를 다시 이해해본다.