聊聊如何利用管道模式来进行业务编排（下篇）

前言

上篇文章我们介绍使用管道形式来进行事务编列的2种完成方法。本文又来介绍其他完成方法

完成方法

方法一：使用springboot主动安装

1、新建管道实体

@Data
@AllArgsConstructor
@NoArgsConstructor
public class PipelineDefinition {
public static final String PREFIX = "lybgeek_pipeline_";
private String comsumePipelineName;
private List<String> pipelineClassNames;
}
}

@Data
@AllArgsConstructor
@NoArgsConstructor
@ConfigurationProperties(prefix = PipelineDefinitionProperties.PREFIX)
public class PipelineDefinitionProperties {
public final static String PREFIX = "lybgeek.pipeline";
private List<PipelineDefinition> chain;
}
}

2、编写主动安装类

@Configuration
@EnableConfigurationProperties(PipelineDefinitionProperties.class)
public class PipelineAutoConfiguration implements BeanFactoryAware,InitializingBean, SmartInitializingSingleton {
@Autowired
private PipelineDefinitionProperties pipelineDefinitionProperties;
private DefaultListableBeanFactory defaultListableBeanFactory;
@Override
public void setBeanFactory(BeanFactory beanFactory) throws BeansException {
    defaultListableBeanFactory = (DefaultListableBeanFactory)beanFactory;
}
private void registerPipeline(DefaultListableBeanFactory defaultListableBeanFactory, PipelineDefinition pipelineDefinition) {
    LinkedBlockingDeque linkedBlockingDeque = buildPipelineQuque(pipelineDefinition);
    GenericBeanDefinition beanDefinition = (GenericBeanDefinition) BeanDefinitionBuilder.genericBeanDefinition(ChannelPipeline.class).getBeanDefinition();
    beanDefinition.getPropertyValues().addPropertyValue("channelHandlers",linkedBlockingDeque);
    defaultListableBeanFactory.registerBeanDefinition(PipelineDefinition.PREFIX + pipelineDefinition.getComsumePipelineName() ,beanDefinition);
}
@SneakyThrows
private LinkedBlockingDeque buildPipelineQuque(PipelineDefinition pipelineDefinition) {
    List<String> pipelineClassNames = pipelineDefinition.getPipelineClassNames();
    if(CollectionUtil.isEmpty(pipelineClassNames)){
       throw new PipelineException("pipelineClassNames must config");
    }
    LinkedBlockingDeque linkedBlockingDeque = new LinkedBlockingDeque();
    for (String pipelineClassName : pipelineClassNames) {
        Class<?> pipelineClassClass = Class.forName(pipelineClassName);
        if(!AbstactChannelHandler.class.isAssignableFrom(pipelineClassClass)){
            throw new PipelineException("pipelineClassNames must be 【com.github.lybgeek.pipeline.handler.AbstactChannelHandler】 subclass");
        }
        Object pipeline = pipelineClassClass.getDeclaredConstructor().newInstance();
        linkedBlockingDeque.addLast(pipeline);
    }
    return linkedBlockingDeque;
}
@Override
public void afterPropertiesSet() throws Exception {
    if(CollectionUtil.isNotEmpty(pipelineDefinitionProperties.getChain())){
        for (PipelineDefinition pipelineDefinition : pipelineDefinitionProperties.getChain()) {
            registerPipeline(defaultListableBeanFactory, pipelineDefinition);
        }
    }
}
@Override
public void afterSingletonsInstantiated() {
    Map<String, ChannelPipeline> pipelineBeanMap = defaultListableBeanFactory.getBeansOfType(ChannelPipeline.class);
    pipelineBeanMap.forEach((key,bean)->{
        bean.setHandlerContext(ChannelHandlerContext.getCurrentContext());
    });
}
}
}

3、编写spring.factories

org.springframework.boot.autoconfigure.EnableAutoConfiguration=
com.github.lybgeek.pipeline.spring.autoconfigure.PipelineAutoConfiguration</code>

事务项目怎么使用该方法完成事务编列

示例：

1、创立管道执行器

@Slf4j
public class UserCheckChannelHandler extends AbstactChannelHandler {
@Override
public boolean handler(ChannelHandlerContext chx) {
    ChannelHandlerRequest channelHandlerRequest = chx.getChannelHandlerRequest();
    System.out.println("yml------------------------------------过程一：用户数据校验【"+channelHandlerRequest.getRequestId()+"】");
    Object params = channelHandlerRequest.getParams();
    if(params instanceof User){
        User user = (User)params;
        if(StringUtils.isBlank(user.getFullname())){
            log.error("用户名不能为空");
            return false;
        }
        return true;
    }
    return false;
}
}

