克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

框架说明

一 背景

概述

在单体/微服务应用下,随着业务的复杂度不断提高,业务功能不断迭代,在保证业务快速发展的前提下,如何写出更可靠、复用的代码成为了难题,为了尝试解决该问题,衍生出了一套自己的方法.
主要想解决以下业务中碰到的一些问题
1、业务核心流程不清晰
2、业务核心功能不清晰,导致开发时到处写if
3、边界混乱,业务和业务、业务和技术相互依赖
5、缺乏系统性的规范,如异常、code等
6、开发不规范

本方案主要是使用单体应用内,尝试解决的是单体内问题。

目标

业务:领域编排 可插拔(易拓展) 稳定 易用 复用
技术:ddd spring netty pool thread engine zk redis lock tree dag  

二 DDD的基本结构

DDD的整体架构如下

img.png

具体编程规范可以参考 com.yilun.gl.dof.excute.framework.ddd的分包

三 编排核心结构

画了个示意图 实在没想好怎么画合适

img_2.png

四 使用说明

一、引入相关starter依赖

    <dependency>
        <groupId>org.gl.dof</groupId>
        <artifactId>biz-dof-spring-boot-starter</artifactId>
        <version>1.0.1</version>
        <!-- 参考Releases包 dof-1.0.1 -->
    </dependency>

二、自定义业务逻辑的处理-编排组件

实现父接口 
1、com.gl.dof.core.excute.framework.logic.DomainService
2、com.gl.dof.core.excute.framework.logic.AggregateService
其核心方法如下
/**
 * 领域服务
 * 使用建议 具体业务应用(即application层)编排则应该基于该接口进行编排 
 */
public interface DomainService{
    /**
    * 执行操作,判断当前领域服务是否应该执行
    */
    boolean  isMatch(HandleContext context);
    /**
    * 业务逻辑实现处,实际写业务逻辑的地方,建议是对聚合根进行编排
    */
    LogicResult doLogic(HandleContext context);
    /**
    * 回滚操作,当doLogic执行失败,或者主链路失败时的回滚操作
    */
    void reverse(HandleContext context, LogicResult logicResult);
}
/**
 * 聚合服务 领域服务的子接口
 * 使用建议 如果在【领域服务】内需要处理子编排,则应该继承该接口
 */
public interface AggregateService{
    /**
    * 执行操作,判断当前领域服务是否应该执行
    */
    boolean  isMatch(HandleContext context);
    /**
    * 业务逻辑实现处,实际写业务逻辑的地方,建议是对聚合根进行编排
    */
    LogicResult doLogic(HandleContext context);
    /**
    * 回滚操作,当doLogic执行失败,或者主链路失败时的回滚操作
    */
    void reverse(HandleContext context, LogicResult logicResult);
}

eg.AddressDoSvr中默认bean的名字是addressDoSvr,这个bean的命名很重要 接下来会用到

@Component
public class AddressDoSvr implements DomainService {
	public static String addressKey = "address";
	public static String addressKey2 = "address2";
	@Override
	public boolean isMatch(HandleContext context) {
		return true;
	}
	@Override
	public LogicResult doLogic(HandleContext context) {

		String address = "北京市海淀区";
		String address2 = "北京市海淀区quququq";

		context.attr(String.class, addressKey).set(address);
		context.attr(String.class, addressKey2).set(address2);
		return LogicResult.createSuccess();
	}
}

三、使用application

在需要使用bean的地方引入属性 private DofExecutor<REQ, RES> ,并用注解@DofReference指定功能和编排逻辑,如下所示

public class EntryTest {
		@DofReference(funcKey="test1",logicFlow ="[addressDoSvr,channelDoSvr]," +
		"grayDoSvr,libraDoSvr," +
		"[nameDoSvr,persionSelectDoSvr]," +
		"responseDoSvr, spaceDoSvr,strategyResponseDataDoSvr, tripDoSvr")
        private DofExecutor<TestRequest, TestResponse> test1;

        @DofReference(funcKey="test2",useCommonPool = false, corePoolSize = 20, logicFlow ="[addressDoSvr,channelDoSvr]," +
		"grayDoSvr,libraDoSvr," +
		"[nameDoSvr,persionSelectDoSvr]," +
		"responseDoSvr, spaceDoSvr,strategyResponseDataDoSvr, tripDoSvr")
        private DofExecutor<TestRequest, TestResponse> test2;
}

然后使用 DofExecutor接口中的方法doLogicSchedule 即可完成整次调用,完整代码如下

@RestController
@Slf4j
public class EntryTest {
	@DofReference(funcKey="test1",logicFlow ="[addressDoSvr,channelDoSvr]," +
			"grayDoSvr,libraDoSvr," +
			"[nameDoSvr,persionSelectDoSvr]," +
			"responseDoSvr, spaceDoSvr,strategyResponseDataDoSvr, tripDoSvr")
	private DofExecutor<TestRequest, TestResponse> test1;

	@GetMapping(path = "/get/test")
	public void entryTest(){
		TestRequest testRequest = new TestRequest();
		testRequest.setName("汤姆");
		TestResponse testResponse = test1.doLogicSchedule(new Input<TestRequest>() {
			@Override
			public void doIn(HandleContext ctx) {
				ctx.attr(TestRequest.class).set(testRequest);
			}
		}, new Output<TestResponse>() {
			@Override
			public TestResponse doOut(HandleContext ctx, LogicResult logicResult) {
				if(ctx.hasAttr(TestResponse.class)){
					return ctx.attr(TestResponse.class).get();
				}
				return null;
			}
		});
		log.info("EntryTest_someThing2Application_TestResponse2={} ", testResponse);
		Assert.assertNotNull(testResponse);
	}
}

