开发规范之——阿里规约插件安装和使用

前言

17年2月9号阿里发布了java规约手册(下载请关注“阿里技术”公众账号),java规约手册分为编程规约,异常日志,MySQL规约,工程规约,安全规约五个章节,编程规范可以帮助我们养成良好的编程习惯,提高代码质量,降低沟通成本。
晚些时候(10月14日)在杭州云栖大会上发布了《阿里巴巴 Java 开发规约》的扫描插件,把《阿里巴巴 Java 开发规约》强制条目转化自动插件,并实现部分的自动编码。
该插件已经在 Github 上开源,项目地址:https://github.com/alibaba/p3c

功能

它以一个 IDE 的插件存在,可以自动对手册中的 Java 不规范的问题进行提示。

安装

作为Android的开发者,以Android studio为例讲解

  • 查找插件
    依次选择:Setting >> Plugins >> Browse repositories
    查找插件
  • 安装插件
    在搜索框中输入关键字alibaba,并在结果中,找到插件并安装

    安装完成之后重启as看到阿里编码规约说明插件安装成功。

使用

  • 切换语言
    可以切换语言,支持中文和英文两种语言环境,你可以在 Tools -> 阿里编码规约 >> 切换语言至 Xxx 进行切换
  • Inspections 支持
    它会自动在我们编码的阶段,进行快速灵活的静态代码分析,自动检测编译器和运行时错误,并提示开发人员再编译之前就进行有效的改正和改进
    如下图:

    当然,所有的规范,都可以在Setting->Editor->Inspections->Ali Checked 中查看到

    代码静态分析

    执行Tools->阿里编码约定->编码规约扫描
    扫描
    它分析的结果,会以 Blocker/Critical/Major 三个级别进行区分。最终检测出来的效果也非常的直观
    扫描结果