30个Java编码规范!培养良好的编码习惯!

Java编码规范 Java编码规范要求 阅读详情

(1) 类名首字母应该大写。字段、方法以及对象(句柄)的首字母应小写。对于所有标识符,其中包含的所有单词都应紧靠在一起,而且大写中间单词的首字母。例如:ThisIsAClassNamethisIsMethodOrFieldName若在定义中出现了常数初始化字符,则大写static final基本类型标识符中的所有字母。这样便可标志出它们属于编译期的常数。Java包(Package)属于一种特殊情况:它们全都是小写字母,即便中间的单词亦是如此。对于域名扩展名称,如com,org,net或者edu等,全部都应小写(这也是Java 1.1和Java 1.2的区别之一)。

(2) 为了常规用途而创建一个类时,请采取"经典形式",并包含对下述元素的定义:equals()hashCode()toString()clone()(implement Cloneable)implement Serializable

(3) 对于自己创建的每一个类,都考虑置入一个main(),其中包含了用于测试那个类的代码。为使用一个项目中的类,我们没必要删除测试代码。若进行了任何形式的改动,可方便地返回测试。这些代码也可作为如何使用类的一个示例使用。

(4) 应将方法设计成简要的、功能性单元,用它描述和实现一个不连续的类接口部分。理想情况下,方法应简明扼要。若长度很大,可考虑通过某种方式将其分割成较短的几个方法。这样做也便于类内代码的重复使用(有些时候,方法必须非常大,但它们仍应只做同样的一件事情)。

(5) 设计一个类时,请设身处地为客户程序员考虑一下(类的使用方法应该是非常明确的)。然后,再设身处地为管理代码的人考虑一下(预计有可能进行哪些形式的修改,想想用什么方法可把它们变得更简单)。

(6) 使类尽可能短小精悍,而且只解决一个特定的问题。下面是对类设计的一些建议:■一个复杂的开关语句:考虑采用"多形"机制■数量众多的方法涉及到类型差别极大的操作:考虑用几个类来分别实现■许多成员变量在特征上有很大的差别:考虑使用几个类。

小编是一个有着5年工作经验的java程序员,对于java,自己有做资料的整合,一个完整学习java的路线,学习资料和工具,相信这里有很多学习java的小伙伴,我创立了一个2000人学习扣群,479121291。每晚都有java的直播课程。无论是初级还是进阶的小伙伴小编我都欢迎!

(7) 让一切东西都尽可能地"私有"--private。可使库的某一部分"公共化"(一个方法、类或者一个字段等等),就永远不能把它拿出。若强行拿出,就可能破坏其他人现有的代码,使他们不得不重新编写和设计。若只公布自己必须公布的,就可放心大胆地改变其他任何东西。在多线程环境中,隐私是特别重要的一个因素--只有private字段才能在非同步使用的情况下受到保护。

(8) 谨惕"巨大对象综合症"。对一些习惯于顺序编程思维、且初涉OOP领域的新手,往往喜欢先写一个顺序执行的程序,再把它嵌入一个或两个巨大的对象里。根据编程原理,对象表达的应该是应用程序的概念,而非应用程序本身。

(9) 若不得已进行一些不太雅观的编程,至少应该把那些代码置于一个类的内部。

(10) 任何时候只要发现类与类之间结合得非常紧密,就需要考虑是否采用内部类,从而改善编码及维护工作(参见第14章14.1.2小节的"用内部类改进代码")。

(11) 尽可能细致地加上注释,并用javadoc注释文档语法生成自己的程序文档。

(12) 避免使用"魔术数字",这些数字很难与代码很好地配合。如以后需要修改它,无疑会成为一场噩梦,因为根本不知道"100"到底是指"数组大小"还是"其他全然不同的东西"。所以,我们应创建一个常数,并为其使用具有说服力的描述性名称,并在整个程序中都采用常数标识符。这样可使程序更易理解以及更易维护。

(13) 涉及构建器和异常的时候,通常希望重新丢弃在构建器中捕获的任何异常--如果它造成了那个对象的创建失败。这样一来,调用者就不会以为那个对象已正确地创建,从而盲目地继续。

(14) 当客户程序员用完对象以后,若你的类要求进行任何清除工作,可考虑将清除代码置于一个良好定义的方法里,采用类似于cleanup()这样的名字,明确表明自己的用途。除此以外,可在类内放置一个boolean(布尔)标记,指出对象是否已被清除。在类的finalize()方法里,请确定对象已被清除,并已丢弃了从RuntimeException继承的一个类(如果还没有的话),从而指出一个编程错误。在采取象这样的方案之前,请确定finalize()能够在自己的系统中工作(可能需要调用System.runFinalizersOnExit(true),从而确保这一行为)。