@Slf4j
public class UserFillUsernameAndEmailChannelHandler extends AbstactChannelHandler {
@SneakyThrows
@Override
public boolean handler(ChannelHandlerContext chx) {
ChannelHandlerRequest channelHandlerRequest = chx.getChannelHandlerRequest();
System.out.println("yml------------------------------------过程二：用户名以及邮箱填充【将汉语转成拼音填充】【"+channelHandlerRequest.getRequestId()+"】");
Object params = channelHandlerRequest.getParams();
if(params instanceof User){
User user = (User)params;
String fullname = user.getFullname();
HanyuPinyinOutputFormat hanyuPinyinOutputFormat = new HanyuPinyinOutputFormat();
hanyuPinyinOutputFormat.setToneType(HanyuPinyinToneType.WITHOUT_TONE);
String username = PinyinHelper.toHanYuPinyinString(fullname, hanyuPinyinOutputFormat);
user.setUsername(username);
user.setEmail(username + "@qq.com");
return true;
}
    return false;
}
}

。。。其他执行器详细检查链接代码

2、装备yml文件

lybgeek:
pipeline:
chain:
- comsumePipelineName: userYmlService
pipelineClassNames:
- com.github.lybgeek.pipeline.spring.test.yml.handler.UserCheckChannelHandler
- com.github.lybgeek.pipeline.spring.test.yml.handler.UserFillUsernameAndEmailChannelHandler
- com.github.lybgeek.pipeline.spring.test.yml.handler.UserPwdEncryptChannelHandler
- com.github.lybgeek.pipeline.spring.test.yml.handler.UserMockSaveChannelHandler
- com.github.lybgeek.pipeline.spring.test.yml.handler.UserPrintChannleHandler

3、详细事务service引进管道bean

@Service
public class UserYmlServiceImpl implements UserYmlService {
@Autowired
private ApplicationContext applicationContext;
@Override
public boolean save(User user) {
    ChannelPipeline pipeline =  applicationContext.getBean(ChannelPipeline.class,PipelineDefinition.PREFIX + StringUtils.uncapitalize(UserYmlService.class.getSimpleName()));
    return pipeline.start(ChannelHandlerRequest.builder().params(user).build());
}
}

4、测试

    @Test
public void testPipelineYml(){
boolean isOk = userYmlService.save(user);
Assert.assertTrue(isOk);
}

方法二：使用spring自界说标签

1、界说xsd束缚文件pipeline.xsd

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:beans="http://www.springframework.org/schema/beans"
xmlns:tool="http://www.springframework.org/schema/tool"
xmlns="http://lybgeek.github.com/schema/pipeline"
targetNamespace="http://lybgeek.github.com/schema/pipeline">
&lt;xsd:import namespace="http://www.w3.org/XML/1998/namespace"/&gt;
&lt;xsd:import namespace="http://www.springframework.org/schema/beans"
            schemaLocation="http://www.springframework.org/schema/beans/spring-beans.xsd"/&gt;
&lt;xsd:import namespace="http://www.springframework.org/schema/tool"/&gt;
&lt;xsd:annotation&gt;
    &lt;xsd:documentation&gt;
        &lt;![CDATA[ Namespace support for pipeline services ]]&gt;&lt;/xsd:documentation&gt;
