对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解决方案的工作。
分享到：
相关推荐
qtz40塔式起重机总体及塔身有限元分析法设计().zip
Elasticsearch是一个基于Lucene的搜索服务器
资源内项目源码是来自个人的毕业设计，代码都测试ok，包含源码、数据集、可视化页面和部署说明，可产生核心指标曲线图、混淆矩阵、F1分数曲线、精确率-召回率曲线、验证集预测结果、标签分布图。都是运行成功后才上传资源，毕设答辩评审绝对信服的保底85分以上，放心下载使用，拿来就能用。包含源码、数据集、可视化页面和部署说明一站式服务，拿来就能用的绝对好资源！！！ 项目备注 1、该资源内项目代码都经过测试运行成功，功能ok的情况下才上传的，请放心下载使用！ 2、本项目适合计算机相关专业(如计科、人工智能、通信工程、自动化、电子信息等)的在校学生、老师或者企业员工下载学习，也适合小白学习进阶，当然也可作为毕设项目、课程设计、大作业、项目初期立项演示等。 3、如果基础还行，也可在此代码基础上进行修改，以实现其他功能，也可用于毕设、课设、作业等。 下载后请首先打开README.txt文件，仅供学习参考, 切勿用于商业用途。
美国纽约HVAC(暖通空调)数据示例，谷歌地图数据包括：时间戳、名称、类别、地址、描述、开放网站、电话号码、开放时间、更新开放时间、评论计数、评级、主图像、评论、url、纬度、经度、地点id、国家等。 在地理位置服务（LBS）中，谷歌地图数据采集尤其受到关注，因为它提供了关于各种商业实体的详尽信息，这对于消费者和企业都有极大的价值。本篇文章将详细介绍美国纽约地区的HVAC（暖通空调）系统相关数据示例，此示例数据是通过谷歌地图抓取得到的，展示了此技术在商业和消费者领域的应用潜力。 无需外网，无需任何软件抓取谷歌地图数据：wmhuoke.com
2023-04-06-项目笔记-第四百五十五阶段-课前小分享_小分享1.坚持提交gitee 小分享2.作业中提交代码 小分享3.写代码注意代码风格 4.3.1变量的使用 4.4变量的作用域与生命周期 4.4.1局部变量的作用域 4.4.2全局变量的作用域 4.4.2.1全局变量的作用域_1 4.4.2.453局变量的作用域_453- 2025-04-01
1_实验三 扰码、卷积编码及交织.ppt
北京交通大学901软件工程导论必备知识点.pdf
内容概要：本文档总结了 MyBatis 的常见面试题，涵盖了 MyBatis 的基本概念、优缺点、适用场合、SQL 语句编写技巧、分页机制、主键生成、参数传递方式、动态 SQL、缓存机制、关联查询及接口绑定等内容。通过对这些问题的解答，帮助开发者深入理解 MyBatis 的工作原理及其在实际项目中的应用。文档不仅介绍了 MyBatis 的核心功能，还详细解释了其在不同场景下的具体实现方法，如通过 XML 或注解配置 SQL 语句、处理复杂查询、优化性能等。 适合人群：具备一定 Java 开发经验，尤其是对 MyBatis 有初步了解的研发人员，以及希望深入了解 MyBatis 框架原理和最佳实践的开发人员。 使用场景及目标：①理解 MyBatis 的核心概念和工作原理，如 SQL 映射、参数传递、结果映射等；②掌握 MyBatis 在实际项目中的应用技巧，包括 SQL 编写、分页、主键生成、关联查询等；③学习如何通过 XML 和注解配置 SQL 语句，优化 MyBatis 性能，解决实际开发中的问题。 其他说明：文档内容详尽，涵盖面广，适合用于面试准备和技术学习。建议读者在学习过程中结合实际项目进行练习，以更好地掌握 MyBatis 的使用方法和技巧。此外，文档还提供了丰富的示例代码和配置细节，帮助读者加深理解和应用。
《基于YOLOv8的智能电网设备锈蚀评估系统》（包含源码、可视化界面、完整数据集、部署教程）简单部署即可运行。功能完善、操作简单，适合毕设或课程设计
插头模具 CAD图纸.zip
资源内项目源码是来自个人的毕业设计，代码都测试ok，包含源码、数据集、可视化页面和部署说明，可产生核心指标曲线图、混淆矩阵、F1分数曲线、精确率-召回率曲线、验证集预测结果、标签分布图。都是运行成功后才上传资源，毕设答辩评审绝对信服的保底85分以上，放心下载使用，拿来就能用。包含源码、数据集、可视化页面和部署说明一站式服务，拿来就能用的绝对好资源！！！ 项目备注 1、该资源内项目代码都经过测试运行成功，功能ok的情况下才上传的，请放心下载使用！ 2、本项目适合计算机相关专业(如计科、人工智能、通信工程、自动化、电子信息等)的在校学生、老师或者企业员工下载学习，也适合小白学习进阶，当然也可作为毕设项目、课程设计、大作业、项目初期立项演示等。 3、如果基础还行，也可在此代码基础上进行修改，以实现其他功能，也可用于毕设、课设、作业等。 下载后请首先打开README.txt文件，仅供学习参考, 切勿用于商业用途。
《基于YOLOv8的智慧农业水肥一体化控制系统》（包含源码、可视化界面、完整数据集、部署教程）简单部署即可运行。功能完善、操作简单，适合毕设或课程设计
python爬虫；智能切换策略，反爬检测机制
台区终端电科院送检文档
e235d-main.zip
丁祖昱：疫情对中国房地产市场影响分析及未来展望
MCP快速入门实战，详细的实战教程
YD5141SYZ后压缩式垃圾车的上装箱体设计.zip
IMG_20250401_195352.jpg
DeepSeek系列专题 DeepSeek技术溯源及前沿探索.pdf