优秀 Java 程序员写代码的风格

简介: 优秀 Java 程序员写代码的风格

今天突发奇想,对编码习惯和 编程风格 很感兴趣,于是乎,找了一下关于编程风格(Java篇)的资料,希望对爱好编码或者开始学习编码的同学有帮助!


来自《The Elements of Java Style》-《Java编程风格》一书,值得一读的书籍,会让你在细节上节省很多时间,合作之间更加愉快!


好处不多说了,但是有几个原则如下


1.保持原有风格


2.坚持最小惊奇原则


3.第一次就做对


4.记录所有非规范行为


格式规范

1.缩进嵌套的代码:在每个代码块和嵌套中加入缩进,缩进代码,加强可读性。这些地方包括【类定义,内部类定义,方法定义,静态块,for循环语句,if-else语句,try、catch和finally块,匿名内部类,while语句,do-while语句】


2.断开很长的句子:第一,如果包含了逗号,那么在每一个逗号后面都另起一行,把逗号后面的每一个表达式都和逗号前面的表达式的第一个字母对齐。第二,应该在优先级最低的运算符之前断行。


3.使用空白:关键字和左括号之间,右括号和紧随其后的关键字,除了”.”之外的运算符与其前后的表达式之间用空格隔开。每个逻辑上独立的方法和代码段之间,定义类或者接口的成员之间,每个类和接口之间应该加入空白行。


4.不要直接使用Tab控制符:不同环境对Tab控制符的解释也是不同的。


命名约定

1.名称应该具有实际意义


2.使用人们熟悉的名称


3.谨慎使用过长的名字,可以使用简明通用的缩写


4.尽量保留元音字母


5.缩写词的第一个字母大写


6.不要使用大小写来区分的名字


包命名

1.用你所在组织的域名的倒序小写形式作为包的根限定词


2.使用单独的小写词作为每个包的根名


3.仅当新旧版本二进制兼容的时候,其包可以使用相同的名字,否则,请使用新名字


类型命名

1.类和接口名中的每个单词的第一个字母大写


类命名

1.用名词命名类


2.具有成组相关属性,静态服务或者常量的类名字使用复数形式


接口命名

1.用名词或者形容词命名接口


方法命名

1.方法名中的第一个单词小写,其后每个单词的第一个字母大写


2.用动词命名方法


3.遵循JavaBean中命名属性访问函数方法:set,get,is


变量命名

1.变量命中的第一个单词小写,其后的每个单词的第一个字母大写


2.用名词命名变量


3.集合引用名要用复数形式


4.为不重要的临时变量简历并使用一套标准名字


字段命名

1.使用this字段变量可以区分开局部变量


参数命名

1.构造函数或者”set”方法给字段分配参数赋值,参数名应该和字段名相同


常量命名

1.常量的每个单词均大写,单词之间使用下划线连接


文档约定

1.为使用和维护你的代码的人编写文档


2.注释和代码要同步


3.使用积极的语气,省略无用的词语


注释类型

1.用文档注释来描述编程接口


2.用标准注释格式隐藏代码而不必删除它们


3.用单行注释解释实现细节


文档注释

1.在编写代码前描述编程接口


2.为公用,受保护,包,私有成员建立文档


3.为每个包编写总结和概述


4.为包的每个应用程序或组编写概述


注释风格

1.对所有文档注释使用统一的格式和组织结构


2.关键字,标识符和常量应放到…标签中


3.将代码放入

image.png标签中

4.在标识符第一次出现的时候用{@link}标签


5.为Javadoc标签简历并使用一套固定的顺序


6.使用第三人称叙述的形式


7.编写独立的概述


8.省略概述中动作和服务的主语


9.省略事物概述中的对象和动词


10.使用this而不是the来指代当前类中的实例


11.方法名或者构造函数名不需圆括号,除非你想突出一个特殊的签名


注释内容

