Java开发必读宝典，专注提升代码质量

恒生LIGHT云社区
453 阅读9分钟

作者：幻好

来源：恒生LIGHT云社区

读后感

读完《Java开发手册》后，能够学到许多开发规范、编码中的一些高效的用法。通过了解规范，可以提前避免一些开发盲区，大大提高团队协作的效率。规范的编程习惯，更能提升coder的职业素养。一个成熟的项目需要长期的发展，开发维护的成本必须作为程序设计者首要考虑的，所以如果能够提高开发质量和效率、大大降低代码维护成本。对应书中所提到的问题需要反复实践才能真正的掌握，就像作者说的：

翻完了不代表记住了，记住了不代表理解了，理解了不代表能够应用上去，真正的知识是实践。

image.png

实例

对于一些开发中常用且重要的点进行了实践和总结：

Java相关

  1. 避免通过一个类的对象引用访问此类的静态变量或静态方法，无谓增加编译器解析成本，直接用类名来访问即可。

    • 如果需要使用类中定义静态变量或静态方法时，使用类名访问更直接。如果为了访问而且new 一个对象，会耗费更多成本。

  2. Object 的 equals 方法容易抛空指针异常，应使用常量或确定有值的对象来调用equals。

    • 尽量使用非空的对象调用equals 去判别另外一个对象；
    • 在不确定对象是否存在时，先判空在比较；

  3. 所有整型包装类对象之间值的比较，全部使用equals方法比较。

    • 由于考虑Integer 在-128至127之间的赋值，Integer 对象是在IntegerCache.cache 产生，会复用已有对象；
    • 因为会有对象复用的情况，而Integer 对equals 进行了重写，使用的值进行比较，所以最好就使用equals进行比较；

  4. 禁止使用构造方法 BigDecimal(double) 的方式把 double 值转化为 BigDecimal 对象。

    • 使用double 传参的构造方法可能会导致精度计算的场景会出现异常，需要慎重使用；

  5. 循环体内，字符串的连接方式，使用 StringBuilder 的 append 方法进行扩展。

    • 在字符串拼接时，我们使用最多的就是 + 号拼接，但是在代码编译时，实际上是new 的StringBuilder 去append ，而且每加一次就创建一个新对象；
    • 使用StringBuilder 进行拼接，是速度最快的，但是如果调用的方法涉及线程安全，考虑使用StringBuffer ;

  6. 慎用 Object 的 clone 方法来拷贝对象。

    • 对象clone 方法默认是浅拷贝，若想实现深拷贝需覆写clone 方法实现域对象的深度遍历式拷贝。

  7. 判断所有集合内部的元素是否为空，使用 isEmpty() 方法，而不是 size()==0 的方式。

    • isEmpty() 的时间复杂度为O(1)，效率更高，而且可读性高；

  8. 使用 Map 的方法 keySet()/values()/entrySet() 返回集合对象时，不可以对其进行添加元素操作，否则会抛出 UnsupportedOperationException 异常。

    • 在实际开发中需要注意这个问题，在循环 Map 时不要添加新的元素进来。

  9. 集合初始化时，指定集合初始值大小。

    • 初始化大小建议是initialCapacity = (需要存储的元素个数 / 负载因子) + 1；
    • 指定集合初始化大小是为了减少集合的扩容，减少性能的损耗；

  10. 使用 entrySet 遍历Map类集合 KV ，而不是 keySet 方式进行遍历。

    • keySet 底层其实是遍历了两次，一次是转为Iterator 对象，另一次是从hashMap 中取出key 所对应的value ；
    • 而entrySet 只是遍历了一次就把key 和value 都放到了entry 中，效率更高。如果是JDK8，使用Map.forEach 方法。

  11. 利用 Set 元素唯一的特性，可以快速对一个集合进行去重操作，避免使用 List 的 contains() 进行遍历去重或者判断包含操作。

    • 使用 Set 去重叠效率会更高；

  12. 线程池不允许使用 Executors 去创建，而是通过 ThreadPoolExecutor 的方式，这样的处理方式让写的同学更加明确线程池的运行规则，规避资源耗尽的风险。

    • FixedThreadPool 和SingleThreadPool ： 允许的请求队列长度为Integer.MAX_VALUE ，可能会堆积大量的请求，从而导致OOM 。
    • CachedThreadPool ： 允许的创建线程数量为Integer.MAX_VALUE ，可能会创建大量的线程，从而导致OOM 。

  13. 并发修改同一记录时，避免更新丢失，需要加锁。要么在应用层加锁，要么在缓存加锁，要么在数据库层使用乐观锁，使用version作为更新依据。

    • 如果每次访问冲突概率小于20%，推荐使用乐观锁，否则使用悲观锁。乐观锁的重试次数不得小于3次。

  14. Java 类库中定义的可以通过预检查方式规避的 RuntimeException 异常不应该通过 catch 的方式来处理，比如：NullPointerException ，IndexOutOfBoundsException 等等。

    • 在对象获取或使用时，一定要进行处理对象可能为空的情况，提前处理；

  15. 不要在 finally 块中使用 return 。

  16. try 块中的 return 语句执行成功后，并不马上返回，而是继续执行 finally 块中的语句，如果此处存在 return 语句，则在此直接返回，try 块中的返回点不会执行。

  17. 防止 NPE ，是程序员的基本修养，注意 NPE 产生的场景：

    • 返回类型为基本数据类型，return 包装数据类型的对象时，自动拆箱有可能产生NPE 。 反例：public int f() { return Integer对象}， 如果为null ，自动解箱抛NPE 。
    • 数据库的查询结果可能为null。
    • 集合里的元素即使isNotEmpty ，取出的数据元素也可能为null。
    • 远程调用返回对象时，一律要求进行空指针判断，防止NPE 。
    • 对于Session 中获取的数据，建议进行NPE 检查，避免空指针。
    • 级联调用obj.getA().getB().getC();一连串调用，易产生NPE 。

  18. 避免出现重复的代码（Don't Repeat Yourself），即DRY原则。

    • 随意复制和粘贴代码，必然会导致代码的重复，在以后需要修改时，需要修改所有的副本，容易遗漏。必要时抽取共性方法，或者抽象公共类，甚至是组件化。

  19. 应用中不可直接使用日志系统（Log4j、Logback）中的 API ，而应依赖使用日志框架 （SLF4J、JCL--Jakarta Commons Logging）中的 API ，使用门面模式的日志框架，有利于维护和各个类的日志处理方式统一。

    • 对于第三方相关的一些 API 不要直接调用使用，而是要封装后在使用，防止框架升级导致 API 改变影响系统使用。

  20. 用户敏感数据禁止直接展示，必须对展示数据进行脱敏。

    • 对于用户敏感数据，一定要做到脱敏查询展示，防止信息泄露；

