Storm高级原语（五） — State in Trident

本文翻译自Storm wiki中State in Trident一文，同时参考derekjiang博客。

Trident在读写有状态的数据源方面是有着一流的抽象封装的。状态既可以保留在topology的内部，比如说内存和HDFS，也可以放到外部存储当中，比如说Memcached或者Cassandra。这些都是使用同一套Trident API。

Trident以一种容错的方式来管理状态以至于当你在更新状态的时候你不需要去考虑错误以及重试的情况。这种保证每个消息被处理有且只有一次的原理会让你更放心的使用Trident的topology。

在进行状态更新时，会有不同的容错级别。在讨论这点之前，让我们先通过一个例子来说明一下如何达到有且只有一次处理的必要的技巧。假定你在做一个关于某stream的计数聚合器，你想要把运行中的计数存放到一个数据库中。如果你在数据库中存了一个值表示这个计数，每次你处理一个tuple之后，就将数据库存储的计数加一。

当错误发生，truple会被重播。这就带来了一个问题：当状态更新的时候，你完全不知道你是不是在之前已经成功处理过这个tuple。也许你之前从来没处理过这个tuple，这样的话你就应该把count加一。另外一种可能就是你之前是成功处理过这个tuple的，但是这个在其他的步骤处理这个tuple的时候失败了（如ack丢失），在这种情况下，我们就不应该将count加一。再或者，你接受到过这个tuple，但是上次处理这个tuple的时候在更新数据库的时候失败了，这种情况你就应该去更新数据库。

如果只是简单的存计数到数据库的话，你是完全不知道这个tuple之前是否已经被处理过了的。所以你需要更多的信息来做正确的决定。Trident提供了下面的语义来实现有且只有一次被处理的目标 (这种处理在前面的transactional和trident一文中都有讲过)。

1、Tuples 是被分成小的集合（一组tuple被称为一个batch）被批量处理的。

2、每一批tuples被给定一个唯一ID作为事务ID (txid). 当这一批tuple被重播时, txid不变。

3、批与批之间的状态更新时严格顺序的。比如说第三批tuple的状态的更新必须要等到第二批tuple的状态更新成功之后才可以进行。

有了这些定义，你的状态实现可以检测到当前这批tuple是否以前处理过，并根据不同的情况进行不同的处理，这个处理取决于你的输入spout。有三种不同类型的可以容错的spout: “non-transactional”, “transactional” 和”opaque transactional”。对应的，也有3种容错的状态：”non-transactional”, “transactional” 和 “opaque transactional”。让我们一起来看看每一种spout类型能够支持什么样的容错类型。

Transactional spouts

Trident是以小批量（batch）的形式在处理tuple，并且每一批都会分配一个唯一的transaction id。不同spout的特性不同，一个transactional spout会有如下这些特性：

1、有着同样txid的batch一定是一样的。当重播一个txid对应的batch时，一定会重播和之前对应txid的batch中同样的tuples。

2、各个batch之间是没有交集的。每个tuple只能属于一个batch

3、每一个tuple都属于一个batch，无一例外

这是一类非常容易理解的spout， tuple 流被划分为固定的batch并且永不改变。（trident-kafka 有一个 transactional spout 的实现。）

你也许会问：为什么我们不总是使用transactional spout？这很容易理解。一个原因是并不是所有的地方都需要容错的。举例来说，TransactionalTridentKafkaSpout 工作的方式是一个batch包含的tuple来自某个kafka topic中的所有partition。一旦这个batch被发出，在任何时候如果这个batch被重新发出时，它必须包含原来所有的tuple以满足 transactional spout的语义。现在我们假定一个batch被TransactionalTridentKafkaSpout所发出，这个batch没有被成功处理，并且同时kafka的一个节点也down掉了。你就无法像之前一样重播一个完全一样的batch（因为kakfa的节点down掉，该topic的一部分partition可能会无法使用），整个处理会被中断。

这也就是”opaque transactional” spouts（不透明事务spout）存在的原因 – 他们对于丢失源节点这种情况是容错的，仍然能够帮你达到有且只有一次处理的语义。后面会对这种spout有所介绍。

在讨论”opaque transactional” spout之前，我们先来看看怎样为transactional spout设计一个具有exactly-once 语义的State实现。这个State的类型是”transactional state” 并且它利用了任何一个txid总是对应同样的tuple序列这个语义。

