L'utilisation du suffixe "Async" dans un nom de méthode dépend-elle de l'utilisation du modificateur 'async'?

Quelle est la convention pour suffixer les noms de méthode avec "Async".

Le modèle asynchrone basé sur les tâches (TAP) dicte que les méthodes doivent toujours renvoyer un Task<T> (ou Task) et être nommées avec un suffixeasync ; ceci est séparé de l'utilisation de async. Task<bool> Connect() et asyncTask<bool> Connect() compilera et fonctionnera très bien, mais vous ne suivrez pas la convention de nommage du robinet.

Si la méthode contient le modificateur async, ou il suffit qu'il retourne juste la tâche?

Si le corps de la méthode (quel que soit le type ou le nom de retour) inclut await, Vous devez utiliser async; et le compilateur vous dira "L'opérateur 'await' ne peut être utilisé que dans une méthode asynchrone. ...". Renvoyer Task<T> ou Task n'est pas "suffisant" pour éviter d'utiliser async. Voir async (référence C#) pour plus de détails.

C'est-à-dire laquelle de ces signatures est correcte:

Les Deux asyncTask<bool> ConnectAsync() et Task<bool> ConnectAsync() suivent correctement le ROBINET conventions. Vous pouvez toujours utiliser le mot-clé async, mais vous obtiendrez un avertissement du compilateur "cette méthode asynchrone manque d'opérateurs' await ' et s'exécutera de manière synchrone. ..."si le corps n'utilise pas await.

Ou assez qu'il retourne juste la tâche?

Ça. Le mot clé async n'est pas le vrai problème ici. Si vous implémentez l'asynchronie sans utiliser le mot clé async, la méthode est toujours "asynchrone", au sens général.

Puisque Task et Task<T>sont tous deux des types awaitable, ils représentent certaines opérations asynchrones. Ou au moins qu'ils sont censés représenter.

Vous devez ajouter le suffixe Async à une méthode qui, dans certains cas (pas nécessairement tous), ne renvoie pas de valeur mais renvoie plutôt un wrapper autour d'une opération en cours. Ce wrapper est généralement un Task, mais sous Windows RT il peut être IAsyncInfo. Suivez votre intuition et rappelez-vous que si un utilisateur de votre code voit la fonction Async, il le fera savoir que l'invocation de cette méthode est découplé du résultat de cette méthode et qu'ils doivent agir en conséquence.

Notez qu'il existe des méthodes telles que Task.Delay et Task.WhenAll qui renvoient Task sans avoir le suffixe Async.

Notez également qu'il existe des méthodes async void qui représentent fire et forget méthode asynchrone et vous devriez mieux être conscient que la méthode est construite de cette manière.

Je construis beaucoup de Services API et d'autres applications qui appellent d'autres systèmes où la plupart de mon code est en cours d'exécution asynchrone.

Ma propre règle de base que je suis est:

S'il existe à la fois une méthode non-asynchrone et une méthode asynchrone qui renvoient la même chose Je suffixe l'async avec Async. Pas autrement.

Exemples:

Une seule méthode:

public async Task<User> GetUser() { [...] }

Même méthode avec deux signatures:

public User GetUser() { [...] }

public async Task<User> GetUserAsync() { [...] }

Cela a du sens puisque ce sont les mêmes données cela est retourné mais la seule chose qui diffère est la façon de renvoyer les données , pas les données elles-mêmes.

Je pense aussi que ces conventions de nommage existent en raison de la nécessité d'introduire des méthodes asynchrones et de maintenir une compatibilité ascendante.

Je soutiens que le nouveau code ne devrait pas utiliser le suffixe asynchrone. C'est tout aussi évident que le type de chaîne de retour, ou Int comme mentionné précédemment dans ce thread.

Dans La programmation asynchrone avec async et await (C#) , Microsoft offre les conseils suivants:

Convention De Nommage

Par convention, vous ajoutez "Async" aux noms des méthodes qui ont un async modificateur.

Vous pouvez ignorer la convention où un événement, une classe de base ou une interface contrat suggère un nom différent. Par exemple, vous ne devriez pas renommer gestionnaires d'événements courants, tels que Button1_Click.

Je trouve cette orientation incomplète et insatisfaisante. Cela signifie-t-il qu'en l'absence du modificateur async, cette méthode devrait être nommée Connect au lieu de ConnectAsync?

public Task<bool> ConnectAsync()
{
    return ConnectAsyncInternal();
}

Je ne pense pas. Comme indiqué dans la réponse concise par @ Servy {[14] } et plus réponse détaillée par @ Luke Puplett , je crois qu'il est approprié et en effet attendu que cette méthode devrait {[40] } être nommée ConnectAsync (car elle renvoie un awaitable). À l'appui de cela, @ John Skeet dans cette réponse à une autre question ajoute Async au nom de la méthode indépendamment de la présence du modificateur async.

Enfin, sur une autre question, considérons ce commentaire par @Damien_The_Unbeliever:

async/await sont mise en œuvre détails de vos méthodes. C'est important pas un seul mot si votre méthode est déclarée async Task Method() ou juste Task Method(), pour autant que votre appelants sont concernés. (Dans fait, vous êtes libre de changer entre ces deux plus tard temps sans qu'il soit considéré comme un changement de rupture.)

De là, je déduis que c'est la nature asynchrone de la méthode qui dicte comment elle doit être nommée. L'utilisateur de la méthode ne saura même pas si le modificateur async est utilisé dans son implémentation (sans le code source C# ou CIL).

Je dirais qu'il devrait utiliser le suffixe Async s'il renvoie une tâche indépendamment du fait que la méthode soit déclarée avec le modificateur async.

La raison derrière cela étant que le nom est déclaré dans l'interface. L'interface déclare le type de retour qui est un Task. Ensuite, il y a deux implémentations de cette interface, une implémentation l'implémente en utilisant le modificateur async, l'autre Non.

public interface IFoo
{
    Task FooAsync();
}

public class FooA : IFoo
{
    public Task FooAsync() { /* ... */ }
}

public class FooB : IFoo
{
    public async Task FooAsync() { /* ... */ }
}