Apache Commons Chain用法

2019-05-07 本文已影响0人勤劳的熊熊

简介

Commons-chain是apache commons中的一个子项目,主要被使用在"责任链"的场景中,struts中action的调用过程,就是使用了"chain"框架做支撑.如果你的项目中,也有基于此种场景的需求,可以考虑使用它.
所谓"责任链"就是一系列有序的command能够按照顺序执行,并能够互相交换或者传递执行结果，和我们常说的"责任链"模式类似.

先从一个例子开始

汽车销售流程：试车 -> 销售谈判 -> 安排财务 -> 结束销售
假设使用传统的模板模式

public abstract class SellVehicleTemplate {  
   // 销售汽车 
   public void sellVehicle() {  
        testDriveVehicle();  
        negotiateSale();  
        arrangeFinancing();  
        closeSale();  
    }  
    // 试车
    public abstract void testDriveVehicle();  
    // 销售谈判
    public abstract void negotiateSale();  
    // 安排财务
    public abstract void arrangeFinancing();  
    // 结束销售
    public abstract void closeSale();  
}

使用Commons Chain责任链模式

import org.apache.commons.chain.Command;  
import org.apache.commons.chain.Context;  
// 试车（继承Command）
public class TestDriveVehicle implements Command {  
    public boolean execute(Context ctx) throws Exception {  
        System.out.println("Test drive the vehicle");  
        return false;  
    }  
}  
// 销售谈判
public class NegotiateSale implements Command {  
    public boolean execute(Context ctx) throws Exception {  
        System.out.println("Negotiate sale");  
        return false;  
    }    
}  
// 安排财务
public class ArrangeFinancing implements Command {  
    public boolean execute(Context ctx) throws Exception {  
        System.out.println("Arrange financing");  
        return false;  
    }    
}  
// 结束销售
public class CloseSale implements Command {  
      public boolean execute(Context ctx) throws Exception {  
        System.out.println("Congratulations " + ctx.get("customerName") +", you bought a new car!");  
        return false;  
    }  
}  

// 定义责任链并测试
import org.apache.commons.chain.impl.ChainBase;  
import org.apache.commons.chain.Command;  
import org.apache.commons.chain.Context;  
import org.apache.commons.chain.impl.ContextBase;  
// 继承ChainBase
public class SellVehicleChain extends ChainBase {  
  
    public SellVehicleChain() {  
        super();  
        addCommand(new GetCustomerInfo());  
        addCommand(new TestDriveVehicle());  
        addCommand(new NegotiateSale());  
        addCommand(new ArrangeFinancing());  
        addCommand(new CloseSale());  
    }  
  
    public static void main(String[] args) throws Exception {  
        Command process = new SellVehicleChain();  
        Context ctx = new ContextBase();  
        process.execute(ctx);  
    }  

// 运行结果：
Test drive the vehicle 
Negotiate sale 
Arrange financing 
Congratulations George Burdell, you bought a new car!

Commons Chain提供了配置文件的方式定义责任链，在项目资源目录中创建chain- config.xml文件

<catalog>  
  <chain name="sell-vehicle">  
    <command id="GetCustomerInfo" className="com.jadecove.chain.sample.GetCustomerInfo"/>  
    <command id="TestDriveVehicle" className="com.jadecove.chain.sample.TestDriveVehicle"/>  
    <command id="NegotiateSale" className="com.jadecove.chain.sample.NegotiateSale"/>  
    <command id="ArrangeFinancing" className="com.jadecove.chain.sample.ArrangeFinancing"/>  
    <command id="CloseSale" className="com.jadecove.chain.sample.CloseSale"/>  
  </chain>  
</catalog>

// 从xml配置中读取
public class CatalogLoader {  
  
    private static final String CONFIG_FILE = "/com/jadecove/chain/sample/chain-config.xml";  
  
    private ConfigParser parser;  
  
    private Catalog catalog;  
  
    public CatalogLoader() {  
        parser = new ConfigParser();  
    }  
  
    public Catalog getCatalog() throws Exception {  
        if (catalog == null) {  
            parser.parse(this.getClass().getResource(CONFIG_FILE));  
        }  
        catalog = CatalogFactoryBase.getInstance().getCatalog();  
        return catalog;  
    }  
  
    public static void main(String[] args) throws Exception {  
        CatalogLoader loader = new CatalogLoader();  
        Catalog sampleCatalog = loader.getCatalog();  
        Command command = sampleCatalog.getCommand("sell-vehicle");  
        Context ctx = new SellVehicleContext();  
        command.execute(ctx);  
    }  
}

API详解

Command: 一个可执行的"指令"，多个command组成"责任链"。它只有一个方法，boolean execute(Context context)，当"责任链"开始调用时，将会依次执行链上的所有Command对象execute方法，直到结束，或者抛出异常，或者某个command返回true终止调用。context对象表示当前"责任链"的上下文信息，它可以用来保存一些临时变量(可以在command间共享)。此方法如果返回false，表示继续责任链将会继续执行后续command，如果返回true，则表示终止调用，后续的command将不会被执行.
Chain：实现类为ChainBase，command组织者，包括addCommand方法，可以添加多个command，再通过调用execute方法，会依次执行command链中的execute方法。
Filter：它本身也扩展了Command接口,能够和Command一样添加到Chain中，同时具有额外的接口boolean postprocess(Context context, Exception exception) 。当所有command以及filter的execute方法都执行完毕且没有异常，那么将会对Filter的postprocess方法按倒序执行；一旦链路发生异常，将立即执行filter的postprocess方法，如果方法处理完后返回true，表示错误处理已经完成，链的执行并不会就此结束，但是本质上来说这个错误被捕捉而且不会再向外抛出。如果postprocess方法返回false，那错误会继续向外抛出，然后链就会非正常结束。
Context：类似于"session"，用来保存当前Chain中需要被保持的"变量参数"或者"Command执行的结果"，Context内部存储结构为一个Map，它的数据可以被Chain中的Command操作，Context并非为线程安全的，也不期望此实例能够被重用，每次Chain被调用，都应该创建新的Context实例，其实现类为ContextBase。

Context显式调用

我们可以编写一个SellVehicleContext 类继承ContextBase，在command中进行类型转换，这样可以直接通过get获取值

public class SellVehicleContext extends ContextBase {  
  
    private String customerName;  

    public String getCustomerName() {  
        return customerName;  
    }  

    public void setCustomerName(String name) {  
        this.customerName = name;  
    }    
}  
// 进行类型转换
public boolean execute(Context ctx) throws Exception {  
    SellVehicleContext myCtx = (SellVehicleContext) ctx;  
    System.out.println("Congratulations " + myCtx.getCustomerName() + ", you bought a new car!");  
    return false;  
}  

// 调用
public static void main(String[] args) throws Exception {  
    Command process = new SellVehicleChain();  
    Context ctx = new SellVehicleContext();  
    process.execute(ctx);  
}

参考：

Commons-chain:责任链框架

使用Apache Commons Chain

Apache Commons Chain用法

简介

先从一个例子开始

API详解

Context显式调用

猜你喜欢

热点阅读