(15) 在一个特定的作用域内,若一个对象必须清除(非由垃圾收集机制处理),请采用下述方法:初始化对象;若成功,则立即进入一个含有finally从句的try块,开始清除工作。

(16) 若在初始化过程中需要覆盖(取消)finalize(),请记住调用super.finalize()(若Object属于我们的直接超类,则无此必要)。在对finalize()进行覆盖的过程中,对super.finalize()的调用应属于最后一个行动,而不应是第一个行动,这样可确保在需要基础类组件的时候它们依然有效。

(17) 创建大小固定的对象集合时,请将它们传输至一个数组(若准备从一个方法里返回这个集合,更应如此操作)。这样一来,我们就可享受到数组在编译期进行类型检查的好处。此外,为使用它们,数组的接收者也许并不需要将对象"造型"到数组里。

(18) 尽量使用interfaces,不要使用abstract类。若已知某样东西准备成为一个基础类,那么第一个选择应是将其变成一个interface(接口)。只有在不得不使用方法定义或者成员变量的时候,才需要将其变成一个abstract(抽象)类。接口主要描述了客户希望做什么事情,而一个类则致力于(或允许)具体的实施细节。

(19) 在构建器内部,只进行那些将对象设为正确状态所需的工作。尽可能地避免调用其他方法,因为那些方法可能被其他人覆盖或取消,从而在构建过程中产生不可预知的结果(参见第7章的详细说明)。

(20) 对象不应只是简单地容纳一些数据;它们的行为也应得到良好的定义。

(21) 在现成类的基础上创建新类时,请首先选择"新建"或"创作"。只有自己的设计要求必须继承时,才应考虑这方面的问题。若在本来允许新建的场合使用了继承,则整个设计会变得没有必要地复杂。

(22) 用继承及方法覆盖来表示行为间的差异,而用字段表示状态间的区别。一个非常极端的例子是通过对不同类的继承来表示颜色,这是绝对应该避免的:应直接使用一个"颜色"字段。

(23) 为避免编程时遇到麻烦,请保证在自己类路径指到的任何地方,每个名字都仅对应一个类。否则,编译器可能先找到同名的另一个类,并报告出错消息。若怀疑自己碰到了类路径问题,请试试在类路径的每一个起点,搜索一下同名的.class文件。

(24) 在Java 1.1 AWT中使用事件"适配器"时,特别容易碰到一个陷阱。若覆盖了某个适配器方法,同时拼写方法没有特别讲究,最后的结果就是新添加一个方法,而不是覆盖现成方法。然而,由于这样做是完全合法的,所以不会从编译器或运行期系统获得任何出错提示--只不过代码的工作就变得不正常了。

(25) 用合理的设计方案消除"伪功能"。也就是说,假若只需要创建类的一个对象,就不要提前限制自己使用应用程序,并加上一条"只生成其中一个"注释。请考虑将其封装成一个"独生子"的形式。若在主程序里有大量散乱的代码,用于创建自己的对象,请考虑采纳一种创造性的方案,将些代码封装起来。

(26) 警惕"分析瘫痪"。请记住,无论如何都要提前了解整个项目的状况,再去考察其中的细节。由于把握了全局,可快速认识自己未知的一些因素,防止在考察细节的时候陷入"死逻辑"中。

(27) 警惕"过早优化"。首先让它运行起来,再考虑变得更快--但只有在自己必须这样做、而且经证实在某部分代码中的确存在一个性能瓶颈的时候,才应进行优化。除非用专门的工具分析瓶颈,否则很有可能是在浪费自己的时间。性能提升的隐含代价是自己的代码变得难于理解,而且难于维护。

(28) 请记住,阅读代码的时间比写代码的时间多得多。思路清晰的设计可获得易于理解的程序,但注释、细致的解释以及一些示例往往具有不可估量的价值。无论对你自己,还是对后来的人,它们都是相当重要的。如对此仍有怀疑,那么请试想自己试图从联机Java文档里找出有用信息时碰到的挫折,这样或许能将你说服。

