Effective Java 案例分享(一)

1、考虑使用静态生产方法替代构造方法

如果某一个类拥有多个构造方法,且参数各不相同,使用静态的生产方法替代构造方法的好处:

  • 过多的构造方法增加了使用者对于类的理解成本,并且很容易产生误解;
  • 静态生产方法拥有自己的方法名,可以进一步描述该方法的使用场景和参数意义;
  • 静态生产方法封装了内部的实现,便于扩展。例如实现内部的单例,缓存,子类,匿名类,简单工厂等等;

缺点:

  • 如果构造方法是私有的,仅仅使用静态生产方法,子类不能继承构造方法;
  • 如果使用静态方法,需要使用者首先了解静态生产方法的存在,并在所有的静态方法中寻找需要的方法,所以建议生成JavaDoc文档,并方法名遵循特定的命名规则。例如添加方便识别的方法名前缀:from、of、new、get、create;

总结:使用静态方法替代构造方法的好处在于,解耦使用者和构造方法的强引用关系,静态方法作为中间层方便功能的扩展;

代码示例:

// java.math.BigInteger
// 通过不同方法名,进一步区分构造函数之间的区别
public static BigInteger probablePrime(int bitLength, @NonNull Random random) {
    return new BigInteger(bitLength, 100, random);
}
public BigInteger remainder(@NonNull BigInteger divisor) {
    BigInt remainder = new BigInt();
    BigInt.division(getBigInt(), divisor.getBigInt(), null, remainder);
    return new BigInteger(remainder);
}


// android.os.Message
// 使用静态生产方法替换了构造方法,obtain内部实现了Message对象缓存复用
public static Message obtain() {}
public static Message obtain(Message orig){}
public static Message obtain(Handler h) {}
public static Message obtain(Handler h, int what) {}

// 内部实现了单例
// java.lang.Boolean
public static Boolean valueOf(boolean b) {}
// java.lang.String
public static String valueOf(boolean b) {}

2、考虑使用Builder替代构造方法

当一个Class拥有非常多的属性,拥有多个构造方法,且大部分属性都是可选的,可以考虑使用Builder替代构造方法。此方案的优点:

  • 使用者只关注需要的属性即可,让构造方法的参数在控制范围内;
  • 相对于setter方法的使用,链式调用的结构可读性更好;
  • 便于添加和修改属性的默认值;

缺点:

  • Builder中的属性要和Class的属性个数可能相同,导致代码冗余,开发成本增加;
  • 容易漏掉必填参数,可以通过在Builder的构造方法中添加必填参数;

总结:Builder是在适当增加开发成本的基础上,让拥有过多参数的类的创建更加灵活可控,并且Builder解耦了使用者和构造方法之间的强引用关系,便于扩展。另外要注意Builder只是中间件,不适合添加和Class属性密切相关的逻辑,应该添加在Class的setter方法中,保持调用Builder中的setter和Class中的setter的一致性;

代码示例:

AlertDialog.Builder(this)
    .setIcon()
    .setTitle("")
    .setMessage("")
    .setView()
    .setCancelable()
    .... // more setter
    .create();

3、确保单例属性的构造方法是私有的或是枚举类型

如何防止单例模式被破坏:

  • 在构造方法中判断,如果已经instance已经创建,抛出异常;
  • 单例需要被序列化,可以在类中添加private Object readResolve()方法,返回instance;
  • 使用枚举类型实现单例;

枚举类型实现单例的好处:

  • 自动支持序列化;
  • 有效防止单例模式被破坏;

枚举实现单例的缺点:

  • 不能继承和被继承;
  • 一旦需求更改不再使用单例,修改成本较大;

4、确保不能被实例化的类构造方法是私有的

如果一个类只是作为工具来使用,他只拥有静态属性和静态方法,那么确保它的构造方法是私有的,防止使用者通过实例化错误的使用该类。

5、避免依赖注入硬编码

如果实现一个类,内部使用了某单例或某静态工具类,应该避免依赖硬编码,使用构造函数传参或工厂模式更为灵活。

代码案例:

// 代码1,SpellChecker内部直接创建Lexicon,导致两者强耦合
public class SpellChecker {
    // 直接创建Lexicon实例,
    private static final Lexicon dictionary = ...;
    // 私有构造方法
    private SpellChecker() {} // Noninstantiable
    public static boolean isValid(String word) { ... }
    public static List<String> suggestions(String typo) { ... }
}

// 代码2,Lexicon的赋值由构造参数决定,两者是间隔耦合的关系,外部可以调整Lexicon的实现(接口或继承)
public class SpellChecker {
    private final Lexicon dictionary;
    public SpellChecker(Lexicon dictionary) {
        this.dictionary = Objects.requireNonNull(dictionary);
    }
    public boolean isValid(String word) { ... }
    public List<String> suggestions(String typo) { ... }
}

6、避免创建不必要的对象

如果一个对象能够复用,那就尽可能复用,这样可以避免对象频繁的创建引起的内存抖动,提高程序运行的效率。例如以下场景:

  • 字符串尽量不要使用new String(),new表示强制创建一个对象,而不是复用常量池;
  • 固定不变的参数对象,应该保持单例,不要每次传参都new;
  • 避免装箱和拆箱;
  • 提供工厂方法,内部实现对象复用,防止使用者创建不必要的对象;

不要过度的缓存对象,这样会破坏JVM的内存回收机制,导致不能正常回收,所以应该复用重量级的对象(使用频繁,内存较大等),而不是考虑所有的对象。

推荐阅读更多精彩内容