规则我说了算! | 自定义规则重磅上线

规则我说了算! | 自定义规则重磅上线

UWA已经推出了本地资源检测,并随着越来越多研发团队的投入使用,自定义规则的需求越来越强烈:大家都希望能为项目量身定制一套资源规范的规则,定期地自动扫描,并在网页端直观地查看数据,从而持续保障项目的质量。所以,我们在今天的更新中为大家开放了自定义规则API。通过它,大家就可以自行开发适合你项目的检测规则。

举个常见的例子:在游戏打包时我们需要有个版本校验的工作,如果版本不一致会导致资源无法加载、报错等各种问题,从而影响测试人员的工作效率。现在,我们可以在本地检测的时候加入这个规则的检测,从而避免返工。

没错,通过简单的脚本编写即可完成!
以下为具体步骤!

脚本编写

开发者可在任意Editor目录下新建C#脚本,在脚本中定义符合规范的类型,并实现相关的接口即可添加自定义规则。

在任意 Editor 目录下新建 C# 脚本文件,并打开;
添加命名空间:using UwaProjScan.ScanRule.CustomRules;
新建类型,使其继承自ICustomRule,如:

继承 ICustomRule 接口类,需实现以下方法:

ushort Id { get; }
该方法需要返回规则的Id,Id可以是 ushort 范围中任何数字,如:


规则的Id不支持重复,同一条规则在多次提交时,Id应该保持一致。

string Description{ get; }
该方法需要返回规则的描述,如:


该描述会显示在网页端:

RulePriority Priority { get; }
该方法需要返回规则的优先级,规则优先级有2个可选项(High,Medium),如:


该描述会显示在网页端:

表格返回

线上报告的数据展示分为两种情况:不返回表格和返回表格。不返回表格只显示检测结果通过与否,返回表格会显示未通过的对象详情。

不需要返回表格的情况:


对应网页端的显示如下:

需要返回表格的情况:


对应网页端的显示如下:

数据查看

以上步骤都完成后,自定义规则的配置就已完成。在触发扫描操作时,自定义规则部分也会被自动触发,不需要在进行其他的设置。

打开线上的报告页面,在左侧的标签中选中“自定义规则”后,即可查看对应的数据。

*以上为实现规则自定义的主要流程,建议大家在使用时更新至最新版Pipeline SDK,并参考完整文档说明。https://www.uwa4d.com/#download


关于【UWA本地资源检测】

本地资源检测是UWA推出的、面向于静态资源的全量分析,可针对项目组制作的美术资源进行检测,结合大家自己设定的阈值,快速检测资源的不合理情况,帮助研发团队及时发现并修复。

该服务目前已经成为不少开发团队的打版必备流程:每天半夜自动检测出报告,便于研发或QA团队第二天能快速查看数据报告并做针对性的修缮,大幅度地提高了研发效率。该服务目前免费开放给开发团队使用。