(29) 如认为自己已进行了良好的分析、设计或者实施,那么请稍微更换一下思维角度。试试邀请一些外来人士--并不一定是专家,但可以是来自本公司其他部门的人。请他们用完全新鲜的眼光考察你的工作,看看是否能找出你一度熟视无睹的问题。采取这种方式,往往能在最适合修改的阶段找出一些关键性的问题,避免产品发行后再解决问题而造成的金钱及精力方面的损失。

(30) 良好的设计能带来最大的回报。简言之,对于一个特定的问题,通常会花较长的时间才能找到一种最恰当的解决方案。但一旦找到了正确的方法,以后的工作就轻松多了,再也不用经历数小时、数天或者数月的痛苦挣扎。我们的努力工作会带来最大的回报(甚至无可估量)。而且由于自己倾注了大量心血,最终获得一个出色的设计方案,成功的快感也是令人心动的。坚持抵制草草完工的诱惑--那样做往往得不偿失

java开发宝典 如果运行环境要求24小时不间断运行(即更新时不能停机),一些关键接口建议在前后端上线的下一个版本再删除,以防止升级过程中出现不必要的服务中断。具体实践过程中都会宣称提供Restful接口,实际由于软件面向业务场景的复杂性,很难将所有业务场景与HTTP请求类型相对应。所有查询接口的返回值都要能通过swagger查看字段定义。不能返回一个Object、Map之类的让前端去猜谜语。多使用 jdk自带库和被验证的第三方库的类和函数,(这个也不太理解,废弃的类直接删了不行吗)无论是包、类、方法、变量, 阅读详情

相关推荐

2024新版Java基础从入门到精通全套教程(含视频+配套资料)

Java基础是所有入门java的同学必过的一关,基础学习的牢固与否决定了程序员未来成就的高度。因此,基础学习的重要性不言而喻。但是很多同学学习java基础知识,要么是学的太“基础”,就是只会各个知识点的简单概念和使用,要么学的太“杂”,不成系统。这两者都会导致后面学习越学越难,只会简单使用你是知其然不知其所以然,各个知识都去了解一下会导致后面使用的时候知识零散,遇到需求不知道用什么知识解决,重复学习,很多同学就倒在了基础学习的路上。

码农王也的博客 1785

Java编码规范总结

Java编码规范总结

linsa_pursuer的博客 8461

关于token无痛刷新的两个方案

目录方案一方案二 方案一 思路: 后端需要返回一个token过期的时间,在请求发起前拦截每个请求,判断token的有效时间是否已经过期,如果已过期,则暂时将请求挂起,先刷新token后再继续请求。 前期思考: 返回过期时间是为了判断是否过期的,但是如果服务器时间和系统时间不一致呢? 如果同时发起多个请求时怎么办? 实现: 因为是在请求前进行拦截,所以这里用axios的axios.interceptors.request.use()方法 首先,关于服务器时间和系统时间不一致的问题,我的解决方法是:

Yugoup的博客 2718

Java开发编码规范

java 开发规范

qq_24577585的博客 5403

神经网络(十五)在VS Code下搭建PyTorch环境

pytorch在vscode中的配置和使用

就随便写写.... 5万+

Visual Studio Git 使用指南

Visual Studio 2022深度集成了Git功能,提供了直观的图形界面管理源代码。本文详细介绍了VS中Git的使用方法:从环境准备、克隆/创建仓库开始,重点讲解了"Git更改"窗口的日常操作,包括查看修改、暂存文件、提交推送等。同时涵盖了分支管理、查看历史、解决冲突等核心功能,以及储藏、重置等高级操作。文章还提供了实用技巧,如提交规范、频繁提交等最佳实践。VS的Git集成覆盖了日常开发需求,图形界面与命令行可互补使用,适合各层次开发者高效管理代码版本。

guigenyi的专栏 1575

java编码规范_不会不行!业界 Java 性能编码规范 30+ 条!

↑↑↑点上方蓝字关注并星标⭐「IT技术思维」一起培养顶尖技术思维来源:http://t.cn/EiP42VF转载自:程序员共成长在JAVA程序中,性能问题的大部分原因并不在于JAVA语言,而是程序本身。养成良好的编码习惯非常重要,能够显著地提升程序性能。孤尽也说过:对程序员来说,关键是骨子里意识到规范也是生产力,个性化尽量表现在代码可维护性和算法效率的提升上。1. 尽量在合适的场合使用单...

weixin_39934063的博客 126

【高低温试验】试验报告模板

