【软件开发规范篇】JAVA后端开发编码格式规范

作者介绍:本人笔名姑苏老陈,从事JAVA开发工作十多年了,带过大学刚毕业的实习生,也带过技术团队。最近有个朋友的表弟,马上要大学毕业了,想从事JAVA开发工作,但不知道从何处入手。于是,产生了写一个博客专栏想法,介绍当前互联网企业JAVA项目开发如何快速入门。

本文收录于《30天企业JAVA项目开发实战入门》专栏,该专栏内容以当前互联网软件企业中的项目实战为线索,介绍企业JAVA项目开发中涉及到的开发流程、技术、工具、规范要求等等。帮助想从事JAVA开发的大学生或新人,更快的、更好的入门JAVA后端开发工作。

文章目录

    • 一、前言
    • 二、代码格式规范
    • 三、插件的安装和使用
    • 四、总结

一、前言

现在的软件项目都是团队多人合作一起开发,软件架构的复杂性也需要协同开发完成,如何高效地协同呢?

无规矩不成方圆,无规范难以协同。对软件来说,适当的规范和标准绝不是消灭代码内容的创造性、优雅性,而是限制过度个性化,以一种普遍认可的统一方式一起做事,提升协作效率,降低沟通成本。

所以,本文介绍一下,JAVA后端开发编码格式规范,以及如何通过代码格式化插件Eclipse Code Formatte格式化代码。

当我们约定了代码的统一模板,使用了统一的编码格式。从而,可以避免不同开发人员使用不同的代码模板带来的编码格式差异化,提高代码的可读性,降低代码Merge时解决冲突问题所花费的成本。

在这里插入图片描述

二、代码格式规范

  1. 【强制】如果是大括号内为空,则简洁地写成{}即可,大括号中间无需换行和空格;如果是非空代码块则:
    1) 左大括号前不换行。
    2) 左大括号后换行。
    3) 右大括号前换行。
    4) 右大括号后还有 else 等代码则不换行;表示终止的右大括号后必须换行。

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

反例:if (空格 a == b 空格)
  1. 【强制】if/for/while/switch/do 等保留字与括号之间都必须加空格。

  2. 【强制】任何二目、三目运算符的左右两边都需要加一个空格。
    说明:包括赋值运算符=、逻辑运算符&&、加减乘除符号等。

  3. 【强制】采用 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";
// 运算符的左右必须有一个空格
int flag = 0;
// 关键词 if 与括号之间必须有一个空格,括号内的 f 与左括号,0 与右括号不需要空格
if (flag == 0) { System.out.println(say);
}// 左大括号前加空格且不换行;左大括号后换行
if (flag == 1) { System.out.println("world");
// 右大括号前换行,右大括号后有 else,不用换行
} else {
System.out.println("ok");
// 在右大括号后直接结束,则必须换行
}
}

关于IDEA 设置tab 为 4 个空格时,请勿勾选 Use tab character。如下面所示:
在这里插入图片描述

  1. 【强制】注释的双斜线与注释内容之间有且仅有一个空格。
正例:
// 这是示例注释,请注意在双斜线之后有一个空格
String commentString = new String();
  1. 【强制】在进行类型强制转换时,右括号与强制转换值之间不需要任何空格隔开。
正例:
long first = 1000000000000L; int second = (int)first + 2;
  1. 【强制】单行字符数限制不超过 120 个,超出需要换行,换行时遵循如下原则:
    1) 第二行相对第一行缩进 4 个空格,从第三行开始,不再继续缩进,参考示例。
    2) 运算符与下文一起换行。
    3) 方法调用的点符号与下文一起换行。
    4) 方法调用中的多个参数需要换行时,在逗号后进行。
    5) 在括号前不要换行,见反例。
正例:
StringBuilder sb = new StringBuilder();
// 超过 120 个字符的情况下,换行缩进 4 个空格,并且方法前的点号一起换行
sb.append("zi").append("xin")...
.append("huang")...
.append("huang")...
.append("huang");反例:
StringBuilder sb = new StringBuilder();
// 超过 120 个字符的情况下,不要在括号前换行
sb.append("you").append("are")...append ("lucky");// 参数很多的方法调用可能超过 120 个字符,逗号后才是换行处
method(args1, args2, args3, ...
, argsX);
  1. 【强制】方法参数在定义和传入时,多个参数逗号后边必须加空格。
正例:下例中实参的 args1,后边必须要有一个空格。
method(args1, args2, args3);
  1. 【强制】IDE 的 text file encoding 设置为 UTF-8; IDE 中文件的换行符使用 Unix 格式,不要使用 Windows 格式。

IDE 的 text file encoding 设置为 UTF-8,如下图所示:
在这里插入图片描述
IDE 中文件的换行符使用 Unix 格式,如下图所示:
在这里插入图片描述

