¿El uso del sufijo "Async" en el nombre de un método depende de si se usa el modificador "async"?

¿Cuál es la convención para agregar sufijos a los nombres de métodos con "Async"?

¿Debería añadirse el sufijo "Async" sólo a un método que se declara con el asyncmodificador?

public async Task<bool> ConnectAsync()

¿O es suficiente que el método simplemente regrese Task<T>o Task?

public Task<bool> ConnectAsync()

Creo que la verdad es ambigua incluso en la documentación de Microsoft:

En Visual Studio 2012 y .NET Framework 4.5, cualquier método que se atribuya con la asyncpalabra clave ( Asyncen Visual Basic) se considera un método asincrónico, y los compiladores de C # y Visual Basic realizan las transformaciones necesarias para implementar el método de forma asincrónica mediante TAP. Un método asincrónico debe devolver Taskun Task<TResult>objeto o un objeto.

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

Eso ya no está bien. Cualquier método con asynces asincrónico y luego dice que debe devolver un Tasko Task<T>, lo que no es correcto para los métodos en la parte superior de una pila de llamadas, Button_Click por ejemplo, o async void.

Por supuesto, hay que considerar cuál es el objetivo de la convención.

Se podría decir que la Asyncconvención de sufijos es comunicar al usuario de la API que el método está disponible. Para que un método sea de espera, debe regresar Taskpara un Task<T>método vacío o para un método de devolución de valor, lo que significa que solo el último puede tener el sufijo Async.

O podría decir que la Asyncconvención de sufijos es comunicar que el método puede regresar inmediatamente, abandonando el hilo actual para realizar otro trabajo y potencialmente causando carreras.

Esta cita de Microsoft doc dice:

Por convención, agrega "Async" a los nombres de los métodos que tienen un modificador Async o async.

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

Lo cual ni siquiera menciona que sus propios métodos asincrónicos que regresan Tasknecesitan el Asyncsufijo, que creo que todos estamos de acuerdo en que lo hacen.

Entonces, la respuesta a esta pregunta podría ser: ambos. En ambos casos, debe agregar Asyncmétodos con la asyncpalabra clave y que devuelvan Tasko Task<T>.

Le voy a pedir a Stephen Toub que aclare la situación.

Actualizar

Así que lo hice. Y esto es lo que escribió nuestro buen hombre:

Si un método público devuelve una tarea y es de naturaleza asíncrona (a diferencia de un método que se sabe que siempre se ejecuta de forma síncrona hasta su finalización, pero que aún devuelve una tarea por alguna razón), debe tener un sufijo "Asíncrono". Esa es la pauta. El objetivo principal aquí con la denominación es hacer que sea muy obvio para un consumidor de la funcionalidad que el método que se invoca probablemente no completará todo su trabajo de forma sincrónica; por supuesto, también ayuda con el caso en el que la funcionalidad se expone con métodos sincrónicos y asincrónicos, de modo que necesita una diferencia de nombre para distinguirlos. La forma en que el método logra su implementación asincrónica es irrelevante para la denominación: si async / await se usa para obtener la ayuda del compilador, o si los tipos y métodos de System.Threading.Tasks se usan directamente (p. Ej. gramo. TaskCompletionSource) realmente no importa, ya que eso no afecta la firma del método en lo que respecta al consumidor del método.

Por supuesto, siempre hay excepciones a una guía. El más notable en el caso de la asignación de nombres serían los casos en los que la razón de ser de un tipo completo es proporcionar una funcionalidad centrada en async, en cuyo caso tener Async en cada método sería excesivo, por ejemplo, los métodos en Task en sí que producen otras Tasks. .

En cuanto a los métodos asincrónicos de devolución de vacío, no es deseable tenerlos en un área de superficie pública, ya que la persona que llama no tiene una buena forma de saber cuándo se ha completado el trabajo asincrónico. Sin embargo, si debe exponer públicamente un método asincrónico de retorno vacío, es probable que desee tener un nombre que transmita que se está iniciando el trabajo asincrónico, y podría usar el sufijo "Async" aquí si tiene sentido. Dado lo raro que debería ser este caso, diría que en realidad es una decisión caso por caso.

Espero que eso ayude, Steve

La guía sucinta de la oración inicial de Stephen es bastante clara. Excluye async voidporque es inusual querer crear una API pública con tal diseño, ya que la forma correcta de implementar un vacío asincrónico es devolver una Taskinstancia simple y dejar que el compilador haga su magia. Sin embargo, si desea un public async void, Asyncse recomienda agregarlo . Otros async voidmétodos de primer nivel, como los controladores de eventos, generalmente no son públicos y no importan / califican.

Para mí, me dice que si me pregunto sobre cómo agregar Asyncun sufijo a un async void, probablemente debería convertirlo en un async Taskpara que las personas que llaman puedan esperarlo y luego agregarlo Async.

Construyo muchos servicios de API y otras aplicaciones que llaman a otros sistemas donde la mayor parte de mi código se ejecuta de forma asincrónica.

Mi propia regla general que estoy siguiendo es:

