Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/justinamiller/async-await-best-practices
Async-Await Best Practices
https://github.com/justinamiller/async-await-best-practices
async async-await asynchronous-programming await guidelines
Last synced: about 2 months ago
JSON representation
Async-Await Best Practices
- Host: GitHub
- URL: https://github.com/justinamiller/async-await-best-practices
- Owner: justinamiller
- License: mit
- Created: 2020-02-05T15:33:39.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2020-02-05T15:36:01.000Z (almost 5 years ago)
- Last Synced: 2024-10-15T11:11:31.119Z (3 months ago)
- Topics: async, async-await, asynchronous-programming, await, guidelines
- Homepage:
- Size: 2.93 KB
- Stars: 18
- Watchers: 4
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Async Await Best Practices
**Summary of Asynchronous Programming Guidelines**
| Name | Description | Exceptions |
| ----------------- | ------------------------------------------------- | ------------------------------- |
| Avoid async void | Prefer async Task methods over async void methods | Event handlers |
| Async all the way | Don't mix blocking and async code | Console main method (C# <= 7.0) |
| Configure context | Use `ConfigureAwait(false)` when you can | Methods that require context |
**The Async Way of Doing Things**
| To Do This ... | Instead of This ... | Use This |
| ---------------------------------------- | -------------------------- | -------------------- |
| Retrieve the result of a background task | `Task.Wait or Task.Result` | `await` |
| Wait for any task to complete | `Task.WaitAny` | `await Task.WhenAny` |
| Retrieve the results of multiple tasks | `Task.WaitAll` | `await Task.WhenAll` |
| Wait a period of time | `Thread.Sleep` | `await Task.Delay` |
**Best practice**
The async/await is the best for IO bound tasks (networking communication, database communication, http request, etc.) but it is not good to apply on computational bound tasks (traverse on the huge list, render a hugge image, etc.). Because it will release the holding thread to the thread pool and CPU/cores available will not involve to process those tasks. Therefore, we should avoid using Async/Await for computional bound tasks.
For dealing with computational bound tasks, prefer to use `Task.Factory.CreateNew` with `TaskCreationOptions` is `LongRunning`. It will start a new background thread to process a heavy computational bound task without release it back to the thread pool until the task being completed.
**Know Your Tools**
There's a lot to learn about async and await, and it's natural to get a little disoriented. Here's a quick reference of solutions to common problems.
**Solutions to Common Async Problems**
| Problem | Solution |
| ----------------------------------------------- | --------------------------------------------------------------------------------- |
| Create a task to execute code | `Task.Run` or `TaskFactory.StartNew` (not the `Task` constructor or `Task.Start`) |
| Create a task wrapper for an operation or event | `TaskFactory.FromAsync` or `TaskCompletionSource` |
| Support cancellation | `CancellationTokenSource` and `CancellationToken` |
| Report progress | `IProgress` and `Progress` |
| Handle streams of data | TPL Dataflow or Reactive Extensions |
| Synchronize access to a shared resource | `SemaphoreSlim` |
| Asynchronously initialize a resource | `AsyncLazy` |
| Async-ready producer/consumer structures | TPL Dataflow or `AsyncCollection` |
Read the [Task-based Asynchronous Pattern (TAP) document](http://www.microsoft.com/download/en/details.aspx?id=19957).
It is extremely well-written, and includes guidance on API design and the proper use of async/await (including cancellation and progress reporting).
There are many new await-friendly techniques that should be used instead of the old blocking techniques. If you have any of these Old examples in your new async code, you're Doing It Wrong(TM):
| Old | New | Description |
| ------------------ | ------------------------------------ | ------------------------------------------------------------- |
| `task.Wait` | `await task` | Wait/await for a task to complete |
| `task.Result` | `await task` | Get the result of a completed task |
| `Task.WaitAny` | `await Task.WhenAny` | Wait/await for one of a collection of tasks to complete |
| `Task.WaitAll` | `await Task.WhenAll` | Wait/await for every one of a collection of tasks to complete |
| `Thread.Sleep` | `await Task.Delay` | Wait/await for a period of time |
| `Task` constructor | `Task.Run` or `TaskFactory.StartNew` | Create a code-based task |