CaseFormat 插件——IntelliJ IDEA字符串格式转换插件

左手的ㄟ右手 2022-04-23 04:10 620阅读 0赞

# CaseFormat插件 #

### 文章目录 ###

*  CaseFormat插件
 *   *  背景
     *  不要重复造轮子
     *  case-format插件介绍
     *   *  环境
         *  原理
         *  快捷键
     *  例子

## 背景 ##

*  数据库表字段名为`this_is_a_column_name`，现在我需要将这张表映射为一个`POJO`，`MyBatis`/`JPA`/`Lombok`等都可以自动生成或省很多事儿，但假设需要手动添加一个字段，为了保证字段名称不出错，一般是复制`this_is_a_column_name`到JavaBean，然后手动改成驼峰，但是这太不优雅了，我需要一个快捷键，直接从下划线变成驼峰；
 *  从其他语言移植代码过来，很多变量名称不符合规范，比如`int this_is_a_var_name = 0;`，如果需要修改成驼峰，那是真的难受，我需要一个快捷键直接修改成驼峰；
 *  有一个驼峰的变量`thisIsACamelVarName`，现在需要将这个变量修改成`final static`的成员变量，可以手动修改，但是很麻烦，先全部变成大写，再用下划线连接单词，我需要一个快捷键……
 *  不知道从哪里复制来了一个字符串`this is a var name`，我想变成驼峰的，我可能还需要变成大写下划线的，我需要快捷键……
 *  我有个变量名`thisIsAValue`，我想用中横线连接……我需要……

## 不要重复造轮子 ##

我在[JetBrains Plugins Repository][]/`github`/`google`/`baidu`用很多关键字搜索过一遍，最后找到了一个插件[UpperLowerCapitalize][]，这个插件可以通过快捷键让选择的字符串变成全大写、全小写或驼峰，这已经解决了一部分问题了，但是非常有限，还要做二次操作。

下定决心重新写一个插件：[case-format][]。

主要借鉴了[guava][]中的`CaseFormat`类，在代码内部转换字符串格式，我都会使用这个工具，但是在IDE层面，我目前还没找到类似的工具。

## case-format插件介绍 ##

### 环境 ###

*  `JDK 1.8`
 *  `Win 10`
 *  `IDEAIntelliJ IDEA 2017.2.7`

### 原理 ###

*  通过API获取`Editor`内选中的文本（如果没有选中，就获取光标后的第一个单词）；
 *  判断文本中是否含有空格、中横线`-`或下划线`_`，如果有，就以这三种分割符分割出单词列表（三种分隔符可以同时存在）；
 *  如果没有上面的三种分隔符，就默认选中的文本为驼峰，然后以驼峰的规则分割出单词列表；
 *  拿到单词列表后，再根据不同的快捷键，用不同的方式处理每个单词，最后再用对应的连接符号连接所有单词列表，返回一个处理过的字符串；
 *  将选中的文本替换为处理后的文本。

### 快捷键 ###

假设选中的文本为`this_is_a_var_name`

<table> 
 <thead> 
  <tr> 
   <th align="center">快捷键</th> 
   <th align="center">英文</th> 
   <th align="center">解释</th> 
   <th align="center">结果</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="center"><code>Alt + H</code></td> 
   <td align="center"><code>lower hyphen</code></td> 
   <td align="center">变成小写中横线连接的字符串</td> 
   <td align="center"><code>this-is-a-var-name</code></td> 
  </tr> 
  <tr> 
   <td align="center"><code>Alt + Shift + H</code></td> 
   <td align="center"><code>upperhyphen</code></td> 
   <td align="center">变成大写中横线连接的字符串</td> 
   <td align="center"><code>THIS-IS-A-VAR-NAME</code></td> 
  </tr> 
  <tr> 
   <td align="center"><code>Alt + M</code></td> 
   <td align="center"><code>lower camel</code></td> 
   <td align="center">变成小写开头的驼峰，因为和<code>UpperLowerCapitalize</code>的快捷键冲突，所以没有使用<code>ALT + C</code>的快捷键</td> 
   <td align="center"><code>thisIsAVarName</code></td> 
  </tr> 
  <tr> 
   <td align="center"><code>Alt + Shift + M</code></td> 
   <td align="center"><code>upper camel</code></td> 
   <td align="center">变成大写开头的驼峰</td> 
   <td align="center"><code>ThisIsAVarName</code></td> 
  </tr> 
  <tr> 
   <td align="center"><code>Alt + U</code></td> 
   <td align="center"><code>lower underscore</code></td> 
   <td align="center">变成小写下划线连接的字符串</td> 
   <td align="center"><code>this_is_a_var_name</code></td> 
  </tr> 
  <tr> 
   <td align="center"><code>Alt + Shift + U</code></td> 
   <td align="center"><code>upper underscore</code></td> 
   <td align="center">变成大写下划线连接的字符串</td> 
   <td align="center"><code>THIS_IS_A_VAR_NAME</code></td> 
  </tr> 
 </tbody> 
</table>

## 例子 ##

lower hyphen  
![alt_h.gif][]

upper hyphen  
![alt_shift_h.gif][]

lower camel  
![alt_m.gif][]

upper camel  
![alt_shift_m.gif][]

lower underscore  
![alt_u.gif][]

upper underscore  
![alt_shift_u.gif][]

[JetBrains Plugins Repository]: https://plugins.jetbrains.com/
[UpperLowerCapitalize]: https://plugins.jetbrains.com/plugin/183-upperlowercapitalize
[case-format]: https://github.com/clyoudu/case-format
[guava]: https://mvnrepository.com/artifact/com.google.guava/guava
[alt_h.gif]: https://github.com/clyoudu/case-format/raw/master/screenshot/alt_h.gif
[alt_shift_h.gif]: https://github.com/clyoudu/case-format/raw/master/screenshot/alt_shift_h.gif
[alt_m.gif]: https://github.com/clyoudu/case-format/raw/master/screenshot/alt_m.gif
[alt_shift_m.gif]: /images/20220323/3b63b3a517d94d7ea643187fb411d2c7.png
[alt_u.gif]: https://github.com/clyoudu/case-format/raw/master/screenshot/alt_u.gif
[alt_shift_u.gif]: /images/20220323/185375ce074a450ea49914d8cd04dba8.png