点击上方“公众号”可以订阅哦 摘要 Java作为一门名副其实的工业级语言,语法友好,学习简单,大规模的应用给代码质量的管控带来了困难,特别是团队开发中,开发过程中的规范会直接影响最终项目的稳定性。 善医者“未有形而除之”,提高工程健壮性最好的方式是在代码出现问题之前就排除掉,不给Bug出现的机会。一份好的开发规范就可以起到这样的作用,大大减少产品上线后的问题。 《阿里巴巴Java开发手册》是阿里巴巴的内部编码规范,阿里官方的Java代码规范标准, 手册以Java应用开发为维度,分为编程规约、异常日志规约、MYSQL规约、工程规约、安全规约五个章节,给出了强制、推荐、参考三个级别,每条规范都有推荐的约束力度,从命名到项目拆分,不仅规范了一些开发细节,也提出了很多工程开发的哲学,值得好好阅读。 下面记录一些对我比较有启发的条款,提纲挈领,快速学习。 一 编程规约 1.如果使用到了设计模式,建议在类名中体现出具体模式 将设计模式体现在名字中,有利于阅读者快速理解架构设计思想。 2.相同参数类型,相同业务含义,才可以使用 Java 的可变参数,避免使用 Object 可变参数必须放置在参数列表的最后,尽量不用可变参数编程。 3.对外暴露的接口签名,原则上不允许修改方法签名,避免对接口调用方产生影响 接口过时必须加@Deprecated 注解,并清晰地说明采用的新接口或者新服务是什么。 4.关于基本数据类型与包装数据类型的使用标准如下 1) 所有的POJO类属性必须使用包装数据类型 2) RPC方法的返回值和参数必须使用包装数据类型 3) 所有的局部变量【推荐】使用基本数据类型 POJO 类属性没有初值是醒使用者在需要使用时,必须自己显式地进行赋值,任何 NPE 问题,或者入库检查,都由使用者来保证。数据库的查询结果可能是null,因为自动拆箱,用基本数据类型接收有NPE风险。 5.注意 serialVersionUID 不一致会抛出序列化运行时异常 序列化类新增属性时,请不要修改 serialVersionUID 字段,避免反序列失败;如果完全不兼容升级,避免反序列化混乱,那么请修改 serialVersionUID 值。 6.POJO 类必须写 toString 方法 使用 IDE 的中工具:source |
|
声明:文章版权归原作者所有 部分文章转自互联网 如有侵权请联系
[邮箱地址] 删除
|