专栏名称: OSC开源社区
OSChina 开源中国 官方微信账号
目录
相关文章推荐
极客之家  ·  美观、易用,一款最好用的 Windows ... ·  昨天  
极客之家  ·  7.3k star,一款开源高效的知识管理神器! ·  3 天前  
OSC开源社区  ·  那个苹果史上最有品味的程序员去世了 ·  3 天前  
51好读  ›  专栏  ›  OSC开源社区

如何编写既美观又规范的Java代码?

OSC开源社区  · 公众号  · 程序员  · 2024-12-12 15:01

主要观点总结

本文探索Java代码美学,介绍了为什么需要Java代码样式规范,包括提高代码可读性、团队协作效率等。同时介绍了业界Java代码样式规范如Google Java Style和阿里Java规范等,以及如何选择和定制规范。最后介绍了如何将规范融入日常开发,包括配置和使用Code Style和CheckStyle等自动化工具。文章总结了Java样式规范在团队协作中的重要性。

关键观点总结

关键观点1: Java代码样式规范的重要性

对于团队开发,不同的代码规范可能引起的问题包括代码可读性、代码质量和团队协作效率等。良好的代码规范能够帮助团队成员快速理解彼此的代码,减少沟通成本,提高开发效率。

关键观点2: 业界Java代码样式规范介绍

包括Google Java Style、阿里Java规范等,这些规范提供了对Java代码编码标准的完整定义,有助于保持项目代码风格一致。

关键观点3: 如何选择和使用Java代码样式规范

在选择代码规范时,需要考虑使用代码规范的目的、开发阅读代码的环境和工具支持等因素。使用Code Style和CheckStyle等工具,可以帮助开发者自动格式化代码和进行代码样式校验。

关键观点4: 如何将Java代码样式规范融入日常开发

包括配置和使用Code Style和CheckStyle等自动化工具,以及在Maven项目中集成CheckStyle插件等,实现自动化代码样式规范检查。

关键观点5: 总结Java样式规范在团队协作中的重要性

通过规范的代码,不仅能提高个人技能,也是团队协作和项目成功的基石。将Java样式规范内化为自己的编码习惯,有助于提高团队协作效率。


正文

请到「今天看啥」查看全文


2.2 规范选择与制定

a. 规范选择

上面列举了多项代码规范,在决定使用哪种规范之前,可以考虑三个方面:

•明确目标:使用代码规范的目的是什么,只是为了项目内代码风格一致,还是为了和其他团队分享或者其他公司分享或者开源?

•使用环境:开发阅读代码的环境是什么,GitHub、GitLab、公司内部的代码平台?

•工具支持:code format工具支持情况,code sytle check工具支持情况,编译工具:maven、gradle,IDE:IntelliJ、Eclipse、VS Code;

综合上面的三个方面的考虑,优先选择Google Java Style。

b. 规范制定

Google Java Style部分代码样式团队难以接受,比如2空格缩进等,可以在原始Google Java Style基础上,适当定制化调整。

2.3 规范使用

代码样式规范的使用分为两个方面:

•代码格式化

•代码样式校验

注意:code style 跟 check style 的「配置文件」必须对应,即按照code style format的代码check style不报错。

代码样式校验

代码格式化依赖于开发者手动进行格式化,为达到团队/项目代码样式规范的落地,需要有全面的自动化的代码检查。根据当前业界推荐,采用Checkstyle作为自动化代码样式校验工具。

需要对原始 Google Code Style 的google_checks进行定制,以适配上面intellij-java-jd-style.xml的定制。

•修改google_checks中的内容:

除了上述的长度和缩进的代码样式校验,Checkstyle还可以配置其它代码校验,可根据团队接受情况予以配置。

03
最佳实践:如何将规范融入日常开发

3.1 Code Style配置&使用

a. IDEA配置Code Style

在 IntelliJ IDEA下,使用intellij-java-jd-style.xml进行代码格式化之前,需要先进行配置。

设置配置文件,路径:IntelliJ IDEA→Preference→Editor→Code Style,参考下图:

导入定制的 Code Style 文件:intellij-java-jd-style.xml

命名Scheme,如图中JD-Style,并启用该代码样式规范

b. IDEA使用 Code Style

完成上述配置后,在Mac环境的IntelliJ IDEA中,可以对选中的代码格式化(快捷键:Option+Command+L)或者对选中的文件格式化(快捷键:Shift+Option+Command+L)







请到「今天看啥」查看全文