高低温循环试验,验证被测设备(DUT)在极端高温、低温环境下的性能稳定性、功能可靠性及安全性,确保其符合设计规范和相关标准(如GB/T 2423.1、GB/T 2423.2)。:验证设备在剧烈温度变化下的耐受能力(如-40℃↔+85℃,温变速率≥10℃/min)。低温测试标准:GB/T 2423.2-2008(温度-40℃,保持时间4小时):模拟高温高湿环境(如温度+60℃,湿度95%RH),测试防潮性能。

电路巫师把一切不可能变成不可能 1566

华为宣布:免费培养2000名Java开发者

Java是近几年来使用最为广泛的语言,在全球全球范围内有超过30亿部设备运行Java,其也一直霸占国内外语言使用排行榜前两名的位置。这得益于他简单易学、可跨平台使用、拥有丰富类库的特点。如...

Java知音 446

STM32F103ZE驱动PMW3901光流模块,从SPI配置到数据读取的完整避坑指南

本文详细解析了STM32F103ZE驱动PMW3901光流模块的全过程,从SPI配置、硬件连接到数据读取与处理,提供了完整的避坑指南。重点介绍了SPI参数配置、初始化序列优化、运动数据滤波等关键技巧,帮助开发者快速实现精准的光流检测。

weixin_42631411的博客 518

『杭电1199』Color the Ball

Problem Description There are infinite balls in a line (numbered 1 2 3 ....), and initially all of them are paint black. Now Jim use a brush paint the balls, every time give two integers a b and follow by a char 'w' or 'b', 'w' denotes the ball from a to

漠宸离若的博客 499

深度解析阿里巴巴P3C规则引擎:从编码规范到企业级代码质量治理

在大型软件工程实践中,代码质量治理一直是技术团队面临的严峻挑战。阿里巴巴Java开发规范(P3C)通过PMD规则引擎,将数百条编码规范转化为可执行的静态检查规则,为Java企业级开发提供了自动化代码质量保障体系。本文将从架构设计、规则扩展、工程实践三个维度,深度解析P3C规则引擎的技术实现与最佳应用方案。 ## 一、企业级代码质量治理的痛点分析 ### 1.1 规模化开发的规范落地难题 在阿里

gitblog_00051的博客 631

零差云控 ZeroErr eRob 电机 CAN、CANopen、EtherCAT、ROS2 机器人开发详细教程

TwinCAT 3(Windows 控制与自动化技术)是 Beckhoff 提供的开发平台,可将任何兼容 PC 转变为实时控制系统,用于管理各种类型的工业自动化系统,如 PLC(可编程逻辑控制器)、运动控制、机器人等。

机器人控制与仿真应用 1万+

30天C语言从零到项目实战:掌握编程核心,开启系统开发之路

编程语言是计算机科学的基础工具,其核心在于理解计算机如何执行指令和处理数据。C语言作为一门中级语言,兼具高级语言的结构化特性和接近硬件的控制能力,通过指针和内存管理等机制,让开发者能够深入理解程序在计算机底层的运行原理。这种对底层机制的掌握,为学习操作系统、编译原理等核心课程奠定了坚实基础,并在系统软件、嵌入式开发、高性能计算等领域具有不可替代的技术价值。本文围绕C语言学习路径,结合指针和内存管理等热词,提供一套从语法基础到项目实战的30天系统训练方案,帮助初学者构建扎实的编程思维和工程实践能力。

weixin_34389926的博客 354

Ghost卷积原理与构建YOLOv11的GhostNet变体

本文探讨了在边缘设备部署YOLOv11时使用Ghost卷积进行模型轻量化的实践经验。针对Jetson Nano的4GB内存限制,作者通过替换Backbone中的3x3标准卷积为Ghost卷积,实现了参数减少28%、推理速度提升38%,仅损失1.1%mAP的优化效果。文章详细介绍了Ghost卷积的实现原理、在YOLOv11中的具体替换策略,以及训练调参和部署优化的关键技巧。作者强调轻量化是计算效率与模型性能的权衡,建议工程团队保留原模型和Ghost变体两个版本,根据实际需求灵活切换。Ghost卷积的核心价值在

as1225120794的博客 169

visio安装包

Microsoft Office Visio 是一款专业的制图软件。利用经过更新的形状、协作工具和数据链接图表,创建专业级图表以简化复杂的信息。

Java开发者必知的20条高效编码法则