&lt;/xsd:annotation&gt;
&lt;xsd:complexType name="pipelineType"&gt;
    &lt;xsd:choice&gt;
        &lt;xsd:element ref="pipelineHandler" minOccurs="1" maxOccurs="unbounded"/&gt;
    &lt;/xsd:choice&gt;
    &lt;xsd:attribute name="id" type="xsd:ID"&gt;
        &lt;xsd:annotation&gt;
            &lt;xsd:documentation&gt;&lt;![CDATA[ The unique identifier for a bean. ]]&gt;&lt;/xsd:documentation&gt;
        &lt;/xsd:annotation&gt;
    &lt;/xsd:attribute&gt;
    &lt;xsd:attribute name="consumePipelinesServiceClassName" type="xsd:string" use="required"&gt;
        &lt;xsd:annotation&gt;
            &lt;xsd:documentation&gt;&lt;![CDATA[ consumePipelinesService class name  ]]&gt;&lt;/xsd:documentation&gt;
        &lt;/xsd:annotation&gt;
    &lt;/xsd:attribute&gt;
    &lt;xsd:attribute name="consumePipelinesMethod" type="xsd:string" use="required"&gt;
        &lt;xsd:annotation&gt;
            &lt;xsd:documentation&gt;&lt;![CDATA[ consumePipelinesMethod name  ]]&gt;&lt;/xsd:documentation&gt;
        &lt;/xsd:annotation&gt;
    &lt;/xsd:attribute&gt;
    &lt;xsd:attribute name="argsType" type="xsd:string" use="required"&gt;
        &lt;xsd:annotation&gt;
            &lt;xsd:documentation&gt;&lt;![CDATA[ consumePipelinesMethod args type , multiple args types are separated by commas ]]&gt;&lt;/xsd:documentation&gt;
        &lt;/xsd:annotation&gt;
    &lt;/xsd:attribute&gt;
&lt;/xsd:complexType&gt;
&lt;xsd:complexType name="pipelineHandlerType"&gt;
    &lt;xsd:attribute name="className" type="xsd:string" use="required"&gt;
        &lt;xsd:annotation&gt;
            &lt;xsd:documentation&gt;&lt;![CDATA[ pipelineHanlder class name]]&gt;&lt;/xsd:documentation&gt;
        &lt;/xsd:annotation&gt;
    &lt;/xsd:attribute&gt;
    &lt;xsd:attribute name="order" type="xsd:string" use="required"&gt;
        &lt;xsd:annotation&gt;
            &lt;xsd:documentation&gt;&lt;![CDATA[ pipeline class name]]&gt;&lt;/xsd:documentation&gt;
        &lt;/xsd:annotation&gt;
    &lt;/xsd:attribute&gt;
&lt;/xsd:complexType&gt;
&lt;xsd:element name="pipelineHandler" type="pipelineHandlerType"&gt;
    &lt;xsd:annotation&gt;
        &lt;xsd:documentation&gt;&lt;![CDATA[ The pipelineHandler config ]]&gt;&lt;/xsd:documentation&gt;
    &lt;/xsd:annotation&gt;
&lt;/xsd:element&gt;
&lt;xsd:element name="pipeline" type="pipelineType"&gt;
    &lt;xsd:annotation&gt;
        &lt;xsd:documentation&gt;&lt;![CDATA[ The pipeline config ]]&gt;&lt;/xsd:documentation&gt;
    &lt;/xsd:annotation&gt;
&lt;/xsd:element&gt;
</xsd:schema>

2、装备xsd束缚文件

在classpath下的resources文件夹新建META-INF文件夹，再建立一个文件spring.schemas，内容如下

http://lybgeek.github.com/schema/pipeline/pipeline.xsd=META-INF/pipeline.xsd

3、界说解析自界说标签的类

public class PipelineNamespaceHandler extends NamespaceHandlerSupport {
@Override
public void init() {
   registerBeanDefinitionParser("pipeline",new PipelineBeanDefinitionParser());
}
}

