隐藏ProgressChanged事件

时间:2013-04-26 08:49:59

标签: c# events backgroundworker

是否可以在backgroundworker类中隐藏ProgressChanged事件?

我创建了一个继承System.ComponentModel.BackgroundWorker的类,我需要有多个事件:我的类处理一个对象列表,我需要(例如)处理一个对象之前和之后的事件。我从Backgroundworker的ProgressChanged事件中触发这些事件,因为它是线程安全的。我调用ReportProgress时调用的类中的方法然后使用该参数来确定要触发的事件。这很有效。

现在我想确保调用我的Backgroundworker 允许直接订阅ProgressChanged事件。相反,它应该只能订阅我提供的其他事件。

1 个答案:

答案 0 :(得分:2)

有几种方法:

禁止订阅并禁止触发

可以将子类写入(a)如果调用者尝试直接订阅ProcessChange事件,则抛出异常,(b)根本不引发事件。请注意,(a)单独不会阻止事件被订阅,因为调用者可以将子类强制转换为BackgroundWorker并直接订阅事件:

class ExtendedBackgroundWorker : BackgroundWorker
{
    public new event ProgressChangedEventHandler ProgressChanges
    {
        add { throw new InvalidOperationException("This event cannot be added directly"); }
        remove {}
    }

    protected override void OnProgressChanged(ProgressChangedEventArgs e)
    {
        // do not call base.OnProgressChanged
    }
}

使用合成代替继承

但是,如果可能的话,更好的方法可能是不从BackgroundWorker继承。 BackgroundWorker使用ProgressChanged事件来报告进度变化;如果不这样做,则不是BackgroundWorker。相反,考虑将BackgroundWorker实现为私有类成员,并根据需要从成员中公开成员,例如:

class CustomBackgroundWorker : Component
{
    private BackgroundWorker worker;
    public event ProgressChangedEventHandler FirstEvent;
    public event ProgressChangedEventHandler SecondEvent;
    public event DoWorkEventHandler DoWork
    {
        add { worker.DoWork += value; }
        remove { worker.DoWork -= value; }
    }
    public event RunWorkerCompletedEventHandler RunWorkerCompleted
    {
        add { worker.RunWorkerCompleted += value; }
        remove { worker.RunWorkerCompleted -= value; }
    }

    public CustomBackgroundWorker()
    {
        worker = new BackgroundWorker();
        worker.ProgressChanged += OnProgressChanged;
        worker.WorkerReportsProgress = true;
    }

    public void RunWorkerAsync()
    {
        worker.RunWorkerAsync();
    }

    protected override void Dispose(bool disposing)
    {
        base.Dispose(disposing);
        worker.Dispose();
    }

    private void OnProgressChanged(object o, ProgressChangedEventArgs e)
    {
        // code to handle progress change reports from the worker
    }
}

拒绝对客户有用的事件

子类可以将其与其他事件结合使用(而不是替代)来向订户提供相关信息(例如,总操作的进度),而不是抑制事件的使用。