在Java开发中,掌握核心编码规范和性能优化技巧至关重要。从基础的对象方法实现(如toString()、equals()和hashCode())到集合框架的高效使用(如预分配容量和空集合处理),这些原则直接影响代码质量和系统性能。异常处理的精确性和并发编程的线程安全是保障系统稳定性的关键,而防御性编程和工程实践(如Optional使用和决策记录)则能提升代码的可维护性。对于开发者而言,深入理解Java内存模型等底层原理,比追逐新技术框架更具长期价值。本文总结的20条黄金法则,涵盖编码规范、集合操作、异常处理

weixin_33462927的博客 227

Data-Structures-and-Algorithm-Analysis-in-Java.pdf

作者: Weiss, Mark A. 出版社: Addison Wesley Data Structures and Algorithm Analysis in Java is an “advanced algorithms” book that fits between traditional CS2 and Algorithms Analysis courses. In the old ACM Curriculum Guidelines, this course was known as CS7. This text is for readers who want to learn good programming and algorithm analysis skills simultaneously so that they can develop such programs with the maximum amo...

计算机专业毕业学生,道出求职真相!

这些技术只会不断的迭代更新,只有不断的使用才能拥有自己对他们的理解。如果找了一份使用上个时代技术的公司,那只会被同龄人越拉越远,后期自己自学的代价也会变大,紧跟潮流永远不会被抛弃。学 科丨...

传智播客的专栏 176

ET2012新版免狗免安装绿色软件

ET2012新版免狗免安祖昂绿色软件。,新界面,新视觉,

jdk-8u144-linux-x64.tar.gz.

该资源为搭建Linux系统Java环境用,资源的后缀为tar.gz格式的压缩包

美团校招技术岗备考指南:算法、Java与分布式系统

算法与数据结构、Java技术栈和分布式系统是互联网大厂技术岗校招的核心考察内容。算法能力作为计算机科学的基石,重点考察动态规划、图论等经典问题的解决思路;Java技术栈则涉及JUC并发、JVM调优及Spring框架原理,这些是构建高并发系统的关键技术;分布式系统领域的一致性协议、服务治理等概念,则是现代微服务架构的必备知识。美团等头部企业尤其注重候选人的工程实践能力,例如通过Redis实现高性能缓存、利用Spring Boot构建微服务等实际场景应用。备考时应采用"基础+专项+冲刺"的三轮复习法,结合Lee

weixin_34318272的博客 346

具备这些能力,离2万月薪的程序员距离就不远了

现在程序员是比较紧俏的一个岗位,其实能够写代码的人很多,但是为什么程序员还那么缺呢?除了需求大以外,小编发现还有一个原因就是,真正合格的程序员确实比较少。想要成为一个合格的程序员,我们需要满足以下几点要求: 具备这些能力,离2万月薪的程序员距离就不远了 ​ 1、细心 对于很多程序员来说,写出来的代码可能这里因为不小心漏了什么,那里因为不小心没有测试到一个大Bug,因为马虎而出现的问题不在少数。所以...

weixin_43703144的博客 132

Java面试中技术能力考察的实战解析

Java作为企业级开发的主流语言,其技术栈深度与工程实践能力是面试考察的重点。从集合框架的底层实现原理到面向对象设计思想,面试官通常会通过分层递进的问题设计验证候选人的真实水平。以ArrayList与LinkedList的区别为例,这不仅是数据结构的选择问题,更涉及时间复杂度分析、内存占用比较等工程实践考量。在电商等高并发场景中,对HashMap扩容机制、哈希冲突处理等原理的掌握直接影响系统性能。本文通过真实面试案例,剖析如何通过编码测试、系统设计等环节,有效评估Java开发者的工程能力与技术深度,帮助求职

weixin_30768881的博客 226

程序员想要月薪2W+?这些能力你有了吗?

现在程序员是比较紧俏的一个岗位,其实能够写代码的人很多,但是为什么程序员还那么缺呢?除了需求大以外,还有一个原因就是,真正合格的程序员确实比较少。想要成为一个合格的程序员,我们需要满足以下几点要求: 1、细心 对于很多程序员来说,写出来的代码可能这里因为不小心漏了什么,那里因为不小心没有测试到一个大Bug,因为马虎而出现的问题不在少数。所以,细心,能够很有效的减少开发周期,为整个项目的推进起到良性...

qfxulei的博客 315
上一篇: Java多态的底层原理
下一篇: Java学习系列之不要学习代码,要学会思考
java03_15
博客等级 码龄9年 263粉丝 10原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值