[UE4]对象的垃圾回收与内存常驻

keywords：UE4, Memory Persist, GC, 垃圾回收, 内存管理

防止GC的办法

一个UObject类型的变量，即使是static，默认也会被GC掉。

要防止该对象被GC，有6种方式：

作为成员变量并标记为UPROPERTY()；
创建对象后 AddToRoot() ；（退出游戏时需要RemoveFromRoot()）
对目标设置一个有效的Owner：SetOwner()；
UGameInstance::RegisterReferencedObject()；
FStreamableManager Load资源时，bManageActiveHandle 设置为true；
FGCObjectScopeGuard 在指定代码区域内保持对象；

Uobject不能使用TSharedPtr进行引用计数，非UObject才可以；如果一个非UObject的类想加入GC，那么必须继承FGCObject类。

UPROPERTY()用法

URPOPERTY()
    UObject* MyObj;

AddToRoot()用法

UMyObject* MyObj = NewObject<UMyObject>();
MyObj.AddToRoot();

SetOwner()用法

void AMyCharacter::BeginPlay()
{
    Super::BeginPlay();

    ActorTest = NewObject<AActor>();
    ActorTest->SetOwner(this);
}

只要AMyCharacter没有销毁，那么ActorTest不会被垃圾回收。

UGameInstance::RegisterReferencedObject()用法

UMyObject* MyObj = NewObject<UMyObject>();

//添加引用，防止GC
UGameInstance* GameInstance = UGameplayStatics::GetGameInstance(this);
GameInstance->RegisterReferencedObject(MyObj);

//移除引用，等待GC
GameInstance->UnregisterReferencedObject(MyObj);

FStreamableManager 用法

FSoftObjectPath AssetPath(TEXT("/Game/Mannequin/Animations/ThirdPersonWalk.ThirdPersonWalk"));
FStreamableManager& AssetLoader = UAssetManager::GetStreamableManager();

//hold object in memory.
TSharedPtr<FStreamableHandle> Handle = AssetLoader.RequestSyncLoad(AssetPath, true);
UObject* Obj = Handle->GetLoadedAsset();

//free memory of object.
Handle->ReleaseHandle();

FGCObjectScopeGuard 用法

{
    FGCObjectScopeGuard(UObject* GladOS = NewObject<...>(...));
    GladOS->SpawnCell();
    RunGC();
    GladOS->IsStillAlive();   // Object will not be removed by GC
}

GC 常见问题

官方论坛上有人说 NewObject() 或者 LoadObject() 创建的对象才会自动被 GC ， SpawnActor 创建的对象会被自动 AddToRoot ，不会被 GC。不知早期的版本是否确实如此，但是目前版本不是这样，即使是 SpawnActor ，默认也会被 GC。
URPOPERTY()前后不能添加其他宏，如果将其他宏加URPOPERTY()前面，会有编译错误，如果加后面，则会导致对象可被垃圾回收。
例如，UPROPERTY()后面添加__V1__和__V2__两个宏，编译运行都正常，但会导致UPROPERTY()失效，MyActor将被回收。
```
UPROPERTY()
#ifdef __V1__
    class AMyActorV1* MyActor = nullptr;
#endif
#ifdef __V2__
    class AMyActorV2* MyActor = nullptr;
#endif
```
如果宏放在URPOPERTY()前面，会导致编译错误：
```
error : UPROPERTY must not be inside preprocessor blocks, except for WITH_EDITORONLY_DATA
```
要解决这种问题，貌似只能用AddToRoot()和RemoveFromRoot()。
很多初学者会用UObject::ConditionalBeginDestroy()销毁对象，不知是早期资料少被别人带偏，还是远古版本确实可以，至少目前版本并不能销毁对象：如果actor仍然被其他地方引用，ConditionalBeginDestroy()执行后，下次GC并不能将其销毁。参考：ConditionalBeginDestroy与MarkPendingKill
AActor::Destroy()是同步销毁对象内存且是在当前帧结束时立即执行。这里说的销毁不是用指针delete内存，而是从内存池中抹掉数据。

参考资料

UE4 Garbage Collection
https://gist.github.com/LordNed/650de717daca23aaf8fc2932bf3f9123

虚幻4垃圾回收剖析
http://www.cnblogs.com/ghl_carmack/p/6112118.html

转载：UE4内存管理 – 实践

原文：
http://blog.csdn.net/yangxuan0261/article/details/52075581

原文内容如下：

UObject gc机制

通过 UPROPERTY() 去保持引用

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "MyChar")
class UBehavData* mBehavData;

mBehavData = NewObject<UBehavData>(this, UBehavData::StaticClass());
bh->mId = 111;

TArray保持引用如果有个 TArray 容器，则这个TArray需要用一个UPROPERTY() 去保持容器的引用，然后里面的UObject就不需要再去AddToRoot去阻止被gc了。
```
UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "UCoolDownComponent")
TArray<UCoolDown*>      mCDArr;

UCoolDown* cd = NewObject<UCoolDown>(_class);
cd->SetSkillId(_skillId);
mCDArr.Add(cd);
```
容器clear后，元素会自动被GC。

