C# 网络连接之文件并发下载的多线程下载演示

一、设计

1、并发下载任务管理

并发控制：设计一个DownLoadFile类通过使用多线程来管理多个并发下载任务。每个下载任务都在一个单独的线程中执行，从而实现并发控制。允许同时下载多个文件，提高下载效率。

任务队列：在DownLoadFile类中的设计一个线程列表list，充当了一个任务队列的角色。这个列表维护了当前正在执行或等待执行的下载任务。通过AddDown方法，可以将新的下载任务添加到这个“队列”中。

public int ThreadNum = 3;
List<Thread> list = new List<Thread>();

public DownLoadFile()//DownLoadFile的构造函数
{
    doSendMsg += Change;
//这一行将Change方法作为事件处理程序添加到doSendMsg事件上。
//意味着每当doSendMsg事件被触发时，Change方法都会被调用。
}

public void AddDown(string DownUrl,string Dir, int Id = 0,string FileName="")
//向线程列表list中添加一个新的下载任务线程
{
    Thread tsk = new Thread(() =>
    {
        download(DownUrl, Dir, FileName,Id);
    });
    list.Add(tsk);
//创建一个新的线程tsk，该线程的目标方法是download，该方法预期会处理实际的下载逻辑。
//将新创建的线程添加到线程列表list中。
}
//DownUrl：下载链接。
//Dir：下载文件的目标目录。
//Id（可选）：下载任务的ID，默认为0。
//FileName（可选）：下载文件的名称，如果未指定，可能需要在download方法内部根据DownUrl确定。

public void StartDown(int StartNum = 3)  
{  
    for (int i2 = 0; i2 < StartNum; i2++)  
    {  
        lock (list)  
        {  
            for (int i = 0; i < list.Count; i++)  
            {  
                if (list[i].ThreadState == System.Threading.ThreadState.Unstarted || list[i].ThreadState == ThreadState.Suspended)  
                {  
                    list[i].Start();  
                    break;  
                }  
            }  
        }  
    }  
}
//外层循环尝试启动StartNum个线程。
//使用lock关键字对线程列表list进行同步，确保在多线程环境中访问列表时的线程安全。
//内层循环遍历线程列表，检查每个线程的状态。
//如果线程的状态是Unstarted（未启动）或Suspended（已挂起），则启动该线程，并跳出内层循环（break）。

2、事件处理

事件处理：通过事件或回调来处理下载过程中的各种状态变化（如开始、进度更新、完成等），并更新UI。

DownLoadFile类使用doSendMsg事件和dlgSendMsg委托来处理这些状态变化。当下载开始、进度更新、完成或发生错误时，这个事件会被触发，通知监听者（如UI层）进行相应的更新。

private void Change(DownMsg msg)//事件处理程序Change的定义
{
    if (msg.Tag==DownStatus.Error||msg.Tag==DownStatus.End)
    {
        StartDown(1);
    }
}

//在方法体内，有一个条件判断：
if (msg.Tag == DownStatus.Error || msg.Tag == DownStatus.End)：这个条件检查msg对象的Tag属性是否等于DownStatus.Error（表示下载错误）或DownStatus.End（表示下载结束）。
如果条件为真，则调用StartDown(1);方法。

3、执行下载任务 

执行下载任务 ：设计download方法执行文件下载任务

private void download(string path, string dir, string filename, int id = 0)

• path：要下载的文件的URL或路径。
• dir：下载后文件的保存目录。
• filename：下载后文件的名称。如果未指定，可能需要在方法内部确定。
• id（可选）：下载任务的唯一标识符，用于跟踪和识别不同的下载任务。

1.初始化消息对象：

• 创建一个DownMsg类型的实例msg，用于传递下载相关的信息。

• 设置msg的Id和Tag属性。

  DownMsg msg = new DownMsg();
  msg.Id = id;
  msg.Tag = 0;

2.触发开始事件：

• 调用事件doSendMsg，传递msg对象，通知其他部分下载任务已经开始。

 doSendMsg(msg);

3.创建下载器实例：

• 创建一个FileDownloader类的实例loader，用于执行实际的下载操作。

• 传入下载路径、目录、文件名和线程数等参数。

• 清除loader的数据（可能是之前的下载信息）。

 FileDownloader loader = new FileDownloader(path, dir, filename, ThreadNum);
 loader.data.Clear();

4.更新消息状态：

• 设置msg的Tag属性为DownStatus.Start，表示下载已经开始。

• 调用loader.getFileSize()方法获取文件大小，并将其转换为整数类型赋值给msg.Length。

