抽象文档模式是一种面向对象结构设计模式。模式中采用key-value形式存储对象的属性,且确保类型不相关,暴露类型相关的属性数据。模式的意图是为强类型语言构建高灵活性的组件管理,保证新的属性可以自由的添加到对象中,且不丢失类型安全。模式使用trait,将不同的属性划分到不同的接口中。"docuemnt"一词来自于面向文档数据库中( document-oriented databases)。
目录
1. 定义
2. 结构
2.1 伪代码
3. 使用场景
4. 实例
5. 参考文献
定义
一个document是包含了若干属性的一个对象。举个例子,一个属性可以为字符串,或者多个其他document。每个属性都需要通过一个key来获取。当遍历构建document树时,使用者需要为下一级的实现类指定构造器。实现类通常是一些实现了document接口的实现类的集合,从而使这些对象能够自己处理属性的获取和设置。
结构
接口"Document"确保属性可以通过put方法设置,通过get方法获取,并且子document可以通过children方法访问。children方法可以提供一个类型相关的child,且此child能够提供自身数据的map。map需要指向源数据,这样所有的修改都能够体现到源对象上。 实现类可以继承自多个描述不同属性的trait接口。甚至多个document可以共享一个map。实现类唯一的限制是,除了从基础组件继承的属性,其他属性必须是无状态了。
伪代码
interface Document put(key : String, value : Object) : Object get(key : String) : Object children(key : String, constructor : Map<String, Object> -> T) : T[]
abstract class BaseDocument : Document properties : Map<String, Object>
constructor(properties : Map<String, Object>) this->properties := properties
implement put(key : String, value : Object) : Object return this->properties->put(key, value)
implement get(key : String) : Object return this->properties->get(key)
implement children(key : String, constructor : Map<String, Object> -> T) : T[] var result := new T[]
var children := this->properties->get(key) castTo Map<String, Object>[]
foreach ( child in children )
result[] := constructor->apply(child)
return result
使用场景
抽象文档模式允许开发者将属性存储到无类型的属性树种,且对document使用类型相关的操作。新的视图,或者供替代的视图实现可以在不影响结构的情况下随意创建。 模式的优势在于提供了一个松耦合的对象,但这也增加了类型转换的风险--继承的属性类型并不是必然的
实例
Document.java
public interface Document { Object put(String key, Object value); Object get(String key); <T> Stream<T> children( String key, Function<Map<String, Object>, T> constructor ); }
BaseDocument.java
public abstract class BaseDocument implements Document { private final Map<String, Object> entries; protected BaseDocument(Map<String, Object> entries) { this.entries = requireNonNull(entries); } @Override public final Object put(String key, Object value) { return entries.put(key, value); } @Override public final Object get(String key) { return entries.get(key); } @Override public final <T> Stream<T> children( String key, Function<Map<String, Object>, T> constructor) { final List<Map<String, Object>> children = (List<Map<String, Object>>) get(key); return children == null ? Stream.empty() : children.stream().map(constructor); } }
Usage.java
Map<String, Object> source = ...; Car car = new Car(source); String model = car.getModel(); int price = car.getPrice(); List<Wheel> wheels = car.children("wheel", Wheel::new) .collect(Collections.toList());
参考文献
Forslund, Emil (2016-01-15). "Age of Java: The Best of Both Worlds". Ageofjava.blogspot.com. Retrieved 2016-01-23. Jump up ^ Fowler, Martin. "Dealing with Properties" (PDF). Retrieved 2016-01-29.
模式理解
1. 所有的属性都通过Map<String,Object>存储。所以存储的时候不需要关心具体的类型是什么。
2. 对象可以有子对象。比如,Car有Wheel,door。wheel和door都是子对象。通过car可以获得whell和door子对象,通过子对象设置和获取子对象的属性。
3. 通过继承接口,实现获取类型相关的属性。Car继承并实现接口HasModel。如果想获得Car的model属性,需要调用HasModel.getModel。从而实现取出的属性类型相关。
4. 通过基类封装基本操作。这样不同Car或者Car和Plane之间可以共享实现。