编写Java代码如何更加规范和简洁?
这个问题包含两点:
- 代码如何更加规范;
- 代码如何更整洁;
下面按照这两点展开说说我的理解。
代码规范
代码规范其实业界大厂或者别的语言已经有很多解决方案了,比如,pylint,clang-format,go-fmt这种,对于JAVA可以试试看Google的google-java-format,我目前是gradle流,喜欢maven的朋友不妨自己去官网上看一下用法。
引入的方法很简单:
直接在plugins里声明一下。
检查的话可以敲命令:gradle verifyGoogleJavaFormat
按照Google模板改写文件:gradle googleJavaFormat
当然最好在Makefile里写好,一劳永逸。
这个格式也支持IDEA和eclipse,以IDEA为例:
- 在插件的Marketplace里搜google-java-format,然后安装。
- IntellJ IDEA -> Other Settings -> google-java-format 勾选Enable
- 默认项目应用的话,在Files -> Other Settings -> Default Settings里启用
应用完成后Ctrl+Alt+L就能格式化代码了。不过这里有个坑,它不会格式化import代码段,这个可以去github上下载个格式导入IDEA解决。
这样几步下来基本就能保证团队内部的代码风格一致。
代码整洁
代码整洁比较考验基本功,最好的办法是去看看Effective Java,按Joshua Bloch大神的要求做。
这个话题三言两语说不清,加油吧。
第一步,简单规范制定;
第二步,代码案例,并生成文档;
第三步,规范+案例 团队集中学习;
第四步,团队自我完善规范——循环;
实践建议:网络上规范一大堆,有一个基本的JAVA规范,没二话大家都可以实现。业务代码功能模块化生成规范。