三、插件的安装和使用

下面介绍在开发工具IDEA中安装代码格式化插件Adapter for Eclipse Code Formatter;

首先,打开开发工具IDEA,通过菜单File>Settings,打开配置窗口。

之后,输入关键字plugins,找到插件安装界面。

之后,在应用市场Marketplace中,搜索要安装的插件名称Adapter for Eclipse Code Formatter;

之后,点击install开始安装;

安装完成后,最后,点击OK。

在这里插入图片描述

之后,下面开始导入代码模板文件。

首先,打开开发工具IDEA,通过菜单File>Settings,打开配置窗口;

之后,输入关键字Adapter for Eclipse Code Formatter,找到刚才安装的插件;

之后,选择“Use Eclipse`s code Fomatter”,并且点击上传代码格式模版文件,最后点击OK完成模板导入。

在这里插入图片描述

说明,这里推荐使用阿里巴巴的代码格式模版。如下,阿里代码格式模板文件已分享到百度网盘。

百度网盘分享链接:https://pan.baidu.com/s/1WeeN6I9_CUwneqrIbBHzyA?pwd=nyde
提取码:nyde

官方下载地址: https://github.com/alibaba/p3c/tree/master/p3c-formatter

最后,插件安装和配置完成后,打开任意的JAVA文件,可以使用快捷键Ctrl+Alt+L ,进行代码格式化操作。

四、总结

以上介绍了JAVA后端开发编码格式相关的规范,以及如何通过使用格式插件进行代码格式化操作。

附本文参考资料:

  • 阿里云官方知乎:https://www.zhihu.com/org/a-li-yun-97-77
  • 阿里云开发者官方社区:https://developer.aliyun.com/
  • 阿里开发者官方CSDN社区:https://blog.csdn.net/alitech2017?type=blog
  • 阿里云云栖号CSDN:https://blog.csdn.net/yunqiinsight/category_10231626.html
  • 阿里巴巴技术团队发布的《JAVA开发手册》泰山版
  • 阿里云开发者官方微信公众号

如果您对文章中内容有疑问,欢迎在评论区进行留言,我会尽量抽时间给您回复。如果文章对您有帮助,欢迎点赞、收藏。您的点赞,是对我最大的支持和鼓励,谢谢 :-)

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/diannao/5589.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

软件网关--Nginx

Nginx 的多功能用途 Nginx 是构建现代化分布式应用程序的重要工具,它的功能远不止于高性能的 Web 服务器和反向代理。它还能充当 API 网关,处理前后端通信、认证、授权、监控等任务。以下是 Nginx 的主要用途: 前后端通信代理:N…

公共 IP 地址与私有 IP 地址区别有哪些?

​  IP 地址是分配给互联网上每个设备的唯一数字 ID。 IP 地址可以在 Internet 上公开使用,也可以在局域网 (LAN)上私有使用。本文,我们主要探讨公共 IP 地址和私有 IP 地址之间的区别。 公共IP地址:公共IP地址是用于访问Internet的向外的I…

头歌:SparkSQL简单使用

第1关:SparkSQL初识 任务描述 本关任务:编写一个sparksql基础程序。 相关知识 为了完成本关任务,你需要掌握:1. 什么是SparkSQL 2. 什么是SparkSession。 什么是SparkSQL Spark SQL是用来操作结构化和半结构化数据的接口。…

c++缓冲区同步原理与std::ios::sync_with_stdio作用

缓冲区同步机制 为什么需要缓冲区同步 c是基于c语言的扩展语言,本质上它继承了c语言许多特性,同时也继承了C语言特性,在c语言中stdio为输入输出缓冲区,stdin是输入缓冲区,stdout是输出缓冲区,C不与C语言使…

Python爬虫-车主之家详情页汽车数据

前言 本文是该专栏的第26篇,后面会持续分享python爬虫干货知识,记得关注。 本文以车主之家的汽车详情页为例,获取对应车型的全部汽车相关数据(包含车型配置,车型销售数据,以及上牌数据等等)。 具体实现思路和详细逻辑,笔者将在正文结合完整代码进行详细介绍。接下来,…

AI家居设备的未来:智能家庭的下一个大步

🔒目录 ☂️智能家居设备的发展和AI技术的作用 ❤️AI技术实现智能家居设备的自动化控制和智能化交互的依赖 AI家居设备的未来应用场景 💣智能家庭在未来的发展和应用前景 💥智能家居设备的发展和AI技术的作用 智能家居设备的发展和AI技术的…

Liunx发布tomcat项目

Liunx在Tomcat发布JavaWeb项目 1.问题2.下载JDK3.下载Tomcat4.Tomcat本地JavaWeb项目打war包、解压、发布5.重启Tomcat,查看项目 1.问题 1.JDK 与 Tomcat 版本需匹配,否则页面不能正确显示 报错相关:Caused by: java.lang.ClassNotFoundException: java…

优化NGINX性能:使用NGINX_THREADS提高并发处理能力

目录标题 1. 什么是NGINX_THREADS?2. 配置NGINX_THREADS3. 使用NGINX_THREADS处理耗时操作4. 性能调优5. 结论 NGINX作为一个高性能的HTTP和反向代理服务器,在处理高并发请求时表现出色。但随着互联网应用对性能要求的不断提高,深入了解和优化…

DA14531如何配置SDK工程路径

1 前言 当我们获取一个DA14531的工成样列,有时是不包括SDK中的公共部分的代码,只有用户项目代码。而想拷贝到自己的SDK中,如:F:\A02_Work\A01_Dailog\DA145xx_SDK\6.0.18.1182.1\projects\User\ble_app_sensor,打开工…

去水印思考

当然,关于去除图片或视频中水印的代码改进,这需要基于您当前使用的技术栈(如Python、OpenCV、PIL等)和具体的需求(例如水印的位置是否固定、水印的颜色、透明度等)。这里我提供一个基于Python和OpenCV的基本…

高颜值管理系统界面,我敢保证你肯定看不够,看了又看。

有不少老铁,还坚持10年前的老思路,总觉得B端管理系统颜值不颜值不重要,关键是好用就行,这就犯了二元论的错误。 谁说高颜值的管理系统,就不好用了呢?高颜值和易用性冲突吗?我看未必吧。看看大厂…

羊大师:羊奶与传统牛奶在健康方面的差异

羊大师:羊奶与传统牛奶在健康方面的差异 羊奶与传统牛奶在健康方面的差异主要体现在以下几个方面: 营养成分:羊奶与传统牛奶在营养成分上有所不同。羊奶中含有更多的维生素A、碳水化合物、烟酸以及磷,而牛奶在钙、蛋白质和锌的含…

大语言模型在专业领域的应用——教育场景下的大语言模型

教育场景下的大语言模型 构建教育相关的大语言模型数据资源总结教育是人类社会进步的基石,对个人和社会发展都至关重要。在教育系统中,大语言模型已经被用于多种教育相关任务,有助于增强教育场景的智能化、自动化和个性化。 构建教育相关的大语言模型 通常来说,教育应用系…

[高质量]2024五一数学建模A题保奖思路+代码(后续会更新)

你的点赞收藏是我继续更新的最大动力,可点击文末卡片获取更多资料 你是否在寻找数学建模比赛的突破点? 作为经验丰富的数学建模团队,我们将为你带来2024 年华东杯(A题)的全面解析包。这个解决方案包不仅包括完整的代…

数组模拟双链表-java

通过数组来模拟双链表,并执行一些插入和删除的功能。 目录 一、问题描述 二、模拟思路 1.变量解释 2.数组初始化 3.在下标是k的结点后面插入一个结点 4.删除下标为k的结点 5.基本功能解释 三、代码如下 1.代码如下: 2.读入数据: 3…

Linux基础part-8

1、计算机硬盘类型和对应接口 1. Linux硬盘接口 硬盘接口类型直接影响到存储设备的性能、兼容性和可靠性。Linux硬盘接口是用来连接硬盘驱动器(包括传统机械硬盘和固态硬盘)到计算机系统的接口,它们允许数据在硬盘和计算机之间进行传输和交换…

【海博】雅思考什么?

文章目录 听力 阅读 写作 口语 参考资料 听力 听力考试分为四个部分,每个部分有10道题,每题1分。问题的排列顺序和答案在听力材料中出现的顺序一致。在播放听力材料过程中,考生会获得读题、写下答案以及检查答案的时间。考生应在播放听力…

深度图上色,深度图raw文件转为png,如何读取深度图raw文件?

raw文件,要知道宽、高、通道数、数据类型,就能顺利转化,下面是转化代码: import numpy as np import cv2# 图像的基本信息 width 640 # 图像宽度 height 480 # 图像高度 channels 1 # 图像通道数,例如3表示RGB d…

Memory augment is All You Need for image restoration 论文翻译

目录 一.介绍 二.实际工作 A.图像阴影去除 B.图像去雨 C.存储模块的开发 三.网络结构 A.内存扩充 B.损失函数设计 四.实验 A.与最先进方法的比较 B.MemoryNet消融研究 五.结论 CVPR2023 MemoryNet 记忆增强是图像恢复所需要的一切 论文地址https://arxiv.org/abs/…

微服务是什么

微服务(Microservices) 是一种软件架构风格,它是以一组小的服务来开发一个单一应用的方式;每个服务运行在其独立的进程中,服务与服务间采用轻量级的通信机制(通常是基于HTTP的RESTful API)。这些…