(UE4 4.20 )UE4的GC(垃圾回收)编程规范

2023-10-20 23:20

本文主要是介绍(UE4 4.20 )UE4的GC(垃圾回收)编程规范,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

UObject系统的GC

UPROPERTY 引用

当我们在一个UObject类声明各种继承UObject的 变量时,得加UPROPERTY(), 这个可以让UE4帮我们自动管理UObject的垃圾回收。UPROPERTY不仅仅用于反射变量到编辑器上编辑,也涉及UObject变量的GC。原理参考(UE4 4.26)UE4 UObject的内存管理机制浅析

如下面所示:

UCLASS(config=Game)
class AMyProject1Character : public ACharacter
{GENERATED_BODY()private:UPROPERTY()UObject* object;}

TWeakObjectPtr

UE4里自创一套C++ GC规则,官方并不推荐使用C++标准库。 学C++的同学可能会对弱指针熟悉,可以访问一个对象又不造成引用。通常定义在一个类内,用于获取其他对象的某个变量当成临时变量方便访问。如下面所示:

UCLASS()
class MYPROJECT3_API ATestActor : public AActor
{GENERATED_BODY()public:	// Sets default values for this actor's propertiesATestActor();UPROPERTY(VisibleAnywhere)class UCameraComponent* cameraComponent;};ATestActor::ATestActor()
{// Set this actor to call Tick() every frame.  You can turn this off to improve performance if you don't need it.PrimaryActorTick.bCanEverTick = true;cameraComponent = CreateDefaultSubobject<UCameraComponent>(TEXT("Camera"));cameraComponent->SetupAttachment(RootComponent);}
UCLASS(config=Game)
class AMyProject3Character : public ACharacter
{GENERATED_BODY()public:TWeakObjectPtr<UCameraComponent> cameraComponent;protected:virtual void BeginPlay() override;
}void AMyProject3Character::BeginPlay()
{Super::BeginPlay();TArray<AActor*> arrayActor;UGameplayStatics::GetAllActorsOfClass(GetWorld(), ATestActor::StaticClass(), arrayActor);if (arrayActor.Num() > 0){ATestActor* testActor = Cast<ATestActor>(arrayActor[0]);if (nullptr == testActor)return;cameraComponent = testActor->cameraComponent;}
}

这里CameraComponent组件创建与Te'stActor,但是AMyproject2Character需要保存临时变量的时候就用弱指针保存。

局部创建的UObject对象GC

局部创建并且在局部使用的UObject要调用AddToRoot来防止被GC, 然后 RemoveFromRoot来移除引用能得到GC

UCLASS()
class MYPROJECT4_API UTestObject : public UObject
{GENERATED_BODY()public:UTestObject(){}float a;};void AMyProject4Character::BeginPlay()
{Super::BeginPlay();UTestObject* testObject = NewObject<UTestObject>(this);testObject->AddToRoot();testObject->a = 1.0f;UE_LOG(LogTemp, Error, TEXT("xxxx = %f"), testObject->a);testObject->RemoveFromRoot();
}

普通结构体Struct的GC

不继承UObject和UStruct对象的结构体的GC有下面几条

TSharedPtr

共享智能指针,类似C++标准库的共享智能指针,不能用于UObject对象(TWeakPtr倒是可以用于UObject), 因为UObject有自己 专门GC的一套规则。总之TSharedPtr用于自定义的结构体(不继承UObject)。

如下所示:

class MYPROJECT2_API FTest
{
public:FTest();~FTest();
};#include "FTest.h"FTest::FTest()
{UE_LOG(LogTemp, Warning, TEXT("1111FTest Constrction"));
}FTest::~FTest()
{UE_LOG(LogTemp, Warning, TEXT("2222FTest Deconstrction"));
}
UCLASS()
class MYPROJECT2_API ATestActor : public AActor
{GENERATED_BODY()public:    // Sets default values for this actor's propertiesATestActor();TSharedPtr<FTest> Test;
protected:// Called when the game starts or when spawnedvirtual void BeginPlay() override;}// Called when the game starts or when spawned
void ATestActor::BeginPlay()
{Super::BeginPlay();Test = MakeShareable(new FTest());}

PIE运行时Actor创建:

PIE取消运行Actor销毁:

如果是局部变量的结构体创建TSharedPtr:


void ATestActor::BeginPlay()
{Super::BeginPlay();TSharedPtr<FTest> Test;Test = MakeShareable(new FTest());}

FGCObject

上面我们说到了UObject的情况,采用NewObject创建和UPROPERTY()标记来进行GC。而不继承UObject的自定义结构体采用MakeShareable来创建SharedPtr来管理GC。这时候一个特殊的情况出现了玩意,一个不继承UObject的结构体中出现UObject对象怎么办?如下面所示:

 */
UCLASS(BlueprintType, notplaceable, MinimalAPI)
class UCameraAnim : public UObject
{。。。。。。。。。。。。。。。。。。。。。。。。
}class UCameraAnim;
/*** */class MYPROJECT2_API FTest
{
public:FTest();~FTest();UPROPERTY()UCameraAnim* CameraAnim;
};

这种情况下,我试过,如果用MakeShareable创建结构体指针,然后直接操作结构体的UObject对象进行NewObjec创建,结构体本身的访问没问题,但是结构体里面的UObject对象一段时间后自动GC掉,成为野指针,不能访问。这种情况怎么解决呢?UE4为我们提供了FGCObject ,我们的结构体继承FGCObject ,然后用AddReferencedObjects 方法引用结构体里的所有UObject对象,这里的UObject对象不需要被UPROPERTY()标记, 如下所示

#include "GCObject.h"class UCameraAnim;
/*** */
class MYPROJECT2_API FTest :public FGCObject
{
public:FTest();~FTest();UCameraAnim* CameraAnim;protected:virtual void AddReferencedObjects(FReferenceCollector& Collector) override{Collector.AddReferencedObject(CameraAnim);}
};

TSharedRef

本质上共享引用(TSharedRef)和共享指针(TSharedPtr)是差不多的,一样是用于非UObject体系的对象,具备引用计数器,不过TSharedRef和TSharedPtr的很大不同在于,共享引用无法引用空对象,就像C++ 声明空引用,编译直接报错。TSharedRef连
“IsValid”判断是否非空都没有,强逼你使用必定是有效的引用。所以在UE4 的SWidget编程大量使用TSharedRef<SWidget>

如 int& a;

正确的声明定义

TSharedRef<FMyCustom> MyCustom = MakeShared<FMyCustom>();

错误的声明定义:

TSharedRef<FMyCustom> MyCustom;TSharedRef<FMyCustom> MyCustom = nullptr;

TSharedRef没有空引用,应该持有的对象必须是有效的

TSharedPtr转为TSharedRef

TSharedPtr<FMyCustom> aaa = MakeShareable(new FMyCustom);
TSharedRef<FMyCustom> a = aaa.ToSharedRef();

一个普通的结构体使用TSharedFromThis继承,就可以拥有AsShared函数让普通的结构体对象转为TSharedRef, 像SWidget这个类本身就使用了TSharedFromThis

struct FMyCustom : TSharedFromThis<FMyCustom>
{int a = 1;FMyCustom(){UE_LOG(LogTemp, Error, TEXT("destruct a = %d"), a);}~FMyCustom(){UE_LOG(LogTemp, Error, TEXT("undestruct a = %d"), a);}
};FMyCustom MyCustom;
RefCustom = MyCustom.AsShared();

TSharedRef可以转化为TSharedPtr, 直接等于就可以了

	TSharedRef<FMyCustom> RefCustom = MakeShared<FMyCustom>();TSharedPtr<FMyCustom> PtrCustom = RefCustom;

TWeakPtr

上面我们说到了 TWeakObjectPtr 为专门用于UObject, 相应的普通结构体也有弱指针TWeakPtr, 能够访问一个非UObject对象,但是又不造成引用计数+1

一般来说通过TWeakPtr来访问其持有的对象,先是用pin转换为TSharePtr指针,判断对象是否有效后,再访问,而不是直接通过弱指针的IsValid,然后直接访问

struct FMyCustom
{int a = 1;FMyCustom(){UE_LOG(LogTemp, Error, TEXT("destruct a = %d"), a);}~FMyCustom(){UE_LOG(LogTemp, Error, TEXT("undestruct a = %d"), a);}
};UCLASS()
class MYPROJECT5_API AMyActor : public AActor
{
public:TWeakPtr<FMyCustom> WeakCustom;virtual void BeginPlay() override;virtual void Tick(float DeltaTime) override;}void AMyActor::BeginPlay()
{Super::BeginPlay();TSharedPtr<FMyCustom> ShareCustom = MakeShareable(new FMyCustom);WeakCustom = ShareCustom;}// Called every frame
void AMyActor::Tick(float DeltaTime)
{Super::Tick(DeltaTime);TSharedPtr<FMyCustom> ShareCustom = WeakCustom.Pin();if (ShareCustom.IsValid()){UE_LOG(LogTemp, Error, TEXT("a = %d"), ShareCustom->a);}}

很显然,弱指针没有引用到局部的智能创建的对象,所以没有“Tick a  = 1”的log

TSharedPtr,TSharedRef, TWeakPtr在容器使用事项

得注意:弱指针(TWeakPtr)对象不能作为Set或者Map的Key,因为一个对象被GC掉无法通知一个容器的Key, 像TMap<TWeakPtr<FMyCustom>, int>就是不正当的使用手法,当然TWeakPtr可以作为容器的Value,  TMap<int,TWeakPtr<FMyCustom>>毫无问题。

而TSharedPtr和TSharedRef既可以当作容器的Key,也可以作为容器的Value.

参考资料

[1] https://docs.unrealengine.com/en-US/Programming/UnrealArchitecture/SmartPointerLibrary/index.html

这篇关于(UE4 4.20 )UE4的GC(垃圾回收)编程规范的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/250369

相关文章

Go语言数据库编程GORM 的基本使用详解

《Go语言数据库编程GORM的基本使用详解》GORM是Go语言流行的ORM框架,封装database/sql,支持自动迁移、关联、事务等,提供CRUD、条件查询、钩子函数、日志等功能,简化数据库操作... 目录一、安装与初始化1. 安装 GORM 及数据库驱动2. 建立数据库连接二、定义模型结构体三、自动迁

使用Python实现Windows系统垃圾清理

《使用Python实现Windows系统垃圾清理》Windows自带的磁盘清理工具功能有限,无法深度清理各类垃圾文件,所以本文为大家介绍了如何使用Python+PyQt5开发一个Windows系统垃圾... 目录一、开发背景与工具概述1.1 为什么需要专业清理工具1.2 工具设计理念二、工具核心功能解析2.

JSR-107缓存规范介绍

《JSR-107缓存规范介绍》JSR是JavaSpecificationRequests的缩写,意思是Java规范提案,下面给大家介绍JSR-107缓存规范的相关知识,感兴趣的朋友一起看看吧... 目录1.什么是jsR-1072.应用调用缓存图示3.JSR-107规范使用4.Spring 缓存机制缓存是每一

浅谈Redis Key 命名规范文档

《浅谈RedisKey命名规范文档》本文介绍了Redis键名命名规范,包括命名格式、具体规范、数据类型扩展命名、时间敏感型键名、规范总结以及实际应用示例,感兴趣的可以了解一下... 目录1. 命名格式格式模板:示例:2. 具体规范2.1 小写命名2.2 使用冒号分隔层级2.3 标识符命名3. 数据类型扩展命

Python 异步编程 asyncio简介及基本用法

《Python异步编程asyncio简介及基本用法》asyncio是Python的一个库,用于编写并发代码,使用协程、任务和Futures来处理I/O密集型和高延迟操作,本文给大家介绍Python... 目录1、asyncio是什么IO密集型任务特征2、怎么用1、基本用法2、关键字 async1、async

JVM垃圾回收机制之GC解读

《JVM垃圾回收机制之GC解读》:本文主要介绍JVM垃圾回收机制之GC,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录一、死亡对象的判断算法1.1 引用计数算法1.2 可达性分析算法二、垃圾回收算法2.1 标记-清除算法2.2 复制算法2.3 标记-整理算法2.4

Java并发编程之如何优雅关闭钩子Shutdown Hook

《Java并发编程之如何优雅关闭钩子ShutdownHook》这篇文章主要为大家详细介绍了Java如何实现优雅关闭钩子ShutdownHook,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起... 目录关闭钩子简介关闭钩子应用场景数据库连接实战演示使用关闭钩子的注意事项开源框架中的关闭钩子机制1.

shell编程之函数与数组的使用详解

《shell编程之函数与数组的使用详解》:本文主要介绍shell编程之函数与数组的使用,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录shell函数函数的用法俩个数求和系统资源监控并报警函数函数变量的作用范围函数的参数递归函数shell数组获取数组的长度读取某下的

SpringBoot应用中出现的Full GC问题的场景与解决

《SpringBoot应用中出现的FullGC问题的场景与解决》这篇文章主要为大家详细介绍了SpringBoot应用中出现的FullGC问题的场景与解决方法,文中的示例代码讲解详细,感兴趣的小伙伴可... 目录Full GC的原理与触发条件原理触发条件对Spring Boot应用的影响示例代码优化建议结论F

揭秘Python Socket网络编程的7种硬核用法

《揭秘PythonSocket网络编程的7种硬核用法》Socket不仅能做聊天室,还能干一大堆硬核操作,这篇文章就带大家看看Python网络编程的7种超实用玩法,感兴趣的小伙伴可以跟随小编一起... 目录1.端口扫描器:探测开放端口2.简易 HTTP 服务器:10 秒搭个网页3.局域网游戏:多人联机对战4.