软件日志分析工具LogAnalysise详细介绍

万恶的加班还在延续着，分析软件日志分析的头疼还是没有能够找到问题的症结所在。 五十多兆的日志文件中，很多都是没用的，有用的信息都被这些无用的信息给推攘到了不知名的角落里。我愣是找了一个小时，找到的有用的信息寥寥无几，抬头望望远处，已经感觉到有些眼晕了。 考虑到每天都要进行这样的诊断工作，于是决定写一个日志分析的小软件，要求能够过滤掉带有指定关键字的行，并且能够高亮某些关键字。于是，LogAnalysiser这个小工具诞生了。

程序运行效果截图：

启动界面(采用了Slash窗体，在程序启动时会自动检测缺失的配置文件或者程序集)：  

然后启动到主界面(主界面包含了配置窗体，着色窗体，更新窗体)：  

这个是配置窗体，多个关键字或者子句，利用竖线分隔开，程序会自动过滤掉含有这些关键字的文本行：

下面的这个是着色窗体，输入关键字，以数显隔开，点击确定按钮可以实时实现关键字高亮：  

下面这个是更新窗体，主要负责软件更新工作：  

然后这里是帮助文档：  

这就是这个软件的大概，虽然很小，但是算是比较的全面。

下面来说下在制作过程中使用到的技术：

技术一： 异步操作(采用APM模式)

      关于这个模式的具体讲解，可以参见我之前的博客文章：我所知道的.net异步

      在软件Slash窗体加载,关键字过滤以及软件更新的时候，由于这三个操作比较耗时，所以采用了异步方式来进行，即使用BeginInvoek和与之配对的EndInvoke方式来达到目的。 比如说软件中的LoadAppendingText()函数主要是用来循环过滤关键字来达到简化日志的目的，一旦日志文件体积非常大的情况下，这个函数将会阻塞主界面，导致假死状况。针对这种情况，我利用异步方式来处理，也就是利用下面代码进行了封装，从而产生异步效果：

#region Begin and End Invoke of Async mode
        ///

      这样，当软件运行的时候，界面不会卡死，一切都很流畅：

     所以，从上面的异步方式看来，这种模式下，我们只需要对耗时函数利用BeginInvoke和EndInvoke进行一下简单的封装即可，省时也省力。

    需要说明的是，利用异步和界面交互，不得不遇到一个跨线程的问题，不过我们可以通过Form控件的Invoke方式来进行，也就是类似如下的操作：

lblStatus.Invoke(new Action(delegate
            {
                lblStatus.Text = "更新完毕。";
            }));

技术二： 委托事件传值。

      关于委托的更多详细情况，请参见我之前的博客：浅谈C#中常见的委托

      在制作本软件的过程中，着色的字体需要实时的显示；Slash窗体检测完毕，也需要传值给主窗体，然后自己关闭掉。 这两个地方都使用了委托事件来进行，具体怎么用呢，请看下面的步骤：

首先，声明全局委托：

 /// 

    /// 全局委托，用于着色
    /// 
    /// 待着色文本
    public delegate void ColorDaemonDelegate(string text);

然后再DaemonFrm窗体中（也就是进行着色配置的窗体中），声明一个OnColorDaemonEventHandler事件，用于抛出通知：

public event ColorDaemonDelegate OnColorDaemonEventHandler;

那么，这个通知如何抛出呢？

当然是在点击着色按钮的时候抛出去，它向外界宣布：我现在要着色啦，于是它在以下的代码中将着色事件抛了出去：

 private void btnColor_Click(object sender, EventArgs e)
        {
            string text = txtWordDaemon.Text;
            OnColorDaemonEventHandler(text);  //抛出事件
        }

可以看出，这个事件抛出的时候，带有一个参数，这个参数就是需要高亮的关键字。 那么事件抛出来了，抛给谁了？谁接收到了呢？ 之后的内容估计就是我们非常常见的了，即事件注册：

  ///

利用上面的+=号，就把刚才抛出的事件给接住了，并且这个抛出的事件被主窗体给接住了。

下面是针对这个抛出的事件进行处理：       

///

上面的RichTextBoxEx.SetColorBox是一个利用扩展方法实现的函数，就可以实现关键字的实时高亮，看看效果：  

这样就可以非常方便的分析日志了。

技术三：更新组件的编写。

       更新组件是软件最常用的组件之一，本软件的更新组件主要采用HttpWebRequest和HttpWebResponse进行数据获取并结合异步机制完成。

      首先，来看看下载数据的函数：

private void DownLoadVersion(string url,string filename,ProgressBar progress,Label label)
        {
            int percent = 0;
            HttpWebRequest request = (HttpWebRequest)HttpWebRequest.Create(url);
            request.ContentType = @"application/octet-stream";
            request.Credentials = CredentialCache.DefaultCredentials;

            HttpWebResponse response = (HttpWebResponse)request.GetResponse();

            long totalBytes = response.ContentLength;  //获取文件字节数

            progress.Invoke(new Action(delegate
            {
                progress.Maximum = (int)totalBytes;
            }));

            Stream responseStream = response.GetResponseStream(); //保存到内存
            Stream fileStream = new FileStream(filename, FileMode.Create);

            long totalDownloadBytes = 0;
            byte[] bytes = new byte[1024];
            int paragraphByteSize = responseStream.Read(bytes, 0, (int)bytes.Length); //一次性读取1024个字节
            while (paragraphByteSize > 0)
            {
                totalDownloadBytes += paragraphByteSize;  //当前已经读取的字节数
                fileStream.Write(bytes, 0, paragraphByteSize); //写入到文件
                progress.Invoke(new Action(delegate
                {
                    progress.Value = (int)totalDownloadBytes;
                }));
               
                paragraphByteSize = responseStream.Read(bytes, 0, (int)bytes.Length); //继续读取下一段

                percent = (int)((float)totalDownloadBytes / (float)totalBytes * 100);  //进度百分比

                label.Invoke(new Action(delegate
                {
                    label.Text = "当前已经更新：" + percent.ToString() + "%";
                }));
            }
            responseStream.Close();
            fileStream.Close();
        }

这里我已经做了不少的注释了，其主体的逻辑就是得到请求数据，然后1字节1字节的写入，直到下载完毕为止。

如果直接运行这个函数进行更新的话，会造成界面假死，所以在这里我采用了和之前一样的异步处理方式，即利用BeginInvoke和EndInvoke方式来进行。这样就保证了界面的流畅性。

///