C# 基础知识系列- 17 小工具优化

程序员小高

发布于 2020-05-14 15:12:14

5910

发布于 2020-05-14 15:12:14

文章被收录于专栏：不做码农的开发者

0. 前言

不知道有没有动手能力强的小伙伴照着上一篇的内容写过程序呢？如果有的话，应该会在使用的时候发现以下几个问题：

每次启动都需要经过漫长的时间去遍历磁盘里的文件目录
因为数据是用的字典保存的，所以会消耗大量的内存空间
不能多次查询

现在我们就针对这些问题，让我们的小工具实用起来。

1. 分析与实现

在动手之前，我们先分析一下问题。在实际开发之前，无论是接到什么需求都要先仔细分析一下，确定好方案再动手方为开发的正道。嗯，没毛病。因为开发过程中跟产品对线、跟客户对线要占整个项目的一半左右时间。好了，不废话了。继续：

遍历文件目录的时间过长，那么我们是不是可以用异步并发去遍历呢？

数据用字典保存会消耗内存空间，那么我们是不是可以用其他的方式保存呢？

不能多次查询，是不是可以使用循环，然后设置一个退出条件？

1.1 C#的异步/并发实现

在C#里，异步和并发的实现是依据线程、任务来实现的。在之前《C# 基础知识系列- 12 任务和多线程》里大概介绍了一下线程和任务，我们知道线程本身是没法返回数据的，它与主线程进行数据交互的过程十分需要注意线程安全。而任务可以返回数据，不需要像线程一样小心翼翼地与主线程进行数据交互。任务有一个优点，它比线程更轻量，所以在当前环境下我们可以试试任务。

当然，线程也有优点，那就是线程的运行环境相对更封闭一点，它能完成一个长的大型运算。

那么继续上一篇的内容，先引用：

using System.Threading.Tasks;

先提取一组根据可枚举目录集合创建任务组并取得结果的方法：

public static Dictionary<string,List<string>> OverDirectories(IEnumerable<DirectoryInfo> directories)
{
    var tasks = directories.Select(dir => Task.Run(()=>OverDirectories(dir))).ToArray();
    Task.WaitAll(tasks);// 这行的意思是等待所有任务完成
    return Concat(tasks.Select(t=>t.Result).ToArray());
}

然后改造原有的OverDirectories方法：

public static Dictionary<string,List<string>> OverDirectories(DirectoryInfo rootDirectory)
{
    Console.WriteLine($"正在遍历目录：{rootDirectory.FullName}");
    var dict = new Dictionary<string, List<string>>();
    IEnumerable<FileInfo> files = new List<FileInfo>();
    try
    {
        files = rootDirectory.EnumerateFiles();
    }
    catch(Exception e)
    {
        Console.WriteLine($"错误信息：{e}");//打印错误信息
    }

    foreach(var file in files)
    {
        var key = Path.GetFileNameWithoutExtension(file.Name);
        if(!dict.ContainsKey(key))
        {
            dict[key] = new List<string>();
        }
        dict[key].Add(file.FullName);
    }
    try
    {
        var dirs = rootDirectory.EnumerateDirectories();
        return Concat(dict, OverDirectories(dirs));// 采用线程版的方法进行遍历
    }
    catch (System.Exception e)
    {
        Console.WriteLine($"错误信息：{e}");//打印错误信息
    }
    return dict;
}

1.2 数据复用

理想状态下，我们的数据应该是保存在数据库的，但因为数据库的操作是在下一系列的教程中，所以目前只能舍弃这个设想。

那么，利用现有方式，我们可以使用文件作为缓存的方式，也就是说把数据保存在文件里，在需要的时候从文件中读取出来。这时候就需要一组操作文件的方法。

首先，声明一个静态变量：

public static readonly string TempFile = "temp.txt";

然后编写读取、存放数据的方法：

public static void WriteLinesToTemp(List<string> lines){
    File.AppendAllLines(TempFile, lines);
}

public static List<string> Search(string file)
{
    var lines = File.ReadLines(file);
    var results = lines.Where(line=>Path.GetFileNameWithoutExtension(line).Contains(file));
    return results.ToList();
}

这时候在文件中存放的都是路径文件，所以需要重新修改遍历文件路径的方法，只保留路径：

public static List<string> OverDirectories(DirectoryInfo rootDirectory)
{
    Console.WriteLine($"正在遍历目录：{rootDirectory.FullName}");
    List<string> files = new List<string>();
    try
    {
        files.AddRange(rootDirectory.GetFiles().Select(f=>f.FullName).ToList());
        Console.WriteLine($"在目录：{rootDirectory.FullName} 下 找到 文件：{files.Count} 个");
    }
    catch(Exception e)
    {
        Console.WriteLine($"加载目录：{rootDirectory.FullName} 中\t错误信息：{e}");//打印错误信息
    }
    try
    {
        var dirs = rootDirectory.GetDirectories();
        OverDirectories(dirs);
    }
    catch (System.Exception e)
    {
        Console.WriteLine($"在下探目录{rootDirectory.FullName}时发生错误：{e}");
    }
    return files;
}

public static void OverDirectories(IEnumerable<DirectoryInfo> directories){
    var tasks =new List<Task<List<string>>>( directories.Select(dir => Task.Run(()=>OverDirectories(dir))));
    while(tasks.Any())
    {
        var completeds = tasks.Where(t=>t.IsCompleted).ToList(); // 提取所有已完成的任务
        foreach(var t in completeds)
        {
            WriteLinesToTemp(t.Result);// 保存文件列表
            tasks.Remove(t);//移除已处理的任务
        }
    }
}

最后修改主方法，设置启动时遍历路径的规则：

static void Main(string[] args){
    if(!File.Exists(TempFile))// 缓存文件存在，则认为上次已经遍历成功了
    {
        var drivers = GetDrivers();
        OverDirectories(drivers);
    }

    Console.WriteLine("请输入要查询的文件名：");
    var search = Console.ReadLine().Trim();

}

1.3 循环使用并设置退出条件

设置用户输入q或Q的时候退出程序，这时候就需要改造Main方法了：

static void Main(string[] args)
{
    Console.WriteLine("文件查询小工具启动了……");
    if(!File.Exists(TempFile))
    {
        Console.WriteLine("尚未加载缓存记录，数据加载中……");
        var drivers = GetDrivers();
        OverDirectories(drivers);
        Console.WriteLine("数据加载完成");
        Thread.Sleep(500);
        Console.Clear();// 清除控制台
    }
    while(true)
    {
        Console.WriteLine("请输入要查询的文件名(输入q/Q 退出)：");
        var search = Console.ReadLine().Trim();// 去除多余的空白字符
        if(search == "q" || search == "Q")//添加退出条件
        {
            break;
        }
        Console.WriteLine("查询中……");
        var results = Search(search);
        Console.WriteLine("查询结果：");
        foreach(var r in results)
        {
            Console.WriteLine(r);
        }
    }
    Console.WriteLine("程序已退出！");
}

在main 方法里加了很多提示语句，以方便使用。