五、补充-@DofReference说明

子编排中可以继续使用-@DofReference注解.

funcKey:    编排功能的标识key,当一个key在多个bean中使用时,为了保证编排流程(logicFlow)的一致性
            【建议】提取出该key和编排流程(logicFlow)到配置文件或者单独bean对象里面
logicFlow: 编排流程 目前仅支持英文 , 和 []。其中 ,表示前后是串行执行,[]内部的表示并行执行,[]内部也可以用,分隔
            【注】如果想编排子逻辑,只需要再次使用该注解即可
            当【logicFlow = ""】时,会根据funcKey从默认的配置文件中找到value,eg.「dof.logicflow.funcKey=logicFlow」也就是针对funcKey中的【建议】用法
dof:
  logicflow:
    test3: "[addressDoSvr,channelDoSvr],grayDoSvr,libraDoSvr,[nameDoSvr,persionSelectDoSvr],responseDoSvr, spaceDoSvr,strategyResponseDataDoSvr, tripDoSvr"
    test4: "[addressDoSvr,channelDoSvr],grayDoSvr,libraDoSvr,[nameDoSvr,persionSelectDoSvr],responseDoSvr, spaceDoSvr,strategyResponseDataDoSvr, tripDoSvr"
public class Test{
	@DofReference(funcKey="test3",logicFlow ="")
	private DofExecutor<TestRequest, TestResponse> test3;
}
execTypeSel:编排引擎 当前只支持类树结构
corePoolSize:编排引擎的线程池的核心线程池数量,当有多个编排配置了corePoolSize,则会取[Max(corePoolSize)]
useCommonPool:是否使用通用线程池,如果不使用,会以funcKey作为新线程池的唯一标识,核心线程数则使用corePoolSize

五、补充-DofExecutor<REQ, RES>说明

 固定注入的属性,目前限定了只有一个方法#doLogicSchedule,泛型为改方法的出入参,具体转换可使用HandleContext进行转换
 其中的Input<TestRequest>和Output<TestResponse>则是使用了接口,来保证出入参到HandleContext下文中的转换

五、补充-HandleContext

继承自 AttributeMap,有如下关键方法
public interface HandleContext extends AttributeMap{
	public <T> Attribute<T> attr(Class<T> c);
	public <T> Attribute<T> attr(String beanId);
	public <T> Attribute<T> attr(Class<T> c, String alias);
	public <T> boolean hasAttr(Class<T> c);
	public <T> boolean hasAttr(String beanId);
	public <T> boolean hasAttr(Class<T> c, String alias);
}
用来获取HandleContext上下中的一些对象,线程安全,使用实例如下
public class Example {
	public void case_setCtx(HandleContext ctx, LogicResult logicResult) {
		//将一个新对象放入到上下中
		TestRequest testRequest = new TestRequest();
		ctx.attr(TestRequest.class).set(testRequest);
		//放入一个String,由于HandleContext使用map的形式,且用类的全路径作为key,
        // 当上下文中需要同一个类的两个对象时,这个时候需要使用别名来定义
        String key1 = "test";
		String key2 = "test2";
		ctx.attr(String.class, key1).set(key1);
		ctx.attr(String.class, key2).set(key2);
	}
	public void case_getCtx(HandleContext ctx, LogicResult logicResult) {
		//从上下文中getTestRequest对象
		TestRequest testRequest = ctx.attr(TestRequest.class).get();
		TestRequest testRequest2 = ctx.attr(TestRequest.class, testRequest2).get();
		//get一个String
		String key1 = ctx.attr(String.class, key1).get();
		String key2 = ctx.attr(String.class, key2).get();
	}
}

五、补充-TreeApplicationExecutor

编排执行器,是父接口 LogicExecutor 的树结构的一种实现,有如下关键方法
    LogicResult doLogicSchedule(HandleContext ctx);

五 使用示例

单侧启动

由于使用了jdk17 单侧启动需要增加参数--add-opens java.base/java.lang=ALL-UNNAMED 已调整成jdk8

启动类

com.yilun.gl.dof.excute.framework.usage.client.EntryTest.entryTest

构建流程类

com.yilun.gl.dof.excute.framework.application.SomeThingApplication

六 其他

1、如何实现DagApplicationExecutor,将编排框架升级为有向无换图结构,可以更加的灵活的编排领域服务?

2、如何更加优雅的使用大的context,全局使用一个大的上下文数据结构不是很优雅??

dof-0.0.1:采用全局context 需要使用者自己继承context,添加自己需要属性

该方式经过实际验证,详细使用实例在tag[dof-0.0.1]上面

最新master:采用AttributeMap的形式去构建,参考netty

目前基本开发完成

3、目前框架实现的编排领域服务,是否有必要对聚合根进行编排??

七 Releases版本说明

dof-0.0.1 非注解版本-第一版源代码码
dof-1.0.1 最新注解版本,支持@DofReference和HandleContext使用
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

单体应用内可灵活编排业务逻辑,详见https://gitee.com/hughyixuan/dof 展开 收起
取消

发行版

暂无发行版

贡献者

全部

近期动态

不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化