目录一Check二Verify三Ensure四Usage Examples在C和C编程中assert可在开发期间帮助检测和诊断不正常或无效的运行时条件这些条件通常检查是否指针为非空、除数为非零、函数并非递归运行或代码要求的其他重要假设但每次检查会使得效率十分低下某些情况下assert会在延迟崩溃发生之前发现导致该崩溃的bug如删除未来tick所需的对象协助开发人员发现引起崩溃的根本原因assert的关键特性之一是不存在于发布代码中这意味着不但不会影响发布产品的性能也没有任何副作用对assert最简单的理解就是断言必须一律为true否则程序会停止运行引擎提供assert等同项的三个不同族系check、verify和ensure若要检查这些功能背后的代码可在Engine/Source/Runtime/Core/Public/Misc/AssertionMacros.h中找到相关的宏各个功能的行为略有不同但它们都是开发期间使用的诊断工具目标大致相同一CheckCheck族系最接近基础assert因为当第一个参数得出的值为false时此族系的成员会停止执行且默认不会在发布版本中运行MacroParametersBehaviorcheckorcheckSlowExpression若Expression为false停止执行checkf或checkfSlowExpression、FormattedText、...若Expression为false则停止执行并将FormattedText输出到日志checkCodeCode在运行一次的do-while循环结构中执行Code主要用于准备另一个Check所需的信息;checkNoEntry/若此行被hit则停止执行类似于check(false)但主要用于不可到达的代码路径checkNoReentry/若此行被hit超过一次则停止执行checkNoRecursion/若此行被hit超过一次而未离开作用域则停止执行unimplemented/若此行被hit则停止执行类似于check(false)但主要用于应被覆盖而不会被调用的虚拟函数检查宏仅在调试Debug、开发Development版本中运行Slow宏仅在调试Debug版本中运行设置USE_CHECKS_IN_SHIPPING1可使Check宏在测试Test和发布编辑器Shipping Editor版本中运行此法在以下情况中十分实用怀疑Check宏中的代码正在修改值发现了仅存在于在发布版本中且难以追踪的bug但认为现有Check宏能找到这些bug项目发布时应将USE_CHECKS_IN_SHIPPING设为默认值0二Verify在大部分版本中Verify族系的行为与Check族系相同但即便在禁用Check宏的版本中Verify宏也会计算其表达式的值意味着仅当该表达式需要独立于诊断检查之外运行时才应使用Verify宏如若某个函数执行操作然后返回bool来说明该操作是否成功则应使用Verify而非Check来确保该操作成功因为在发布版本中Verify将忽略返回值但仍将执行操作而Check在发布版本中根本不调用该函数所以行为才会有所不同MacroParametersBehaviorverifyorverifySlowExpression若Expression为false停止执行verifyforverifyfSlowExpression、FormattedText、...若Expression为false则停止执行并将FormattedText输出到日志验证宏在调试Debug、开发Development、测试Test和发布编辑器Shipping Editor版本中完整运行以Slow结尾的宏除外其仅在调试Debug版本中运行定义USE_CHECKS_IN_SHIPPING来保留一个true值通常为1从而覆盖此行为在所有其他情况下Verify宏将计算其表达式但不会停止执行或将文本输出到日志三EnsureEnsure族系类似于Verify族系但可在出现非致命错误时使用这意味着若Ensure宏的表达式计算得出的值为false引擎将通知崩溃报告器但仍会继续运行为避免崩溃报告器收到太多通知Ensure宏在每次引擎或编辑器会话中仅报告一次若实际情况需要Ensure宏在每次表达式计算得值为false时都报告一次则使用Always版本的宏MacroParametersBehaviorensureExpressionExpression首次为false时通知崩溃报告器ensureMsgfExpression、FormattedText、...Expression首次为false时通知崩溃报告器并将FormattedText输出到日志ensureAlwaysExpressionExpression为false时通知崩溃报告器ensureAlwaysMsgfExpression、FormattedText、...Expression 为false时通知崩溃报告器并将 FormattedText 输出到日志Ensure宏在所有版本中计算其表达式的值但仅在调试Debug、开发Development、测试Test和发布编辑器Shipping Editor版本中联系崩溃报告器四Usage Examples以下假设情况展示了一些用例其中Check、Verify和Ensure可帮助理清代码或协助调试// 决不可使用空JumpTarget调用此函数若发生此情况须停止程序 void AMyActor::CalculateJumpVelocity(AActor* JumpTarget, FVector JumpVelocity) { check(JumpTarget ! nullptr); // 计算在JumpTarget上着陆所需的速度现在可确定JumpTarget为非空 }// 这行代码捕获了在产品发布版本中可能出现的小错误 // 此错误较小无需停止执行便可解决 // 虽然该bug已修复但开发者仍然希望了解之前是否曾经出现过此bug void AMyActor::Tick(float DeltaSeconds) { Super::Tick(DeltaSeconds); // 确保bWasInitialized为true然后再继续若为false则在日志中记录该bug尚未修复 if (ensureMsgf(bWasInitialized, TEXT(%s ran Tick() with bWasInitialized false), *GetActorLabel())) { // 执行一些需要已正确初始化AMyActor的操作 } }// 若添加新形状类型但忘记在此切换块中处理则此代码将停止 switch (MyShape) { case EShapes::S_Circle: //处理圆圈。 break; case EShapes::S_Square: //处理方块。 break; default: // 每种形状类型都应有相应情况因此这种情况不应该发生 checkNoEntry(); break; }// 此UObject拥有测试函数IsEverythingOK没有副作用若出现问题则返回false // 若发生这种情况将出现致命错误并终止 // 因为代码无副作用仅作诊断之用因此无需在发布版本中运行 checkCode( if (!IsEverythingOK()) UE_LOG(LogUObjectGlobals, Fatal, TEXT(Something is wrong with %s!Terminating.), *GetFullName()); );// 此列表中不应有圆圈若有程序将停转但检查圆圈耗时较长因此建议在调试版本中操作 checkSlowf(!MyLinkedList.HasCycle(), TEXT(Found a cycle in the list!)); // 遍历列表在各个元素上运行一些代码
)
