提高代码可读性、复用性、可扩展性,从而提高开发体验和效率是基础素养。减少重复代码,对重复代码进行抽象、下沉,遵守设计原则,应用设计模式,都有一个共同的目的:发现变化,封装变化,提高代码的可复用性,减少需求变化影响的范围,从而使软件、系统、云服务、网站等能够可控的修改与升级,具有更长的生命周期。
一、最常见的三层架构
以我们平常接触较多的三层架构开始:biz-core-common。
在开发的过程中,从三层架构的角度考虑,最简单的认识便是对于业务逻辑,在biz层去编排处理。而对于一些与业务逻辑无关,可复用的逻辑,从业务逻辑中抽离出来,在core层进行处理。底层的模型、DAO方法、外部服务的门面等,放在common层处理。这样对于新增的业务,可以复用core层的通用方法。
这是最简单的理解与要求,在这之上,很多应用都根据自身的特点,从不同的角度用不同的方法提高代码的可复用性。本文以条码的处理逻辑为例,介绍一种组件化链路设计思想。
二、为什么要用组件化链路
可以想象这样一种场景,有一种产品,处理的逻辑很复杂,代码很长。随着业务的发展,这个产品衍生出很多其它具有类似性质,但处理链路各有差异的产品。此时,怎样去设计代码的结构,才能更好地提高代码的复用性呢?
比如我们常见的18位付款码,对于一次解码链路,就要涉及复杂的逻辑,要经历十余种业务处理阶段,还要考虑一些不影响主链路的弱依赖逻辑。而除了18位otp离线码之外,还有19位离线码、18位在线码、19位在线码、24位db在线码等等。同时又涉及发码、解码、支付token置换等逻辑,对于一个专门处理码的平台,需要定制的逻辑就有百余种。每一种码的每一个流程之间都有差异性,但也有共性,若不做特殊处理,每一种码都在biz层编排业务逻辑,复用core层的方法,其开发的复杂性也是很大的,并且随着产品的持续增多,代码中的分支会越来越多,影响理解、维护与新增。
那么如何最大化的把通用逻辑抽离出来,提高其复用性、可维护性以及可拓展性呢?组件化链路的设计是其中的一种方式。
三、组件化链路设计
3.1 组件化链路思想
对于涉及多个业务处理阶段的逻辑,若每个阶段之间有所联系,但又彼此独立,便可以把每个流程抽象成一个个节点,对于一个特定业务流程而言,每一个子流程都可作为一个节点,依次执行流程节点,传递节点参数即可。如下
当我们把所有业务处理的子流程都抽象成节点以后,每一个业务流程的处理便可以通过节点间的排列组合去完成。如18位离线条码处理流程
NodeWrapper便是每个子流程抽像出来的节点,对于18离线条码的业务处理流程barCodeOfflineOtp18ParseProcess,只需要去依次处理每个节点的业务逻辑就好了。通过这样的方式,便可以通过一个统一的流程处理方法,执行所有组件化的业务流程,如下所示。
通过业务上下文context保存每个节点执行的结果并向下传递,首先执行nodeProcess主链路强依赖的节点,节点的执行结果影响链路推进,而后extensionProcess执行弱依赖的节点,执行失败并不影响主流程。这样我们对于业务逻辑的处理就变为了根据传参识别业务身份->执行对应流程->返回业务执行流程上下文context。而对于业务流程的处理,都只用在xml配置一下node,便可复用现有的逻辑。
更进一步地,对于ProcessModel以及NodeWrapper,我们应该怎么设计才能承载上述的功能实现?
3.2 流程节点的具体设计
3.2.1 节点设计
ProcessModel与NodeWrapper之间的关系如下
processModel内部其实就是一堆节点,是一种一对多的关系,将强依赖的主链路节点与弱依赖节点分开,如下
自然,节点执行的能力要交予节点自己,一个节点的内部参数如下
一个节点会有节点名称nodeName、真正的执行节点node、以及参数转换的nodeParametersMaping。每个参数的设计都有其特殊的考虑,首先是业务节点名称,这个参数有什么意义呢?其实是在业务执行的过程中,可能会有分支链路的出现,根据不同的结果,可能会跳过一些节点。此时便可以指定下一个执行节点的nodeName,实现节点跳转的功能。
对于ProcessNode来说,它才是严格意义上的执行节点。
processNode是一个接口,每个节点给予其具体实现。此处的入参是Map params,上文已经说到,节点处理是通过context传递的,但对于每个节点而言,并不需要所有context的所有参数。所以对于下一节点执行的时候,只需通过context取出需要的部分执行即可。这引发了下一个问题,如何设计一种通用的方法,去转换参数呢,这就是NodeParametersMaping所要做的。
这里contextToNode便是用于从context中取出某些参数,转换成节点入参的配置。nodeToContextMapping便是节点执行结果放进context的配置。那这里为什么是一个Map类型的数据呢,主要是因为节点执行可能成功可能失败,失败的结果也有很多,此处主要是根据不同的执行结果,取出相应的NodeToContextMaping,往context里填充数据。NodeToContextMaping如下
这里的processMethod便是用于指定下一个执行节点的,是执行下一个执行节点,还是跳转节点。nodeToContext便是将节点执行结果放进context的配置文件,不同的执行结果会有不同的配置。该配置也是事先在xml中配置实现的
以上述为例,当key=1时,说明发生错误,该节点processMethod是ERROR_NODE不需要向下执行。当key=1时,将执行结果中的terminalResult放入context中的terminalResult,并且processMethod是默认值,执行下一节点。
至此,关于节点的设计思路便结束了。通过这样的设计,节点执行的顺序、不同的分支逻辑都可以覆盖到了,并且对于新增业务逻辑,在xml中配置即可,不需要重新编排复杂的业务逻辑。此时又有一个问题,context和node间具体传递参数的逻辑是怎样实现的呢?
3.2.2 参数转换的实现
context是一个业务执行上下文,上下文类内中包含了所有执行过的节点结果,那是如何设计一个通用的转换方法,使得只需要在xml中配置参数转换map,就可以实现节点参数与context之间的参数转换的呢?以一个context中取参数转换node入参的case为例,一个contexToNode的定义如下
这里的配置的key:codeParseInfo.macauthIndex,表示的含义是从context中取值,相当于取出context.codeParseInfo.macauthIndex,而value:acauthIndex表示的含义是节点node的入参params的key。大概的含义是params.put(acauthIndex, context.codeParseInfo.macauthIndex)。具体的实现方式为
通过PropertyUtils.getProperty()方法,取出context.codeParseInfo.macauthIndex的值,再通过PropertyUtils.setProperty()方法,将值放入params当中。从而实现params.put(acauthIndex, context.codeParseInfo.macauthIndex)的作用。
3.3 业务身份的识别
通过如上的设计,便实现了一个组件化链路的设计。这里其实还有一个问题,每个业务流程都通过这种方式编排业务逻辑,那如何用一个通用的方法,识别出业务流程呢?这个问题其实与组件化链路的思想关系不大,每个业务都可以结合各自的业务特点去设计,这里简要介绍其中一种实现方案(不感兴趣可直接忽略)。
以生活中常见的码为例,对于码,匹配业务身份的思想其实就是根据码的特征与规则,预加载每种码的规则parseMatcher,根据传入的码值依次去匹配码的特征。
代码中的parseMatchers装有所有的待解析码的匹配规则,依次取出parseMatcher,判断当前传入的码值是否符合当前规则,若符合,则组装结果ParseMatchResult。parseMatchers的配置如下
通过对每种码的规则在xml中进行配置,解析码的时候依次去解析即可。这是parse解析码的业务类型,拓展到其余的业务类型,业务身份的模型关系如下
当有额外的业务类型出现时,需要用过入参去判断具体业务类型时,可根据其业务性质和特殊场景去额外定设计匹配逻辑,继承BizidentifyModel,额外的去设计匹配逻辑。
四、总结
组件化链路是一种解决节点间复用问题的设计思想,在老链路的基础上,提高了代码复用性、可维护性以及可拓展性。某种特定的方法并不是最重要的,最重要的还是提高代码复用性,解耦的思想。