利用Sonar定制自定义JS扫描规则(三)——SSLR JavaScript Toolkit 使用说明

Published on:
Tags: sonar js

在上一篇 blog 中讲了在 sonar 中如何新增自定义的 JS 规则,这里面比较难的地方是 XPath 语句的编写,而要编写正确的 XPath 语句,首先要拿到语法的 AST,下面我们就来介绍如何使用 SSLR JavaScript Toolkit 工具来得到源代码的语法树。

首先通过在这里下载 SSLR JavaScript Toolkit 工具,下载下来是一个 jar 包,在 cmd 窗口使用 java -jar sslr-javascript-toolkit-1.3.jar 打开这个工具,操作界面如下:

左上方的窗口是用来输入你的源代码,右上方的窗口是来显示你的 AST,最下面的窗口是来输入你的 XPath 规则。

我们现在左上方输入一些简单的 javascript 代码,然后点击 Parse Source Code 按钮,可以得到源代码的语法树:

得到语法树后,我们也可以点击右边窗口的 XML 页面,得到的是语法树的 XML 文档。有了 XML 文档,就可以通过 XPath 轻松得到你想要的语句了。

举个例子:比如我想得到本地变量名,即 var 关键字后面的变量名,可以通过 XPath 的语法来查询。

在最下方的窗口输入 XPath 语法规则,点击 Evaluate XPath 按钮,如果语法正确,就会出现返回结果,并高亮选中你想要查询的代码,如下:

如果语法错误,右边的窗口会给出提示,如果查询语句不正确,任何源代码都不会被选中。更多的 XPath 语法可以参考http://www.w3schools.com/xpath/

总结:sonar 其实很早就支持了对 JS 的代码校验,但是你如果想自己定制校验规则,最简单的方式就是通过 sonar 的 web 接口增加 XPath 规则,这个需要在 XPath 语法上多花点力气,如果写出来的查询语法不正确,可以多试几遍,用 SSLR JavaScript Toolkit 可以很方便的调试。最后祝大家都可以在 sonar 上配置自己的自定义规则。

赞赏

Comments