相信每个iOS开发者都会断点,断点之后,就能使用lldb的命令进行操作,基本上每个人都用过po这个命令吧.它在断点的时候可以非常方便的查看各种值.但是,如果是相对复杂的场景,自定义调试命令就显得十分必要了.
几种方式
LLDB提供了几种让你自定义命令的方式:
1.别名(alias),使用简单,但是这个只能用来实现没有输入的命令
2.正则命令(command regex),可以通过正则表达式来捕获输入,并且将其应用到命令中.但是这个在执行多行命令的时候非常不方便,并且,这个只能有一个输入参数.
3.桥接脚本(script bridging) 基于python,这个很好的权衡了方便和复杂性.并且可以做任何LLDB能做的事情.
script bridging 就是今天我想写的,官方文档写的实在是无力吐槽.文笔能力有限,如果有问题,可以追问.算是抛砖引玉了.
需求
定义一个findclass命令,它能够实现打印出所有运行时的类.用法如下:
1.没有参数,则打印所有类
findclass
2.带参数,则只打印类名中包含参数(GUI)的类
findclass GUI
准备工作
前面说了,这个脚本实际是基于python的,就目前来说(2017年07月13日16:59:15)LLDB中使用的还是python2.x,所以为了一致性,请做个检查.
- 检查LLDB中python版本:
打开一个终端,输入:
lldb
然后你会发现终端行中会出现以(lldb)开头的行,然后依次输入如下命令:
script import sys
script print (sys.version)
script表明接下来的输入是脚本(也就是python)语句.后面的部分是python,一个导入,一个调用,不多赘述.
可以看到我的是2.7.10.
- 查看系统python版本
再开个终端,或者使用quit退出LLDB,输入:
python --version
验证是统一的,如果不统一,可以先行尝试后面的,有问题,就改下系统python的版本吧.具体怎么改版本这里不赘述,自行Google
实现
在终端中的简单实现
为了方便理解,我们首先在终端中用个非常简单的函数.
1.创建目录(这个随意)
mkdir ~/lldb
touch findclass.py
2.编辑findclass.py(注意缩进)
def findclass(debugger,command,result,internal_dict):
print("hello lldb")
3.加载
因为我们的文件是放在我们自建目录下,所以LLDB根本不可能知道它的存在.所以需要经过下面几步加载:
注意:都是打开终端,输入lldb进入lldb模式之后
command script import ~/lldb/findclass.py
command : 管理LLDB自定义命令
script : 用脚本实现的自定义命令
import : 导入文件路径
上面做的仅仅是将路径加入到了LLDB的认知(相当于环境变量),所以如果要执行命令.还需要继续:
script import findclass
上面做的是导入模块.好了,已经将模块导入了.为了方便的使用,我们还要进行下一步:
command script add -f findclass.findclass findclass
command : 管理LLDB自定义命令
script : 用脚本实现的自定义命令
add : 添加一个LLDB命令
-f : function 用于绑定一个ptyhon函数
findclass.findclass : findclass模块(默认一个文件是一个模块)中的findclass函数
findclass: 映射成的LLDB命令
现在在终端输入findclass,终端就会输出:
hello lldb
恭喜,这就是一个简单的LLDB自定义命令了!
优化
如果你刚刚手抖关闭了LLDB的终端,当你再次输入的时候,你会发现findclass命令无效了.这可蛋疼了,以后每次开终端都这么弄,要死人.
我们希望,LLDB每次启动,都会加载我们的命令.LLDB有个内置函数__lldb_init_module,这是一个钩子,当你的模块被引入LLDB的时候就会调用.
1.将我们的findclass.py修改成如下样式:
def findclass(debugger,command,result,internal_dict):
print("hello lldb")
def __lldb_init_module(debugger, internal_dict):
debugger.HandleCommand('command script add -f findclass.findclass findclass')
2.编辑~/.lldbinit,就是用户根目录下的.lldbinit
注意:需要打开finder的显示隐藏文件功能.如果没有打开,新开个终端窗口,输入:
defaults write com.apple.finder AppleShowAllFiles -bool true
找到文件之后,在文件末尾添加:
command script import ~/lldb/findclass.py
这个文件是LLDB初始化的时候就会调用的.这样我们就形成了一个链条:
初始化文件(.lldbinit)--->加载findclass.py--->执行__lldb_init_module-->完成自定义命令添加
好了,现在无论重新关闭打开多少次,进入lldb,这个命令也是有效的了.
如果测试确实如此,那么就可以关了终端.
在Xcode中
随便打开一个原来项目(或者你新建一个),弄个断点,就是为了触发lldb.
这时候,你输入findclass,可以看到,控制台有输出了! 这就是一个自定义命令了!
真正实现功能
如果是仅仅为了打印,就不用都这么多圈子了.
现在开始实现我们的需求:
1.删除原来的打印语句
2.定义一个要执行的表达式,当然这里就是利用OC的runtime获取类的程序了.runtime在这里不赘述.
codeString = r'''
@import Foundation;
int numClasses;
Class * classes = NULL;
classes = NULL;
numClasses = (int)objc_getClassList(NULL, 0);
NSMutableString *returnString = [NSMutableString string];
classes = (__unsafe_unretained Class *)malloc(sizeof(Class) * numClasses);
numClasses = (int)objc_getClassList(classes, numClasses);
for (int i = 0; i < numClasses; i++) {
Class c = classes[i];
[returnString appendFormat:@"%s,", class_getName(c)];
}
free(classes);
returnString;
'''
可以看到,我们把整个代码赋值给codeString这个字符串. r是python的语法,为了防止转义字符串的.如果不了解可以参考python学习之 字符串前'r'的用法
3.获取运行结果
res = lldb.SBCommandReturnObject() #1
debugger.GetCommandInterpreter().HandleCommand("expression -lobjc -O -- " + codeString, res) #2
returnVal = res.GetOutput() #3
#1 获取命令执行的返回值对象
#2 执行一段命令(codeString),并将命令执行结果放到返回值对象(res)中
#3 将res的输出(可以理解为,就是刚刚OC代码中的returnString)赋值给returnVal
4.python优化显示
剩下的事情就简单了,就是处理好换行.还有过滤.
我们的函数有个command参数,这个参数就是用户的输入:
findclass aaa
这个aaa就是command参数.
resultArray = returnVal.split(",")
if not command: # 没有输入,显示所有类
print returnVal.replace(",", "\n").replace("\n\n\n", "")
else:
filteredArray = filter(lambda className: command in className, resultArray)
filteredResult = "\n".join(filteredArray)
result.AppendMessage(filteredResult) #1
#1 能够让命令执行完,输出filteredResult,也就是我们需要类的列表.
好了,到Xcode中试试吧!!!
注意:如果要生效,要先过了断点,然后重新触发断点.
完整代码:
import lldb
def __lldb_init_module(debugger, internal_dict):
debugger.HandleCommand('command script add -f findclass.findclass findclass')
def findclass(debugger, command, result, internal_dict):
codeString = r'''
@import Foundation;
int numClasses;
Class * classes = NULL;
classes = NULL;
numClasses = (int)objc_getClassList(NULL, 0);
NSMutableString *returnString = [NSMutableString string];
classes = (__unsafe_unretained Class *)malloc(sizeof(Class) * numClasses);
numClasses = (int)objc_getClassList(classes, numClasses);
for (int i = 0; i < numClasses; i++) {
Class c = classes[i];
[returnString appendFormat:@"%s,", class_getName(c)];
}
free(classes);
returnString;
'''
res = lldb.SBCommandReturnObject()
debugger.GetCommandInterpreter().HandleCommand("expression -lobjc -O -- " + codeString, res)
returnVal = res.GetOutput()
resultArray = returnVal.split(",")
if not command: # No input supplied
print returnVal.replace(",", "\n").replace("\n\n\n", "")
else:
filteredArray = filter(lambda className: command in className, resultArray)
filteredResult = "\n".join(filteredArray)
result.AppendMessage(filteredResult)
扩展更多
现在你已经有个架子了,以后想实现什么自定义命令,就先用OC的runtime实现了,然后替换上面例子中的OC代码,保证有个正确的返回值就好了.欢迎大家留言分享创意.