假如说你有一个用来计算单词出现次数的topology，你想要将单词的出现次数以key/value对的形式存储到数据库中。key就是单词，value就是这个这个单词出现的次数。你已经看到只是存储一个数量是不足以知道你是否已经处理过一个batch的。你可以通过将value和txid一起存储到数据库中。这样的话，当更新这个count之前，你可以先去比较数据库中存储的txid和现在要存储的txid。如果一样，就跳过什么都不做，因为这个value之前已经被处理过了。如果不一样，就执行存储。这个逻辑可以工作的前提就是txid永不改变，并且Trident保证状态的更新是在batch之间严格顺序进行的。

考虑下面这个例子的运行逻辑， 假定你在处理一个txid为3的包含下面tuple的batch：

["man"]

["man"]

["dog"]

假定数据库中当前保存了下面这样的key/value 对：

man => [count=3, txid=1]

dog => [count=4, txid=3]

apple => [count=10, txid=2]

单词“man”对应的txid是1. 因为当前的txid是3，你可以确定你还没有为这个batch中的tuple更新过这个单词的数量。所以你可以放心的给count加2并更新txid为3. 与此同时，单词“dog”的txid和当前的txid是相同的，因此你可以跳过这次更新。此时数据库中的数据如下：

man => [count=5, txid=3]

dog => [count=4, txid=3]

apple => [count=10, txid=2]

接下来我们一起再来看看 opaque transactional spout，以及怎样去为这种spout设计相应的state。

Opaque transactional spouts

正如之前说过的，opaque transactional spout并不能确保一个txid所对应的batch的一致性。一个opaque transactional spout有如下特性：

1、每个tuple只在一个batch中被成功处理。然而，一个tuple在一个batch中被处理失败后，有可能会在另外的一个batch中被成功处理。

OpaqueTridentKafkaSpout 是一个拥有这种特性的spout，并且它是容错的，即使Kafka的节点丢失。当OpaqueTridentKafkaSpout 发送一个batch的时候, 它会从上个batch成功结束发送的位置开始发送一个tuple序列。这就确保了永远没有任何一个tuple会被跳过或者被放在多个batch中被多次成功处理的情况.

使用opaque transactional spout，再使用和transactional spout相同的处理方式：判断数据库中存放的txid和当前txid去做对比已经不好用了。这是因为在state的更新过程之间，batch可能已经变了。

你只能在数据库中存储更多的信息。除了value和txid，你还需要存储之前的数值在数据库中。让我们还是用上面的例子来说明这个逻辑。假定你当前batch中的对应count是“2”， 并且我们需要进行一次状态更新。而当前数据库中存储的信息如下：

{ value = 4, prevValue = 1, txid = 2 }

如果你当前的txid是3， 和数据库中的txid不同。那么就将value中的值设置到prevValue中，根据你当前的count增加value的值并更新txid。更新后的数据库信息如下：

{ value = 6, prevValue = 4, txid = 3 }

现在再假定你的当前txid是2，和数据库中存放的txid相同。这就说明数据库里面value中的值包含了之前一个和当前txid相同的batch的更新。但是上一个batch和当前这个batch可能已经完全不同了，以至于我们需要无视它。在这种情况下，你需要在prevValue的基础上加上当前count的值并将结果存放到value中去。数据库中的信息如下所示:

{ value = 3, prevValue = 1, txid = 2 }

因为Trident保证了batch之间的强顺序性，因此这种方法是有效的。一旦Trident去处理一个新的batch，它就不会重新回到之前的任何一个batch。并且由于opaque transactional spout确保在各个batch之间是没有共同成员的，每个tuple只会在一个batch中被成功处理，你可以安全的在之前的值上进行更新。

Non-transactional spouts

Non-transactional spout(非事务spout)不确保每个batch中的tuple的规则（是否重叠）。所以如果tuple被处理失败不重发则该tuple最多被处理一次，如果tuple在不同的batch中被多次成功处理的时候他也可能会是至少处理一次的。无论怎样，这种spout是不可能实现有且只有一次被成功处理的语义的。

Summary of spout and state types

这个图展示了哪些spout和state的组合能够实现有且只有一次被成功处理的语义：

Opaque transactional state有着最为强大的容错性。但是这是以存储更多的信息作为代价的。Transactional states 需要存储较少的状态信息，但是仅能和 transactional spouts协同工作。non-transactional state所需要存储的信息最少，但是却不能实现有且只有一次被成功处理的语义。

State和Spout类型的选择其实是一种在容错性和存储消耗之间的权衡，你的应用的需要会决定那种组合更适合你。

State APIs

你已经看到实现有且只有一次被执行的语义时的复杂性。Trident这样做的好处把所有容错想过的逻辑都放在了State里面 — 作为一个用户，你并不需要自己去处理复杂的txid，存储多余的信息到数据库中，或者是任何其他类似的事情。你只需要写如下这样简单的code：

