异步导入导出架构设计

我会带着你远行 2022-04-13 12:45 765阅读 0赞

# 异步导入导出架构设计 #

2018年04月27日 00:00:00 [架构文摘][Link 1] 阅读数：409

## **为什么要用异步？** ##

在我们平时的业务系统中，文件导入，文件导出是一个很常见的业务需求。正常情况下，同步导出就可以满足我们80%的需求。但是对于数据量大，业务拼接复杂的系统来说，导出超时，导入超时是不可避免的，而且是无法忍受的。异步能让业务线程在后台运行，没有等待时间，处理完成通知出来就行了。这种场景在现实生活中也很常见，比如医院里面拍CT，做体检时的体检报告，都是延后去拿结果的。

# #

## **异步导出的使用场景** ##

那什么时候会需要用到异步呢？统计、导入、导出、发送模板消息、订单状态变更后的复杂业务处理。

它们都有共同的特点：

1. 处理耗时长

2. 业务优先级低

3. 容易超时

4. 数据量大

# **文件导出** #

# #

## **异步导出的优缺点** ##

*  异步的优点：

它能解决导出超时问题，能大大的提高接口请求处理速度，提高吞吐量，提升系统性能

任何事情都有两面性，也许不具有绝对性，但是在这里是成立的。既然它有那么多优点，当然也会有缺点。

*  异步的缺点：

它比同步导出要复杂得多，接口多了几倍，所需服务器也要多，学习成本高，开发成本高

# #

## **架构图设计** ##

![640?wx\_fmt=png][640_wx_fmt_png]

## **架构解析** ##

按流程来：

1. 前端发出导出请求

2. 接口服务器接到请求并校验参数

3. 如果参数不符，直接弹出校验结果，流程结束！

4. 生成一个任务实体，状态设为处理中并将实体写入redis。开启异步线程，在异步方法中调用导出接口。返回给前端在处理中状态

5. 前端接受到已经在处理中返回值，开启ajax轮询，每隔10秒请求一次任务查询状态接口

6. 导出接口将数据拼接完成

7. 将数据传到文件服务器生成文件并返回url

8. 从redis中取出任务实体将url写入，并且将状态设为已完成并更新redis(后端处理流程就结束了)

9. 前端ajax请求发现返回值状态变成已完成后，取出url并停止轮询。

10. 前端请求清除任务实体接口，通过后端接口将redis中的对象移除。

11. 前端展示导出结果，自动下载或者手动点击可以根据业务来。

这里还有一个页面初始化的按钮变化流程。

1. 打开页面后导出按钮置灰不可点击

2. ajax请求查询任务状态接口，如果显示没有任务在进行中，那就让导出按钮可以点击。如果状态是导出已完成，则显示下载按钮相关页面

另外，为了防止意外出现redis死锁的情况，导致客户一直用不了导出功能，每个任务redis对象都有过期时间，设置为30分钟。也就是说，不管导出任务执行是否完成，30分钟后任务将放弃，用户可以再次点击导出按钮。

# #

## **数据来源** ##

![640?wx\_fmt=png][640_wx_fmt_png 1]

## **接口设计** ##

## ##

> ### 接口列表 ###

**1. 获取任务状态** getTaskStatus

返回实体TaskResultOut：

<table> 
 <tbody> 
  <tr> 
   <td>字段</td> 
   <td>l类型</td> 
   <td>是否可为空</td> 
   <td>注释</td> 
  </tr> 
  <tr> 
   <td> <pre>status</pre> </td> 
   <td>&nbsp;int</td> 
   <td>&nbsp;不，默认0</td> 
   <td>&nbsp;任务状态（0=未开始，1=进行中 2=已完成）</td> 
  </tr> 
  <tr> 
   <td>&nbsp; &nbsp;message</td> 
   <td>&nbsp;string</td> 
   <td>&nbsp;是</td> 
   <td>&nbsp;提示信息（正确或错误）</td> 
  </tr> 
  <tr> 
   <td>&nbsp; &nbsp;url</td> 
   <td>&nbsp;string</td> 
   <td>&nbsp;是</td> 
   <td>&nbsp;文件地址</td> 
  </tr> 
  <tr> 
   <td>&nbsp; &nbsp;state</td> 
   <td>&nbsp;bool</td> 
   <td>&nbsp;不,默认fasle</td> 
   <td>&nbsp;任务成功还是失败（y）</td> 
  </tr> 
 </tbody> 
