commons-chain 应用记录

相关参考：

开始使用Commons Chain （第一部分）

开始使用Commons Chain （第二部分）

Apache Commons Chain简明手册

 

命令模式和责任链模式是编写业务处理流程中值得推荐的（可以有效解耦业务流程，使实现更面向对象），Apache 的 Commons-Chain 项目已将两者完美的结合。

 

以下简要记录应用 commons-chain 实现具体业务流程的过程，以“增加企业员工”为例。

“增加企业员工”的流程如下：

1）检查企业是否存在

2）检查企业是否可用

3）检查是否已达到企业员工数上限

4）检查待新增的员工是否已存在

5）上述校验均通过则增加员工

6）成功增加员工后，更新企业有关信息

 

应用 commons-chain 实现该业务流程的过程如下：

1. 进行“增加企业员工”的流程 chain 配置（即创建catalog xml文件），demo-chain.xml 内容如下：

<?xml version="1.0" encoding="UTF-8"?>

<catalog name="demo-chain">
	<!-- 定义 command 别名 -->
	<define name="lookupCommand" className="org.apache.commons.chain.generic.LookupCommand" />
	<define name="filterAddMember"
		className="demo.chain.Interceptor.AddMemberHandler" />
	<define name="cmdIsCorpExist"
		className="demo.chain.Interceptor.IsCorpExist" />
	<define name="cmdIsCorpValid"
		className="demo.chain.Interceptor.IsCorpValid" />
	<define name="cmdIsOverAccountNum"
		className="demo.chain.Interceptor.IsOverAccountNum" />
	<define name="cmdIsMemberExist"
		className="demo.chain.Interceptor.IsMemberExist" />
	<define name="cmdAddMemberInfo" className="demo.chain.command.AddMemberInfo" />

	<!-- 增加企业员工 chain -->
	<chain name="AddMemberMain">
		<cmdIsCorpExist id="IsCorpExist" /><!-- “增加企业员工”  第1）步-->
 		<cmdIsCorpValid id="IsCorpValid" /><!-- “增加企业员工”  第2）步-->
 		<cmdIsOverAccountNum id="IsOverAccountNum" /><!-- “增加企业员工”  第3）步-->
 		<lookupCommand catalogName="demo-chain" name="ValidateMember"
			optional="true" /><!-- 通过 lookup 调用子过程：“增加企业员工”  第4）步-->
 		<lookupCommand catalogName="demo-chain" name="AddMember"
			optional="true" /><!-- 通过 lookup 调用子过程：“增加企业员工”  第5）6）步-->
 	</chain>

	<!-- “增加企业员工”  第4）步-->
	<chain name="ValidateMember">
		<cmdIsMemberExist id="IsMemberExist" />
	</chain>

	<!--  “增加企业员工”  第5）6）步 -->
	<chain name="AddMember">
		<filterAddMember id="AddMemberHandler" />
		<cmdAddMemberInfo id="AddMemberInfo" />
	</chain>

</catalog>  

 

2. 编写各个具体的 command 类（即各个步骤的具体实现），有2个接口可供实现 ：

1）org.apache.commons.chain.Command， 以 demo.chain.Interceptor.IsCorpExist 为例，其代码如下：

package demo.chain.Interceptor;

import org.apache.commons.chain.Command;
import org.apache.commons.chain.Context;

public class IsCorpExist implements Command {

	public boolean execute(Context context) throws Exception {
		// TODO Auto-generated method stub
		System.out.println("IsCorpExist");
		return false;
	}

}

 

2）org.apache.commons.chain.Filter ，以 demo.chain.Interceptor.AddMemberHandler 为例，其代码如下：

package demo.chain.Interceptor;

import org.apache.commons.chain.Context;
import org.apache.commons.chain.Filter;

public class AddMemberHandler implements Filter {

	public boolean execute(Context context) throws Exception {
		// TODO Auto-generated method stub
		System.out.println("before AddMemberInfo.");
		return false;
	}

	public boolean postprocess(Context context, Exception exception) {
		// TODO Auto-generated method stub
		if (exception != null) {
			System.out.println("Exception " + exception.getMessage()
					+ " occurred.");
			return true;
		} else {
			System.out.println("after AddMemberInfo: UpdateCorp");
			return false;
		}
	}

}

 

filter 主要可以用于异常处理，同时在业务流程比较简单时，也可将这个业务流程写在一个 filter 里，在 execute 方法中实现其主流程，postprocess 中实现主流程之后的附加处理。

 

3. 具体的 command 类均实现后，调用 “增加企业员工”的流程实现 ：

package demo.chain;

import org.apache.commons.chain.Catalog;
import org.apache.commons.chain.Command;
import org.apache.commons.chain.Context;
import org.apache.commons.chain.config.ConfigParser;
import org.apache.commons.chain.impl.CatalogFactoryBase;
import org.apache.commons.chain.impl.ContextBase;

public class ChainTest {

	private static final String CONFIG_FILE = "/config/demo-chain.xml";

	private ConfigParser parser;

	private Catalog catalog;

	public ChainTest() {
		parser = new ConfigParser();
	}

	public Catalog getCatalog() throws Exception {
		if (catalog == null) {
			parser.parse(this.getClass().getResource(CONFIG_FILE));
		}
		catalog = CatalogFactoryBase.getInstance().getCatalog("demo-chain"); // 与xml文件中的catalog元素的name属性值一致
		return catalog;
	}

	/**
	 * @param args
	 * @throws Exception
	 */
	public static void main(String[] args) throws Exception {
		ChainTest loader = new ChainTest();
		Catalog sampleCatalog = loader.getCatalog();
		Command command = sampleCatalog.getCommand("AddMemberMain"); // 与xml文件中的chain元素的name属性值一致
		Context ctx = new ContextBase();
		command.execute(ctx);
	}

}

 

运行main函数，结果如下：

IsCorpExist
IsCorpValid
IsOverAccountNum
IsMemberExist
before AddMemberInfo.
AddMemberInfo
after AddMemberInfo: UpdateCorp

 

另： 在整个chai n的处理过程中，可能前后几个command都需要对同个对象进行 访问或操作，若对象需要访问DB获得，在每个command中都直接去DB获取显然是影响效率和性能的，同时在处理过程中还有可能需要改变这个对象并传递它，这时可以通过扩展 ContextBase 来实现，DemoCtx 代码如下：

package demo.chain;

import org.apache.commons.chain.impl.ContextBase;

@SuppressWarnings("serial")
public class DemoCtx extends ContextBase {

	private String name;

	public String getName() {
		return name;
	}

	public void setName(String name) {
		this.name = name;
	}

}

 

扩展 ContextBase 类中的属性可以是任何类型，绝对满足应用需要，在 command 中可以通过形如： ((DemoCtx) context).getName() 、 ((DemoCtx) context).setName("test")  的方式来get 或 set 要传递的值。

 

最后，附上应用commons-chain 的关键 maven 依赖：

			<dependency>
				<groupId>commons-chain</groupId>
				<artifactId>commons-chain</artifactId>
				<version>1.2</version>
			</dependency>
			<dependency>
				<groupId>commons-digester</groupId>
				<artifactId>commons-digester</artifactId>
				<version>1.8.1</version>
			</dependency>

 

经实践，commons-digester 1.8.1 和  commons-chain 1.2 运行以上代码无问题， commons-digester 1.7 和 commons-digester 2.0 在 main 函数运行过程中均有异常产生（均与解析xml有关）。