Schreiben Sie eine gut gestaltete asynchrone/nicht-asynchrone API

Question

Ich stehe vor dem Problem, Methoden zu entwerfen, die mit Netzwerk-I/O (für eine wiederverwendbare Bibliothek) durchführt. Ich habe diese Frage lesen

c# 5 await/async pattern in API design

und auch andere, die näher an mein Problem.

Also, die Frage ist, wenn ich sowohl async als auch nicht-async Methode zur Verfügung stellen möchte, wie ich diese zu entwerfen? es ist nicht ein großer Entwurf

Zum Beispiel einer nicht-Asynchron-Version eines Verfahrens auszusetzen, ich brauche so etwas wie

public void DoSomething() { 
    DoSomethingAsync(CancellationToken.None).Wait(); 
} 

und ich fühle mich zu tun. Ich hätte gerne einen Vorschlag (zum Beispiel), wie man private Methoden definieren kann, die in öffentliche eingebunden werden können, um beide Versionen zur Verfügung zu stellen.

Answer 1

Wenn Sie die wartungsfreundlichste Option haben möchten, stellen Sie nur eine async API bereit, die implementiert wird, ohne blockierende Aufrufe auszuführen oder Thread-Thread-Threads zu verwenden.

Wenn Sie sowohl async als auch synchrone APIs haben möchten, stoßen Sie auf ein Wartungsproblem. Sie müssen es wirklich zweimal implementieren: einmal async und einmal synchron. Beide dieser Methoden werden fast identisch aussehen, so dass die anfängliche Implementierung einfach ist, aber Sie werden mit zwei separaten nahezu identischen Methoden enden, so dass die Wartung problematisch ist.

Insbesondere gibt es keine gute und einfache Möglichkeit, nur einen async oder synchronen "Wrapper" zu machen. Stephen Toub hat die besten Infos zum Thema:

1. Should I expose asynchronous wrappers for synchronous methods?
2. Should I expose synchronous wrappers for asynchronous methods?

(die kurze Antwort auf beide Fragen lautet "nein")

Answer 2

ich sowohl mit Marc und Stephen zustimmen (Cleary).

(BTW, begann ich dies als Kommentar zu Stephen's Antwort zu schreiben, aber es stellte sich heraus, zu lang zu sein; lassen Sie mich wissen, wenn es OK ist, dies als Antwort zu schreiben oder nicht, und fühlen Sie sich frei, Bits zu nehmen daraus und fügen Sie es Stephen's Antwort, im Geiste der "Bereitstellung der besten Antwort").

Es hängt wirklich "ab": wie Marc sagte, ist es wichtig zu wissen, wie DoSomethingAsync asynchron ist. Wir sind uns alle einig, dass es keinen Sinn macht, wenn die "sync" -Methode die "async" -Methode aufruft und "wartet": Dies kann im Benutzercode geschehen. Der einzige Vorteil einer separaten Methode besteht darin, tatsächliche Leistungsgewinne zu erzielen, eine Implementierung zu haben, die unter der Haube anders ist und auf das synchrone Szenario zugeschnitten ist. Dies trifft insbesondere zu, wenn die "async" -Methode einen Thread erstellt (oder aus einem threadpool): Sie haben am Ende etwas, das darunter zwei "Kontrollflüsse" verwendet, während "vielversprechend" mit seinen synchronen Looks in der ausgeführt wird Kontext der Anrufer. Dies kann je nach Implementierung sogar Nebenläufigkeitsprobleme haben.

Auch in anderen Fällen, wie die intensive I/O, die das OP erwähnt, kann es sich lohnen, zwei verschiedene Implementierungen zu haben.Die meisten Betriebssysteme (Windows für sicher) haben für I/O unterschiedliche Mechanismen, die auf die beiden Szenarien zugeschnitten sind: Async-Ausführung und I/O-Operation bringt große Vorteile von OS-Level-Mechanismen wie I/O-Completion-Ports Overhead (nicht signifikant, aber nicht null) im Kernel (schließlich müssen sie Buchhaltung, Versand, etc.) und direktere Implementierung für synchrone Operationen. Die Code-Komplexität variiert auch sehr, besonders bei Funktionen, bei denen mehrere Operationen ausgeführt/koordiniert werden.

Was ich tun würde, ist:

• haben einige Beispiele/Test für typische Verwendung und Szenarien
• sehen, welche API-Variante verwendet wird, wo und zu messen. Messen Sie auch den Leistungsunterschied zwischen einer "reinen Sync" -Variante und "Sync". (nicht für die gesamte API, sondern für ausgewählte wenige typische Fälle)
• basierend auf Messung, entscheiden, ob die zusätzlichen Kosten es wert ist.

Dies vor allem, weil zwei Ziele irgendwie im Gegensatz zueinander stehen. Wenn Sie wartbaren Code möchten, ist es naheliegend, die Synchronisation in async/wait (oder anders herum) zu implementieren (oder, noch besser, nur die async-Variante bereitzustellen und den Benutzer warten zu lassen); Wenn Sie Leistung wünschen, sollten Sie die beiden Funktionen unterschiedlich implementieren, um verschiedene zugrunde liegende Mechanismen (vom Framework oder vom Betriebssystem) auszunutzen. Ich denke, dass es aus Sicht des Komponententests keinen Unterschied machen sollte, wie Sie Ihre API tatsächlich implementieren.