Java开发手册学习(1)文档说明及插件安装

325 阅读4分钟

3a6efe38dfe84aac8f16f7d750df45e8_3.png

《Java开发手册》是一份由阿里巴巴集团编写的技术规范和最佳实践指南,旨在帮助Java开发人员编写高质量、高效、可维护的代码。该手册包含了大量的编码规范、代码示例和开发建议,涵盖了Java语言编程的各个方面,包括:编程规约、异常日志、单元测试、安全规约、MySQL数据库、工程结构、设计规约等。

发布版本说明

自从 2016.12.07 试读版本首次对外发布,到目前为止已经经历了十多个的版本,以下是各个版本的发布时间:

版本号版本名发布日期
----2016.12.07
1.0.0正式版2017.02.09
1.0.1--2017.02.13
1.0.2--2017.02.20
1.1.0--2017.02.27
1.1.1--2017.03.31
1.2.0完美版2017.05.20
1.3.0终极版2017.09.25
1.3.1纪念版2017.11.30
1.4.0详尽版2018.05.20
1.5.0华山版2019.06.19
1.6.0泰山版2020.04.22
1.7.0嵩山版2020.08.03
1.7.1黄山版2022.02.03

不同版本的下载地址

非完全整理,不同版本可到阿里云网站搜索下载

《Java开发手册(终极版)》

《Java开发手册 (正式版)》

《Java 开发手册(华山版)》

《Java开发手册(泰山版)》

《Java开发手册(嵩山版)》

为什么要学习Java开发手册

统一的编码规范:该手册提供了一套统一的编码规范,使得不同开发人员之间的代码风格更加一致。这有助于提高代码的可读性和可维护性,减少团队协作中的沟通成本。

提高代码质量:该手册强调了代码质量和最佳实践,推崇一些编码规范和开发建议。遵循这些规范和建议可以帮助开发人员编写更高质量的代码,减少潜在的bug和错误。

性能优化:该手册也提供了一些性能优化的建议和最佳实践,如减少代码的复杂度、合理使用并发编程等。这些实践可以帮助开发人员编写更高效的代码,提高系统的性能和响应速度。

总的来说,阿里巴巴的Java开发手册是一份非常有价值的学习资料,它可以帮助你提高代码质量、开发效率和系统性能。通过学习和应用手册中的规范和建议,你可以成为一名更优秀的Java开发人员。

Java开发手册idea插件使用

1、打开 IDEA,选择 File - Settings - Plugins - Browse repositories 后,输入 alibaba 选中 Alibaba Java Coding Guidelines,点击 Install

Alibaba Java Coding Guidelines 1.png

2、重启IDEA,安装后,会提示你重启 IDEA 已启用插件,重启后选择项目,右键会多出两个菜单,编码规约扫描、关闭实时检测功能,当然它也有个快捷键是Ctrl+Shift+Alt+J

Alibaba Java Coding Guidelines 2.png

3、或者,选中某一个类,或者在这个类里边右键,也会出现编码规约扫描、关闭实时检测功能,两个菜单

Alibaba Java Coding Guidelines 3.png

4、扫描出不符合规范的代码,扫描代码后,将不符合规约的代码按 Blocker、Critical、Major 三个等级显示在下方,双击可以定位至代码处,右侧窗口还有针对代码的批量修复功能。

Alibaba Java Coding Guidelines 4.png

5、Blocker、Critical、Major 这三个等级,翻译成中文的意思就是:崩溃、严重、重要 ,至少前两个级别是必须要处理掉的

Java开发手册idea插件源码下载

GitHub下载地址: github.com/alibaba/p3c

P3C是阿里巴巴开源的一套Java代码规约和最佳实践工具。它是基于阿里巴巴的Java开发手册(Alibaba Java Coding Guidelines)而开发的,旨在帮助开发人员自动检测和修复代码中的潜在问题,提高代码质量和可维护性。

P3C的全称是"Programmer's Performance Profiling Center",它包含了一系列的静态代码分析规则和插件,可以与主流的Java开发工具(如IDEA、Eclipse等)集成使用。通过P3C,开发人员可以在编码过程中自动检测出一些常见的代码问题,如命名规范、代码风格、异常处理、并发编程、性能优化等方面的违规情况,并提供相应的修复建议。

P3C的目标是帮助开发人员遵循阿里巴巴的Java开发手册,统一团队的编码规范,减少潜在的bug和错误,提高代码的可读性和可维护性。它在阿里巴巴内部得到了广泛的应用,并且也受到了Java开发社区的认可和使用。