1.每个类、接口、字段和方法都编写概述


2.完整描述每个方法的签名


3.包含示例


4.为前置、后置、不变条件编写文档


5.为已知的缺陷和不足编写文档


6.为同步语法编写文档


内部注释

1.仅添加有助于理解你的代码的内部注释


2.描写代码为什么这样做,而不是在做什么


3.避免使用行尾注释


4.用行尾注释解释局部变量声明


5.建立并使用一套关键词来标识尚未解决的问题


6.在嵌套程度高的控制结构中标记出嵌套结束位置


7.如果两个case标记之间没有break语句,就在中间加入“fall-through”注释


8.标记空语句


编程约定

1.将表示基础数据类型的类声明为final类型


2.通过本地类型和其他具体类型建立具体类型


3.定义小的类和小的方法


4.定义子类,以便任何使用超类的地方都可以使用子类


5.使所有字段私有


6.使用多态来替代instanceof


类型安全

1.以java.lang.Object包装通用类,提供静态类型检查


2.以类的形式封装枚举类型


3.尽量使用泛型


语句和表达式

1.用等价的方法替换重复的、复杂的表达式


2.使用块语句代替控制流结构的表达式


3.使用括号明确操作顺序


4.在switch语句中的最后一个case体使用break语句


5.使用equals(),而不是==来检测对象的对等关系


构造

1.构造状态有效的对象


2.不要从构造函数中调用非final方法


3.用嵌套的构造函数消除冗余代码


异常处理

1.使用不受检查、运行时的异常来报告可能在程序逻辑中出错的严重未查明错误


2.使用检查异常来报告可能发生,而在正常的程序运行时极少发生的错误


3.用返回代码报告可预知的状态改变


4.仅转化异常来添加信息


5.不要私自处置运行时或者错误异常


6.用finally语句块释放资源


断言

1.按照约定编程


2.用无用代码消除机制实现断言


3.用断言捕捉代码中的逻辑错误


4.用断言检测方法的前置条件和后置条件


并发

1.仅在适当的地方使用线程


同步

1.避免同步


2.用同步的包装器,提供同步接口


3.如果方法包含几个不需要同步的重要操作,那么不要同步整个方法


4.读写实例变量的时候避免不必要的同步


5.使用notify()而不是notifyAll()


6.为同步初始化使用双重检查模式


效率

1.使用懒惰初始化


2.避免创建不必要的对象


3.重新初始化并重新使用对象,尽量不要新建对象


4.把优化工作留在日后


打包约定

1.将经常使用、更改、同时发布或者互相依存的类型,放在同一个包里


2.共同封闭原则


3.重用/发布等价原则


4.无环依赖原则


5.将不稳定的类和接口隔离在单独的包中


6.易于修改的包不要依赖于难以修改的包


7.最大化抽象最大化稳定性


8.将高层设计和架构作为稳定的抽象,组织为稳定的包


以上仅是一些规则简单的罗列,推荐阅读此书。


推荐去我的博客阅读更多:


1.Java JVM、集合、多线程、新特性系列教程


2.Spring MVC、Spring Boot、Spring Cloud 系列教程


3.Maven、Git、Eclipse、Intellij IDEA 系列工具教程


4.Java、后端、架构、阿里巴巴等大厂最新面试题


觉得不错,别忘了点赞+转发哦!


image.png