4.15版本支持了蓝图 TMap 容器，也是可以通过 UPROPERTY()去保持容器的引用，容器内的UObject就不需要再去AddToRoot去阻止被gc了

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "MyChar")
    TMap<int32, UBehavData*> mTestMap2;

UBehavData* bh = NewObject<UBehavData>(this, UBehavData::StaticClass());
bh->mId = 111;
mTestMap2.Add(111, bh);
bh = NewObject<UBehavData>(this, UBehavData::StaticClass());
bh->mId = 222;
mTestMap2.Add(222, bh);

没有任何容器保持引用需要AddToRoot添加标记去阻止被gc
```
m_sInstance = NewObject<T>();
m_sInstance->AddToRoot();
```
让对象重新被gc回收，需要移除标记（不是立即释放对象，是在某个时间gc时才释放对象）
```
m_sInstance->RemoveFromRoot();
m_sInstance = nullptr;
```

c++ new对象丢个蓝图引用住防止gc

c++ new对象

UFUNCTION(BlueprintPure, Category = "UBehavData")
static UBehavData* CreateBehavData();

UBehavData * UBehavData::CreateBehavData()
{
    UBehavData* behavData = (UBehavData*)NewObject<UBehavData>(UBehavData::StaticClass());
    return behavData;
}

蓝图第一时间用一个变量 mBehavData 引用住，就可以防止这个对象被gc掉。切记第一时间。

将蓝图中的变量 mBehavData 设为 null，则对象会被gc不定时回收掉

强制gc
```
GEngine->ForceGarbageCollection(true);
```

AActor gc机制

一般重写这两个函数，来做一些初始化和清理工作

virtual void PostActorCreated() override; //做初始化工作
virtual void BeginPlay() override; //做初始化工作
virtual void BeginDestroy() override; //引擎在gc的时候调用，并不是立即调用，一般不用
virtual void EndPlay(const EEndPlayReason::Type EndPlayReason) override; //做清理工作
virtual void Destroyed() override; //用于释放成员，调用Destroy();会立即调用

调用SpawnActor或DestroyActor会调用到这两个函数，析构函数则要在gc的时候才会调用，可以调用gc函数测试一下

GEngine->ForceGarbageCollection(true);

UActorComponent gc机制

作为Actor的组件存在于Actor的组件列表中，销毁Actor时会把组件列表遍历一边destroy掉并标记为待gc的对象，在一个不定时的时间被gc掉
```
UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "MyChar")
    UCoolDownComponent*     mCDComp;    //注册cd组件
```

任意时刻销毁，即使宿主Actor未被销毁C++销毁则直接调用接口

void UActorComponent::DestroyComponent(bool bPromoteChildren/*= false*/)

蓝图销毁，需要设置一个UActorComponent的属性

bAllowAnyoneToDestroyMe = true;

因为提供给蓝图的接口需要判断这个字段，默认是false

UFUNCTION(BlueprintCallable, Category="Components", meta=(Keywords = "Delete", HidePin="Object", DefaultToSelf="Object", DisplayName = "DestroyComponent"))
void K2_DestroyComponent(UObject* Object);

void UActorComponent::K2_DestroyComponent(UObject* Object)
{
    AActor* MyOwner = GetOwner();
    if (bAllowAnyoneToDestroyMe || Object == this || MyOwner == NULL || MyOwner == Object)
    {
        DestroyComponent();
    }
    else
    {
        // TODO: Put in Message Log
        UE_LOG(LogActorComponent, Error, TEXT("May not destroy component %s owned by %s."), *GetFullName(), *MyOwner->GetFullName());
    }
}

一般重写这两个函数，来做一些初始化和清理工作

// Begin UActorComponent Interface.
virtual void BeginPlay() override; //组件RegisterComponent注册的时候，且有OwnerActor才会立即调用，一般不用
virtual void BeginDestroy() override; //引擎在gc的时候调用，并不是立即调用，一般不用
virtual void EndPlay(const EEndPlayReason::Type EndPlayReason) override; //立即调用，一般这里做清理工作（注册过才会调用），且gc时还会再调用一次，一般不用
virtual void OnComponentCreated() override; //组件RegisterComponent注册的时候立即调用，一般这里做初始化工作
virtual void OnComponentDestroyed(bool bDestroyingHierarchy) override;//立即调用，一般这里做清理工作（只要DestroyComponent就会调用）

// End UActorComponent Interface.

默认的gc是时间测试得到为1min 如果需要立即销毁，使用这个接口

mCDComp->DestroyComponent(); //会立即调用到 OnComponentDestroyed，并标记为准备被gc回收

参考资料

官网地址： https://wiki.unrealengine.com/Garbage_Collection_%26_Dynamic_Memory_Allocation

他们如此单纯，以至于认为贫穷是一种罪过，还以为可以通过赚钱来遗忘。——杰拉尔·萨利克

[UE4]对象的垃圾回收与内存常驻

防止GC的办法

UPROPERTY()用法

AddToRoot()用法

SetOwner()用法

UGameInstance::RegisterReferencedObject()用法

FStreamableManager 用法

FGCObjectScopeGuard 用法

GC 常见问题

参考资料

转载：UE4内存管理 – 实践

UObject gc机制

AActor gc机制

UActorComponent gc机制

参考资料

Wang Aiguo