阿里JAVA规约插件IDEA实操

在10月14日阿里巴巴正式发布《阿里巴巴Java开发手册》扫描插件,一时名声大燥,作为程序员的我们,在思考自己编码规范和风格的时候,更应该看看这款插件能如何便利解决我们日常编码中存在的问题,今天小编带大家来实操下

工具: IDEA(全称 IntelliJ IDEA)

  • 插件安装
    1.点击菜单 File->settings
    2.弹出框右侧选择plugins
    idea
    没有安装的话右侧有个installl 安装后重启

  • 语法检查全览

    安装完了插件我们看看这个插件都对哪些语法做了检测,规范的抑或是不规范的,我们来查看下它检查了哪些语法

    idea

  • 举例

    ArrayList的subList结果不可强转成ArrayList,否则会抛出ClassCastException异常。 说明:禁止强 转,如果需要用到集合特性方法,请新建一个集合,然后置入sublist,new 集合(sublist结果)。

    反例:
       List<String> list = new ArrayList<String>();
       list.add("22");
       //warn
       List<String> test = (ArrayList<String>) list.subList(0, 1);   
    
    
    
    正例:
       List<String> list2 = new ArrayList<String>(list.subList(0, 1));
  • 实操

    我们来编写两段出现在规约插件的代码,里面有正例和反例 ,并利用插件检测

        public class Main {
            public static void main(String[] args) {
               //1
                List<String> list = new ArrayList<String>();
                list.add("22");
                List<String> test = (ArrayList<String>) list.subList(0, 1);
                List<String> list2 = new ArrayList<String>(list.subList(0, 1));
    
                //2
                Long warn = 1l;
                Long notwarn = 1L;
            }
        }

    鼠标右键,点击 编码规约扫描
    idea
    在idea底部会出现扫描结果
    idea
    从图中可以看到扫描结果有1个block错误(不符合命名方式),1个critical(不可强转))错误和1个major(代码作者信息)错误,
    点击错误处可快速定位到具体代码处,这么友好的中文提示看的真是爽,更可喜的是第一处右侧代码还有个提示,按钮 ‘l’替换成’L’,点击后即可快速修正,真的是很贴心,另外如果你在项目中编写不规范的代码,在idea编辑器会体现为不规范代码会被标记为红色下划线,移至具体位置会有很详细的中文提示
    idea

使用感受和总结

  • 中文提示,爽
  • 不规范代码写完自动标红,逼迫着你写规范的代码
  • 写完代码运行检测一下,不仅能检测自己代码隐藏的风险或明显的错误,并且还提供修复方案,怎一个屌字了得
  • 在全局的规约检查里,我们可以将他们列出来的东西全部都看一下,并且在工作中尽量不要犯这种错误,想必我们的编码能 力会更上一层楼

猜你喜欢

转载自blog.csdn.net/lzp492782442/article/details/78379388
今日推荐