器材日志使用规范

前言

目前器材开发中使用的日志函数没有一个统一的接口,导致大家开发中调用的接口五花八门,没法做统一的管理。故重新设计了Logger类,正式的器材包统一使用该接口进行日志输出,其他接口只作为日常开发时调试用。

调试用日志接口:

新日志函数

新的日志使用一个器材一个Logger的方式进行时。便于后续日志的统一管理查找。

使用示例

1. 获取Logger
在脚本加载时调用全局方法GetLogger(<Tag>)获取属于自己的Logger,需要注意Logger不要声明全局变量,只在当前器材脚本内使用。

2. 输出日志
新的日志工具提供4个级别的日志输出,分别对应4个日志打印函数Info(str,...)Debug(str,...)Warn(str,...)Error(str,...)
新的日志支持Unity的Debug相同的格式化输出、使用大括号占位符。

调用(PS:调用时使用的是冒号”:”而不是点”.”)

输出结果:

日志使用规范

1.旧的日志调试接口只允许在本地开发过程中使用,禁止将带有旧日志接口的器材打包提测,打包工具会对旧的接口调用情况做检测。

2.GetLogger时传入的Tag应该是具有唯一标识的,便于查看日志时能精确定位问题,这里建议使用器材编码。

3.明确各个级别的日志的作用,避免滥用。

日志函数 使用场景
Info 记录器材的正常运行状态,例如器材某个关键组件的初始化,某个交互成功的记录等等。Info日志不宜过多,建议只在有必要的关键节点输出日志。
Debug 这种日志记录的是器材的一些更精确的状态和数值,通过该种日志,可以查看某一个操作每一步的执行过程,可以准确定位是何种操作,何种参数,何种顺序导致了某种错误的发生。比如电池的电流值、玻璃片的拼接状态等等。
Warn 该日志表示系统可能出现问题,也可能没有,比如一些将要过时的接口被调用了等等。日常开发中比较少遇到。
Error 这个级别说明器材已经遇到了影响运行的错误了,比如对外的接口中,调用方传入了错误的参数等。