安全相关

  1. 用户请求传入的任何参数必须做有效性验证。

    • 对于前端请求的参数一定要考虑对系统的影响。

  2. 用户输入的 SQL 参数严格使用参数绑定或者 METADATA 字段值限定，防止 SQL 注入，禁止字符串拼接 SQL 访问数据库。

    • 尤其在使用mybatis 等工具时，尽量使用# 来传入参数，来防止SQL 的注入；

  3. 在使用平台资源，譬如短信、邮件、电话、下单、支付，必须实现正确的防重放的机制，如数量限制、疲劳度控制、验证码校验，避免被滥刷而导致资损。

    • 对用户的请求下一定场景下，需要进行限制，防止重复请求对平台资源产生影响；

MySQL相关

  1. 在varchar字段上建立索引时，必须指定索引长度，没必要对全字段建立索引，根据实际文本区分度决定索引长度。

    • 索引的长度与区分度是一对矛盾体，一般对字符串类型数据，长度为20的索引，区分度会高达90%以上，可以使用count(distinct left(列名, 索引长度))/count(*)的区分度来确定。

  2. 如果有order by的场景，请注意利用索引的有序性。order by 最后的字段是组合索引的一部分，并且放在索引组合顺序的最后，避免出现file_sort的情况，影响查询性能。

    • 索引如果存在范围查询，那么索引有序性无法利用，如：WHERE a>10 ORDER BY b; 索引a_b无法排序。

  3. 利用覆盖索引来进行查询操作，避免回表。

    • 覆盖索引是一种查询的一种效果，用explain的结果，extra列会出现：using index。

  4. 利用延迟关联或者子查询优化超多分页场景。

    • MySQL并不是跳过offset行，而是取offset+N行，然后返回放弃前offset行，返回N行，那当offset特别大的时候，效率就非常的低下，要么控制返回的总页数，要么对超过特定阈值的页数进行SQL改写。

  5. SQL性能优化的目标：至少要达到 range 级别，要求是ref级别，如果可以是consts最好。

    • 通过不断优化SQL查询效率，提高数据库的响应；

总结

手册读了两遍，第一遍快速阅读，第二遍对一些实例进行了实践。

看完后，发现书中讲的许多问题都是我们开发中经常遇到，而且容易犯错的。对于一些开发中常遇到的细节进行了总结和归纳，对个人开发能力会有一定提升。

在以后的开发编码中，要参考遵循相关规范开发，可以让开发效率和编写的程序性能得到一定的提升，继续修炼。

想学习的同学，可以点击 链接 下载本文附件。

avatar
文章
阅读
粉丝