[按键精灵]按键日志功能——定期自动清理脚本日志

大家好，我是郭立员，今天讲一下定期自动清理脚本日志。

前言

日志功能是一个挺重要的查错功能，如果脚本出现错误，可以查看日志，或许可以找到脚本错误的原因。

一、开启/关闭脚本日志

脚本日志是需要执行对应的命令代码才可以开启的：

Log.Open()

在脚本的任意位置执行这行代码，脚本就开启了日志功能。

关闭日志功能

Log.Close()

二、脚本日志里面是什么内容

当开启脚本日志记录以后，执行Traceprint命令输出的所有内容都会写入到日志文件里面，直到脚本执行结束，或者是使用Log.Close关闭日志文件。

脚本代码：

For 2
    Log.Open()
    TracePrint "日志1"
    TracePrint "日志2"
    TracePrint "日志3"
    Log.Close()
Next

日志内容：

三、查看日志的方法

查看日志记录的方法有2个方法：

①、脚本设置里面，查看日志

②、在文件管理器里面查看日志文件

这种方法首先要知道日志文件的存放路径，通过查看命令介绍可以知道，日志文件是存放在临时目录的log文件夹里面，文件名是脚本运行时间。

获取临时目录的命令是GetTempDir()，这个命令获取的是一个“动态”路径，不同的脚本的临时目录是不同的。

按键助手调试脚本的临时目录是

//按键助手调试脚本的临时目录是
/storage/emulated/0/com.cyjh.mobileanjian/
缩减形式：
/sdcard/com.cyjh.mobileanjian/log/

打包成小精灵

//比如你的小精灵包名是com.abc,目录是
/sdcard/com.abc/log/
通用：
/sdcard/包名/log/

四、日志文件的文件名称

默认日志文件的名称是脚本日志开启运行的时间：

如果想自定义名称，可以在开启日志命令的参数中设置：

Log.Open("abc.log")

这里名称写的是abc.log，为了方便后续的区分和查看，这里后缀写的是.log，代表这个文件类型是日志类型。

这里文件类型并不强制，你可以写.txt的文本类型，甚至不填写后缀都可以。

关于日志的名称是使用默认的还是使用自定义名称要看具体需求，如果想保留多个日志，那么就使用默认名称，如果想方便读取可以使用自定义的固定名称。

五、定期清理日志

日志文件里面的内容会随着脚本的运行越积累越多，并且它不会在脚本停止或者关闭日志后清除，因为如果脚本停止后清除了日志就不能用来查找问题了。

那怎么解决日志文件内容越来越多的问题？

我的想法是定期自动清理日志内容~

比如脚本记录有100行了，我就清空日志，这样日志文件最多保留100条数据。

对于按键来说日志文件和文本一样，可以使用file命令进行读写，我们要清空日志内容有两个方法一是删除日志文件，二是写入“空内容”到日志文件里面，覆盖掉原有的内容。

这里有个知识点，无论上面哪种方法都要求关闭日志记录才能执行，我猜测原因是开启日志后脚本会一直占用日志文件用来写入Traceprint的内容。

For 10
    Log.Open("abc.log")
    TracePrint "日志1"
    TracePrint "日志2"
    TracePrint "日志3"     
    Dim arr = file.readlines(gettempdir()&"log/abc.log")    
    If Len(arr) > 10 Then 
        Log.Close 
        TracePrint file.read(gettempdir()&"log/abc.log")   
        TracePrint Len(arr)
        file.write(gettempdir()&"log/abc.log")
    End If
Next

日志清空代码加在哪里比较合适，这里我是用的是自定义日志名称，清空日志的代码是

    Dim arr = file.readlines(gettempdir()&"log/abc.log")    
    If Len(arr) > 10 Then 
        Log.Close 
        TracePrint file.read(gettempdir()&"log/abc.log")   
        TracePrint Len(arr)
        file.write(gettempdir()&"log/abc.log")
    End If

我的建议是在脚本循环每轮结束的位置加上，也就是运行一轮循环就清空一次日志。

加在这个位置是因为已经完整运行了一个循环的所有代码，清空日志并不会有啥影响。

当然我建议控制日志行数可以稍微写大点，比如写3-5个循环产生的记录行数当做清空日志的判断条数。

六、补充知识

获取最新的日志文件，如果脚本使用默认的文件名称，也就是日期名称，可以使用下面代码获取日志名

Import "zm.luae"
zm.Init 
Dim temp = {0,null}
Dim arr = zm.DirScan(GetTempDir()&"log")
For Each k In arr
    TracePrint k
    TracePrint zm.Execute("stat -c %Y "&k)
    If cint(zm.Execute("stat -c %Y " & k)) > cint(temp[1]) Then 
        temp[1] = zm.Execute("stat -c %Y " & k)
        temp[2] = k
    End If
Next
TracePrint "最新文件：",temp[2]

七、可能的bug

其实我写的清空日志代码并不完善，会存在bug。比如刚刚清空了日志脚本就出现了问题，那么就看不到日志了，也无法找到问题。

比较好的清空形式应该是写一行日志，判断一下总的日志行号，如果超限了，就删掉第一行日志，这样可以保证日志的总行数是固定的。

但是这样就要求每个traceprint后都要执行关闭日志记录命令，非常繁琐。

八、总结

日志记录是为了在脚本不正常运行出错的时候方便查找问题使用，定期清理日志可以防止日志文件体积过大。

如果你脚本运行很稳妥是没必要开启日志记录的，甚至连traceprint命令都可以删除。