使用静态工厂方法替代构造方法

This commit is contained in:
尉勇强2 2019-09-11 18:56:22 +08:00
parent e0558ec5d9
commit b50e2ad14e
8 changed files with 412 additions and 0 deletions

View File

@ -0,0 +1,74 @@
## 考虑使用静态工厂方法替代构造方法
### 示例
- [Item01Example01.java](CreatingAndDestroyingObjects/src/main/java/com/jueee/item01/Item01Example01.java):公共构造方法和公共静态工厂方法 对比
- [Item01Example02.java](CreatingAndDestroyingObjects/src/main/java/com/jueee/item01/Item01Example02.java):静态工厂方法不会每次调用时都创建对象(单例模式)
- [Item01Example03.java](CreatingAndDestroyingObjects/src/main/java/com/jueee/item01/Item01Example03.java):静态工厂方法可以返回原返回类型的任何子类型对象
- [Item01Example04.java](CreatingAndDestroyingObjects/src/main/java/com/jueee/item01/Item01Example04.java):静态工厂方法使代码更为简洁
- [Item01Example05.java](CreatingAndDestroyingObjects/src/main/java/com/jueee/item01/Item01Example05.java):静态工厂方法是有名字的,可读性更强。
### 说明
一个类允许客户端获取其实例的传统方式是提供一个公共构造方法。 其实还有另一种技术应该成为每个程序员工具箱的一部分。 一个类可以提供一个公共静态工厂方法,它只是一个返回类实例的静态方法。
下面是一个`Boolean`简单的例子(`boolean`基本类型的包装类)。 此方法将`boolean`基本类型转换为`Boolean`对象引用:
```java
public static Boolean valueOf(boolean b) {
return b ? Boolean.TRUE : Boolean.FALSE;
}
```
注意,静态工厂方法与设计模式中的工厂方法模式不同。本条目中描述的静态工厂方法在设计模式中没有直接的等价。
类可以为其客户端提供静态工厂方法,而不是公共构造方法。提供静态工厂方法而不是公共构造方法有优点也有缺点。
**静态工厂方法的一个优点是,不像构造方法,它们是有名字的,可读性更强。** 如果构造方法的参数本身并不描述被返回的对象,则具有精心选择名称的静态工厂更易于使用,并且生成的客户端代码更易于阅读。 例如,返回一个可能为素数的`BigInteger`的构造方法`BigInteger(intintRandom)`可以更好地表示为名为`BigInteger.probablePrime`的静态工厂方法。 这个方法是在Java 1.4中添加的。)
一个类只能有一个给定签名的构造方法。 程序员知道通过提供两个构造方法来解决这个限制,这两个构造方法的参数列表只有它们的参数类型的顺序不同。 这是一个非常糟糕的主意。 这样的API用户将永远不会记得哪个构造方法是哪个最终会错误地调用。 阅读使用这些构造方法的代码的人只有在参考类文档的情况下才知道代码的作用。
因为他们有名字,所以静态工厂方法不会受到上面讨论中的限制。在类中似乎需要具有相同签名的多个构造方法的情况下,用静态工厂方法替换构造方法,并仔细选择名称来突出它们的差异。
**静态工厂方法的第二个优点是,与构造方法不同,它们不需要每次调用时都创建一个新对象。**这允许不可变的类(条目17)使用预先构建的实例,或者在构造时缓存实例,并反复分配它们以避免创建不必要的重复对象。`boolean.valueof(boolean)`方法说明了这种方法它从不创建对象。这种技术类似于享元模式Flyweight。如果经常请求等价对象那么它可以极大地提高性能特别是如果在创建它们非常昂贵的情况下。
静态工厂方法从重复调用返回相同对象的能力允许类保持在任何时候存在的实例的严格控制。这样做的类被称为实例控制( instance-controlled。编写实例控制类的原因有很多。实例控制允许一个类来保证它是一个单例(3)项或不可实例化的(条目4)。同时,它允许一个不可变的值类(条目17)保证不存在两个相同的实例:当且仅当`a== b`时`a.equals(b)`。这是享元模式的基础。`Enum`类型(条目34)提供了这个保证。
**静态工厂方法的第三个优点是,与构造方法不同,它们可以返回其返回类型的任何子类型的对象。** 这为你在选择返回对象的类时提供了很大的灵活性。
这种灵活性的一个应用是API可以返回对象而不需要公开它的类。 以这种方式隐藏实现类会使 API非常紧凑。 这种技术适用于基于接口的框架条目20其中接口为静态工厂方法提供自然返回类型。
在Java 8之前接口不能有静态方法。根据约定一个名为`Type`的接口的静态工厂方法被放入一个非实例化的伙伴类(companion class)(条目4)`Types`类中。例如Java集合框架有45个接口的实用工具实现提供不可修改的集合、同步集合等等。几乎所有这些实现都是通过静态工厂方法在一个非实例类(`java .util. collections`)中导出的。返回对象的类都是非公开的。
`Collections`框架API的规模要比它之前输出的45个单独的公共类要小得多每个类有个便利类的实现。不仅是API的大部分减少了还包括概念上的权重程序员必须掌握的概念的数量和难度才能使用API。程序员知道返回的对象恰好有其接口指定的API因此不需要为实现类读阅读额外的类文档。此外使用这种静态工厂方法需要客户端通过接口而不是实现类来引用返回的对象这通常是良好的实践(条目64)。
从Java 8开始接口不能包含静态方法的限制被取消了所以通常没有理由为接口提供一个不可实例化的伴随类。 很多公开的静态成员应该放在这个接口本身。 但是,请注意,将这些静态方法的大部分实现代码放在单独的包私有类中仍然是必要的。 这是因为Java 8要求所有接口的静态成员都是公共的。 Java 9允许私有静态方法但静态属性和静态成员类仍然需要公开。
**静态工厂的第四个优点是返回对象的类可以根据输入参数的不同而不同。** 声明的返回类型的任何子类都是允许的。 返回对象的类也可以随每次发布而不同。
`EnumSet`类(条目 36没有公共构造方法只有静态工厂。 在OpenJDK实现中它们根据底层枚举类型的大小返回两个子类中的一个的实例如果大多数枚举类型具有64个或更少的元素静态工厂将返回一个`RegularEnumSet`实例, 返回一个`long`类型;如果枚举类型具有六十五个或更多元素,则工厂将返回一个`JumboEnumSet`实例,返回一个`long`类型的数组。
这两个实现类的存在对于客户端是不可见的。 如果`RegularEnumSet`不再为小枚举类型提供性能优势,则可以在未来版本中将其淘汰,而不会产生任何不良影响。 同样,未来的版本可能会添加`EnumSet`的第三个或第四个实现,如果它证明有利于性能。 客户端既不知道也不关心他们从工厂返回的对象的类别; 他们只关心它是`EnumSet`的一些子类。
**静态工厂的第5个优点是在编写包含该方法的类时返回的对象的类不需要存在。**这种灵活的静态工厂方法构成了服务提供者框架的基础比如Java数据库连接API(JDBC)。服务提供者框架是提供者实现服务的系统,并且系统使得实现对客户端可用,从而将客户端从实现中分离出来。
服务提供者框架中有三个基本组服务接口它表示实现提供者注册API提供者用来注册实现以及服务访问API客户端使用该API获取服务的实例。服务访问API允许客户端指定选择实现的标准。在缺少这样的标准的情况下API返回一个默认实现的实例或者允许客户端通过所有可用的实现进行遍历。服务访问API是灵活的静态工厂它构成了服务提供者框架的基础。
服务提供者框架的一个可选的第四个组件是一个服务提供者接口,它描述了一个生成服务接口实例的工厂对象。在没有服务提供者接口的情况下,必须对实现进行反射实例化(条目65)。在JDBC的情况下`Connection`扮演服务接口的一部分,`DriverManager.registerDriver`提供程序注册API、`DriverManager.getConnection`是服务访问API`Driver`是服务提供者接口。
服务提供者框架模式有许多变种。 例如服务访问API可以向客户端返回比提供者提供的更丰富的服务接口。 这是桥接模式。 依赖注入框架条目5可以被看作是强大的服务提供者。 从Java 6开始平台包含一个通用的服务提供者框架`java.util.ServiceLoader`所以你不需要一般也不应该自己编写条目59。 JDBC不使用`ServiceLoader`,因为前者早于后者。
**只提供静态工厂方法的主要限制是,没有公共或受保护构造方法的类不能被子类化。**例如,在`Collections`框架中不可能将任何方便实现类子类化。可以说,这可能是因祸得福,因为它鼓励程序员使用组合而不是继承(条目18),并且是不可变类型(条目17)。
**静态工厂方法的第二个缺点是,程序员很难找到它们。**它们不像构造方法那样在API文档中突出因此很难找出如何实例化一个提供静态工厂方法而不是构造方法的类。Javadoc工具可能有一天会引起对静态工厂方法的注意。与此同时可以通过将注意力吸引到类或接口文档中的静态工厂以及遵守通用的命名约定来减少这个问题。下面是一些静态工厂方法的常用名称。以下清单并非完整
- **from**——A类型转换方法它接受单个参数并返回此类型的相应实例例如`Date d = Date.from(instant)`;
- **of**——一个聚合方法,接受多个参数并返回该类型的实例,并把他们合并在一起,例如:`Set<Rank> faceCards = EnumSet.of(JACK, QUEEN, KING)`;
- **valueOf**——from和to更为详细的替代方式例如`BigInteger prime = BigInteger.valueOf(Integer.MAX_VALUE)`;
- **instance**或**getInstance**——返回一个由其参数(如果有的话)描述的实例,但不能说它具有和参数相同的值,例如:`StackWalker luke = StackWalker.getInstance(options)`;
- **create****newInstance**——与instance 或 getInstance类似除了该方法保证每个调用返回一个新的实例例如`Object newArray = Array.newInstance(classObject, arrayLen)`;
- **getType**——与getInstance类似但是如果在工厂方法中不同的类中使用。Type是工厂方法返回的对象类型例如`FileStore fs = Files.getFileStore(path)`;
- **newType**——与newInstance类似但是如果在工厂方法中不同的类中使用。Type是工厂方法返回的对象类型例如`BufferedReader br = Files.newBufferedReader(path)`;
- **type**—— getType 和 newType简洁的替代方式例如`List<Complaint> litany = Collections.list(legacyLitany)`;
总之,静态工厂方法和公共构造方法都有它们的用途,并且了解它们的相对优点是值得的。通常,静态工厂更可取,因此避免在没有考虑静态工厂的情况下提供公共构造方法。

View File

@ -0,0 +1,32 @@
HELP.md
target/
!.mvn/wrapper/maven-wrapper.jar
!**/src/main/**
!**/src/test/**
### STS ###
.apt_generated
.classpath
.factorypath
.project
.settings
.springBeans
.sts4-cache
### IntelliJ IDEA ###
.idea
*.iws
*.iml
*.ipr
### NetBeans ###
/nbproject/private/
/nbbuild/
/dist/
/nbdist/
/.nb-gradle/
build/
### VS Code ###
.vscode/
/chromedriver.exe

View File

@ -0,0 +1,25 @@
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.github.jueee</groupId>
<artifactId>CreatingAndDestroyingObjects</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>jar</packaging>
<name>CreatingAndDestroyingObjects</name>
<url>http://maven.apache.org</url>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
<dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>3.8.1</version>
<scope>test</scope>
</dependency>
</dependencies>
</project>

View File

@ -0,0 +1,44 @@
package com.jueee.item01;
// 考虑使用静态工厂方法替代构造方法
public class Item01Example01 {
public static void main(String[] args) {
// 传统构造器
Item01Test1 test1 = new Item01Test1("true");
System.out.println(test1.getParam());
// 使用静态工厂方法替代构造方法
Item01Test2 test2 = Item01Test2.valueOf("false");
System.out.println(test2.getParam());
}
}
class Item01Test1 {
private String param;
public Item01Test1(String param) {
this.param = param;
}
public String getParam() {
return param;
}
}
class Item01Test2 {
private static String param;
private Item01Test2() {}
public static Item01Test2 valueOf(String paramData) {
param = paramData;
return new Item01Test2();
}
public String getParam() {
return param;
}
}

View File

@ -0,0 +1,30 @@
package com.jueee.item01;
// 静态工厂方法不会每次调用时都创建对象单例模式
public class Item01Example02 {
public static void main(String[] args) {
Item01Singleton singleton = Item01Singleton.getInstance();
System.out.println(singleton.getClass().getName());
}
}
class Item01Singleton {
/*
* 利用一个静态变量来记录Item01Singleton类的唯一实例
*/
private static Item01Singleton uniqueInstance;
/*
* 声明为private使得只有Item01Singleton类内才可以调用构造器
*/
private Item01Singleton(){}
/*
* 通过该方法实例化对象并返回这个实例
*/
public static Item01Singleton getInstance(){
if (uniqueInstance == null){
uniqueInstance = new Item01Singleton();
}
return uniqueInstance;
}
}

View File

@ -0,0 +1,46 @@
package com.jueee.item01;
// 静态工厂方法可以返回原返回类型的任何子类型对象
public class Item01Example03 {
public static void main(String[] args) {
Item01Shape shape = Item01Shape.newInstance("");
Item01Shape triangle = Item01Shape.newInstance("triangle");
Item01Shape circle = Item01Shape.newInstance("circle");
shape.getName();
triangle.getName();
circle.getName();
}
}
class Item01Shape {
private Item01Shape(){
}
//根据类型决定返回的对象
public static Item01Shape newInstance(String type){
if (type.equalsIgnoreCase("triangle")){
return new Triangle();
} else if (type.equalsIgnoreCase("circle")){
return new Circle();
}
return new Item01Shape();
}
public void getName(){
System.out.println("My name is shape");
}
private static class Triangle extends Item01Shape{
public void getName(){
System.out.println("My name is triangle");
}
}
private static class Circle extends Item01Shape{
public void getName(){
System.out.println("My name is circle");
}
}
}

View File

@ -0,0 +1,28 @@
package com.jueee.item01;
public class Item01Example04 {
public static void main(String[] args) {
Item01MyMap1<String,String> map1 = new Item01MyMap1<String,String>();
System.out.println(map1.getClass().getName());
Item01MyMap2<String,String> map2 = Item01MyMap2.newInstance();
System.out.println(map2.getClass().getName());
}
}
class Item01MyMap1<K,V>{
public Item01MyMap1(){}
}
class Item01MyMap2<K,V>{
private Item01MyMap2(){}
public static <K, V> Item01MyMap2<K,V> newInstance(){
return new Item01MyMap2<K,V>();
}
}

View File

@ -0,0 +1,133 @@
package com.jueee.item01;
import java.util.Random;
/**
* 假设我们需要写一个产生随即数的类RandomIntGenerator该类有两个成员属性最小值min和最大值max
*
* 假设我们的需求是需要创建三种类型的RandomIntGenerator对象
* 1大于min小于max
* 2大于min 小于Integer.MAX_VALUE
* 3大于Integer.MIN_VALUE 小于max
*
* @author hzweiyongqiang
*/
public class Item01Example05 {
public static void main(String[] args) {
RandomIntGenerator1 generator11 = new RandomIntGenerator1(3);
System.out.println(generator11.getRandom());
RandomIntGenerator1 generator12 = new RandomIntGenerator1(3,10);
System.out.println(generator12.getRandom());
System.out.println();
RandomIntGenerator2 generator21 = RandomIntGenerator2.between(3, 6);
System.out.println(generator21.getRandom());
RandomIntGenerator2 generator22 = RandomIntGenerator2.biggerThan(3);
System.out.println(generator22.getRandom());
RandomIntGenerator2 generator23 = RandomIntGenerator2.smallerThan(6);
System.out.println(generator23.getRandom());
}
}
class RandomIntGenerator1 {
/**
* 最小值
*/
private int min = 0;
/**
* 最大值
*/
private int max = Integer.MAX_VALUE;
/**
* 大于min 小于max
* @param min
* @param max
*/
public RandomIntGenerator1(int min, int max) {
this.min = min;
this.max = max;
if (this.min < 0) {
this.min = 0;
}
}
/**
* 大于min 小于Integer.MAX_VALUE
*/
public RandomIntGenerator1(int min) {
this.min = min;
}
// 报错Duplicate method RandomIntGenerator1(int) in type RandomIntGenerator1
// /**
// * 大于Integer.MIN_VALUE 小于max
// */
// public RandomIntGenerator1(int max)
// {
// this.max = max;
// }
public int getRandom() {
Random r = new Random();
int Result = r.nextInt(max-min) + min;
return Result;
}
}
class RandomIntGenerator2 {
/**
* 最小值
*/
private int min = Integer.MIN_VALUE;
/**
* 最大值
*/
private int max = Integer.MAX_VALUE;
/**
* 大于min 小于max
*
* @param min
* @param max
*/
public RandomIntGenerator2(int min, int max) {
this.min = min;
this.max = max;
if (this.min < 0) {
this.min = 0;
}
}
/**
* 大于min 小于max
*
* @param min
* @param max
*/
public static RandomIntGenerator2 between(int min, int max) {
return new RandomIntGenerator2(min, max);
}
/**
* 大于min 小于Integer.MAX_VALUE
*/
public static RandomIntGenerator2 biggerThan(int min) {
return new RandomIntGenerator2(min, Integer.MAX_VALUE);
}
/**
* 大于Integer.MIN_VALUE 小于max
*/
public static RandomIntGenerator2 smallerThan(int max) {
return new RandomIntGenerator2(Integer.MIN_VALUE, max);
}
public int getRandom() {
Random r = new Random();
int Result = r.nextInt(max-min) + min;
return Result;
}
}