Java开发过程中的编码规范总结

在日常实际开发中我们需要注意以下方面的编码规范：

《1》注释规范：

注释增加代码可读性，便于自己查找问题，也有利于其他工程师阅读你的代码，方便项目的后期维护。一般来说所有的类都要有类注释，完整的类注释需要包含：创建者、创建日期、版本、功能描述，若修改过应增加修改者、修改日期、修改功能的简单描述，变更相应的版本。这是主要的，一般每个公司都有自己的一套规范，具体细节上会有一些小的差异。

《2》函数规范

函数结构清晰，简洁，无冗余代码。最佳的函数设是一个函数只做一件事，保证函数不出现复用的情况。对于无用的注释或者未注释的代码予以删除，冗余的代码不仅带来阅读上的不便，也有可能会干扰正常代码的阅读与执行。对于关键的业务代码最好有注释和设计文档说明。对于只需要实例化一次的代码不要放入到循环中做实例化处理，对于嵌套循环终止条件明确，保证代码在执行后，无论任何情境都可以正常跳出循环。在这一部分需要自己及时做好单元测试，调式代码，保证功能的准确性，同时需要不断积累，以自己的实际经验在编码时规避一些常见问题，说白了就是写好代码的意识，和习惯的建立。

《3》业务逻辑规范

代码业务逻辑结构合理，简单明了。前期的需求分析，可以为为后来代码的编写，减轻很大的压力，提高效率。一般程序猿多多少少都有过埋怨需求SA的情况，“需求怎么又变了，或者需求不明确不好写代码”。这都是常见的问题。当然有些情况避无可避，完美只是理想中的状态，对于我们写程式的人来说，要做好需求变更，修改代码的心理准备。同时也要求做需求的人提供规范的文档（如用例图——可以得出用户与系统的交互情况，主要流程；ER图——DB关系模型，只针对关系型数据库；详细设计文档从中得出准确的业务流程处理......），这样才能便于后期的沟通，做到有理有据。

《4》对外接口规范

尽量以bean或对象的方式对外提供接口访问，目前多数对外接口都会采用JSON封装，对于接口最好有详细的接口文档，说明清楚版本定义，功能描述，调用方式，字段中文描述，字段可输入，字段限制等，一般公司开了对外接口的话，都会有相应的API文档，比较坑的一种情况是，版本更新，无相应说明。

《5》日志规范

日志是我们查看异常情况，记录系统性能参数的好工具，对于日志文件名最好按日期格式处理，便于查阅和备份，避免日志覆盖的情况发生，正式上线后尽量去除输出控制台的信息输出，当日志同时输出文件和控制台时，在高并发系统中会增加IO的压力，同时输出信息时避免前后都有打印换行，当内容增多时，无形中降低程序执行的效率，此外要避免日志文件集群共享。这对性能来说影响致命。

《6》SQL编码规范

理论上SQL执行复杂业务时语句较长，对于其他人来说阅读不便，同时频繁的调用数据库连接池也会大大降低系统效率，但很多情况下，维护老系统，以及业务需要，SQL来执行增删改查还是不可避免，因此如果条件允许尽量不使用SQL来做操作，取而代之使用像JPA、HQL来执行操作。灵活控制事务的使用，对于只查询结果的语句，可以适当降低事务级别，以提升程序执行的效率。数据库设计合理减少开销，合理使用索引提高查询速度，很多公司喜欢使用存储过程，但却并不是最好的选择，因为储存过程易造成移植的不便。大数据量时可以考虑分批循环查询，将数据放到List中，然后对List逐笔处理

《7》有完善的差错处理机制

异常建议打印异常的信息和对应的堆栈信息，有业务逻辑的异常要有响应的编码，未使用或者使用完的对象要关闭，如输入输出流，文件流等。

符合规范的代码可以提高自身开发效率，增加代码可读性，便于维护和CodeReView，可以使测试事半功倍。让这种意识成为习惯，以上是我个人的一点小体会，希望对大家有帮助。