原文链接：[A generic input/output API in Java](https://web.archive.org/web/20130216100207/http://www.jroller.com/rickard/entry/a_generic_input_output_api) - _Rickard Öberg_ （PS：[文章原链接](http://www.jroller.com/rickard/entry/a_generic_input_output_api)已失效）  
译文发在：[【译】Java的通用I/O API](http://oldratlee.com/474/tech/java/generic-io-api-in-java-and-api-design.html)，2012-05-11

## 🍎 译序

本文给出了一个通用`Java` `IO` `API`设计，并且有`API`的`Demo`代码。

更重要的是给出了这个`API`设计本身的步骤和过程，这让`API`设计有些条理。
文中示范了从 普通简单实现 整理成 正交分解、可复用、可扩展、高性能和错误保真的`API`设计 的过程，这个过程是很值得理解和学习！

设计偏向是艺术，一个赏心悦目的设计，尤其是`API`设计，旁人看来多是妙手偶得的感觉，如果能有些章可循真是一件美事。

在艺术工作中，真的艺术性工作量也只是一部分，而给出 _**方法**_ 以 _**减少艺术工作之中艺术性工作量**_ 的人是 **大师**。 ❤️

# `Java`的通用`I/O` `API`设计

-------------------------------------------------------------------------------

<img src="input-output.jpg" align="right" />

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->


- [API](#api)
- [标准化`I/O`](#%E6%A0%87%E5%87%86%E5%8C%96io)
- [拦截传输过程](#%E6%8B%A6%E6%88%AA%E4%BC%A0%E8%BE%93%E8%BF%87%E7%A8%8B)
- [Usage in the `Qi4j` `SPI`](#usage-in-the-qi4j-spi)
- [结论](#%E7%BB%93%E8%AE%BA)
- [译跋](#%E8%AF%91%E8%B7%8B)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

-------------------------------------------------------------------------------

上周处理了很多数据搬移，有原始`byte`形式的，也有`String`形式的，还有`SPI`和领域级对象形式。这些活让我觉得，以可伸缩、高性能、正确处理错误的方式把数据从一处搬到另一处，是非常有难度。我要一遍又一遍做一些事，比如从文件中读出`String`。

这让我有了个想法：一定有个通用模式来处理这些事，可以抽取出来放到库中。“从文本文件中读出文本行”这样的事应该只做一遍，然后用在各个需要的场景中。让我们看一个读文件然后写入另一个文件的典型场景，看看能不能从中发现包含了哪几个部分。

```java
1: File source = new File( getClass().getResource( "/iotest.txt" ).getFile() );
1: File destination = File.createTempFile( "test", ".txt" );
1: destination.deleteOnExit();
2: BufferedReader reader = new BufferedReader(new FileReader(source));
3: long count = 0;
2: try
2: {
4:    BufferedWriter writer = new BufferedWriter(new FileWriter(destination));
4:    try
4:    {
2:        String line = null;
2:        while ((line = reader.readLine()) != null)
2:        {
3:            count++;
4:            writer.append( line ).append( '\n' );
2:        }
4:        writer.close();
4:    } catch (IOException e)
4:    {
4:        writer.close();
4:        destination.delete();
4:    }
2: } finally
2: {
2:     reader.close();
2: }
1: System.out.println(count)
```

行左边的数字是我标识的4个部分。

1. 客户代码，初始化了传输，要知道输入和输出的源。
1. 从输入中读的代码。
1. 辅助代码，用于跟踪整个过程。这些代码我希望能够重用，而不管是何种传输的类型。
1. 最后这个部分是接收数据，写数据。这个代码，我要批量读写，可以在第2第4部分修改，改成一次处理多行。

## API

一旦明确上面划分的内容，剩下就只是为每个部分整理成一个接口，并保证在各种场景能方便使用。结果如下。 首先要有输入，即`Input`接口：

```java
public interface Input<T, SenderThrowableType extends Throwable>
{
    <ReceiverThrowableType extends Throwable> void transferTo( Output<T,ReceiverThrowableType> output )
        throws SenderThrowableType, ReceiverThrowableType;
}
```

`Input`，如`Iterables`，可以被多次使用，用于初始化一处到另一处的传输。因为我泛化传输的数据类型为`T`，所以可以是任何类型（`byte[]`、`String`、`EntityState`、`MyDomainObject`）。为了让发送者和接收者可以抛出各自的异常，接口上把各自己的异常声明成了类型参数。比如：在出错的时，`Input`抛的可以是`SQLException`，`Output`抛的是`IOException`。异常是强类型的，并且在出错时发送和接收双方都必须知道的，这使的双方做合适的恢复操作，关闭他们打开了的资源。

在接收端的是`Output`接口：

```java
public interface Output<T, ReceiverThrowableType extends Throwable>
{
    <SenderThrowableType extends Throwable> void receiveFrom(Sender<T, SenderThrowableType> sender)
            throws ReceiverThrowableType, SenderThrowableType;
}
```

当`receiveFrom`方法被`Input`调用时（通过调用`Input`的`transferTo`方法触发），`Output`应该打开好了它所需要的资源，然后期望数据从`Sender`发送过来。`Input`和`Output`必须要有类型`T`，两者对要发送的内容达到一致。后面我们可以看到如何处理不一致的情况。

接下来是`Sender`接口：

```java
public interface Sender<T, SenderThrowableType extends Throwable>
{
    <ReceiverThrowableType extends Throwable> void sendTo(Receiver<T, ReceiverThrowableType> receiver)
        throws ReceiverThrowableType, SenderThrowableType;
}
```

`Output`调用`sendTo`方法，传入一个`Receiver`，`Sender`使用这个`Receiver`来发送一个一个的数据。`Sender`在这个时候发起传输，把类型数据`T`传输到`Receiver`，一次一个。`Receiver`接口如下：

```java
public interface Receiver<T, ReceiverThrowableType extends Throwable>
{
    void receive(T item)
        throws ReceiverThrowableType;
}
```

当`Receiver`从`Sender`收到数据时，即可以马上写到底层资源中，也可以分批写入。`Receiver`知道传输什么时候结束（`sendTo`方法返回了），所以正确写入剩下的分批数据、关闭持有的资源。

这个简单的模式在发送方和接收方各有2个接口，并保持了以可伸缩、高性能和容错的方式传输数据的潜能。

## 标准化`I/O`

上文的`API`定义了数据发送和接收的契约，然后可以制定几个输入输出的标准。比如：从文本文件中读取文本行后再写成文本文件。这个操作可以静态方法中，方便的重用。最后，拷贝文本文件可以写成：

```java
File source = ...
File destination = ...
Inputs.text( source ).transferTo( Outputs.text(destination) );
```

一行代码处理了读文件、写文件、资源清理和其它零零碎碎的操作。真心的赞！`transferTo`方法会抛出`IOException`，要向用户显示`Error`可以`catch`这个异常。但实际处理这些`Error`往往是，关闭文件，把没有写成功的文件删除，而这些`Input`、`Output`已经处理好了。我们再也不需要关心文件读写的细节！

## 拦截传输过程

上面处理了基本的`I/O`传输，我们常常还要做些其它的事。可能要计数一下传输了多少个数据，过滤一下数据，或者是每1000条数据做一下日志，又或者要看一下正在进行什么操作。既然输入输出已经分离，这些事变成在输入输出的协调代码中简单地插入一些逻辑。大部分协调代码有类似的功能，可以放到标准的工具方法中，更方便使用。

第一个标准修饰器是一个过滤器。实现时我用到了`Specification`。

```java
public static <T,ReceiverThrowableType extends Throwable>
Output<T, ReceiverThrowableType> filter( final Specification<T> specification, final Output<T, ReceiverThrowableType> output)
{
   ... create an Output that filters items based on the Specification<T> ...
}
```

`Specification`如下：

```java
interface Specification<T>
{
     boolean test(T item);
}
```

有了这个简单部件，我可以在传输时轻松地过滤掉那些不要出现在接收者端的数据。下面的例子删除文件中的空行：

```java
File source = ...
File destination = ...
Inputs.text( source ).transferTo( Transforms.filter(new Specification<String>()
{
   public boolean test(String string)
   {
      return string.length() != 0;
   }
}, Outputs.text(destination) );
```

第二个常见的操作是把数据从一个类型映射到另一个类型。就是处理要`Input`和`Output`的数据类型不同，要有方法把输入数据类型映射成输出的数据类型。下面例子的把`String`映射成`JSONObject`，操作方法会是这个样子：

```java
public static <From,To,ReceiverThrowableType extends Throwable>
Output<From, ReceiverThrowableType> map(final Function<From,To> function, final Output<To, ReceiverThrowableType> output)
```

`Function`定义是：

```java
interface Function<From, To>
{
    To map(From from);
}
```

通过这些，可以把`String`的`Input`连接到`JSONObject`的`Output`：  

```java
Input<String,IOException> input = ...;
Output<JSONObject,RuntimeException> output = ...;
input.transferTo(Transforms.map(new String2JSON(), output);
```

`String2JSON`类实现了`Function`接口，它的`map`方法把`String`转换成`JSONObject`。

到了现在，我们可以实现前面提到数据计数的例子，可以把计数实现成一个通用的映射，转换前后的类型不变，只是维护了一个计数，在每次调用`map`方法时更新计数。例子代码如下：

```java
File source = ...
File destination = ...
Counter<String> counter = new Counter<String>();
Inputs.text( source ).transferTo( Transforms.map(counter, Outputs.text(destination) ));
System.out.println("Nr of lines:"+counter.getCount())
```

## Usage in the `Qi4j` `SPI`

【译者注，这一节说具体库`Qi4j`，略过】

## 结论

软件开发时，从一个输入到另一个输出的数据和对象的搬移很常见，可能在中间还要做些转换。通常都是用一些零散代码（`scratch`）来完成这些事，结果是代码错误和使用不当的模式。通过引入通用`I/O` `API`，恰当封闭和隔离，这个任务可以可以更轻松地以伸缩、高性能、无错误的方式完成，并且还可以在在需要额外功能时修饰实现。

这遍文章仅仅勾勒了这种使用方式，`API`和辅助类可以在`Qi4j Core 1.3-SNAPSHOT`中有（详见`Qi4j`的[主页](http://www.qi4j.org/)）。理想状态是，在整个`Qi4j`使用中任何使用`I/O`的地方一开始按这种方式来。

> 【译注】`Qi4j`已经更名为`polygene`，在`Apache`上
> - 官网 <https://polygene.apache.org/>
> - GitHub仓库： <https://github.com/apache/polygene-java>

多谢你的阅读，希望你能有所收获 :-)

**_`-EOF-`_**

## 译跋

原文中只给出设计的

- 发展思路
- 关键接口
- 典型的使用方式。

没有给出实现细节，看起来可能比较费力。（细致的分解后的设计往往比较抽象，不容易快速理解），
我实现了[完整工程的Demo代码](https://github.com/oldratlee/io-api)，并写了一篇[简单分析](https://github.com/oldratlee/io-api/blob/master/docs/java-api-design-exercise.md)。