public class PipelineBeanDefinitionParser implements BeanDefinitionParser {
@Override
public BeanDefinition parse(Element element, ParserContext parserContext) {
    PipelineConfig pipelineConfig = buildPipelineConfig(element);
    List<HandlerInvotation> handlerInvotations = this.buildHandlerInvotations(pipelineConfig);
    GenericBeanDefinition beanDefinition = getGenericBeanDefinition(element, parserContext, pipelineConfig, handlerInvotations);
    return beanDefinition;
}
private GenericBeanDefinition getGenericBeanDefinition(Element element, ParserContext parserContext, PipelineConfig pipelineConfig, List<HandlerInvotation> handlerInvotations) {
    GenericBeanDefinition beanDefinition = (GenericBeanDefinition) BeanDefinitionBuilder.genericBeanDefinition().getBeanDefinition();
    beanDefinition.getPropertyValues().addPropertyValue("pipelineServiceClz",pipelineConfig.getConsumePipelinesService());
    beanDefinition.getPropertyValues().addPropertyValue("handlerInvotations",handlerInvotations);
    beanDefinition.getPropertyValues().addPropertyValue("createByXml",true);
    beanDefinition.setBeanClass(ComsumePipelineFactoryBean.class);
    String beanName = BeanUtils.generateBeanName(element,"id",parserContext,pipelineConfig.getConsumePipelinesService().getSimpleName());
    parserContext.getRegistry().registerBeanDefinition(beanName,beanDefinition);
    return beanDefinition;
}
@SneakyThrows
private List<HandlerInvotation> buildHandlerInvotations(PipelineConfig pipelineConfig){
    List<HandlerInvotation> handlerInvotations = new ArrayList<>();
    for (PipelineHandlerConfig pipelineHandlerConfig : pipelineConfig.getPipelineChain()) {
        if(!AbstactChannelHandler.class.isAssignableFrom(pipelineHandlerConfig.getPipelineClass())){
            throw new PipelineException("pipelineHandler className must be 【com.github.lybgeek.pipeline.handler.AbstactChannelHandler】 subclass");
        }
        AbstactChannelHandler channelHandler = (AbstactChannelHandler) pipelineHandlerConfig.getPipelineClass().getDeclaredConstructor().newInstance();
        HandlerInvotation invotation = HandlerInvotation.builder()
                .args(pipelineConfig.getArgs())
                .handler(channelHandler)
                .order(pipelineHandlerConfig.getOrder())
                .consumePipelinesMethod(pipelineConfig.getConsumePipelinesMethod())
                .build();
        handlerInvotations.add(invotation);
    }
    return handlerInvotations;
}
@SneakyThrows
private PipelineConfig buildPipelineConfig(Element element){
    String argsType = element.getAttribute("argsType");
    String[] argsTypeArr = trimArrayElements(commaDelimitedListToStringArray(argsType));
    String consumePipelinesMethod = element.getAttribute("consumePipelinesMethod");
    String consumePipelinesServiceClassName = element.getAttribute("consumePipelinesServiceClassName");
    Class[] args = null;
    if(ArrayUtil.isNotEmpty(argsTypeArr)){
        args = new Class[argsTypeArr.length];
        for (int i = 0; i < argsTypeArr.length; i++) {
            Class argType = Class.forName(argsTypeArr[i]);
            args[i] = argType;
        }
    }
    List<PipelineHandlerConfig> pipelineHandlerConfigs = buildPipelineHandlerConfig(element);
    return PipelineConfig.builder().args(args)
            .consumePipelinesMethod(consumePipelinesMethod)
            .consumePipelinesService(Class.forName(consumePipelinesServiceClassName))
            .pipelineChain(pipelineHandlerConfigs)
            .build();
}
@SneakyThrows
private List<PipelineHandlerConfig> buildPipelineHandlerConfig(Element element){
    NodeList nodeList = element.getChildNodes();
    if (nodeList == null) {
        return Collections.emptyList();
    }
    List<PipelineHandlerConfig> pipelineHandlerConfigs = new ArrayList<>();
    for (int i = 0; i < nodeList.getLength(); i++) {
        if (!(nodeList.item(i) instanceof Element)) {
            continue;
        }
        Element childElement = (Element) nodeList.item(i);
        if ("pipelineHandler".equals(childElement.getNodeName()) || "pipelineHandler".equals(childElement.getLocalName())) {
            String pipelineHanlderClassName = childElement.getAttribute("className");
            String pipelineHanlderOrder = childElement.getAttribute("order");
            Class pipelineHanlderClass = Class.forName(pipelineHanlderClassName);
            PipelineHandlerConfig pipelineHandlerConfig = PipelineHandlerConfig.builder()
                    .PipelineClass(pipelineHanlderClass)
                    .order(Integer.valueOf(pipelineHanlderOrder))
                    .build();
            pipelineHandlerConfigs.add(pipelineHandlerConfig);
        }
    }
    return pipelineHandlerConfigs;
}
}

4、注册解析类

在META-INF文件夹新建spring.handlers文件，内容如下

http://lybgeek.github.com/schema/pipeline=com.github.lybgeek.pipeline.spring.shema.PipelineNamespaceHandler

事务项目怎么使用该方法完成事务编列

示例：

1、创立管道执行器

@Slf4j
public class UserCheckChannelHandler extends AbstactChannelHandler {
@Override
public boolean handler(ChannelHandlerContext chx) {
    ChannelHandlerRequest channelHandlerRequest = chx.getChannelHandlerRequest();
    System.out.println("XML------------------------------------过程一：用户数据校验【"+channelHandlerRequest.getRequestId()+"】");
    String json = JSON.toJSONString(channelHandlerRequest.getParams());
    List<User> users = JSON.parseArray(json,User.class);
    if(CollectionUtil.isEmpty(users) || StringUtils.isBlank(users.get(0).getFullname())){
        log.error("用户名不能为空");
        return false;
    }
    return true;
}
}

