黑马程序员技术交流社区

标题: 阿里JAVA开发规约插件安装,规范你的代码,让协作更高效。 [打印本页]

作者: wang_55    时间: 2018-6-12 19:16
标题: 阿里JAVA开发规约插件安装,规范你的代码,让协作更高效。
本帖最后由 wang_55 于 2018-6-12 19:42 编辑

这是一篇关于给IDE软件安装阿里JAVA开发规约插件的帖子


发帖要严谨,所以我在选题之前,在论坛里面搜索了一下,虽然有几篇关于阿里的JAVA开发手册的帖子,不过基本上都是去年的,版本还停留在1.3,并且还停留在手册的层面,并没有介绍如何在我们编写的过程中直接的,及时的提示程序员规范自己的代码。本帖主要介绍规范代码的重要性,以及插件的安装,还有安装前后IntelliJ IDEA编辑界面的对比。(不好意思,我电脑上没有安装Eclipse,所以没有图文并茂的安装过程以及前后对比,但我会提供文字的插件安装方法。)

没有规矩,不成方圆。

JAVA作为一款开发语言,在日后的应用中,不同的项目都有一个共同点,就是需要程序员们协同工作。我们都知道信息的传递是有损耗或者变换的,就好比同一件事经过10个人的传递,最后一个人和第一个人获取到的事件信息肯定不是完全一致的。

在看程序员们在同一个项目中的协同工作时,假设大家都是用JAVA语言进行开发,除了那些编译没报错的语句,众多自定义的变量名,类名等名称,很难让另外一个程序员直接看明白它代表的是什么,这样就会让大家的协同工作效率降低,极有可能会出现曲解,误解,甚至产生错误的调用,或者逻辑上的错误。

如何更高效的沟通,这就需要我们大家都使用同样的,规范的,共识的语言。这就好比正常人很难和一个语无伦次的人交流,即使大家都讲中文。

综上所述,我们不仅仅需要让自己写的代码符合其本身的规定,同时在我们书写的习惯上,也要尽可能的统一,让代码更易读,从而提高协同工作的效率。

就像上课第一天,老师说的“所谓的好代码,就是可以让人看懂的代码”,我想大致就是这个意思吧。团队其他人能看懂,自己不用返工,何乐而不为?

不好意思,说的有点多,完全是想引起大家的重视。

众多的IDE软件中,我使用了黑马教程推荐的IntelliJ IDEA,在我惊叹它便利的同时,其实它还有更多的功能我们还没有了解到。下面给各位同学们安利一个非常NB的插件,可能有些前辈已经在使用了,请轻喷,我还只是一个JAVAEE 15期的小白。

如果你也使用IntelliJ IDEA,请打开它。
File-->Setting(快捷键:Ctrl+Alt+S)

左侧点击Plugins,右侧下方中间,点击Brower repositories

在弹出窗口的查找栏里输入“Alibaba”,下方排行第一个,全称为“Alibaba Java Coding Guidelines”

下载安装中


重启IDEA


重启后,需要重新同意IDEA的用户协议



至此,插件已经安装完毕了。下面想大家展示一下插件安装前后,在IDEA编写代码时的前后效果。

这是一段代码,注意我的写的变量名。虽然它们符合JAVA的编译规则,此时IDEA并没有报错。


但是当我安装了“Alibaba Java Coding Guidelines”阿里巴巴JAVA编写规约插件之后。

我看到浅黄色的波浪线,提示我//注释加在该行代码末尾是不规范的。


同时提示我,自定义变量名也是不规范的,注意这些提示不是IDEA自带的,而是在安装插件之后才有的。


最后,给大家放上符合规约的,修改后的代码。




类似的情况还有很多,不仅仅包括命名规范,同时还有其他更高深的规约,帖子中没办法向大家一一展示,在这里给大家提供《阿里巴巴Java开发手册(1.4)》的电子版下载。 阿里巴巴Java开发手册(详尽版).zip (1005.84 KB, 下载次数: 1, 售价: 1 黑马币)
需要一个币就可以下载,签到就可以有一个币了呢~


关于Eclipse的插件安装:
Eclipse版插件支持4.2(Juno,JDK1.8+)及以上版本,我们提供自主的Update Site,通过 Help >> Install New Software
然后输入https://p3c.alibaba.com/plugin/eclipse/update即可看到安装列表。大家可以通过 Help >> Check for Udates
进行插件新版检测。



IDEA的插件我已经安装并且在使用了,如果有任何安装的问题,请在下方留言。如果你发现其他更好的插件,请你一定分享出来哈~



祝大家学业有成!

作者: boluofan    时间: 2018-6-12 21:46
老王牛逼!!!
好人一生平安!
作者: 一个老李    时间: 2018-6-12 21:49
老王666!
小手一抖,插件拿走!




欢迎光临 黑马程序员技术交流社区 (http://bbs.itheima.com/) 黑马程序员IT技术论坛 X3.2