dotnet/runtime

Analyzer for STAThread attribute applied to async Main

Open

#78.502 aperta il 17 nov 2022

Vedi su GitHub
 (3 commenti) (7 reazioni) (0 assegnatari)C# (5445 fork)batch import
api-approvedarea-System.Threading.Taskscode-analyzerhelp wanted

Metriche repository

Star
 (17.886 star)
Metriche merge PR
 (Merge medio 12g 11h) (661 PR mergiate in 30 g)

Descrizione

Describe the problem you are trying to solve

When the [STAThread] attribute is applied to an async Main method, it does not have the intended effect (the main thread of the application is not created with the single-threaded apartment state). Since this gotcha seems to be fairly common (see e.g. https://github.com/dotnet/roslyn/issues/22112 and the issues linked to it), users should be made aware of it.

Describe suggestions on how to achieve the rule

I'm not certain if a code fix is necessary, but it could remove [STAThread] from the async Main method and then do one of the following:

  1. Add Thread.CurrentThread.SetApartmentState(ApartmentState.STA); at the start of the async Main method.
  2. Rename the async Main method to MainAsync and then add [STAThread] static void Main() => MainAsync().GetAwaiter().GetResult();.

Guida contributor

Direzione di ricerca
Esplora l'infrastruttura esistente degli analizzatori Roslyn in dotnet/runtime (vedi gli analizzatori in src/libraries/System.Runtime.Analyzers). Comprendi come implementare un analizzatore diagnostico che rilevi STAThread su Main asincrono. Considera le due possibili correzioni del codice descritte nell'issue. Rivedi l'issue collegato dotnet/roslyn#22112 per ulteriore contesto. Testa l'analizzatore con metodi Main asincroni di esempio.
Tech stack
csharp
Dominio
toolingdeveloper experience
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
C#Roslyn analyzer basics
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
60