@Slf4j
public class UserFillUsernameAndEmailChannelHandler extends AbstactChannelHandler {
@SneakyThrows
@Override
public boolean handler(ChannelHandlerContext chx) {
ChannelHandlerRequest channelHandlerRequest = chx.getChannelHandlerRequest();
System.out.println("XML------------------------------------过程二：用户名以及邮箱填充【将汉语转成拼音填充】【"+channelHandlerRequest.getRequestId()+"】");
String json = JSON.toJSONString(channelHandlerRequest.getParams());
List<User> users = JSON.parseArray(json,User.class);
if(CollectionUtil.isNotEmpty(users)){
User user = users.get(0);
String fullname = user.getFullname();
HanyuPinyinOutputFormat hanyuPinyinOutputFormat = new HanyuPinyinOutputFormat();
hanyuPinyinOutputFormat.setToneType(HanyuPinyinToneType.WITHOUT_TONE);
String username = PinyinHelper.toHanYuPinyinString(fullname, hanyuPinyinOutputFormat);
user.setUsername(username);
user.setEmail(username + "@qq.com");
return true;
    }
    return false;
}
}

。。。其他执行器详细检查链接代码

2、界说管道xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:lybgeek="http://lybgeek.github.com/schema/pipeline"
xmlns="http://www.springframework.org/schema/beans"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.3.xsd
http://lybgeek.github.com/schema/pipeline http://lybgeek.github.com/schema/pipeline/pipeline.xsd">
&lt;lybgeek:pipeline consumePipelinesServiceClassName="com.github.lybgeek.pipeline.spring.test.xml.service.UserXmlService" consumePipelinesMethod="save" argsType="com.github.lybgeek.pipeline.spring.test.model.User"&gt;
    &lt;lybgeek:pipelineHandler className="com.github.lybgeek.pipeline.spring.test.xml.handler.UserCheckChannelHandler" order="1"/&gt;
    &lt;lybgeek:pipelineHandler className="com.github.lybgeek.pipeline.spring.test.xml.handler.UserFillUsernameAndEmailChannelHandler" order="2"/&gt;
    &lt;lybgeek:pipelineHandler className="com.github.lybgeek.pipeline.spring.test.xml.handler.UserPwdEncryptChannelHandler" order="3"/&gt;
    &lt;lybgeek:pipelineHandler className="com.github.lybgeek.pipeline.spring.test.xml.handler.UserMockSaveChannelHandler" order="4"/&gt;
    &lt;lybgeek:pipelineHandler className="com.github.lybgeek.pipeline.spring.test.xml.handler.UserPrintChannleHandler" order="5"/&gt;
&lt;/lybgeek:pipeline&gt;

3、创立事务管道类

public interface UserXmlService {
boolean save(User user);
}

直接界说接口即可

4、项目发动类上加上@ImportResource("classpath:/pipeline.xml")

@SpringBootApplication
@ImportResource("classpath:/pipeline.xml")
public class SpringPipelineApplication  {
public static void main(String[] args) {
    SpringApplication.run(SpringPipelineApplication.class);
}
}

5、测试

    @Test
public void testPipelineXml(){
boolean isOk = userXmlService.save(user);
Assert.assertTrue(isOk);
}</code></pre><p></p><h2>总结</h2><p>本文的管道形式的中心逻辑内核和上篇文章是一样，仅仅把管道执行器通过装备文件会集管理起来，这个后续维护也比较不容易犯错</p><h2>demo链接</h2><p><a href="https://link.segmentfault.com/?enc=vCBa8EMOH2UK5HgT%2FdaQ4Q%3D%3D.87KfMl3PdP7e0VLkJztNPLPBek5VZuMK%2BMNKEQ9MgNm3uHGpbez6uMD0zEb51H2OBrlQScpQpqlxTGIeo%2BxDpeUqjHKK5z0DS9I%2BRXSwq8k%3D" rel="nofollow">https://github.com/lyb-geek/springboot-learning/tree/master/springboot-pipeline</a></p><blockquote>
本文来历：聊聊怎么使用管道形式来进行事务编列（下篇）