• 再次调用事件doSendMsg，传递更新后的msg对象，通知其他部分文件大小已经获取。

 msg.Tag = DownStatus.Start;
 msg.Length = (int)loader.getFileSize(); ;
 doSendMsg(msg);

5.设置进度监听器：

• 创建一个DownloadProgressListener类的实例linstenter，用于监听下载进度。

• 将doSendMsg事件与监听器的内部事件处理程序关联起来，这样监听器就可以在下载过程中发送进度更新。

• 调用loader.download(linstenter)开始下载，并将监听器传递给下载器。

 DownloadProgressListener linstenter = new DownloadProgressListener(msg);
 linstenter.doSendMsg = new DownloadProgressListener.dlgSendMsg(doSendMsg);
 loader.download(linstenter);

 6.异常处理：

在download方法中，使用try-catch结构来捕获和处理可能发生的异常。当发生网络错误、文件写入错误等异常情况时，这些错误会被捕获，并通过doSendMsg事件发送包含错误信息的DownMsg对象。这样，UI层或其他监听者可以接收到错误通知，并采取相应的处理措施。

 catch (Exception ex)
 {
     DownMsg msg = new DownMsg();
     msg.Id = id;
     msg.Length = 0;
     msg.Tag =DownStatus.Error;
     msg.ErrMessage = ex.Message;
     doSendMsg(msg);
    
     Console.WriteLine(ex.Message);
 }

• 如果在下载过程中发生异常，捕获异常ex。

• 创建一个新的DownMsg实例msg，并设置其属性以反映下载失败。

• 设置msg.Tag为DownStatus.Error，表示下载失败。

• 设置msg.ErrMessage为异常的消息字符串。

• 调用事件doSendMsg，传递失败信息的msg对象，通知其他部分下载失败。

• 使用Console.WriteLine(ex.Message)在控制台打印异常信息，以便于调试和排查问题。

4、用户界面

用户界面：设计一个图形用户界面，允许用户查看下载进度、暂停、恢复或取消下载。通过Windows Forms进行展示

设计一个测试button，当用户点击一个名为btnTest的按钮时，程序会执行以下操作：

• 读取下载信息

• 解析文本行：遍历每一行文本，并使用|字符作为分隔符将其拆分为一个字符串数组。如果每行包含两个由|分隔的部分（即数组长度为2），则进行下一步操作。

• 处理下载路径和文件名：

  • 对第二部分进行URI转义处理，确保URL的有效性。
  • 使用Path.GetFileName方法从转义后的URL或路径中获取文件名。

• 指定保存目录：指定一个固定的目录作为下载文件的保存位置。

• 更新列表视图：

  在listView1控件中添加一个新的列表项，并为这个列表项设置多个子项，包括下载文件的序号、文件名、下载状态（初始为“等待中”）、文件的原始URL或路径等。

• 添加下载任务：调用DownLoadFile实例（dlf）的AddDown方法，将下载任务添加到下载队列中。传递的参数包括文件的下载路径、保存目录、以及列表视图中对应列表项的ID等。

• 开始下载：最后，调用dlf.StartDown方法来启动所有已添加到下载队列中的下载任务。

总结：整个流程涉及读取下载信息、解析和准备下载文件的相关信息、更新用户界面以显示下载列表，并最终启动实际的下载任务。这个过程中，DownLoadFile类扮演了下载任务管理的角色，负责处理实际的文件下载逻辑，并在下载状态改变时更新列表视图中的相关信息。

二、分析

1、Form1_Load：这个方法在窗体加载时被调用。

1. 设置下载线程数：

   dlf.ThreadNum = 3; 

2. 注册下载过程处理事件：

   dlf.doSendMsg += SendMsgHander;

    这行代码将SendMsgHander方法注册为DownLoadFile实例（dlf）的下载过程处理事件的回调方法。当下载过程中的某个事件发生时（例如开始下载、下载完成等），dlf会调用这个回调方法，并传递一个DownMsg对象作为参数

2、SendMsgHander：这个方法是下载过程处理事件的回调方法，用于处理从DownLoadFile实例接收到的消息。

• 方法参数：它接受一个DownMsg对象（msg）作为参数，该对象包含了关于下载任务的信息，如文件ID、下载状态、进度等。

• switch语句：根据msg.Tag（下载状态）的值执行不同的操作。

  • DownStatus.Start：下载开始，更新列表视图中的对应项。
  • DownStatus.GetLength：获取文件长度或连接成功。
  • DownStatus.End 或 DownStatus.DownLoad：下载结束或正在进行中。这个操作更新列表视图中的多个子项，包括文件大小、下载进度、剩余时间、下载速度以及下载状态（进行中或已完成）。
  • DownStatus.Error：下载失败，更新列表视图中的对应项。

结果展示：