用于本地资源检测,帮助开发者尽早发现资源文件中存在的问题
-
支持所有版本的Unity项目
-
不依赖Unity Editor,无需安装绿色运行
-
检测速度极快,可在UPR中查阅检测结果
-
支持命令行模式,可与CI/CD工具轻松集成,实现自动化检测
-
规则库持续更新
-
支持AssetBundle冗余检测
-
支持静态代码分析
Asset Checker 官方教程地址(包含工具下载地址)
资源检测
- 生成配置文件。
assetcheck.exe generate-config
- 检测Unity工程。
assetcheck.exe --project=
--projectId=
为Unity工程所在路径, 为UPR项目Id。
非必需项。如果填写了 ,检测结束后,可直接在UPR网站该项目内查看检测结果。
UPR项目创建方式可参考UPR App 使用手册,步骤2。点击ProjectId可以快速拷贝。
- 当前文件夹下运行需要在assetcheck.exe前面添加“.\”
- 查看检测结果。
直接打开rule_report.yaml文件查看。
或者登陆UPR网站查看。
在检测时如果填写了
UPR网站支持离线「上传资源检测文件」。可直接将assetcheck文件夹内的assetcheck_result.json文件上传,查看检测结果。
点击「详情」,可查看资源检测的详细结果。
4.设置待检测资源的路径范围
assetcheck支持通过命令行参数 --includePaths 和 --excludePaths 来控制待检测资源所在的文件夹集合
(注意,此参数中填入的路径分隔符在1.10.2版本之前不会被自动转换为操作系统默认)
例1:此时仅有Assets目录(及子目录)下的资源会进入检测,其余资源会被忽略
assetcheck.exe --project="C:\unity\sample201904" --includePaths="Assets"
例2:此时Assets目录下Scripts和Scenes这两个子目录中的资源会被忽略,其他Assets下的资源会进入检测
assetcheck.exe --project="C:\unity\sample201904" --includePaths="Assets" --excludePaths="Assets\Scripts,Assets\Scenes"
例3:--excludePaths单独也可以发挥作用
assetcheck.exe --project="C:\unity\sample201904" --excludePaths="Third-party-repo,Assets\Lib"
(此外注意,AssetChecker默认已经将项目根目录下的Package和Library目录忽略)
AssetChecker还支持在config.yaml中对某类别的规则或者某条具体规则设置生效的路径范围,配置的生效优先级为:规则 > 类别 > 项目,高优先级的配置会直接覆盖低优先级
例4:当项目级别(命令行参数)和规则设置中都配置了includePaths或者excludePaths时,对于”Video size limit“这条规则,仅有它自己的路径范围设置生效,即Assets/Video下的除了CGExport外的资源将参与检测;对于所有其他规则,则适用项目级别的配置,即Assets目录下的资源都被跳过
assetcheck.exe --project="C:\unity\sample201904" --excludePaths="Assets"
(...) - category: Video enabled: true includePaths: Assets/Included_0,Assets/Included_1 excludePaths: Assets/Ignored_0,Assets/Ignored_1 rules: - name: Video size limit description: Size of imported video should not over limit, default at 256MB includePaths: Assets/Video,Assets/VideoClip excludePaths: Assets/Video/CGExport enabled: true platform: All customParameters: sizeLimit: 256
5.指定服务器地址
对于购买了UPR企业版的用户,可以通过--serverIp参数来指定AssetCheck,AssetBundleCheck,CodeAnalyze的检测结果的上传目的服务器地址,此时使用协议默认为http,上传端口默认为8080,展示页面的端口默认为3005
assetcheck.exe --project="C:\unity\sample201904" --serverIp="123.123.123.123" ---- 2020-08-13 15:33:07,407 INFO: Current version is 1.11.0 2020-08-13 15:33:07,408 INFO: {***} 2020-08-13 15:33:07,408 WARNING: No project id provided, report will not be uploaded to upr server 2020-08-13 15:33:07,408 INFO: Upload server set to: http://123.123.123.123:8080 2020-08-13 15:33:07,408 INFO: Browse server set to: http://123.123.123.123:3005
也可以通过--uploadServer和--browseServer来直接指定服务器的完整URL(此时--serverIp会被忽略)
6.资源修复
Asset Checker中的部分规则支持直接对检测到缺陷的资源进行修复
在检测完成后,如果发现资源的缺陷是可以自动修复的,Asset Checker会生成fix_report.yaml文件,记录准备执行修复的资源和修复规则
之后,用户需要执行
assetcheck.exe fix --project=
来完成资源修复
现阶段用户可以手动删除fix_report.yaml中的部分条目来控制所要执行的修复范围,后续我们将提供过滤命令或UPR Web中的操作界面优化操作
资源包冗余检测
1.检测资源包
assetcheck.exe abcheck --project= --projectId=
为AssetBundle包所在绝对路径(其中不能包括中文), 为UPR项目Id。
非必需项。如果填写了 ,检测结束后,可直接在UPR网站该项目内查看检测结果。
UPR项目创建方式可参考UPR App 使用手册,步骤2。点击ProjectId可以快速拷贝。
2.查看整体检测结果
检测执行完成后,可点击运行日志末尾的URL跳转至UPR网站查看详细结果
3.查看Asset依赖关系链
点击上图中相应的资源AB包中某一个AssetBundle名字,可以在弹出页面中进一步查看此Asset到指定AssetBundle的依赖关系链
4.本地解析结果
abcheck的执行结果会同时在本地以json文件格式保存在assetcheck所在文件夹下asse_bundle_analyze_result.json中
代码缺陷检测
1.检测项目地址
assetcheck.exe code-analyze --project= --projectId=
为Unity项目所在绝对路径(其中不能包括中文), 为UPR项目Id。