打造一款代码命名工具的详细教程

打造一款代码命名工具的详细教程

你是否还在为代码命名而纠结不已？

here are only two hard things in Computer Science: cache invalidation and naming things.-- Phil Karlton

那么如何更好的命名呢？ 是否有好的工具可以支持我们命名呢？网上搜索一圈没有发现满意的，于是自己动手丰衣足食，https://jadepeng.gitee.io/code-naming-tool/。

使用方法： 打开网页后，在中文输入框中输入 中文命名，然后回车即可。也可以直接在英文输入框输入英文，搜索候选。

现有的工具

界面做的很酷，但是推荐出来的变量名称质量参差不齐，失去了参考意义。

新的思路

我们常说以史为鉴，换一个思路，我们可以从优秀的开源库中去吸收他们命名的经验，看看他们是如何命名的，来供我们参考。

实现思路：

1. 从spring、apache等代码库，读取变量、方法、类名称

2. 根据关键词匹配出候选命名

3. 候选结果排序

获取优秀命名

要获取命名，首先想到的是读取代码库，需要先-代码，然后解析 ———— 工作量巨大，PASS。

那怎么做呢，换个角度，可以通过java的反射来实现。

首先添加一个辅助库：

org.reflections

reflections

0.9.12

然后初始化Reflections,FilterBuilder可以用来过滤类库，我们设置"org","javax","com","io", 基本上囊库了主要的开源类库，比如spring，apache等.

List classLoadersList = new LinkedList();

classLoadersList.add(ClasspathHelper.contextClassLoader());

classLoadersList.add(ClasspathHelper.staticClassLoader());

Reflections reflections = new Reflections(new ConfigurationBuilder()

.setScanners(new SubTypesScanner(false), new ResourcesScanner())

.setUrls(ClasspathHelper.forClassLoader(classLoadersList.toArray(new ClassLoader[0])))

.filterInputsBy(new FilterBuilder().includePackage("org","javax","com","io")));

然后，可以通过reflections.getSubTypesOf(Object.class);来获取相关的class了,注意，我们初始化一个 Map name2count = new HashMap();用来存储代码命名以及对应的出现次数。

Set> allClasses =

reflections.getSubTypesOf(Object.class);

Map name2count = new HashMap();

for (Class> clazz : allClasses) {

System.out.println(clazz.getName());

try {

appendToNameMap(name2count, clazz.getSimpleName());

Field[] fhttp://ields = clazz.getDeclaredFields();

for (Field field : fields) {

String name = field.getName();

appendToNameMap(name2count, name);

}

Method[] methods = clazz.getMethods();

for (Method method : methods) {

String name = method.getName();

appendToNameMap(name2count, name);

// parameters

Parameter[] parameters = method.getParameters();

for (Parameter param : parameters) {

name = param.getName();

appendToNameMap(name2count, name);

}

}

}catch(Throwable t)

{ }

其中appendToNameMap:

private static void appendToNameMap(Map name2count, String name) {

// filter

if(name.contains("-") || name.contains("_")|| name.contains("$")){

return;

}

if (!name2count.containsKey(name)) {

name2count.put(name, 1);

} else {

name2count.put(name, name2count.get(name) +1);

}

}

最后把结果存储到文件，作为我们的资源。

FileUtils.writeAllText(jsON.toJSONString(name2mgXrTCAxgucount), new File("name2count.txt"));

可以到https://gitee.com/jadepeng/code-naming-tool/blob/master/vars.js查看结果。

命名推荐

命名推荐，还是遵循，先翻译，然后根据翻译结果搜索并召回。

其中翻译直接调用网易有道的，但是搜索如何搞定呢？

最简单的方法，肯定是分词，然后建立索引，lucene是标配。但是上lucene就要上服务器，PASS!

我们来找一个浏览器端的lucene，google 后选定flexsearch.

flexsearch github上有6.5k star，因此优先选择。

下面来看具体的实现。

建立索引

初始化FlexSearch，然后将之前获取的代码命名建立索引。

var index = new FlexSearch({

encode: "advanced",

tokenize: "reverse",

suggest: true,

cache: true

})

var data = []

var i = 0

for (var name in names) {

var indexName = name.replace(/([A-Z])/g, " $1")

data[i] = {

"name": name,

"count": names[name]

}

index.add(i++, indexName)

}

这里有个小技巧，name.replace(/([A-Z])/g, " $1") 可以将驼峰命名拆分成单词。

同时data数组会保存所有的命名和响应的出现次数。

搜索候选

先翻译，然后将翻译结果给FlexSearch搜索。

function searchFromIndex(value) {

var results = index.search(value, 25)

results = results.map(function (i) {

return data[i]

})

results = results.sort(function (a, b) {

return b.count - a.count

})

return results

}

先搜索，出来的结果是data中的index序号，转换为list对象，然后按照count倒排。

tips： 理论上，翻译的结果可以去除一些停用词，搜索效果应该更好，这里先放着。

显示结果

对结果进行格式化：

function formatSuggestion(item){

return `${item.name} 代码库共出现${item.count}次 (相关搜索： codelf   searchcode)`;

}

增加到codelf 和 searchcode的链接，显示结果如下：

开源地址

github: https://github.com/jadepeng/code-naming-tool

gitee: https://gitee.com/jadepeng/code-naming-tool

命名工具地址： https://jadepeng.gitee.io/code-naming-tool/

总结

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。