阿里巴巴Java规约插件试水

阿里去年出了一个有关IDE的插件,应该对我这种层次的比较有用,养成一个好习惯,试试水

云栖社区链接:https://yq.aliyun.com/articles/224817?spm=a2c4e.11153959.blogcont224345.14.12a81178NBwput

按这个链接IDEA上安装应该没问题,如果网速不好,下载的链接帖子里也有

安装好了之后,Idea的Tools菜单里就有这一项

或者直接鼠标右键里也有这个选项

话不多说,来一个Hello World试一试

package Love;

public class HelloWorld {
    public static void main(String[] args) {
        System.out.println("Hello world");
    }
}

检查一下,结果就有2个Major问题

第一个包名必须小写,包名的点分隔符之间只有一个自然语义英语单词,我这里maven创建时指定的Love不合要求,这个可以测试下,并且必须单数,给出了例子

第二个所有的类要添加作者信息

那么这里加一个作者,至于package,改成小写的同时,顺便测试一下,如果点分隔符之间不止一个自然语义英语单词会怎么样

package com.maoxiaomeng.lihui;

/**
 *  Demo HelloWorld
 *  
 *  @author lihui 
 *  @date 2018/03/19
 */

public class HelloWorld {
    public static void main(String[] args) {
        System.out.println("Hello world");
    }
}

包名中间来了个猫小萌,检查,我先以为为啥没法检查,原来是下面这行浅绿色的字样,显示没有违反规约

这里有2点比较奇怪,一个是每次重新检查居然不会清理掉上次检查的结果,另一个就是猫小萌满足要求,有可能是这还不够明显,换一个明显的试试,可是我将maoxiaomeng换成了myname,sunshine,hellobike,也都没检查出问题来,所以所谓的点分隔符之间有且仅有一个自然语义的英语单词,不明觉厉

帖子里的例子,有一些信息可以高亮提示

可是我定义一个private interface,没任何反应,小失望,或许是因为quickstart里面有的,插件就没怎么管,不过这都不是目的

经过用了这么会的感觉来看,插件的作用是提高编码规范,而不是为了给你提示错误的,既然这里有Major等级,估计还有其他等级的警告,一方面规范自己,一方面保证一个项目所有人按照既定的规则来完成,对于项目维护十分有必要

我就默默规范自己吧

发表评论