Java编码规范2014526.docVIP

Java 编码规范 概述 本标准系公司首次发布实施，主要针对公司所有软件产品源代码范围的Java编码风格，对Java文件的文件组织、代码风格、注释、命名、声明、异常、习惯等方面均做Pascal case - 所有单词第一个字母大写，其它字母小写。 例如：Camel case - 除了第一个单词，所有单词第一个字母大写，其他字母小写。 例如：oilLevel, customerName。 重要规范 操作规范 cdrundle的codetemplates.xml代码模板文件。 开发人员必须配置cdrundle的cdrundleFormatter.xml代码格式化文件。 每次提交代码之前，必须对java代码format。 模板文件： Eclipse中配置的位置： Window-Preferences-Java-Code templates Window-Preferences-Java-Formatter 代码提交 为防止冲突，任何时候，代码（及配置文件）提交前，先从SVN中更新代码和配置文件，以及早发现不。。。 垃圾清理 对从来没有用到的或者被注释的方法、、、 日志规范 对trace/debug/info级别的日志输出，必须使用条件输出形式，否则大量的日志会增加来自对象toString的性能成本。 对于日志的打印，任何情况下都不允许日志错误导致业务失败。 错误日志 对于由于系统原因造成业务处理失败的事件，需要记录错误日志。非系统原因的业务处理失败，不应该记录错误日志（推荐使用warn级别），避免错误日志过大，影响紧急情况下的故障分析不诊断。 注释规范 必须保证代码和注释的一致性。 正确区分使用文档注释和实现逻辑注释。 异常处理 最外层的业务使用者，必须处理异常，将其转化为用户可以理解的内容。 安全规范 对于前台的web页面，严禁出现方便调试的后门页面。 不允许出现页面向自身重定向、或者多个页面间相互重定向的情况。如果控制不当，很容易造成系统宕机。 敏感信息的保护 用户的敏感信息包括密码、短信验证码、支付验证码、身份证号、银行卡号、银行密钥，商户密钥等信息，用户敏感信息不能泄露，否则可能会带来不安全因素。可能会导致敏感信息泄露的方式有：Logger、URL的get参数（因为URL的get参数会在apache日志中被输出）。 通用规范 UserID、URL、文件名、系统开关参数、业务规则的可变参数等硬编码。 资源的使用 对系统资源的访问，使用后必须释放系统资源。这类资源包括：文件流、线程、网络连接、数据库连接等。 对于文件、流的IO操作，必须通过finally关闭。 对于线程，线程资源必须通过线程池提供，不允许在应用中自行显式创建线程。 对于网络连接与数据库连接，必须由框架通过连接池提供，不允许应用中自行建立网络与数据库连接。 类的编写规范 格式规范 import java.io.IOException; import .URL; import java.rmi.RmiServer; import java.rmi.server.Server; import javax.swing.JPanel; import javax.swing.event.ActionEvent; import org.linux.apache.server.SoapServer; 只倒入明确需要的类，这样只要看导入列表，就可以知道该类依赖于哪些类和接口，保证可读性。 import java.util.List; // 避免: import java.util.* import java.util.Arraylist; import java.util.HashSet; 类和接口中元素的布局顺序。 1、类和接口的文档描述 2、类和接口的声明 3、类的静态变量，按照public，protected，package，private的顺序。 4、实例变量，按照public，protected，package，private的顺序。 5、类的方法，无固定顺序。 类的声明，基类和实现的接口应该独立成行，保证可读性。 class UserManagerImpl extends AbstractManager implements IUserManager{ … } 方法修饰关键字定义顺序。 public, protected, private static abstract synchronized unuaual final native methodName 注意访问标示符一定要在最前面。 public static double square(double a); //避免: static pub