本文首发于泊浮目的专栏：https://segmentfault.com/blog/camile

在Go语言中，有一个关键字叫做defer——其作用是在函数return前执行。在ZStack中也有类似的工具类，让我们来看看吧。

演示代码

  1.     private void handle(APICreateInstanceOfferingMsg msg) {
  2.         APICreateInstanceOfferingEvent evt = new APICreateInstanceOfferingEvent(msg.getId());
  4.         String type = msg.getType() == null ? UserVmInstanceOfferingFactory.type.toString() : msg.getType();
  5.         InstanceOfferingFactory f = getInstanceOfferingFactory(type);
  7.         InstanceOfferingVO vo = new InstanceOfferingVO();
  8.         if (msg.getResourceUuid() != null) {
  9.             vo.setUuid(msg.getResourceUuid());
  10.         } else {
  11.             vo.setUuid(Platform.getUuid());
  12.         }
  13.         HostAllocatorStrategyType allocType = msg.getAllocatorStrategy() == null ? HostAllocatorStrategyType
  14.                 .valueOf(HostAllocatorConstant.LEAST_VM_PREFERRED_HOST_ALLOCATOR_STRATEGY_TYPE) : HostAllocatorStrategyType.valueOf(msg.getAllocatorStrategy());
  15.         vo.setAllocatorStrategy(allocType.toString());
  16.         vo.setName(msg.getName());
  17.         vo.setCpuNum(msg.getCpuNum());
  18.         vo.setCpuSpeed(msg.getCpuSpeed());
  19.         vo.setDescription(msg.getDescription());
  20.         vo.setState(InstanceOfferingState.Enabled);
  21.         vo.setMemorySize(msg.getMemorySize());
  22.         vo.setDuration(InstanceOfferingDuration.Permanent);
  23.         vo.setType(type);
  25.         InstanceOfferingInventory inv = new SQLBatchWithReturn<InstanceOfferingInventory>() {
  26.             @Override
  27.             @Deferred
  28.             protected InstanceOfferingInventory scripts() {
  29.                 Defer.guard(() -> dbf.remove(vo));
  30.                 InstanceOfferingInventory inv = f.createInstanceOffering(vo, msg);
  31.                 acntMgr.createAccountResourceRef(msg.getSession().getAccountUuid(), vo.getUuid(), InstanceOfferingVO.class);
  32.                 tagMgr.createTagsFromAPICreateMessage(msg, vo.getUuid(), InstanceOfferingVO.class.getSimpleName());
  33.                 return inv;
  34.             }
  35.         }.execute();
  37.         evt.setInventory(inv);
  38.         bus.publish(evt);
  39.         logger.debug("Successfully added instance offering: " + printer.print(inv));
  40.     }

这段代码是ZStack ManageNode(简称MN)在接收到创建计算规格的请求后的处理逻辑，大致的逻辑即：

  1. 在DB中创建一条记录
  2. 添加当前账户与该计算规格的关联
  3. 创建相应的系统标签
  4. 回复该消息，并打印一行log

在这段代码中，我们可以看到在执行逻辑2、3时，这里做了一个Defer.guard(() -> dbf.remove(vo));，其作用是在执行下面的逻辑发生异常时执行，这样就移除了脏数据。

如何使用

Defer的使用方法也很简单，如果你要在某个函数使用它，在上面添加一个 @Deferred的Annotation，然后就可以在该函数内使用它了。

一般有两种用法：

  • Defer.guard：在该函数抛出异常时执行Runable。
  • Defer.defer：在该函数返回前执行。我们可以使用其释放局部锁。

为了避免不熟悉ZStack读者理解起来生涩，建议参考其Case在这里，我们将展现一个较为简单的case：

  1. public class TestDefer1 {
  2.     CLogger logger = Utils.getLogger(TestDefer1.class);
  3.     int count = 0;
  5.     @Before
  6.     public void setUp() throws Exception {
  7.     }
  10.     @Deferred
  11.     private void case1() {
  12.         count++;
  13.         Defer.guard(new Runnable() { //当捕捉到异常时，执行其中的匿名Runable语句
  14.             @Override
  15.             public void run() {
  16.                 count--;
  17.             }
  18.         });
  19.         //抛出一个异常
  20.         throw new CloudRuntimeException("Roll back count");
  21.     }
  23.     @Test(expected = CloudRuntimeException.class)
  24.     public void test() {
  25.         case1();
  26.         Assert.assertEquals(0, count);
  27.     }
  28. }

实现

Defer的库非常的小。其本质通过对Spring提供的AOP和Java提供的ThreadLocal以及一个Stack数据结构进行封装：对于执行函数的当前线程存入一个Stack数据结构，每一个填写在Defer中的Runable都会被放入，之后根据调用的Defer的函数来决定其行为。

这里Runable的放入来自系统启动时利用反射所做的一个行为。因此并不会影响使用时的性能。