对Java开发者来说，有许多的标准和最佳实践。本文列举了每一个开发人员必须遵从的十大基本法则；如果有了可以遵从的规则而不遵从，那么将导致的是十分悲惨的结局。
1． 在你的代码里加入注释
每个人都知道这点，但不知何故忘记了遵守。算一算有多少次你“忘记”了添加注释？这是事实：注释对程序在功能上没有实质的贡献。但是，你需要一次又一次的回到你两个礼拜之前写的代码上来，可能一辈子都是这样，你一定记不住这些代码为什么会这样。如果这些代码是你的，你还比较的幸运。因为它有可能让你回忆起。但是不幸的是，很多时间，这些代码是别人的，而且很有可能他已经离开了公司。
2． 不要让事情复杂化
我以前就这么干过，而且我相信所有的人都这么干过。开发人员常常为一个简单的问题而提出一个解决方案。我们为仅仅只有5个用户的应用而引入EJBs。我们为一个应用使用框架而它根本不需要。我们加入属性文件，面向对象的解决方案，和线程到应用中，但是它根本不需要这些。为什么我们这样做？我们中的一些人是因为不知道怎么做更好，但是还有一些人这样做的目的是为了学习新的知识，从而使得这个应用对于我们自己来说做得比较有趣。
3． 牢牢记住——“少即是多（less is more）”并不永远是好的
代码的效率是一伟大的事情，但是在很多情况下，写更少的代码行并不能提高该代码的效率。请让我向你展示一个简单的例子。
if(newStatusCode.equals("SD") && (sellOffDate == null ||
todayDate.compareTo(sellOffDate)<0 || (lastUsedDate != null &&
todayDate.compareTo(lastUsedDate)>0)) ||
(newStatusCode.equals("OBS") && (OBSDate == null ||
todayDate.compareTo(OBSDate)<0))){
newStatusCode = "NYP";
}
我想问一句：说出上面的那段代码的if条件想干什么容易吗？现在，我们再来假设无论是谁写出这段代码，而没有遵从第一条规则——在你的代码里加入注释。
如果我们把这个条件分到两个独立的if陈述句中，难道不是更简单一些吗？现在，考虑下面的修正代码：
if(newStatusCode.equals("SD") && (sellOffDate == null ||
todayDate.compareTo(sellOffDate)<0 || (lastUsedDate != null &&
todayDate.compareTo(lastUsedDate)>0))){
newStatusCode = "NYP";
}else
if(newStatusCode.equals("OBS") && (OBSDate == null ||
todayDate.compareTo(OBSDate)<0))
{
newStatusCode = "NYP";
}
难道它不是有了更好的可读性？是的，我们重复了陈述条件。是的，我们多出了一个多余的“IF”和两对多余的括弧。但是代码有了更好的可读性和可理解性。
4． 请不要有硬代码
开发人员常常有意识的忘记或者忽视这条规则，原因是我们，和一般时候一样，在赶时间。如果我们遵从这条规则，我们可能会赶不上进度。我们可能不能结束我们的当前状态。但是写一条额外的定义静态常量的代码行又能花费我们多少时间呢？
这里有一个例子。
public class A {
public static final String S_CONSTANT_ABC = "ABC";
public boolean methodA(String sParam1){
if(A.S_CONSTANT_ABC.equalsIgnoreCase(sParam1)){
return true;
}
return false;
}
}
现在，每一次我们需要和某一些变量比较字符串“ABC”的时候，我们只需要引用S_CONSTANT_ABC，而不是记住实际的代码是什么。它还有一个好处是：更加容易在一个地方修改常量，而不是在所有的代码中寻找这个代码。
5． 不要发明你自己的frameworks
已经推出了几千种frameworks，而且它们中的大多数是开源的。这些frameworks中间有很多是极好的解决方案，被应用到成千上万的应用中。你们需要跟上这些新frameworks的步伐，最起码是肤浅的。在这些极好的、应用广泛的frameworks中间，一个最好的、最直接的例子是Struts。在你所能想象到的frameworks中，这个开源的web frameworks对于基于web的应用是一个完美的候选者。但是你必须记住第二条规则——不要让事情复杂化。如果你开发的应用只有三个页面—请，不要使用Struts，对于这样一个应用，没有什么“控制”请求的。
6． 不要打印行和字符串相加
我知道，为了调试的目的，开发人员喜欢在每一个我们认为适合的地方添加System.out.println，而且我们会对我们自己说，会在以后删掉这些代码的。但是我们常常忘掉删去这些代码行，或者我们根本就不想删掉它们。我们使用System.out.println来测试，当我们测试完成以后，为什么我们还能接触到它们呢？我们可能删掉一行我们实际需要的代码，仅仅是因为你低估了System.out.println所带来的伤害，考虑下面的代码：
public class BadCode {
public static void calculationWithPrint(){
double someValue = 0D;
for (int i = 0; i < 10000; i++) {
System.out.println(someValue = someValue + i);
}
}
public static void calculationWithOutPrint(){
double someValue = 0D;
for (int i = 0; i < 10000; i++) {
someValue = someValue + i;
}
}
public static void main(String [] n) {
BadCode.calculationWithPrint();
BadCode.calculationWithOutPrint();
}
}
在下面的表格中，你能够看到calculationWithOutPrint()方法的运行花了0.001204秒。相比较而言，运行calculationWithPrint()方法花了令人惊讶的10.52秒。
避免这样一个CPU浪费的最好方法是引入一个包装器方法，就象下面这样
public class BadCode {
public static final int DEBUG_MODE = 1;
public static final int PRODUCTION_MODE = 2;
public static void calculationWithPrint(int logMode){
double someValue = 0D;
for (int i = 0; i < 10000; i++) {
someValue = someValue + i;
myPrintMethod(logMode, someValue);
}
}
public static void myPrintMethod(int logMode, double value) {
if (logMode > BadCode.DEBUG_MODE) { return; }
System.out.println(value);
}
public static void main(String [] n) {
BadCode.calculationWithPrint(BadCode.PRODUCTION_MODE);
}
}
在下面的图中，你将看到，使用了StringBuffer的那个方法只花了0.01秒来执行，而那个使用了字符串相加的方法却花了0.08秒来运行。选择是显而易见的。
7． 关注GUI
不管这听起来有多么可笑，我都要再三地说明：GUI对于商业客户来说和功能和性能一样重要。GUI是一个成功的系统的必要的一部分。（但是），IT杂志常常倾向于忽视GUI的重要性。很多机构为了省钱而不雇用那些在设计“用户友好”GUI方面有丰富经验的设计人员。Java开发人员不得不依赖他们自己的HTML知识，但是他们在这方面的知识十分有限。我看到过很多这样的应用：它们是“计算机友好”，而不是“用户友好”我很少很少能看到有开发人员既精通软件开发，又精通GUI开发。如果你是那个不幸的开发人员，被分配去开发用户接口，你应该遵从以下的三条原则：
一、不要重复发明轮子。寻找有相似用户接口需求的已经存在的系统。
二、首先创建一个原型。这是非常重要的步骤。客户喜欢看看他们将要得到什么。这对你来说也是很好的，因为在你全力以赴而做出一个将要使用户生气的用户接口之前，你就得到了它们的反馈。
三、戴用户的帽子。换一句话说，站在用户的视角检查应用的需求。例如，一个总结页面到底要不要分页。作为一个软件开发者，你倾向于在一个系统中忽视分页，因为这样使得你有比较少的开发复杂性。但是，这对于从一个用户的视角来说却不是最好的解决方案，因为小结的数据将会有成百上千个数据行。
8． 永远准备文档化的需求
每一个业务需求都必须文档化。这可能在一些童话故事里才能成真，但是在现实世界却不可能。不管时间对于你的开发来说是多么紧迫，也不管交付日期马上就要到来，你永远都必须清楚，每一个业务需求是文档化的。
9． 单元测试、单元测试、单元测试
我将不会深入地讨论哪些什么是把你的代码进行单元测试的最佳方法的细节问题。我将要说的是单元测试必须要做。这是编程的最基本的法则。这是上面所有法则中最不能被忽略的一个。如果你的同事能为你的代码创建和测试单元测试，这是最好不过的事。但是如果没有人为你做这些事，那么你就必须自己做。在创建你的单元测试计划的时候，遵从下面的这些规则：
一、在写代码之前就写单元测试用例。
二、在单元测试里写注释。
三、测试一切执行“interesting”功能的公有方法（“interesting”的意思是非setters或getters方法，除非它们通过一种特殊的方式执行set和get方法）。
10． 记住—质量，而不是数量。
不要在办公室里呆得太晚（当你不必呆的太晚的时候）。我理解有时，产品的问题、紧迫的最终期限、意想不到的事件都会阻止我们按时下班。但是，在正常情况下，经理是不会赏识和奖赏那些下班太晚的员工的，他赏识他们是因为他们所做产品的质量。如果你遵从了我上面给出的那些规则，你将会发现你的代码更加少的bug，更加多的可维护性。而这才是你的工作的最重要的部分。
总结
在这篇文章里，我给出了针对Java开发人员的十个重要的规则。重要的不仅仅是知道这些规则，在编码的过程中遵从这些规则更为重要。希望这些规则能够帮助我们成为更好的编程人员和专业人员。
关于作者
Aleksey Shevchenko在面向对象方面的编程有着七年以上的经验。他现在在从事华尔街、制造和出版工业方面的IT解决方案的工作。
分享到：
相关推荐
### JAVA开发人员的十大戒律 #### 一、养成良好的编码习惯 良好的编程习惯对于提升代码的可读性和协作效率至关重要。例如，在编写Java代码时，应该注重代码的整洁与清晰，合理使用注释来解释复杂的逻辑部分。此外...
### Java开发者的十大戒律解析 #### 一、遵循简洁原则（Less is more） 在Java开发过程中，简洁性是一项至关重要的原则。代码应当尽可能简单明了，避免不必要的复杂度。例如，在条件判断语句中，如果可以将多个...
【Java开发人员需知的十大戒律】是Java开发者应当遵循的重要原则，旨在提升代码质量、可维护性和可读性。以下是对这十大戒律的详细解析： 1. **加入注释**：注释虽然不直接影响程序运行，但在长期维护中至关重要。...
# 基于C语言的SmartPlugModbus固件项目 ## 项目简介 该项目是一个基于C语言的固件项目，旨在实现一个支持Modbus RTU通信协议的智能设备固件。该固件被设计为与SmartPlugModbus设备配合使用，用于控制和管理多个电源插座，提供过流、欠流、过压、欠压和过热保护，同时监控插座状态和电压、电流等参数。 ## 项目的主要特性和功能 1. Modbus RTU通信协议支持固件实现了Modbus RTU通信协议，允许通过Modbus协议与设备进行通信，包括读取和写入设备参数、状态和控制命令。 2. 多插座控制固件支持控制多个电源插座，包括开启、关闭、查询状态等。 3. 保护功能设备提供过流、欠流、过压、欠压和过热保护，防止设备损坏和安全事故。 4. 参数配置通过Modbus协议，用户可以配置设备的保护参数，如电流、电压限制等。
【项目资源】： 单片机项目适用于从基础到高级的各种项目，特别是在性能要求较高的场景中，比如操作系统开发、嵌入式编程和底层系统编程。如果您是初学者，可以从简单的控制台程序开始练习；如果是进阶开发者，可以尝试涉及硬件或网络的项目。 【项目质量】： 所有源码都经过严格测试，可以直接运行。 功能在确认正常工作后才上传。 【适用人群】： 适用于希望学习不同技术领域的小白或进阶学习者。 可作为毕设项目、课程设计、大作业、工程实训或初期项目立项。 【附加价值】： 项目具有较高的学习借鉴价值，也可直接拿来修改复刻。 对于有一定基础或热衷于研究的人来说，可以在这些基础代码上进行修改和扩展，实现其他功能。 【沟通交流】： 有任何使用上的问题，欢迎随时与博主沟通，博主会及时解答。 鼓励下载和使用，并欢迎大家互相学习，共同进步。 # 注意 1. 本资源仅用于开源学习和技术交流。不可商用等，一切后果由使用者承担。 2. 部分字体以及插图等来自网络，若是侵权请联系删除。
【项目资源】： 物联网项目适用于从基础到高级的各种项目，特别是在性能要求较高的场景中，比如操作系统开发、嵌入式编程和底层系统编程。如果您是初学者，可以从简单的控制台程序开始练习；如果是进阶开发者，可以尝试涉及硬件或网络的项目。 【项目质量】： 所有源码都经过严格测试，可以直接运行。 功能在确认正常工作后才上传。 【适用人群】： 适用于希望学习不同技术领域的小白或进阶学习者。 可作为毕设项目、课程设计、大作业、工程实训或初期项目立项。 【附加价值】： 项目具有较高的学习借鉴价值，也可直接拿来修改复刻。 对于有一定基础或热衷于研究的人来说，可以在这些基础代码上进行修改和扩展，实现其他功能。 【沟通交流】： 有任何使用上的问题，欢迎随时与博主沟通，博主会及时解答。 鼓励下载和使用，并欢迎大家互相学习，共同进步。 # 注意 1. 本资源仅用于开源学习和技术交流。不可商用等，一切后果由使用者承担。 2. 部分字体以及插图等来自网络，若是侵权请联系删除。
# 基于嵌入式系统的StackAttack游戏项目 ## 项目简介 StackAttack是一个基于嵌入式系统的游戏项目，设计用于SPI TFT彩色液晶显示面板上运行。游戏的核心玩法是操控一个名为“Claw”（爪子）的游戏角色，在由格子组成的地图上移动并抓取箱子。玩家通过操纵杆控制游戏角色，成功抓取并移动箱子到目标位置后得分。游戏地图由二维数组表示，每个格子代表一个位置。当玩家成功将所有箱子移动到目标行时，游戏结束。 ## 项目的主要特性和功能 1. 游戏角色控制玩家通过操纵杆控制Claw（爪子）角色移动。 2. 地图和箱子管理游戏地图由二维数组表示，每个格子代表一个位置。箱子在游戏地图上的位置由数组中的值表示。 3. 游戏逻辑包括角色的移动、箱子的抓取和移动、得分计算等。 4. 图形显示使用SPITFTILI9341图形库控制SPI TFT显示屏，实现游戏的图形输出。 5. 暂停功能游戏支持暂停功能，方便玩家随时暂停游戏。
内容概要：本文档提供了基于STM32、OpenCV和卷积神经网络的车牌识别系统的完整代码示例。系统通过摄像头捕捉视频流，利用OpenCV进行图像处理（如灰度化、二值化、轮廓检测等）以定位车牌区域，并使用预训练的ONNX模型对车牌字符进行识别。之后，系统将识别到的车牌号与预先存储在CSV文件中的居民车牌数据库进行匹配，以判断车辆是否为小区居民所有，从而实现对外来车辆的收费管理。; 适合人群：对嵌入式系统开发、计算机视觉和深度学习感兴趣的开发者，尤其是有一定C++编程基础和技术背景的研究人员或工程师。; 使用场景及目标：①适用于社区、停车场等场所的车辆管理；②帮助开发者理解车牌识别的基本流程，包括图像预处理、车牌定位、字符识别以及与数据库的交互；③提供一个可扩展的基础框架，便于后续优化和功能增加。; 阅读建议：读者应确保具备基本的OpenCV库使用经验和C++编程能力。在学习过程中，建议同时参考相关文献资料，深入理解每个步骤背后的原理，并尝试调整参数或替换模型以提高识别精度。此外，还需准备相应的硬件设备（如摄像头）和软件环境（如安装OpenCV库），以便实际运行代码并观察效果。
efwfw
内容概要：本文详细介绍了利用西门子S7-200 PLC和MCGS组态软件构建智能交通灯控制系统的方法。首先阐述了系统的硬件配置，包括PLC的选择、IO分配、光电开关的应用等。接着深入探讨了梯形图编程的核心逻辑，如定时器嵌套、车流判断、紧急模式处理等。同时，还讲解了MCGS组态界面的设计要点，如动态指示灯、车流统计曲线、急停按钮等功能的实现。此外，文中分享了一些调试经验和优化技巧，如信号隔离、通信参数设置、夜间模式优化等。 适合人群：对PLC编程和工业自动化感兴趣的工程技术人员、高校相关专业学生。 使用场景及目标：适用于城市交通管理部门进行智能交通灯系统的规划与实施，旨在提高交通效率，减少拥堵。通过学习本文，读者能够掌握PLC编程的基本方法和MCGS组态软件的使用技巧。 其他说明：文中提供了详细的接线图、梯形图代码片段和组态界面截图，便于读者理解和实践。同时，作者还分享了许多实际操作中的注意事项和经验教训，有助于初学者少走弯路。
【项目资源】： 物联网项目适用于从基础到高级的各种项目，特别是在性能要求较高的场景中，比如操作系统开发、嵌入式编程和底层系统编程。如果您是初学者，可以从简单的控制台程序开始练习；如果是进阶开发者，可以尝试涉及硬件或网络的项目。 【项目质量】： 所有源码都经过严格测试，可以直接运行。 功能在确认正常工作后才上传。 【适用人群】： 适用于希望学习不同技术领域的小白或进阶学习者。 可作为毕设项目、课程设计、大作业、工程实训或初期项目立项。 【附加价值】： 项目具有较高的学习借鉴价值，也可直接拿来修改复刻。 对于有一定基础或热衷于研究的人来说，可以在这些基础代码上进行修改和扩展，实现其他功能。 【沟通交流】： 有任何使用上的问题，欢迎随时与博主沟通，博主会及时解答。 鼓励下载和使用，并欢迎大家互相学习，共同进步。 # 注意 1. 本资源仅用于开源学习和技术交流。不可商用等，一切后果由使用者承担。 2. 部分字体以及插图等来自网络，若是侵权请联系删除。
摘 要 面对信息时代的机遇与挑战，利用高科技手段来提高企业的管理水平无疑是一条行之有效的途径。利用计算机管理可以最大限度的发挥准确、快捷、高效等作用, 在越来越激烈的珠宝行业中，计算机管理技术对珠宝首饰公司的服务管理提供强有力的支持。因此，利用全新的计算机网络和珠宝首饰管理系统，已成为提高珠宝首饰公司的管理效率，改进服务水准的重要手段之一。本系统应用Visual Basic 6.0 中文版开发前台，用Microsoft Access 作后台服务器，采用客户机/服务器（C/S）管理思想来对珠宝首饰进销存管理。 关键词：管理水平， 管理效率，服务水准，珠宝首饰管理系统，客户机/服务器，管理思想
稀疏分解方法在信号去噪中的应用研究_内含源码数据论文.zip
本书由吉姆·诺埃尔和大卫·多蒂奇编辑，旨在探讨领导力发展领域的最新趋势和实践。书中不仅提供了领导力发展领域的历史回顾，还挑战了组织对领导力发展的战略视角，详细介绍了如何培养全球领导者，并提供了关于领导力发展方法、策略和系统、高潜力人才发展、高层管理参与、有效学习方法以及领导力指标等方面的深入案例研究和理论分析。此外，书中还探讨了创新的领导力发展方法，并对未来的发展趋势进行了展望。
一种基于 QR 二维码的彩色二维码编码译码设计及其软件实现.zip
【项目资源】： 单片机项目适用于从基础到高级的各种项目，特别是在性能要求较高的场景中，比如操作系统开发、嵌入式编程和底层系统编程。如果您是初学者，可以从简单的控制台程序开始练习；如果是进阶开发者，可以尝试涉及硬件或网络的项目。 【项目质量】： 所有源码都经过严格测试，可以直接运行。 功能在确认正常工作后才上传。 【适用人群】： 适用于希望学习不同技术领域的小白或进阶学习者。 可作为毕设项目、课程设计、大作业、工程实训或初期项目立项。 【附加价值】： 项目具有较高的学习借鉴价值，也可直接拿来修改复刻。 对于有一定基础或热衷于研究的人来说，可以在这些基础代码上进行修改和扩展，实现其他功能。 【沟通交流】： 有任何使用上的问题，欢迎随时与博主沟通，博主会及时解答。 鼓励下载和使用，并欢迎大家互相学习，共同进步。 # 注意 1. 本资源仅用于开源学习和技术交流。不可商用等，一切后果由使用者承担。 2. 部分字体以及插图等来自网络，若是侵权请联系删除。
【项目资源】： 物联网项目适用于从基础到高级的各种项目，特别是在性能要求较高的场景中，比如操作系统开发、嵌入式编程和底层系统编程。如果您是初学者，可以从简单的控制台程序开始练习；如果是进阶开发者，可以尝试涉及硬件或网络的项目。 【项目质量】： 所有源码都经过严格测试，可以直接运行。 功能在确认正常工作后才上传。 【适用人群】： 适用于希望学习不同技术领域的小白或进阶学习者。 可作为毕设项目、课程设计、大作业、工程实训或初期项目立项。 【附加价值】： 项目具有较高的学习借鉴价值，也可直接拿来修改复刻。 对于有一定基础或热衷于研究的人来说，可以在这些基础代码上进行修改和扩展，实现其他功能。 【沟通交流】： 有任何使用上的问题，欢迎随时与博主沟通，博主会及时解答。 鼓励下载和使用，并欢迎大家互相学习，共同进步。 # 注意 1. 本资源仅用于开源学习和技术交流。不可商用等，一切后果由使用者承担。 2. 部分字体以及插图等来自网络，若是侵权请联系删除。
内容概要：本文详细介绍了使用COMSOL Multiphysics的弱形式接口对三维光子晶体进行数值模拟的方法和技巧。文章通过具体的代码示例，解释了如何构建光子晶体的介电常数分布、设置弱形式PDE、处理电磁场切向连续性、应用Floquet周期边界条件以及特征值求解等关键步骤。特别强调了弱形式接口相比传统物理场接口的优势，如灵活性和对复杂边界的处理能力。文中还分享了一些实用的经验和注意事项，如布洛赫边界条件的实现、特征值求解器参数的优化配置以及网格划分的技巧。 适合人群：具备一定电磁学和数值模拟基础的研究人员或工程师，尤其是对光子晶体仿真感兴趣的读者。 使用场景及目标：①理解并掌握COMSOL弱形式接口在光子晶体仿真中的应用；②学习如何通过弱形式设置处理复杂的电磁场问题；③提高对光子晶体能带结构和带隙特性的认识；④掌握特征值求解和网格划分的最佳实践。 阅读建议：由于本文涉及较多的具体代码和物理概念，建议读者在阅读过程中结合COMSOL软件进行实际操作，同时查阅相关电磁理论书籍以加深理解。此外，对于文中提到的一些具体参数设置和技巧，可以通过尝试不同的配置来巩固所学知识。
内容概要：PT5000汽轮机滑动轴承系统模拟试验台是一个类似于电厂汽轮机发电机的缩小模型，旨在帮助用户获取汽轮机转子动态行为和滑动轴承油膜现象的实际经验，并研究振动控制方法。该试验台模拟两级涡轮机（低压和中压），每级转子两侧各有8个叶片，共计16个叶片。通过电机驱动而非涡轮发电机，可以进行启停机测试，识别共振现象。试验台还支持多种实验，如不平衡/现场动平衡、轴不对中实验、摩擦实验、油膜故障试验、轴颈轴承实验以及根据油压和温度进行的转子动力学试验。试验台配备了多种传感器和控制系统，包括电涡流传感器、温度传感器、压力传感器等，用于监测和记录实验数据。 适合人群：从事汽轮机设计、制造、维护的技术人员，以及相关专业的高校师生和研究人员。 使用场景及目标：①研究汽轮机转子的动态行为和滑动轴承的油膜现象；②进行振动控制方法的研究；③模拟再现油膜涡动转和油膜震荡，研究其控制条件；④进行不平衡、不对中、摩擦等常见故障的模拟和分析；⑤通过调整油压、温度和预加载力，研究轴的行为变化。 其他说明：该试验台不仅适用于教学和科研，还可用于工业领域的培训和技术验证。试验台具有丰富的配置和可选配件，可以根据具体需求进行定制。试验台的机械和电气参数详细列出，确保用户能够全面了解设备性能。