相关文章
|
2月前
|
Java 数据安全/隐私保护
快手小红书抖音留痕工具,自动留痕插件工具,java代码开源
这个框架包含三个核心模块:主操作类处理点赞评论、配置管理类和代理管理类。使用时需要配合
|
1月前
|
算法 IDE Java
Java 项目实战之实际代码实现与测试调试全过程详解
本文详细讲解了Java项目的实战开发流程,涵盖项目创建、代码实现(如计算器与汉诺塔问题)、单元测试(使用JUnit)及调试技巧(如断点调试与异常排查),帮助开发者掌握从编码到测试调试的完整技能,提升Java开发实战能力。
209 0
|
2月前
|
Java 机器人 API
tiktok群控脚本,养号关注私信点赞脚本插件,java代码分享
这个代码模拟了一个社交机器人的基本行为模式,包括登录、关注、点赞、私信等操作。请注意
|
4月前
|
人工智能 Kubernetes Java
回归开源,两位 Java 和 Go 程序员分享的开源贡献指引
Higress是一个基于Istio和Envoy的云原生API网关,支持AI功能扩展。它通过Go/Rust/JS编写的Wasm插件提供可扩展架构,并包含Node和Java的console模块。Higress起源于阿里巴巴,解决了Tengine配置重载及gRPC/Dubbo负载均衡问题,现已成为阿里云API网关的基础。本文介绍Higress的基本架构、功能(如AI网关、API管理、Ingress流量网关等)、部署方式以及如何参与开源贡献。此外,还提供了有效的开源贡献指南和社区交流信息。
498 33
|
2月前
|
Java 编译器 数据库连接
Java异常处理:写出更健壮的代码
Java异常处理:写出更健壮的代码
146 0
|
2月前
|
安全 Java 测试技术
Java 项目实战中现代技术栈下代码实现与测试调试的完整流程
本文介绍基于Java 17和Spring技术栈的现代化项目开发实践。项目采用Gradle构建工具,实现模块化DDD分层架构,结合Spring WebFlux开发响应式API,并应用Record、Sealed Class等新特性。测试策略涵盖JUnit单元测试和Testcontainers集成测试,通过JFR和OpenTelemetry实现性能监控。部署阶段采用Docker容器化和Kubernetes编排,同时展示异步处理和反应式编程的性能优化。整套方案体现了现代Java开发的最佳实践,包括代码实现、测试调试
107 0
|
3月前
|
人工智能 前端开发 Java
Java 面试资料中相关代码使用方法与组件封装方法解析
这是一份详尽的Java面试资料代码指南,涵盖使用方法与组件封装技巧。内容包括环境准备(JDK 8+、Maven/Gradle)、核心类示例(问题管理、学习进度跟踪)、Web应用部署(Spring Boot、前端框架)、单元测试及API封装。通过问题库管理、数据访问组件、学习进度服务和REST接口等模块化设计,帮助开发者高效组织与复用功能,同时支持扩展如用户认证、AI推荐等功能。适用于Java核心技术学习与面试备考,提升编程与设计能力。资源链接:[点此下载](https://pan.quark.cn/s/14fcf913bae6)。
92 6
Java 面试资料中相关代码使用方法与组件封装方法解析
|
2月前
|
SQL Java 数据库连接
Java 期末考试救急必备涵盖绝大多数核心考点及五大类经典代码助你过关
本文为Java期末考试复习指南,涵盖基础语法、面向对象编程、异常处理、文件操作、数据库连接五大核心考点,提供详细解析与实用代码示例,助力快速掌握重点,高效备考,轻松应对考试。
65 0
|
3月前
|
Java 调度 流计算
基于Java 17 + Spring Boot 3.2 + Flink 1.18的智慧实验室管理系统核心代码
这是一套基于Java 17、Spring Boot 3.2和Flink 1.18开发的智慧实验室管理系统核心代码。系统涵盖多协议设备接入(支持OPC UA、MQTT等12种工业协议)、实时异常检测(Flink流处理引擎实现设备状态监控)、强化学习调度(Q-Learning算法优化资源分配)、三维可视化(JavaFX与WebGL渲染实验室空间)、微服务架构(Spring Cloud构建分布式体系)及数据湖建设(Spark构建实验室数据仓库)。实际应用中,该系统显著提升了设备调度效率(响应时间从46分钟降至9秒)、设备利用率(从41%提升至89%),并大幅减少实验准备时间和维护成本。
233 0