阿里巴巴Java开发手册(第2版)-第1章(3)

简介: 本章是传统意义上的代码规范,包括变量命名、代码风格、控制语句、代码注释、前后端规约等基本的编程习惯,以及从高并发场景中提炼出来的集合处理技巧与并发多线程的注意事项。

1.3 代码格式

1

【强制】如果是大括号内为空,则简捷地写成 {} 即可,大括号中间无须换行和空格;如果是非空代码块,则:

1)左大括号前不换行;

2)左大括号后换行;

3)右大括号前换行;

4)右大括号后如果还有else 等代码,则不换行;表示终止的右大括号后必须换行。

2

【强制】左小括号和右边相邻字符之间不出现空格;右小括号和左边相邻字符之间也不出现空格;而左大括号前需要加空格。详见本节第5条下方正例提示。

反例:if (空格a == b 空格)

3

【强制】if/for/while/switch/do 等保留字与括号之间都必须加空格。

4

【强制】任何二目、三目运算符的左右两边都需要加一个空格。

说明:运算符包括赋值运算符=、逻辑运算符&&、加减乘除符号等。

5

【强制】采用4 个空格缩进,禁止使用Tab 字符。

说明:如果使用Tab 缩进,必须设置1 个Tab 为4 个空格。当IDEA 设置Tab 为4 个空格时,必须勾选Use tab character;而在Eclipse 中,必须勾选insert spaces for tabs。

正例:(涉及1~ 5点)

public static void main(String[] args) {

      // 缩进4 个空格

      String say = "hello";

      // 运算符的左右必须有1 个空格

      int flag = 0;

      // if 与括号之间必须有1 个空格

      // 括号内的f 与左括号,0 与右括号不需要空格

      if (flag == 0) {

          System.out.println(say);

      }

      // 左大括号前加空格且不换行;左大括号后换行

      if (flag == 1) {

          System.out.println("world");

          // 右大括号前换行。若右大括号后有else,则不用换行

      } else {

          System.out.println("ok");

          // 在右大括号后直接结束,则必须换行

      }

}

6

【强制】注释的双斜线与注释内容之间有且仅有一个空格。

正例:

// 这是示例注释,请注意在双斜线之后有一个空格

String commentString = new String();

7

【强制】在进行类型强制转换时,右括号与被强制转换的值之间不需要任何空格隔开。

正例:

double first = 3.14d;

int second = (int)first + 2;

8

【强制】单行字符数限制不超过120 个,超出需要换行,换行时遵循如下原则:

1)第二行相对第一行缩进4 个空格,从第三行开始,不再继续

缩进,参考示例;

2)运算符与下文一起换行;

3)方法调用的点符号与下文一起换行;

4)方法调用中的多个参数需要换行时,在逗号后进行;

5)在括号前不要换行,见反例。

正例:

StringBuilder sb = new StringBuilder();

// 在超过120 个字符的情况下,换行缩进4 个空格

// 方法前的点号一起换行

sb.append("yu").append("wen")...

      .append("han")...

      .append("han")...

      .append("han");

反例:

StringBuilder sb = new StringBuilder();

// 在超过120 个字符的情况下,不要在括号前换行

sb.append("you").append("are")...append

      ("lucky");

// 参数很多的方法调用可能超过120 个字符逗号后才是换行处

method(args1, args2, args3, ...

      , argsX);

9

【强制】在定义和传入方法参数时,多个参数逗号后面必须加空格。

正例:下例中实参的args1 的逗号后边必须要有一个空格。

method(args1, args2, args3);

10

【强制】IDE 的text file encoding 设置为UTF-8; IDE中文件的换行符使用UNIX 格式,不要使用Windows 格式。

11

【推荐】单个方法的总行数不超过80。

说明:除注释外的方法签名、左右大括号、方法内代码、空行、回车及任何不可见字符的总行数不超过80。

正例:代码逻辑分清红花和绿叶、个性和共性,绿叶逻辑单独出来成为额