</table>

**2. 注册导出任务（导出）** registerExportTask

返回true/false,表明是否注册成功

**3. 清除任务状态** clearTaskInfo

返回true/fasle,表明清除是否成功

# #

## **前端设计** ##

前端js由前端编写,具体的由于嵌套太深，就不贴出来了,在架构解析中已经说的很详细了。

> "export": function(e) \{  
> return t.post(r.api.form\["export"\], e, \{\})  
> \},  
> getTaskStatus: function(e) \{  
> return t.post(r.api.form.getTaskStatus, e, \{\})  
> \},  
> registerExportTask: function(e) \{  
> return t.post(r.api.form.registerExportTask, e, \{\})  
> \},  
> clearTaskInfo: function(e) \{  
> return t.post(r.api.form.clearTaskInfo, e, \{\})  
> \}

## **项目实际应用** ##

![640?wx\_fmt=png][640_wx_fmt_png 2]

![640?wx\_fmt=png][640_wx_fmt_png 3]

点击取消后

![640?wx\_fmt=png][640_wx_fmt_png 4]

![640?wx\_fmt=png][640_wx_fmt_png 5]

异步导出的整个流程和设计就全在这里了。

# **文件导入的设计** #

由于篇幅有限，且导入的流程大同小异。直接奉上一副设计图吧。

# #

## **多级异步导入方案** ##

##  ![640?wx\_fmt=png][640_wx_fmt_png 6] ##

## **最后** ##

代码是没有滴，东西是要自己创造滴！

**补充**

一些人说需要贴代码，但这个是涉及3个服务器的协作，（前端服务器，node层web服务器，纯后端接口服务器），代码太过于零散且没有多余的技术含量，无法贴上来，加上这套机制我在C\#大型电商项目和java的多个项目中都有部署应用。对于不同语言有不同的实现。就目前来说，在电商项目中稳定运行了一年多，它的可靠性已经得到了实际应用的考验。

服务器需求

组成这套系统最少要求（web服务器一台，接口服务器一台，redis服务器一台，文件服务器一台）

如果在java体系里面，前后端完全分离，且有服务器资源充足的情况下

前端服务器

node层服务器(集群)

后端接口层服务器(集群)

redis服务器

文件服务器

架构定位

对于小公司来说，服务器资源没有那么充足，可能实施起来有难度，且开发和学习成功较高

对于大型公司来说，对于大数据量和复杂业务的导出，可能早就有了成熟稳定的框架来支持，例如任务中心这种完善的异步消息来实现，具有高可用，可伸缩的等稳定性很强的系统，也用不到了，

因此这套架构适合于中型规模的公司

各层级职责解析

![640?wx\_fmt=png][640_wx_fmt_png 7]

node或者web

![640?wx\_fmt=png][640_wx_fmt_png 8]

> **出处：http://www.cnblogs.com/jingch/p/8832161.html**

版权申明：内容来源网络，版权归原创者所有。除非无法确认，我们都会标明作者及出处，如有侵权烦请告知，我们会立即删除并表示歉意。谢谢。

[Link 1]: https://me.csdn.net/uxiAD7442KMy1X86DtM3
[640_wx_fmt_png]: /images/20220413/8cb31be0699d4830bd84db15bec22fc3.png
[640_wx_fmt_png 1]: /images/20220413/36e3ba3b49b2429899c9f3b2a11aad20.png
[640_wx_fmt_png 2]: /images/20220413/998d8b2c5a8647559d885f173e9a42ff.png
[640_wx_fmt_png 3]: /images/20220413/dd44687efe144fd7802f8c800117b386.png
[640_wx_fmt_png 4]: /images/20220413/00791a0afeeb4ba8811e38bee4e9ed8b.png
[640_wx_fmt_png 5]: /images/20220413/1badc851b54044839ea4a18b8df41e7b.png
[640_wx_fmt_png 6]: /images/20220413/6bbd510762f4481aa7ab8e4c8518d3ec.png
[640_wx_fmt_png 7]: /images/20220413/78caa081958f4db4934c24ce4a29611b.png
[640_wx_fmt_png 8]: /images/20220413/2b054d26a179434988df78b777c3d183.png