一个注解搞定责任链，学还是不学？

　　背景
　　在繁琐的业务流程处理中，通常采用面向过程的设计方法将流程拆分成N个步骤，每个步骤执行独立的逻辑。publicvoidprocess（params）｛doFirst（params）；doSecond（params）；。。。。doLast（params）；｝
　　但是这样剥离仍然是不彻底的，修改其中一个步骤仍然可能影响其他步骤（同一个类修改，不符合开闭原则）。在这种场景下，有一种经典的设计模式责任链模式，可以将这些子步骤封装成独立的handler，然后通过pipeline将其串联起来。
　　常见的责任链模式会设计如下：
　　总体来看，纯手动编写有以下问题：正确性：实现复杂度较高，短时间手工编写容易出错开发效率：涉及多个类的实现，需要花费不少时间进行测试非业务的pipeline流程，ROI不高复用性：不同业务流程难以复用同一套pipeline的关键代码
　　那有没有一套靠谱的框架能够解决上述问题呢？有的，它就是foldrightautopipeline，是责任链领域的lombok！
　　QuirkStart
　　下面以读取系统配置为例，读取逻辑如下：从本地配置文件读取，读取成功则直接返回，否则执行下一步从系统变量读取，返回对应的值
　　为了实现这个需求，读取配置接口定义如下：publicinterfaceConfigSource｛Stringget（Stringkey）；｝
　　如果使用autopipeline，该如何
　　以下大部分内容引至autopipeline官网：https：github。comfoldrightautopipeline
　　1。引入Maven依赖dependencygroupIdcom。foldright。autopipelinegroupIdautopipelineprocessorartifactIdversion0。2。0versionscopeprovidedscopedependency
　　2。在需要生成pipeline的接口上加上AutoPipeline
　　只需为这个接口加上AutoPipelineAutoPipelinepublicinterfaceConfigSource｛Stringget（Stringkey）；
　　3。实现pipeline的handlerpublicclassMapConfigSourceHandlerimplementsConfigSourceHandler｛privatefinalMapString，Stringmap；publicMapConfigSourceHandler（MapString，Stringmap）｛this。mapmap；｝OverridepublicStringget（Stringkey，ConfigSourceHandlerContextcontext）｛Stringvaluemap。get（key）；if（StringUtils。isNotBlank（value））｛returnvalue；｝returncontext。get（key）；｝｝publicclassSystemConfigSourceHandlerimplementsConfigSourceHandler｛publicstaticfinalSystemConfigSourceHandlerINSTANCEnewSystemConfigSourceHandler（）；OverridepublicStringget（Stringkey，ConfigSourceHandlerContextcontext）｛StringvalueSystem。getProperty（key）；if（StringUtils。isNotBlank（value））｛returnvalue；｝returncontext。get（key）；｝｝
　　4。使用pipelineMapString，StringmapConfignewHashMapString，String（）；mapConfig。put（hello，world）；ConfigSourceHandlermapConfigSourceHandlernewMapConfigSourceHandler（mapConfig）；ConfigSourcepipelinenewConfigSourcePipeline（）。addLast（mapConfigSourceHandler）。addLast（SystemConfigSourceHandler。INSTANCE）；pipeline。get（hello）；getvalueworldfrommapConfigmapConfigSourceHandlerpipeline。get（java。specification。version）getvalue1。8fromsystempropertiesSystemConfigSourceHandler
　　实现原理
　　业务接口通过生成的Pipeline构造实现，Pipeline负责责任链的组装及调用链表的首个节点（head）。首个节点如果处理完成有返回值，则直接返回；否则传递给下一个节点。如果处理到最后一个节点（tail）返回仍然为空，则直接返回空。
　　以获取配置为例：
　　用户实现：ConfigSource用户自定义的获取配置的接口Handler实现：MapConfigSourceHandler、SystemConfigSourceHandlerAutoPipeline生成ConfigSourcePipeline含义：责任链管道核心作用：将ConfigSourceHandler串联成链表ConfigSourceHandlerContext含义：Handler的上下文，相比传统责任链，新增了获取全局Pipeline的能力AbstractConfigSourceHandlerContext含义：Handler的上下文的抽象类数据结构：主要由三个部分组成：pre、next、handler核心作用：通过handler（）。get（key，findNextCtx（））实现了Stringget（Stringkey）方法DefaultConfigSourceHandlerContext持有ConfigSourceHandler对象的默认实现类
　　源码解读
　　目录
　　autopipelineannotations框架包含的注解：AutoPipeline、PipelineDirection
　　AutoPipeline生成pipeline的核心注解PipelineDirectionpipeline处理的顺序方向autopipelineprocessor
　　AutoPipelineProcessor生成pipeline的入口类SourceGeneratorFacade源代码生成器autopipelineexamples一些实例，比如获取配置、rpc、merger
　　生成原理
　　通过SPI的方式注册编译时注解AutoPipelineProcessor，在编译过程中通过javapoet框架生成业务pipeline源代码。注册编译时注解编写注解类：AutoPipelineProcessor继承JDK的AbstractProcessor，实现process方法在resources目录下新建文件夹：METAINFservices在METAINFservices里面新增spi文件：javax。annotation。processing。Processor，文件写入需要继承AbstractProcessor的全类名
　　相关类介绍：Processor提供注解处理，它遵循SPI规约进行拓展AbstractProcessor注解处理器主要拓展处理类生成源代码
　　JDK术语介绍：ProcessingEnvironment注解处理工具的集合Element是一个接口，表示一个程序元素，它可以是包、类、方法或者一个变量PackageElement表示一个包程序元素，提供对有关包及其成员的信息的访问。ExecutableElement表示某个类或接口的方法、构造方法或初始化程序（静态或实例），包括注释类型元素。TypeElement表示一个类或接口程序元素，提供对有关类型及其成员的信息的访问。注意，枚举类型是一种类，而注解类型是一种接口。VariableElement表示一个字段、enum常量、方法或构造方法参数、局部变量或异常参数。Filer文件管理器，主要负责生成源代码、class或者辅助文件
　　JavaPoet技术介绍：TypeSpec用于生成类、接口、枚举的工具类MethodSpec用于生成构造方法或者普通的方法的工具类关键代码解读生成入口：AutoPipelineProcessorprocessoverridefunprocess（annotations：SetTypeElement，roundEnv：RoundEnvironment）：Boolean｛valelementsroundEnv。getElementsAnnotatedWith（AutoPipeline：：class。java）if（elements。isEmpty（））｛returnfalse｝for（elementinelements）｛if（element。kind！ElementKind。INTERFACE）｛error（element，｛（elementasTypeElement）。qualifiedName｝isnotainterface！Onlyinterfacecanannotatedwith｛AutoPipeline：：class。simpleName｝）returnfalse｝if（！element。modifiers。contains（Modifier。PUBLIC））｛error（element，interface｛（elementasTypeElement）。qualifiedName｝isnotpublic！Onlypublicinterfacecanannotatedwith｛AutoPipeline：：class。simpleName｝）returnfalse｝if（elementisTypeElement）｛doProcess（element）｝｝returnfalse｝通过roundEnv获取所有被AutoPipeline注释修饰的类，如果没有则直接返回遍历elements，处理每个element（被注解的类必须是public修饰的接口）生成源码门户：SourceGeneratorFacadegenSourceCode
　　生成相关源代码，一个源文件采用一个特定的代码生成器生成，各个类的生成器继承AbstractGenerator
　　源代码生成类：HandlerGeneratorgen
　　下面以HandlerGeneratorgen为例：fungen（）｛生成类valhandlerTypeBuilderTypeSpec。interfaceBuilder（desc。handlerRawClassName）。addTypeVariables（desc。entityDeclaredTypeVariables）。addModifiers（Modifier。PUBLIC）构建handlerContext参数valcontextParamParameterSpec。builder（desc。handlerContextTypeName，desc。handlerContextRawClassName。asFieldName（））。build（）为原来接口的每个方法额外添加handlerContext参数desc。entityMethods。forEach｛valoperationMethodcreateMethodSpecBuilder（it。executableElement）。addParameter（contextParam）。build（）handlerTypeBuilder。addMethod（operationMethod）｝生成源码javaFileBuilder（desc。handlerRawClassName。packageName（），handlerTypeBuilder。build（））。build（）。writeTo（filer）｝
　　编译Debug探秘
　　可以通过IdeaMaven自带的Debug工具调试编译过程在项目的mavencompile上右键，点击Debug｛moduleName｝在AutoPipelineProcessorprocess方法上加上断连，即可断点Debug源码
　　场景实战
　　下面举一个项目中真实的例子消息分级限流。
　　消息发送的流量现状：同一个请求可能包含有多个AppKey的消息同一个请求可能包含多个消息分级的消息同一个请求的消息可能经过多个接口每个消息都会有对应的Appkey、消息分级
　　限流规则如下：需要对消息所属的AppKey进行单独限流仅对营销类消息进行限流，IM实时类消息无需限流如果一个消息已经被一个接口限流过，经过下一个接口时不应该被限流对于同一个请求，只有整体限流和整体不限流两种情况，不允许部分成功部分失败的情况（历史遗留问题）
　　面对这种的场景，该如何设计呢？首先是将限流规则拆分成三个步骤：消息分级处理、去重处理、请求限流令牌处理将整体限流和整体不限流抽象成合并策略，通过proxy的方式对外暴露
　　代码设计如下：限流接口类消息限流器AutoPipelinepublicinterfaceMessageThrottler｛节流单个消息parammessageThrottlerToken消息限流令牌return是否被节流booleanthrottle（MessageThrottlerTokenmessageThrottlerToken）；节流多个消息。任意一个消息被节流将返回true，否则返回falseparammessageThrottlerTokens多个消息限流令牌return是否被节流booleananyThrottle（ListMessageThrottlerTokenmessageThrottlerTokens）；节流多个消息。所有消息被节流才会返回true，否则返回falseparammessageThrottlerTokens多个消息限流令牌return是否被节流booleanallThrottle（ListMessageThrottlerTokenmessageThrottlerTokens）；｝将限流规则拆分成三个不同的处理类ClassificationThrottlerHandler消息分类节流器p目前仅针对营销消息进行节流publicclassClassificationThrottlerHandlerimplementsMessageThrottlerHandler｛Overridepublicbooleanthrottle（MessageThrottlerTokenmessageThrottlerToken，MessageThrottlerHandlerContextcontext）｛if（！ClassificationConstant。MARKETING。equals（messageThrottlerToken。getClassification（）））｛returnfalse；｝returncontext。throttle（messageThrottlerToken）；｝OverridepublicbooleananyThrottle（ListMessageThrottlerTokenmessageThrottlerTokens，MessageThrottlerHandlerContextcontext）｛if（CollectionUtils。isEmpty（messageThrottlerTokens））｛returnfalse；｝获取营销消息ListMessageThrottlerTokenmarketingMessageThrottlerTokensmessageThrottlerTokens。stream（）。filter（messageThrottlerToken｛returnClassificationConstant。MARKETING。equals（messageThrottlerToken。getClassification（））；｝）。collect（Collectors。toList（））；如果营销消息为空，说明消息均不需要被限流，直接返回falseif（CollectionUtils。isEmpty（marketingMessageThrottlerTokens））｛returnfalse；｝returncontext。anyThrottle（marketingMessageThrottlerTokens）；｝OverridepublicbooleanallThrottle（ListMessageThrottlerTokenmessageThrottlerTokens，MessageThrottlerHandlerContextcontext）｛if（CollectionUtils。isEmpty（messageThrottlerTokens））｛returnfalse；｝获取营销消息ListMessageThrottlerTokenmarketingMessageThrottlerTokensmessageThrottlerTokens。stream（）。filter（messageThrottlerToken｛returnClassificationConstant。MARKETING。equals（messageThrottlerToken。getClassification（））；｝）。collect（Collectors。toList（））；存在非营销消息，非营销消息不会被限流if（marketingMessageThrottlerTokens。size（）messageThrottlerTokens。size（））｛returnfalse；｝returncontext。allThrottle（marketingMessageThrottlerTokens）；｝｝DuplicateThrottlerHandlerSlf4jpublicclassDuplicateThrottlerHandlerimplementsMessageThrottlerHandler｛Overridepublicbooleanthrottle（MessageThrottlerTokenmessageThrottlerToken，MessageThrottlerHandlerContextcontext）｛if（messageThrottlerToken。isThrottled（））｛returnfalse；｝booleanthrottleResultcontext。throttle（messageThrottlerToken）；messageThrottlerToken。markThrottled（）；returnthrottleResult；｝OverridepublicbooleananyThrottle（ListMessageThrottlerTokenmessageThrottlerTokens，MessageThrottlerHandlerContextcontext）｛if（CollectionUtils。isEmpty（messageThrottlerTokens））｛returnfalse；｝过滤掉已经被限流的消息ListMessageThrottlerTokenneedMessageThrottlerTokensmessageThrottlerTokens。stream（）。filter（messageThrottlerToken！messageThrottlerToken。isThrottled（））。collect（Collectors。toList（））；if（CollectionUtils。isEmpty（needMessageThrottlerTokens））｛returnfalse；｝booleanthrottleResultcontext。anyThrottle（needMessageThrottlerTokens）；needMessageThrottlerTokens。forEach（messageThrottlerTokenmessageThrottlerToken。markThrottled（））；returnthrottleResult；｝OverridepublicbooleanallThrottle（ListMessageThrottlerTokenmessageThrottlerTokens，MessageThrottlerHandlerContextcontext）｛if（CollectionUtils。isEmpty（messageThrottlerTokens））｛returnfalse；｝过滤掉已经被限流的消息ListMessageThrottlerTokenneedMessageThrottlerTokensmessageThrottlerTokens。stream（）。filter（messageThrottlerToken！messageThrottlerToken。isThrottled（））。collect（Collectors。toList（））；if（CollectionUtils。isEmpty（needMessageThrottlerTokens））｛returnfalse；｝booleanthrottleResultcontext。allThrottle（needMessageThrottlerTokens）；needMessageThrottlerTokens。forEach（messageThrottlerTokenmessageThrottlerToken。markThrottled（））；returnthrottleResult；｝｝AcquireThrottlerHandler请求令牌处理类publicclassAcquireThrottlerHandlerimplementsMessageThrottlerHandler｛privatestaticfinalLoggerapiThrottlerLogLoggerFactory。getLogger（api。throttler。log）；AutowiredprivateThrottlerProxythrottlerProxy；AutowiredprivateThrottlerModeConfigurationthrottlerModeConfiguration；privatebooleanthrottle（AcquireTokenacquireToken）｛获取限流模式ThrottlerModethrottlerModethrottlerModeConfiguration。getThrottlerMode（acquireToken。getAppKey（），acquireToken。getThrottleTag（））；执行限流return！throttlerProxy。tryAcquireWithAppKey（throttlerMode，acquireToken。getAppKey（），acquireToken。getPermits（））；｝Overridepublicbooleanthrottle（MessageThrottlerTokenmessageThrottlerToken，MessageThrottlerHandlerContextcontext）｛booleanthrottledthrottle（newAcquireToken（messageThrottlerToken。getThrottleTag（），messageThrottlerToken。getAppKey（），messageThrottlerToken。getPermits（）））；限流日志埋点if（SendSwitch。THROTTLERONLYWATCHthrottled）｛log（messageThrottlerToken。getAppKey（），messageThrottlerToken。getPermits（），messageThrottlerToken。getThrottleTag（），throttled）；｝returnthrottled；｝OverridepublicbooleananyThrottle（ListMessageThrottlerTokenmessageThrottlerTokens，MessageThrottlerHandlerContextcontext）｛returnthrottle（messageThrottlerTokens，acquireTokensacquireTokens。stream（）。anyMatch（this：：throttle））；｝OverridepublicbooleanallThrottle（ListMessageThrottlerTokenmessageThrottlerTokens，MessageThrottlerHandlerContextmessageThrottlerHandlerContext）｛returnthrottle（messageThrottlerTokens，acquireTokensacquireTokens。stream（）。allMatch（this：：throttle））；｝privatestaticbooleanthrottle（ListMessageThrottlerTokenmessageThrottlerTokens，FunctionList，Booleanfunction）｛if（CollectionUtils。isEmpty（messageThrottlerTokens））｛returnfalse；｝ListacquireTokensmessageThrottlerTokens。stream（）。collect（Collectors。groupingBy（messageThrottlerTokenmessageThrottlerToken。getAppKey（）））。entrySet（）。stream（）。map（messageEntry｛StringappKeymessageEntry。getKey（）；intpermitsmessageEntry。getValue（）。stream（）。map（messageThrottlerTokenmessageThrottlerToken。getPermits（））。reduce（Integer：：sum）。orElse（1）；StringthrottlerTagmessageEntry。getValue（）。get（0）。getThrottleTag（）；returnnewAcquireToken（throttlerTag，appKey，permits）；｝）。collect（Collectors。toList（））；booleanthrottledfunction。apply（acquireTokens）；限流日志埋点if（SendSwitch。THROTTLERONLYWATCHthrottled）｛messageThrottlerTokens。forEach（messageThrottlerToken｛log（messageThrottlerToken。getAppKey（），messageThrottlerToken。getPermits（），messageThrottlerToken。getThrottleTag（），throttled）；｝）；｝returnthrottled；｝privatestaticvoidlog（StringappKey，intpermits，StringthrottlerTag，booleanthrotted）｛ListStringmetricsnewArrayList（）；metrics。add（appKey）；metrics。add（String。valueOf（permits））；metrics。add（throttlerTag）；metrics。add（String。valueOf（throtted））；StringlogContentStringUtils。join（metrics，）；apiThrottlerLog。info（logContent）；｝DataAllArgsConstructorprivatestaticclassAcquireToken｛privatefinalStringthrottleTag；privatefinalStringappKey；privatefinalintpermits；｝｝消息限流代理消息限流代理Slf4jpublicclassMessageThrottlerProxy｛AutowiredprivateAcquireThrottlerHandleracquireThrottlerHandler；privateMessageThrottlermessageThrottler；PostConstructpublicvoidinit（）｛messageThrottlernewMessageThrottlerPipeline（）。addLast（newClassificationThrottlerHandler（））。addLast（newDuplicateThrottlerHandler（））。addLast（acquireThrottlerHandler）；｝限流单个消息parammessageThrottlerToken单个消息令牌return是否限流成功publicbooleanthrottle（MessageThrottlerTokenmessageThrottlerToken）｛if（！SendSwitch。ENABLEAPITHROTTLER）｛returnfalse；｝try｛booleanthrottledmessageThrottler。throttle（messageThrottlerToken）；returnSendSwitch。THROTTLERONLYWATCH？false：throttled；｝catch（Exceptione）｛log。error（FailedtothrottlemessageSendDTO：messageThrottlerToken，e）；throttle内部异常不应该影响正常请求，遇到此情况直接降级限流通过returnfalse；｝｝限流多个消息，合并策略可通过｛linkSendSwitchTHROTTLERMERGESTRATEGY｝开关控制parammessageThrottlerTokens多个消息令牌return是否限流成功publicbooleanthrottle（ListMessageThrottlerTokenmessageThrottlerTokens）｛if（！SendSwitch。ENABLEAPITHROTTLER）｛returnfalse；｝if（CollectionUtils。isEmpty（messageThrottlerTokens））｛returnfalse；｝MergeStrategymergeStrategyMergeStrategy。getByName（SendSwitch。THROTTLERMERGESTRATEGY）；if（mergeStrategynull）｛log。error（illegalthrottlermergeStrategy：SendSwitch。THROTTLERMERGESTRATEGY）；returnfalse；｝try｛booleanthrottledmergeStrategy。throttle（messageThrottler，messageThrottlerTokens）；returnSendSwitch。THROTTLERONLYWATCH？false：throttled；｝catch（Exceptione）｛log。error（FailedtothrottlemessageSendDTO：messageThrottlerTokens，e）；throttle内部异常不应该影响正常请求，遇到此情况直接降级限流通过returnfalse；｝｝publicenumMergeStrategy｛ALL｛Overridepublicbooleanthrottle（MessageThrottlermessageThrottler，ListMessageThrottlerTokenmessageThrottlerTokens）｛returnmessageThrottler。allThrottle（messageThrottlerTokens）；｝｝，ANY｛Overridepublicbooleanthrottle（MessageThrottlermessageThrottler，ListMessageThrottlerTokenmessageThrottlerTokens）｛returnmessageThrottler。anyThrottle（messageThrottlerTokens）；｝｝；publicstaticMergeStrategygetByName（Stringname）｛MergeStrategy〔〕valuesvalues（）；for（MergeStrategyvalue：values）｛if（value。name（）。equalsIgnoreCase（name））｛returnvalue；｝｝returnnull；｝publicabstractbooleanthrottle（MessageThrottlermessageThrottler，ListMessageThrottlerTokenmessageThrottlerTokens）；｝｝
　　ps：相关类并未全部列出，仅展示主要逻辑
　　原文链接：https：mp。weixin。qq。comswR0NByDFWs5RDgWS2Jn6yA