打造一款代碼命名工具的詳細教程

更新時間：2020年09月01日 08:50:33 作者：JadePeng

這篇文章主要介紹了來,我們一起打造一款代碼命名工具,本文給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下

你是否還在為代碼命名而糾結(jié)不已？

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

那么如何更好的命名呢？是否有好的工具可以支持我們命名呢？網(wǎng)上搜索一圈沒有發(fā)現(xiàn)滿意的，于是自己動手豐衣足食，https://jadepeng.gitee.io/code-naming-tool/。

使用方法：打開網(wǎng)頁后，在中文輸入框中輸入中文命名，然后回車即可。也可以直接在英文輸入框輸入英文，搜索候選。

現(xiàn)有的工具

unbug.github.io/codelf/ 提供了一個選擇，作者先調(diào)用有道、百度等翻譯，然后調(diào)用searchcode搜索代碼，從搜索的代碼中提取變量名。

界面做的很酷，但是推薦出來的變量名稱質(zhì)量參差不齊，失去了參考意義。

新的思路

我們常說以史為鑒，換一個思路，我們可以從優(yōu)秀的開源庫中去吸收他們命名的經(jīng)驗，看看他們是如何命名的，來供我們參考。

實現(xiàn)思路：
1. 從spring、apache等代碼庫，讀取變量、方法、類名稱
2. 根據(jù)關(guān)鍵詞匹配出候選命名
3. 候選結(jié)果排序

獲取優(yōu)秀命名

要獲取命名，首先想到的是讀取代碼庫，需要先下載代碼，然后解析 ———— 工作量巨大，PASS。

那怎么做呢，換個角度，可以通過java的反射來實現(xiàn)。

首先添加一個輔助庫：

<dependency>
   <groupId>org.reflections</groupId>
   <artifactId>reflections</artifactId>
   <version>0.9.12</version>
  </dependency>

然后初始化Reflections,FilterBuilder可以用來過濾類庫，我們設(shè)置"org","javax","com","io", 基本上囊?guī)炝酥饕拈_源類庫，比如spring，apache等.

 List<ClassLoader> classLoadersList = new LinkedList<ClassLoader>();
  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);來獲取相關(guān)的class了,注意，我們初始化一個 Map<String, Integer> name2count = new HashMap<String, Integer>();用來存儲代碼命名以及對應的出現(xiàn)次數(shù)。

Set<Class<? extends Object>> allClasses =
    reflections.getSubTypesOf(Object.class);
  Map<String, Integer> name2count = new HashMap<String, Integer>();
  for (Class<?> clazz : allClasses) {
   System.out.println(clazz.getName());
   try {
    appendToNameMap(name2count, clazz.getSimpleName());

    Field[] fields = 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<String, Integer> 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);
  }
 }

最后把結(jié)果存儲到文件，作為我們的資源。

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

可以到https://gitee.com/jadepeng/code-naming-tool/blob/master/vars.js查看結(jié)果。

命名推薦

命名推薦，還是遵循，先翻譯，然后根據(jù)翻譯結(jié)果搜索并召回。

其中翻譯直接調(diào)用網(wǎng)易有道的，但是搜索如何搞定呢？

最簡單的方法，肯定是分詞，然后建立索引，lucene是標配。但是上lucene就要上服務器，PASS!

我們來找一個瀏覽器端的lucene，google 后選定flexsearch.

flexsearch github上有6.5k star，因此優(yōu)先選擇。

下面來看具體的實現(xiàn)。

建立索引

初始化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數(shù)組會保存所有的命名和響應的出現(xiàn)次數(shù)。

搜索候選

先翻譯，然后將翻譯結(jié)果給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
 }

先搜索，出來的結(jié)果是data中的index序號，轉(zhuǎn)換為list對象，然后按照count倒排。

tips：理論上，翻譯的結(jié)果可以去除一些停用詞，搜索效果應該更好，這里先放著。

顯示結(jié)果

對結(jié)果進行格式化：

function formatSuggestion(item){
 return `${item.name} <span class='tips'>代碼庫共出現(xiàn)${item.count}次 (相關(guān)搜索： <a target='_blank' >codelf</a> &nbsp; <a target='_blank' >searchcode</a>)</span>`;
}

增加到codelf 和 searchcode的鏈接，顯示結(jié)果如下：