Si hay un método no asíncrono y asíncrono que devuelve lo mismo, le agrego el sufijo asíncrono con Asíncrono. De otra forma no.

Ejemplos:

Solo un método:

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

Mismo método con dos firmas:

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

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

Esto tiene sentido ya que se devuelven los mismos datos, pero lo único que difiere es la forma de devolver los datos , no los datos en sí.

También creo que estas convenciones de nomenclatura existen debido a la necesidad de introducir métodos asincrónicos y aún mantener la compatibilidad con versiones anteriores.

Sostengo que el nuevo código no debería usar el sufijo Async. Es tan obvio como el tipo de retorno de String o Int como se mencionó anteriormente en este hilo.

¿Cuál es la convención para agregar sufijos a los nombres de métodos con "Async"?

El patrón asincrónico basado en tareas (TAP) dicta que los métodos siempre deben devolver un Task<T>(o Task) y ser nombrados con un sufijo Async ; esto es independiente del uso de async. Ambos Task<bool> Connect()y se compilarán y ejecutarán bien, pero no seguirás la convención de nomenclatura TAP.asyncTask<bool> Connect()

¿Debería el método contener el asyncmodificador, o lo suficiente como para devolver Task?

Si el cuerpo del método (independientemente del tipo de retorno o el nombre) incluye await, debe usar async; y el compilador le dirá "El operador 'await' solo se puede usar dentro de un método asincrónico. ...". Volver Task<T>o Taskno es "suficiente" para evitar su uso async. Consulte async (Referencia de C #) para obtener más detalles.

Es decir, cuáles de estas firmas son correctas:

Ambos y siguen correctamente las convenciones de TAP. Usted podría siempre utilizar la palabra clave, pero vas a obtener una advertencia del compilador "Este método asíncrono carece '' aguardan los operadores y se ejecutará de forma sincrónica. ..." si el cuerpo no utiliza .asyncTask<bool> ConnectAsync()Task<bool> ConnectAsync()asyncawait

¿O es suficiente que solo devuelva Task?

Ese. La asyncpalabra clave no es el problema real aquí. Si implementa la asincronía sin usar la asyncpalabra clave, el método sigue siendo "Async", en el sentido general.

Dado que Tasky Task<T>son tipos de espera, representan una operación asincrónica. O al menos deberían representar.

Debe agregar un sufijo Asynca un método que, en algunos casos (no necesariamente todos), no devuelve un valor, sino que devuelve un contenedor alrededor de una operación en curso. Ese contenedor suele ser un Task, pero en Windows RT puede serlo IAsyncInfo. Siga su instinto y recuerde que si un usuario de su código ve la Asyncfunción, sabrá que la invocación de ese método está desacoplada del resultado de ese método y que debe actuar en consecuencia.

Tenga en cuenta que hay métodos como Task.Delayy Task.WhenAllque regresan Tasky, sin embargo, no tienen el Asyncsufijo.

También tenga en cuenta que hay async voidmétodos que representan fuego y olvidan el método asincrónico y es mejor que tenga en cuenta que el método está construido de esa manera.

Yo diría que debería usar el sufijo Async si devuelve una tarea independientemente de si el método se declara con el asyncmodificador o no.

La razón detrás de esto es que el nombre se declara en la interfaz. La interfaz declara el tipo de retorno que es a Task. Luego hay dos implementaciones de esa interfaz, una implementación la implementa usando el asyncmodificador, la otra no.

public interface IFoo
{
    Task FooAsync();
}

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

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

En la programación asincrónica con async y await (C #) , Microsoft ofrece la siguiente guía:

Convenio de denominación

Por convención, agrega "Async" a los nombres de los métodos que tienen un modificador async .

Puede ignorar la convención donde un evento, clase base o contrato de interfaz sugiere un nombre diferente. Por ejemplo, no debe cambiar el nombre de los controladores de eventos comunes, como Button1_Click.

Encuentro esta guía incompleta e insatisfactoria. ¿Significa esto que, en ausencia del asyncmodificador, este método debería nombrarse en Connectlugar de ConnectAsync?

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

No lo creo. Como se indica en la respuesta concisa de @Servy y la respuesta más detallada de @Luke Puplett , creo que es apropiado y, de hecho, se espera que este método deba ser nombrado ConnectAsync(porque devuelve un awaitable). En mayor apoyo a esto, @John Skeet en esta respuesta a otra pregunta se agrega Asyncal nombre del método independientemente de la presencia del asyncmodificador.

Finalmente, en otra pregunta , considere este comentario de @Damien_The_Unbeliever :

async/awaitson detalles de implementación de sus métodos. No importa un ápice si su método está declarado async Task Method()o simplemente Task Method(), en lo que respecta a las personas que llaman . (De hecho, puede cambiar entre estos dos en un momento posterior sin que se considere un cambio importante).

De eso, infiero que es la naturaleza asincrónica del método lo que dicta cómo debe nombrarse. El usuario del método ni siquiera sabrá si el asyncmodificador se usa en su implementación (sin el código fuente de C # o CIL).