1 2 3 4 5 6 7

TridentTopology topology = new TridentTopology(); TridentState wordCounts =        topology.newStream( "spout1" , spout)          .each( new Fields( "sentence" ), new Split(), new Fields( "word" ))          .groupBy( new Fields( "word" ))          .persistentAggregate(MemcachedState.opaque(serverLocations), new Count(), new Fields( "count" ))          .parallelismHint( 6 );

所有管理opaque transactional state所需的逻辑都在MemcachedState.opaque方法的调用中被涵盖了，除此之外，数据库的更新会自动以batch的形式来进行以避免多次访问数据库。State的基本接口只包含下面两个方法：

1 2 3 4

public interface State {      void beginCommit(Long txid); // can be null for things like partitionPersist occurring off a DRPC stream      void commit(Long txid); }

当一个State更新开始时，以及当一个State更新结束时你都会被告知，并且会告诉你该次的txid。Trident并没有对你的state的工作方式有任何的假定。

假定你自己搭了一套数据库来存储用户位置信息，并且你想要在Trident中去访问它。则在State的实现中应该有用户信息的set、get方法：

01 02 03 04 05 06 07 08 09 10 11 12 13 14 15

public class LocationDB implements State {      public void beginCommit(Long txid) {      }        public void commit(Long txid) {      }        public void setLocation( long userId, String location) {        // code to access database and set location      }        public String getLocation( long userId) {        // code to get location from database      } }

然后你还需要提供给Trident一个StateFactory来在Trident的task中创建你的State对象。LocationDB 的 StateFactory可能会如下所示：

1 2 3 4 5

public class LocationDBFactory implements StateFactory {     public State makeState(Map conf, int partitionIndex, int numPartitions) {        return new LocationDB();     } }

Trident提供了一个QueryFunction接口用来实现Trident中在一个state source上查询的功能。同时还提供了一个StateUpdater来实现Trident中更新state source的功能。比如说，让我们写一个查询地址的操作，这个操作会查询LocationDB来找到用户的地址。下面以以怎样在topology中使用该功能开始，假定这个topology会接受一个用户id作为输入数据流：

1 2 3 4

TridentTopology topology = new TridentTopology(); TridentState locations = topology.newStaticState( new LocationDBFactory()); topology.newStream( "myspout" , spout)          .stateQuery(locations, new Fields( "userid" ), new QueryLocation(), new Fields( "location" ))

接下来让我们一起来看看QueryLocation 的实现应该是什么样的：

01 02 03 04 05 06 07 08 09 10 11 12 13

public class QueryLocation extends BaseQueryFunction<LocationDB, String> {      public List<String> batchRetrieve(LocationDB state, List<TridentTuple> inputs) {          List<String> ret = new ArrayList();          for (TridentTuple input: inputs) {              ret.add(state.getLocation(input.getLong( 0 )));          }          return ret;      }        public void execute(TridentTuple tuple, String location, TridentCollector collector) {          collector.emit( new Values(location));      } }

QueryFunction的执行分为两部分。首先Trident收集了一个batch的read操作并把他们统一交给batchRetrieve。在这个例子中，batchRetrieve会接受到多个用户id。batchRetrieve应该返还一个大小和输入tuple数量相同的result列表。result列表中的第一个元素对应着第一个输入tuple的结果，result列表中的第二个元素对应着第二个输入tuple的结果，以此类推。

你可以看到，这段代码并没有像Trident那样很好的利用batch的优势，而是为每个输入tuple去查询了一次LocationDB。所以一种更好的操作LocationDB方式应该是这样的：

01 02 03 04 05 06 07 08 09 10 11 12 13 14 15

public class LocationDB implements State {      public void beginCommit(Long txid) {      }        public void commit(Long txid) {      }        public void setLocationsBulk(List<Long> userIds, List<String> locations) {        // set locations in bulk      }        public List<String> bulkGetLocations(List<Long> userIds) {        // get locations in bulk      } }

接着，你可以这样改写上面的QueryLocation：

01 02 03 04 05 06 07 08 09 10 11 12 13

public class QueryLocation extends BaseQueryFunction<LocationDB, String> {      public List<String> batchRetrieve(LocationDB state, List<TridentTuple> inputs) {          List<Long> userIds = new ArrayList<Long>();          for (TridentTuple input: inputs) {              userIds.add(input.getLong( 0 ));          }          return state.bulkGetLocations(userIds);      }        public void execute(TridentTuple tuple, String location, TridentCollector collector) {          collector.emit( new Values(location));      } }

通过有效减少访问数据库的次数，这段代码比上一个实现会高效的多。

如果你要更新State，你需要使用StateUpdater接口，下面是一个StateUpdater的例子，用来将新的地址信息更新到LocationDB当中。

01 02 03 04 05 06 07 08 09 10 11

public class LocationUpdater extends BaseStateUpdater<LocationDB> {      public void updateState(LocationDB state, List<TridentTuple> tuples, TridentCollector collector) {          List<Long> ids = new ArrayList<Long>();          List<String> locations = new ArrayList<String>();          for (TridentTuple t: tuples) {              ids.add(t.getLong( 0 ));              locations.add(t.getString( 1 ));          }          state.setLocationsBulk(ids, locations);      } }

下面列出了你应该如何在Trident topology中使用上面声明的LocationUpdater：

1 2 3 4

TridentTopology topology = new TridentTopology(); TridentState locations =      topology.newStream( "locations" , locationsSpout)          .partitionPersist( new LocationDBFactory(), new Fields( "userid" , "location" ), new LocationUpdater())

partitionPersist 操作会更新一个State，其内部是将 State和一批更新的tuple交给StateUpdater，由StateUpdater完成相应的更新操作。

在这段代码中，只是简单的从输入的tuple中提取出userid和对应的location，并一起更新到State中。

partitionPersist 会返回一个TridentState对象来表示被这个Trident topoloy更新过的location db。 然后你就可以使用这个state在topology的任何地方进行查询操作了。

同时，你也可以看到我们传了一个TridentCollector给StateUpdaters，collector发送的tuple就会去往一个新的stream。在这个例子中，我们并没有去往一个新的stream的需要，但是如果你在做一些事情，比如说更新数据库中的某个count，你可以emit更新的count到这个新的stream。然后你可以通过调用TridentState#newValuesStream方法来访问这个新的stream来进行其他的处理。

persistentAggregate

Trident有另外一种更新State的方法叫做persistentAggregate。你在之前的word count例子中应该已经见过了，如下：

1 2 3 4 5 6

TridentTopology topology = new TridentTopology(); TridentState wordCounts =        topology.newStream( "spout1" , spout)          .each( new Fields( "sentence" ), new Split(), new Fields( "word" ))          .groupBy( new Fields( "word" ))          .persistentAggregate( new MemoryMapState.Factory(), new Count(), new Fields( "count" ))

persistentAggregate是在partitionPersist之上的另外一层抽象,它知道怎么去使用一个Trident 聚合器来更新State。在这个例子当中，因为这是一个groupedstream，Trident会期待你提供的state是实现了MapState接口的。用来进行group的字段会以key的形式存在于State当中，聚合后的结果会以value的形式存储在State当中。MapState接口看上去如下所示：

1 2 3 4 5

public interface MapState<T> extends State {      List<T> multiGet(List<List<Object>> keys);      List<T> multiUpdate(List<List<Object>> keys, List<ValueUpdater> updaters);      void multiPut(List<List<Object>> keys, List<T> vals); }

当你在一个非groupedstream上面进行聚合的话，Trident会期待你的state实现Snapshottable接口：

1 2 3 4 5

public interface Snapshottable<T> extends State {      T get();      T update(ValueUpdater updater);      void set(T o); }

MemoryMapState 和 MemcachedState 分别实现了上面的2个接口。

Implementing Map States

在Trident中实现MapState是非常简单的，它几乎帮你做了所有的事情。OpaqueMap, TransactionalMap, 和 NonTransactionalMap 类实现了所有相关的逻辑，包括容错的逻辑。你只需要将一个IBackingMap 的实现提供给这些类就可以了。IBackingMap接口看上去如下所示：

1 2 3 4

public interface IBackingMap<T> {      List<T> multiGet(List<List<Object>> keys);      void multiPut(List<List<Object>> keys, List<T> vals); }

OpaqueMap’s会用OpaqueValue的value来调用multiPut方法，TransactionalMap’s会提供TransactionalValue中的value，而NonTransactionalMaps只是简单的把从Topology获取的object传递给multiPut。

Trident还提供了一种CachedMap类来进行自动的LRU cache。

另外，Trident 提供了 SnapshottableMap 类将一个MapState 转换成一个 Snapshottable 对象.

大家可以看看 MemcachedState的实现，从而学习一下怎样将这些工具组合在一起形成一个高性能的MapState实现。MemcachedState是允许你选择使用opaque transactional, transactional, 还是 non-transactional 语义的。

• 本文固定链接: http://www.flyne.org/article/222
• 转载请注明: 东风化宇 2014年05月14日 于 Flyne 发表