外方法,使主干代码更加清晰;共性逻辑抽取成为共性方法,便于

复用和维护。

12

【推荐】没有必要增加若干空格使变量的赋值等号与上一行对应位置的等号对齐。

正例:

int one = 1;

long two = 2L;

float three = 3f;

StringBuilder four = new StringBuilder();

说明:增加four 这个变量,如果需要对齐,则要给one、two、three增加几个空格,在变量比较多的情况下,是一件累赘的事情。

13

【推荐】在不同逻辑、不同语义、不同业务的代码之间插入一个空行,分隔开来以提升可读性。

说明:在任何情形下,都没有必要插入多个空行进行分隔。

相关文章
|
人工智能 前端开发 Java
2025年WebStorm高效Java开发全指南:从配置到实战
WebStorm 2025不仅是一款强大的JavaScript IDE,也全面支持Java开发。本文详解其AI辅助编程、Java特性增强及性能优化,并提供环境配置、高效开发技巧与实战案例,助你打造流畅的全栈开发体验。
978 4
|
前端开发 JavaScript Java
Java 开发中 Swing 界面嵌入浏览器实现方法详解
摘要:Java中嵌入浏览器可通过多种技术实现:1) JCEF框架利用Chromium内核,适合复杂网页;2) JEditorPane组件支持简单HTML显示,但功能有限;3) DJNativeSwing-SWT可内嵌浏览器,需特定内核支持;4) JavaFX WebView结合Swing可完美支持现代网页技术。每种方案各有特点,开发者需根据项目需求选择合适方法,如JCEF适合高性能要求,JEditorPane适合简单展示。(149字)
1470 1
|
10月前
|
安全 前端开发 Java
《深入理解Spring》:现代Java开发的核心框架
Spring自2003年诞生以来,已成为Java企业级开发的基石,凭借IoC、AOP、声明式编程等核心特性,极大简化了开发复杂度。本系列将深入解析Spring框架核心原理及Spring Boot、Cloud、Security等生态组件,助力开发者构建高效、可扩展的应用体系。(238字)
|
安全 Java 领域建模
Java 17 探秘:不容错过的现代开发利器
Java 17 探秘:不容错过的现代开发利器
1292 0
|
11月前
|
消息中间件 人工智能 Java
抖音微信爆款小游戏大全:免费休闲/竞技/益智/PHP+Java全筏开源开发
本文基于2025年最新行业数据,深入解析抖音/微信爆款小游戏的开发逻辑,重点讲解PHP+Java双引擎架构实战,涵盖技术选型、架构设计、性能优化与开源生态,提供完整开源工具链,助力开发者从理论到落地打造高留存、高并发的小游戏产品。
|
JavaScript 安全 前端开发
Java开发:最新技术驱动的病人挂号系统实操指南与全流程操作技巧汇总
本文介绍基于Spring Boot 3.x、Vue 3等最新技术构建现代化病人挂号系统,涵盖技术选型、核心功能实现与部署方案,助力开发者快速搭建高效、安全的医疗挂号平台。
504 3
|
安全 Java 数据库
Java 项目实战病人挂号系统网站设计开发步骤及核心功能实现指南
本文介绍了基于Java的病人挂号系统网站的技术方案与应用实例,涵盖SSM与Spring Boot框架选型、数据库设计、功能模块划分及安全机制实现。系统支持患者在线注册、登录、挂号与预约,管理员可进行医院信息与排班管理。通过实际案例展示系统开发流程与核心代码实现,为Java Web医疗项目开发提供参考。
521 2
|
11月前
|
存储 Java 关系型数据库
Java 项目实战基于面向对象思想的汽车租赁系统开发实例 汽车租赁系统 Java 面向对象项目实战
本文介绍基于Java面向对象编程的汽车租赁系统技术方案与应用实例,涵盖系统功能需求分析、类设计、数据库设计及具体代码实现,帮助开发者掌握Java在实际项目中的应用。
412 0