# dactor **Repository Path**: handyun/dactor ## Basic Information - **Project Name**: dactor - **Description**: Dactor是基于Java的轻量级同步异步统一编程框架 - **Primary Language**: Java - **License**: Not specified - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 90 - **Forks**: 21 - **Created**: 2019-01-28 - **Last Updated**: 2025-06-16 ## Categories & Tags **Categories**: utils **Tags**: None ## README [![GitHub release](https://img.shields.io/github/release/allon2/dactor.svg)](https://github.com/allon2/dactor/releases) ![JDK](https://img.shields.io/badge/JDK-1.8-green.svg) ![Gradle](https://img.shields.io/badge/Gradle-6.2.2-green.svg) ![SpringBoot](https://img.shields.io/badge/SpringBoot-2.2.7.RELEASE-green.svg) ![Spring](https://img.shields.io/badge/Spring-5.2.6.RELEASE-green.svg) ![Servlet](https://img.shields.io/badge/Servlet-3.0-green.svg) # **DActor** ## Introduction DActor框架基于协程思想设计，可同时支持同步和异步代码，简化在线异步代码的开发，用同步代码的思维来开发异步代码，兼顾异步代码的高并发、无阻塞和同步代码的易读性，可维护性。 最大程度的降低阻塞，提高单个线程的处理能力，并可有效的降低线程数。 ## 项目地址 GitHub:https://github.com/allon2/dactor GitEE:https://gitee.com/handyun/dactor ## 文档 - 更新日志：[ChangeLog](https://github.com/allon2/dactor/wiki/ChangeLog) - 注解说明：[注解配置说明](https://github.com/allon2/dactor/wiki/%E6%B3%A8%E8%A7%A3%E8%AF%B4%E6%98%8E) - 视图配置说明:[视图配置说明](https://github.com/allon2/dactor/wiki/%E8%A7%86%E5%9B%BE%E9%85%8D%E7%BD%AE%E8%AF%B4%E6%98%8E) - SpringBoot Yml 配置说明:[Yml配置说明](https://github.com/allon2/dactor/wiki/Yml%E9%85%8D%E7%BD%AE%E8%AF%B4%E6%98%8E) - XML 配置说明:[XML配置说明](https://github.com/allon2/dactor/wiki/XML%E9%85%8D%E7%BD%AE%E8%AF%B4%E6%98%8E) - 常用类说明:[常用类说明](https://github.com/allon2/dactor/wiki/%E5%B8%B8%E7%94%A8%E7%B1%BB%E8%AF%B4%E6%98%8E) - 配置和API说明:[配置和API说明](https://github.com/allon2/dactor/wiki) - 更多文档详见：[WIKI](https://github.com/allon2/dactor/wiki) ## QQ交流群 783580303 ## 接入系统 - [Dpress](https://github.com/allon2/dpress)：基于Dactor构建的多域名博客系统 - 持续更新中。。欢迎大家自荐 ## Overview 目前开发过程中的几个常见模型 - 同步编程 所有步骤都在一个主线程中完成,调用一个方法，等待其响应返回。一个请求占用一个线程,在有数据库操作、TCP和Http通讯时因为有阻塞情况，会导致占用线程占用而无法及时释放 ，因此在同步交易中引入了线程池概念,提高系统的吞吐量 - 异步编程 所有步骤都可在不同线程中完成,调用一个方法，不等待响应既返回，典型交易如NodeJs。 目前市面上的异步框架都比较复杂，市面的通用解决方案是CallBack和Promise/Deferred模式模式。 ## 设计思路 - 为了保留异步的高性能,简化异步的开发模式，同时使得程序更容易被程序员理解，在性能和代码可阅读性中间取得平衡，设计了此框架。 - 处理步骤:将请求封装为消息,丢入消息队列，寻找合适步骤处理消息,上述过程不断循环，直到所有可用步骤都执行完毕。 因为是对消息队列进行处理,对于同步交易，处理完毕即可丢入消息队列。对于异步交易，等待回调完毕再丢入消息队列。 两种情况对于框架来说是无差别的。同时因为通过异步交易避免了阻塞情况的发生,所以可在不大幅度提高线程数的情况下，提高吞吐量， 同时也可在一定程度避免流量突增的情况发生。 - 消息队列采用Disruptor的的高性能队列RingBuffer。 - 以Actor协程并发模型为基础设计框架。 ## Features - 1、集成Netty - 2、集成HttpClient - 3、集成HttpServlet - 4、支持多层父子结构 - 5、支持责任链模式 - 6、J2EE支持json,csv,pdf,xml,html格式输出 - 7、J2EE支持数据流输出,动态文件下载、动态图片输出、跳转和可根据配置动态输出 - 8、同时支持SpringBoot和Spring ## 环境要求 - JDK 1.8 - Spring FrameWork 5.2.4.RELEASE + 或者 Spring Boot 2.2.7.RELEASE + - Servlet 3.0+(因为需要使用Servlet的异步功能) ### 注意事项 请求的完整逻辑是分散在不同的线程中执行的，所以尽量避免使用ThreadLocal ## Getting Started example是J2EE程序,下载后，可直接运行,其中集成了若干例子 默认使用.do提交相关交易，但如果是.json将会返回json数据 启动后,在浏览器中输入http://localhost:8080/example/randomTxt2.json 输出的是json格式的字符串 randomTxt2:只有一级父子关系 randomTxt1:有二级父子关系 chaintest1:只使用责任链 chaintest2:同时使用责任链和一级父子关系 exceptionTest:子交易抛出错误,框架对错误的处理 randomTxt3为beginBeanId为Actor标签的BeanId例子 httptest演示的是通过httpclient异步方式访问百度网站 访问URL:http://localhost:8080/example/ httptest.do http://localhost:8080/example/np.randomTxt2.json为使用命名空间的例子,相关配置在conf/namespace.xml中。 启动后，可在控制台看到内部调用结果 ![1.png](https://i.loli.net/2020/05/21/pFyl5fOS4zIPw1k.png) ### Maven dependency ```xml cn.ymotel dactor 1.1.2 ``` ### Gradle dependency ``` compile group: 'cn.ymotel', name: 'dactor', version:'1.1.2' ``` ### 代码简单讲解 执行过程为chain->grandfather->parent->Selft。 依次调用执行责任链中逻辑，grandfather中的逻辑，parent的逻辑和自身逻辑。 chain,grandfather,parent都可为空，不设置 在grandfather和parent中的Steps中至少有一个为placeholderActor交易，以调用子逻辑 整个过程中，需要先设置全局占位符 交易中如果未填写beginBeanId或者endBeanId时，系统默认使用全局中配置的beginBeanId或者endBeanId ``` ``` condtion可为空，空字符串，或者是ognl表达式 placeholderActor的作用是在暂存当前环境，并调用子交易，待子交易执行完毕后，再恢复当前环境继续执行 如果在Step中未找到toBeanIdActor，会直接调用endBeanId方法，认为自身交易已执行结束。 交易的请求和流转信息都保存在Message中 如果指定handleException=false或者使用默认设置，直接返回父中执行，如果父中也未捕获，则继续返回上一级执行， 一般来说至少有要有一个actor中指定handleException=true 启动框架接收和执行请求 # **同步异步写法** ## 同步写法 ``` public class BeginActor implements Actor { /* (non-Javadoc) * @see com.ymotel.util.actor.Actor#HandleMessage(com.ymotel.util.actor.Message) */ @Override public Object HandleMessage(Message message) throws Exception { return message; } } ``` 继承Actor接口，在HandlerMessage返回message方法，框架判断返回不为空的情况下，直接将结果丢给框架进行下一步出来 ## 异步写法 以HttpClientActor为例,在HandlerMessage中最后返回null，框架收到请求后等待下一步处理，释放线程，在HttpClient中的CallBack中调用 message.getControlMessage().getMessageDispatcher().sendMessage(message);框架收到后进行下一步处理。 ``` public Object HandleMessage(final Message message) throws Exception { Map context = message.getContext(); // HttpUriRequest request = getHttpBuild(message.getContext()).build(); if (referer != null) { request.addHeader("Referer", referer); } /** * 通过此处可共用会话，进行类似登录后交易 */ HttpClientContext tmplocalContext = null; if (context.containsKey(HTTPCLIENT_CONTEXT)) { tmplocalContext = (HttpClientContext) context.get(HTTPCLIENT_CONTEXT); } else { tmplocalContext = HttpClientContext.create(); CookieStore cookieStore = new BasicCookieStore(); tmplocalContext.setCookieStore(cookieStore); context.put(HTTPCLIENT_CONTEXT, tmplocalContext); } final HttpClientContext localContext = tmplocalContext; // CookieStore cookieStore = new BasicCookieStore(); // localContext.setCookieStore(cookieStore); if (logger.isInfoEnabled()) { logger.info("HandleMessage(Message) - httpclient----" + request); //$NON-NLS-1$ } // final HttpGet httpget = new HttpGet(uri); final String tmpcontent = content; final String tmpcharset = charset != null ? charset : (String) context.get(CHARSET); httpClientHelper.getHttpclient().execute(request, localContext, new FutureCallback() { public void completed(final HttpResponse response) { try { /** * 完成后及时清除 */ message.getContext().remove(tmpcontent); actorHttpClientResponse.handleResponse(response, localContext, tmpcharset, message); // String responseString=HandleResponse((String)message.getContext().get(CHARSET),response); // message.getContext().put(RESPONSE, responseString); } catch (Exception e) { // TODO Auto-generated catch block if (logger.isErrorEnabled()) { logger.error("$FutureCallback.completed(HttpResponse)", e); //$NON-NLS-1$ } message.setException(e); message.getControlMessage().getMessageDispatcher().sendMessage(message); } // System.out.println(httpget.getRequestLine() + "->" + response.getStatusLine()); } public void failed(final Exception ex) { if (logger.isErrorEnabled()) { logger.error("$FutureCallback.failed(Exception)", ex); //$NON-NLS-1$ } message.setException(ex); message.getControlMessage().getMessageDispatcher().sendMessage(message); // System.out.println(httpget.getRequestLine() + "->" + ex); } public void cancelled() { Exception exception = new Exception("已取消"); message.setException(exception); message.getControlMessage().getMessageDispatcher().sendMessage(message); // System.out.println(httpget.getRequestLine() + " cancelled"); } }); return null; } ``` # **配置和API说明** ## 配置说明 通过在xml中的Step实现内部Actor之间的流程跳转 在配置文件中包含 Actor、chain、和global配置 。 程序整个执行顺序为根据交易码找到对应的Actor,然后执行按照chain->parent->selft的顺序进行执行。 chain执行到placeholder处,调用parent交易继续执行,在parent交易中执行到placeholder交易后，调用selft自身交易继续执行。 自身交易执行完毕，弹出parent的placeholder处交易继续执行.parent执行完毕,弹出chain中代码继续执行。 global配置如下 ``` ``` beginBeanId为默认的开始Actor,value中的值是在Spring中对应的beanName，程序初始化时将会取得此值，对未指定beginBeanId或者endBeanId的Actor初始化全局配置。 beginActor和endActor都需要继承Actor接口。 actor配置如下 ``` htmlstream: ``` 属性handleException如果不设置的话,遇到异常,程序将会认为子类中已经执行完毕,跳到parent中PlaceHolder处执行。设置为true，将不会直接跳转到parent中，由子类进行自我处理。 parent和chain为调用具体交易前需要调用的公共交易，由于大部分交易都有通用的前置交易和统一的后置交易。通过设置parent或者chain，可提高代码复用度。 fromBeanId和toBeanId配置的是Actor或者实现Actor接口的beanId。 parent和chain中的ref都需要是Actor. results中可定义返回的state和需要处理的viewActor async标记是否是旁路交易，默认值为false，为true值时,会将上下文内容设置复制一份，重新生成一份Message,进行执行，不影响主流程。 chain配置 ``` ``` chain可直观展现Actor调用顺序. 在chain中可顺序并列多个parent类。每个parent中的Step都需要有placeHolderActor，以调用子类。 依次执行list中的交易，再执行自身交易。自身交易执行完毕，再依次回溯责任链中的每个交易，直到无可用交易。 命名空间 ``` ``` 在actor中可增加命名空间，简化代码开发。在actor中配置namespace=np,则实例中的actor的id会自动拼装为np.randomTxt2 http://localhost:8080/example/np.randomTxt2.json为使用命名空间的例子,相关配置在conf/namespace.xml中。 ## 重要类方法说明 cn.ymotel.dactor.core.MessageDispatcher是交易流转的核心接口类 public void startMessage(Message message, ActorTransactionCfg actorcfg, boolean blocked) throws Exception 方法,用于开始整个流程，其中message需要在执行前进行构造，actorcfg可通过spring的getBean方法得到为Actor对象，如下 ``` ``` 通过getBean('randomTxt1')即可得到ActorTransactionCfg对象。 blocked为是否阻塞，一般在交易初次放入队列是为false,表示如果队列满，则直接扔给客户端进行处理。为true则一般为内部交易,必须提交给队列进行处理。 sendMessage方法内部调用，用于将处理完毕的Message重新放入队列，继续下一步流程。 cn.ymotel.dactor.core.disruptor.MessageRingBufferDispatcher是MessageDispatcher的接口实现类。,在启动Spring是需要在配置中加上 ``` ``` MessageRingBufferDispatcher的strategy、bufferSize、threadNumber为三个可设置属性.正常情况下使用默认设置即可。 strategy默认使用ringBuffer的BlockingWaitStrategy策略进行调度，如果交易量比较大，可调整此策略。 bufferSize默认使用1024。 threadNumber默认使用CPU个数的线程数。 ## 其他默认Actor说明 cn.ymotel.dactor.message.Message.Actor,所有需要在执行的交易都必须继承此接口。 public Object HandleMessage(Message message) throws Exception;程序通过调用HandleMessage对象,如果返回的不是message对象或者为NULL,则认为此交易是异步执行,不再自行调度。由异步交易在收到请求后，自己调用将Message再此放入队列中。 cn.ymotel.dactor.action.PlaceholderActor 交易为特殊交易，用来将当前队列暂存，并调用子交易。 cn.ymotel.dactor.action.BeginActor 为Actor中step的默认开始交易。 cn.ymotel.dactor.action.EndActor 为Actor中step的默认结束交易。 cn.ymotel.dactor.action.JsonViewResolverActor为需要返回Json的J2EE view cn.ymotel.dactor.action.ViewResolveActor为需要返回J2EE view的统一处理Actor cn.ymotel.dactor.action.httpclient.HttpClientActor 提供的异步调用httpClient的Actor cn.ymotel.dactor.action.netty.aysnsocket.TcpClientActor 提供的异步调用netty的Actor ## 交易流程举例说明 ``` ``` 以上交易的交易流程图如下 ![randomTxt2.png](https://i.loli.net/2020/05/21/gP3jKls72BVxvNY.png) 以上的完整例子都可在example中得到