Skip to main content
 首页 » 编程设计

c#之如何记录 BackgroundWorker.RunWorkerAsync(Object) 的参数

2024年08月12日37zlslch

我有一个 DoWorkEventHandler,它需要在 RunWorkerAsync 调用上有一个参数才能工作。

public static void ProcessData(object sender, DoWorkEventArgs e) 
{ 
    if (e.Argument == null) 
            throw new ArgumentNullException(); 
        MyType argument; 
        try 
        { 
            argument = (MyType)e.Argument; 
        } 
        catch 
        { 
            throw new ArgumentException("Argument passed is not from type MyType"); 
        } 
    /* ... */ 
} 

如果用户在没有参数的情况下执行 RunWorkerAsync、传递 null 或传递无法转换为 MyType 的参数,它将抛出>。

我可以做这样的事情来记录这个需求

/// <summary>...</summary> 
/// <param name="e">e.Argument must be of type MyType</param> 
public static void ProcessData(object sender, DoWorkEventArgs e) { /*...*/ } 

但是,在用户写完之后

var worker = new BackgroundWorker(); 
worker.DoWork += ProcessData; 

当她/他写下这行时

worker.RunWorkerAsync(); 

IDE 不会显示参数的必要性。

有什么方法可以让 IDE 向用户显示该信息?

如果没有,我应该如何记录?

编辑: 我不能像 this那样使用围绕 RunWorkerAsync() 的包装器. DoWork 是在model 上实现的,ProgressChanged 和RunWorkerCompleted 是在viewmodel 上实现的,因为每个viewmodel 都实现了不同的handler。

Edit2: 实际上@usr 的回答就可以了。如果我在模型中声明后台 worker ,并简单地公开 2 个委托(delegate),它就可以做到这一点,允许我将业务与设计完全分开,允许 View / View 模型实现 ProcessChanged 和 RunWorkerCompleted,而无需担心其他细节,并且能够有效地使用包装器。

请您参考如下方法:

只需说:

var myArg = (MyType)e.Argument; 

这 100% 清楚了 nullness 和正确的类型。

使用错误会导致本应发生的崩溃。这是只有开发人员才能看到的崩溃。根本原因将是显而易见的。如果你想让它更明显:

Debug.Assert(e.Argument is MyType); 
var myArg = (MyType)e.Argument; 

如果您希望文档出现在 RunWorkerAsync 的调用位置,请将其包裹起来:

void StartMyWorker(MyType arg) { ... } 

现在 IDE 会显示正确的类型。