L'utilisation de la “Async” le suffixe d'un nom de la méthode dépend de si le "asynchrone" modificateur est-il utilisé?

Qu'est-ce que la convention pour la suffixant noms de méthode avec "Async"?

Si le "Async" suffixe être annexé seulement une méthode déclarée avec le async modificateur?

public async Task<bool> ConnectAsync()

Ou suffit-il que la méthode retourne juste Task<T> ou Task?

public Task<bool> ConnectAsync()

Pour la désignation de la partie, APPUYEZ sur la doc dit: méthodes Asynchrones ROBINET inclure la Async suffixe après le nom de l'opération; par exemple, GetAsync pour une opération get. Si vous êtes l'ajout d'un ROBINET méthode à une classe qui contient déjà le nom de la méthode avec l'Async suffixe, utiliser le suffixe TaskAsync à la place. Par exemple, si la classe a déjà un GetAsync méthode, utiliser le nom GetTaskAsync.
Oui, je sais que "Async" doit être ajouté pour le nom de la méthode, mais ce n'est pas vraiment la question.
ok, je suppose que j'ai été confondu par la question du titre de la "convention de Nommage des méthodes asynchrones"
C'est un mal construites question. Les gens de chicane, équivoques réponses.
Pourquoi pensez-vous qu'il est mal construit?
Parce que beaucoup de gens ont mal compris et font valoir que la chose réelle à être demandé, en se demandant si ses une question en deux parties, etc. La preuve que son déroutant, c'est que les gens sont confus.
Mal formulé la question.
Pourquoi pensez-vous ainsi? Je ne peux pas comprendre pourquoi les gens ne comprennent pas cette question.
Après la lecture de votre question initiale et les modifications ultérieures apportées ainsi que les réponses, dans l'édition de votre question, je crois que j'ai précisé à votre intention. Si ce n'est pas le cas, s'il vous plaît laissez-moi savoir. Bien sûr, vous pouvez modifier d'autres ou même de reculer mes modifications. Peu importe, si le résultat de mes modifications n'est pas la question que vous avez posée, c'est la question dont la réponse que je cherche. 🙂
À ce jour, je ne comprends toujours pas le montant de la confusion que cette question a apparemment causé. Si vos éditions de mettre de l'ordre dans la confusion telle qu'il vous a aidé et peut peut-être aider les autres, alors je vous remercie de vos modifications vous avez réalisé quelque chose que je ne pouvais pas dans la formulation initiale. La question est maintenant de savoir si vieux maintenant que je peux à peine rappeler mon état d'esprit quand j'ai demandé ici et donc, l'intention initiale est de moins en moins important. La réponse de luc refléter le fait que tous n'étaient pas confondre. Je l'ai trouvé très utile.
J'ai soudain se rappeler ce à quoi je pensais quand vous posez la question. Le problème fondamental est celui de l'intention. Je peux écrire une méthode retournant une Tâche et ajouter le "Async" suffixe, mais la méthode pourrait ou ne pourrait pas être bloquant. L'ajout de la async mot-clé pourrait communiquer plus clairement l'intention, c'est à dire ce qui suggère plus fortement qu'une méthode est en effet asynchrone.

InformationsquelleAutor kasperhj | 2013-04-11

.net async-await c#naming naming-conventions

94

Je pense que la vérité est ambigu, même à partir de la documentation de Microsoft:

Dans Visual Studio 2012 et le .NET Framework 4.5, une méthode qui est
attribué à l' async mot-clé (Async en Visual Basic) est
considérée comme une méthode asynchrone, et le C# et Visual Basic
les compilateurs d'effectuer les transformations nécessaires pour mettre en œuvre les
méthode asynchrone en utilisant APPUYEZ sur. Une méthode asynchrone doit
de retour d'un Task ou un Task<TResult> objet.

http://msdn.microsoft.com/en-us/library/hh873177(v=vs. 110).aspx

C'est pas bon déjà. Toute méthode avec async est asynchrone et puis son disant qu'elle doit renvoyer une Task ou Task<T> - qui n'est pas bon pour les méthodes au sommet d'une pile d'appel, Button_Click par exemple, ou async void.

Bien sûr, vous avez à considérer ce qui est le point de la convention?

On pourrait dire que le Async suffixe convention est de communiquer à l'utilisateur API que la méthode est awaitable. Pour une méthode à awaitable, il doit retourner Task pour un vide, ou Task<T> pour une valeur de retour de la méthode, ce qui signifie que seule cette dernière peut être suffixé avec Async.

Ou vous pourriez dire que la Async suffixe convention est de communiquer que la méthode peut retourner immédiatement, en renonçant à le thread en cours pour effectuer d'autres travaux et pouvant causer des courses.

Ce Microsoft doc citation dit:

Par convention, vous ajoutez "Async" pour les noms de méthodes qui ont un
Async ou asynchrone modificateur.

http://msdn.microsoft.com/en-us/library/hh191443.aspx#BKMK_NamingConvention

Qui ne mentionne même pas que vos propres méthodes asynchrones retour Task besoin de la Async suffixe, qui, je pense, nous sommes tous d'accord qu'ils font.

Donc la réponse à cette question pourrait être: à la fois. Dans les deux cas, vous devez ajouter Async de méthodes avec async mot-clé et que le retour Task ou Task<T>.

Je vais demander à Stephen Toub, pour clarifier la situation.

Mise à jour

Je l'ai fait. Et voici ce que notre bon homme a écrit:

Si une méthode publique est une Tâche de retour et est asynchrone dans la nature (comme
contrairement à une méthode qui est connu pour toujours exécuter de manière synchrone à
d'achèvement, mais renvoie toujours une Tâche pour une raison quelconque), il devrait avoir
un “Async” suffixe. C'est la ligne directrice. L'objectif principal ici avec
le nom est pour le rendre évident pour le consommateur de l'
fonctionnalité de la méthode invoquée ne sera probablement pas terminée
l'ensemble de ses travaux de manière synchrone; il permet aussi le cas
où la fonctionnalité est exposée à la fois synchrone et asynchrone
des méthodes telles que vous avez besoin d'un nom de différence pour les distinguer. Comment
la méthode réalise sa mise en œuvre asynchrone est négligeable pour
le naming: si async/await est utilisé pour recueillir le compilateur d'aide,
ou si les types et les méthodes de Système.Le filetage.Les tâches sont utilisés
directement (par exemple, TaskCompletionSource) n'a pas vraiment d'importance, comme
n'affecte pas la signature de la méthode dans la mesure où un consommateur de la
la méthode est concerné.

Bien sûr, il y a toujours des exceptions à une
ligne directrice. Le plus remarquable dans le cas de nommage serait le cas
où un ensemble de type a pour raison d'être est de fournir async-concentré
la fonctionnalité, dans ce cas avoir Async sur chaque méthode de l'
overkill, par exemple, les méthodes sur la Tâche elle-même qui produisent d'autres Tâches.

Comme pour les nuls-le retour des méthodes asynchrones, il n'est pas souhaitable de disposer d'
public de la surface, puisque l'appelant n'a pas de bonne façon de
savoir quand le travail asynchrone est terminée. Si vous devez exposer
un vide-retour à la méthode asynchrone publiquement, cependant, il est probable que vous ne
envie d'avoir un nom qui indique que le travail asynchrone est
lancé, et vous pouvez utiliser le “Async” suffixe ici si elle fait sens.
Vu la rareté de cette affaire devrait être, je dirais, c'est vraiment un
cas par cas, la nature de la décision.

J'espère que ça aide, Steve

De la brièveté des conseils de Stephen ouverture de la phrase est assez claire. Il exclut async void parce qu'il est rare de vouloir créer une API publique avec une telle conception, depuis la bonne façon de mettre en œuvre un asynchrone à vide est de retour une plaine Task instance et laisser le compilateur à sa magie. Toutefois, si vous ne voulez qu'un public async void, en ajoutant Async est conseillé. D'autres haut-de-pile async void des méthodes telles que les gestionnaires d'événements sont généralement pas en public et n'a pas d'importance/qualifier.

Pour moi, il me dit que si je me demande à propos de suffixant Async sur un async void, je devrais en faire un async Task sorte que les appelants peuvent l'attendre, puis ajouter Async.
- Bien ses une honte que nous n'avons pas le temps de compilation des contrôles pour les appels de méthode.. oh wait. Si j'ai le nom de la Méthode Get ou GetAsync et de ne pas utiliser attendre de la partie appelante, la compilation échoue à construire. Si cette convention est STUPIDE et vraiment aller à l'encontre de nombreux Microsoft lignes directrices de Style, comme éviter les choses comme PersonString ou PriceDecimal alors pourquoi utiliser GetAsync - API consommateurs de async l'API n'a pas besoin de s'inquiéter de ce que la requête renvoie toujours après que toutes les tâches sont terminées, de toute façon. Son ridicule et vraiment ennuyeux moi. Mais juste une autre convention que personne ne sait vraiment pourquoi il est là.
- Pour les conventions de programmation proposer.. Devrait signature de la méthode afficher les détails de mise en œuvre?
- Comme Stephen l'a souligné, une méthode peut facilement être asynchrone dans la nature, sans l'aide de async/await, ainsi que l'appelant n'a pas d'autres indications que le nom de si oui ou non la fonctionnalité fonctionne asynchrone.
- À défaut d'attendre une méthode asynchrone, par défaut, les résultats au moment de la compilation d'avertissement; pas une erreur de compilation.
- Je trouve cette convention idiot. Il y a trois automatique des indications qu'une méthode async: 1. Le type de retour est une Tâche. 2. La complétion de Code présente une awaitable indice 3. l'IDE vous avertira en soulignant en vert et présentation un avertissement du compilateur. Donc, je suis totalement d'accord avec @ppumkin. L'Async-le suffixe est aussi stupide que si vous avez écrit une propriété comme suit: public Paresseux<Client> CustomerLazy. Qui ferait cela!??
- BTW: je suis d'accord avec @Hannobo, il y a des exceptions où un consommateur de votre API ne peut pas savoir si votre méthode est asynchrone. Mais je considère une telle méthode "sale", parce que la bonne façon de le faire est de toujours renvoyer un awaitable tâche si votre méthode peut exécuter asynchrone. CELA devrait être la convention, et non pas quelque meanlingless Async-suffixe.
- J'ai soulevé cette idée sur GitHub, pensait que c'était le meilleur endroit, mais n'ont pas l'engagement avec elle, je pensais que je voudrais obtenir: github.com/dotnet/core/issues/1464
- Merci de souligner ce point. J'ai juste ajouté mon soutien.
- C'est une excellente réponse. Il peut être tentant de base à savoir si ou de ne pas le suffixe de la méthode sur si oui ou non l'appel est naturellement async - à-dire sans CPU à travailler. Cependant, ce n'est pas pertinent pour l'appelant. L'Async suffixe signifie que l'appel d'une méthode de bloc de travail INTERFACE utilisateur semblable travail.
- Dans Visual Studio 2017, vous pouvez traiter le message d'avertissement comme une erreur en ajoutant des <PropertyGroup> <WarningsAsErrors>NU1605;CS4014</WarningsAsErrors> </PropertyGroup> dans le fichier csproj (NU1605 était déjà il y a comme un défaut; CS4014 est l'attendent manquants avertissement.
InformationsquelleAutor Luke Puplett
31

Je construire un grand nombre d'API de services et d'autres applications qui en appelle 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:

Si il est à la fois non-async et de méthode asynchrone qui renvoient la même chose
Je le suffixe async un 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() { [...] }
```
Ce sens puisque c'est les mêmes données qui sont retournés, mais la seule chose qui diffère, c'est le chemin de retour de données, et non les données.

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

Je soutiens que le nouveau code ne devriez pas utiliser la Async suffixe. Il est tout aussi évident que le type de retour de la Chaîne, ou Int comme mentionné précédemment dans ce fil.
- Je suis d'accord, surtout que généralement vous avez besoin d'aller "async tout le chemin", et dans ce cas, le suffixe est redondant - quel est le point de l'ajoutant à 90% du code;)
- c'est la meilleure solution. Sans le remarquer, j'ai été faire de la même façon dans mon Api.
- C'est bien mieux que de suffixant avec "Async" toutes les méthodes d'application asynchrone
- Le problème avec cette technique est que si vous créez un non-async version ultérieure, vous ne pouvez pas utiliser votre sinon préféré "GetUser()" de nom.
- C'est la pragmatique de chemin à faire. Ajoutant Asynchrone à chaque méthode async modificateur est juste la Notation hongroise 2019. @David, si vous finissez par l'ajout d'un non-async version ultérieure, puis renommez les méthodes et suivre la convention de nommage ou tout simplement ne pas le faire.
InformationsquelleAutor Jonas Stensved
23

Qu'est-ce que la convention pour la suffixant noms de méthode avec "Async".

La Basée sur les tâches du Modèle Asynchrone (TAP) dicte que les méthodes doit toujours retourner une Task<T> (ou Task) et être nommé avec un Async suffixe; ceci est distinct de l'utilisation de async. Les deux Task<bool> Connect() et asyncTask<bool> Connect() de compiler et d'exécuter très bien, mais vous ne serez pas en suivant le ROBINET convention de nommage.

Si la méthode de contenir la async modificateur, ou il suffit qu'elle retourne Tâche?

Si le corps de la méthode (quel que soit le type de retour ou le nom) comprend await, vous doit utilisation async; et le compilateur va vous dire "Le 'attendre' opérateur ne peut être utilisé dans une méthode asynchrone. ...". De retour Task<T> ou Task n'est pas "assez" pour éviter d'utiliser async. Voir async (Référence C#) pour plus de détails.

I. e. laquelle de ces signatures sont correctes:

Les deux asyncTask<bool> ConnectAsync() et Task<bool> ConnectAsync() suivent correctement le ROBINET conventions. Vous pourriez toujours utiliser le async mot-clé, mais vous obtiendrez un avertissement du compilateur "Cette méthode async le manque d '"attendre" opérateurs et exécuté de manière synchrone. ..." si le corps n'utilise pas await.
- Il est en se référant à savoir si ou non vous ajoutez "Async" la méthode nom de, pas de savoir si vous utilisez le async mot-clé.
- si ou de ne pas utiliser le mot-clé async est la deuxième partie de la question.
- L'OP n'est pas en train de demander si il doit être à l'aide de la async mot clé sur ses méthodes. Il est évident qu'il sait déjà quand il en a besoin. Il demande si une méthode qui n'a pas la async mot-clé, mais renvoie une tâche, utilisez ajout Async pour le nom de la méthode. Cette réponse, bien que pas mal, répond à une question entièrement différente de ce que l'OP demande, qui n'est pas utile.
- C'est une partie de la question. La première partie, comme vous l'avez dit, est de savoir si ou de ne pas ajouter "Async" pour le nom de la méthode. La deuxième partie est de savoir si ou de ne pas utiliser le async modificateur. Voir également OPs exemples, public async Task<bool> ConnectAsync() (avec async modificateur) vs public Task<bool> ConnectAsync() (sans async modificateur). La méthode nom lui-même a le suffixe "Async" dans les deux cas.
- C'est pas une deuxième partie de la question. La question est de savoir si "Async" être ajouté à des méthodes de noms de méthodes qui retournent des Task ou des méthodes qui ont async Task.
- vous devez améliorer la question; les "contre" des extraits de code de la rendre claire la question (dans son intégralité) est d'environ async que c'est la seule différence.
- La question réelle est donc assez clairement ce qu'il demande...
- Il est maintenant modifié pour préciser qu'il n'est pas un deux partie de la question. Je ne pense pas que vous pouvez faire beaucoup de sens à partir de la "vs" fragments sans regarder le titre et le texte d'accompagnement.
InformationsquelleAutor Ðаn
11

ou il suffit qu'elle retourne Tâche?

Que. Le async mot-clé n'est pas la vraie question. Si vous implémentez l'asynchronie sans l'aide de la async mot-clé de la méthode est encore "Async", dans le sens général.

InformationsquelleAutor Servy
7

Depuis Task et Task<T> sont à la fois awaitable types, ils représentent certains opération asynchrone. 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 retourne pas une valeur mais renvoie un wrapper autour d'une opération en cours. Cette enveloppe est généralement un Task, mais sur Windows RT, il peut être IAsyncInfo. Suivez votre instinct et n'oubliez pas que si un utilisateur de votre code voit le Async fonction, il ou elle saura 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.

Noter qu'il existe des méthodes telles que Task.Delay et Task.WhenAll de retour Task et pourtant n'ont pas la Async suffixe.

Également noter qu'il y a async void méthodes qui représentent feu et oublier méthode asynchrone et vous devriez mieux être conscient que la méthode est construite de telle façon.

InformationsquelleAutor Toni Petrina
5

Je dirais qu'il doit utiliser la Async-suffixe si elle renvoie une Tâche, peu importe si la méthode est déclarée auprès de la async modificateur ou pas.

La raison derrière cela est que le nom est déclarée dans l'interface. L'interface déclare le type de retour qui est un Task. Ensuite, il existe deux implémentations de cette interface, on met en œuvre la mise en œuvre à l'aide de la async modificateur, l'autre pas.
```
public interface IFoo
{
    Task FooAsync();
}

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

public class FooB : IFoo
{
    public async Task FooAsync() { /* ... */ }
}
```
InformationsquelleAutor Fred
4

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

Convention De Nommage

Par convention, vous ajoutez "Async" pour les noms de méthodes qui ont un
async modificateur.

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

Je trouve cette orientation incomplète et insatisfaisante. Est-ce à dire que, en l'absence de la async modificateur, cette méthode doit être nommé Connect au lieu de ConnectAsync?
```
public Task<bool> ConnectAsync()
{
    return ConnectAsyncInternal();
}
```
Je ne le pense pas. Comme indiqué dans le concise réponse par @Servy et le plus réponse détaillée par @Luc Puplett, je crois qu'il est approprié et en effet prévu que cette méthode devrait être nommé ConnectAsync (parce qu'il renvoie un awaitable). En plus de l'appui de cela, @John Skeet dans cette réponse à une autre question ajoute Async pour le nom de la méthode, indépendamment de la présence de la async modificateur.

Enfin, sur une autre question, envisager ce commentaire par @Damien_The_Unbeliever:

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

De cela, je en déduire que c'est la nature asynchrone de la méthode qui dicte la façon dont il devrait être nommé. L'utilisateur de la méthode n'a même pas de savoir si le async modificateur est utilisé dans sa mise en œuvre (sans le code source C# ou CIL).

InformationsquelleAutor DavidRR

Vous devez vous connecter pour publier un commentaire.