È necessario avvolgere StreamWriter in un blocco usando?

Question

Qualche giorno fa ho postato qualche codice come questo:

StreamWriter writer = new StreamWriter(Response.OutputStream); 
writer.WriteLine("col1,col2,col3"); 
writer.WriteLine("1,2,3"); 
writer.Close(); 
Response.End(); 

mi è stato detto che invece avrei dovuto avvolgere StreamWriter in un blocco utilizzando in caso di eccezioni. Un tale cambiamento lo farebbe apparire così:

using(StreamWriter writer = new StreamWriter(Response.OutputStream)) 
{ 
    writer.WriteLine("col1,col2,col3"); 
    writer.WriteLine("1,2,3"); 
    writer.Close(); //not necessary I think... end of using block should close writer 
} 
Response.End(); 

Non so perché questo è un cambiamento prezioso. Se si è verificata un'eccezione senza il blocco using, lo scrittore e la risposta verrebbero comunque ripuliti, giusto? Cosa mi guadagna il blocco usando?

Answer 1

No, il flusso rimarrebbe aperto nel primo esempio, poiché l'errore annullerebbe la chiusura di esso.

L'operatore che utilizza forza la chiamata di Dispose() che deve pulire l'oggetto e chiudere tutte le connessioni aperte quando esce dal blocco.

Answer 2

Se si verifica un'eccezione senza utilizzare il blocco e si interrompe il programma, si rimarrà le connessioni opzionali. Il blocco using chiuderà sempre la connessione per te, come se tu dovessi usare try {} catch {} finally {}

Answer 3

A mio parere è necessario avvolgere qualsiasi classe che implementa IDisposable in un blocco using. Il fatto che una classe implementa IDisposable significa che la classe ha risorse che devono essere ripulite.

Answer 4

il blocco di utilizzo chiama dispose() quando finisce. È solo un modo pratico per garantire che le risorse vengano pulite in modo tempestivo.

Answer 5

In quasi tutti i casi, se una classe implementa IDisposable, e se si sta creando un'istanza di quella classe, allora è necessario il blocco using.

Answer 6

Alla fine, lo scrittore verrà ripulito. Quando ciò accade dipende dal garbage collector, che noterà che il comando Dispose per il comando non è stato chiamato e lo invoca. Ovviamente, il GC potrebbe non funzionare per minuti, ore o giorni a seconda della situazione. Se lo scrittore è in possesso di un blocco esclusivo per dire, un file, nessun altro processo sarà in grado di aprirlo, anche se hai una lunga durata.

Il blocco di utilizzo garantisce che venga sempre effettuata la chiamata di Dispose e quindi che la chiusura venga sempre chiamata, indipendentemente dal flusso di controllo.

Answer 7

Avvolgere la StreamWriter in un blocco using è praticamente equivalente del seguente codice:

StreamWriter writer; 
try 
{ 
    writer = new StreamWriter(Response.OutputStream); 
    writer.WriteLine("col1,col2,col3"); 
    writer.WriteLine("1,2,3"); 
} 
catch 
{ 
    throw; 
} 
finally 
{ 
    if (writer != null) 
    { 
     writer.Close();  
    } 
} 

Mentre si potrebbe benissimo scrivere questo codice da soli, è molto più facile appena messo in un blocco utilizzando .

Answer 8

La mia regola generale è, se vedo Dispose elencato in intellisense, lo avvolgo in un blocco using.

Answer 9

Mentre è buona norma dipovare sempre classi usa e getta come StreamWriter, come altri sottolineano, in questo caso non importa.

Response.OutputStream verrà smaltito dall'infrastruttura ASP.NET al termine dell'elaborazione della richiesta.

StreamWriter presuppone che "sia proprietario" di un flusso trasmesso al costruttore e pertanto chiude il flusso quando è eliminato.Ma nell'esempio fornito, lo stream è stato istanziato all'esterno del codice, quindi ci sarà un altro proprietario responsabile della pulizia.

Answer 10

Ho intenzione di dare l'opinione dissenziente. La risposta alla domanda specifica "È necessario avvolgere StreamWriter in un blocco usando?" è in realtà No. In effetti, si non deve chiamare Dispose su StreamWriter, perché Dispose è progettato male e fa la cosa sbagliata.

Il problema con StreamWriter è che, quando lo si elimina, disattiva il flusso sottostante. Se hai creato StreamWriter con un nome file e ha creato internamente il proprio FileStream, questo comportamento sarebbe del tutto appropriato. Ma se, come qui, hai creato StreamWriter con uno stream esistente, allora questo comportamento è assolutamente The Wrong Thing (tm). Ma lo fa comunque.

codice come questo non funzionerà:

var stream = new MemoryStream(); 
using (var writer = new StreamWriter(stream)) { ... } 
stream.Position = 0; 
using (var reader = new StreamReader(stream)) { ... } 

perché quando using blocco del StreamWriter dispone la StreamWriter, che a sua volta buttare via la corrente. Quindi quando provi a leggere dallo stream, ottieni una ObjectDisposedException.

StreamWriter è un'orribile violazione della regola "ripulisci il tuo casino". Cerca di ripulire il caos di qualcun altro, che lo volessero o meno.

(immaginate se si è tentato questo nella vita reale. Prova spiegare alla polizia perché si è rotto nella casa di qualcun altro e cominciò a gettare tutte le loro cose nel cestino ...)

Per questo motivo, ho considera StreamWriter (e StreamReader, che fa la stessa cosa) tra le poche classi in cui "se implementa IDisposable, dovresti chiamare Dispose" è sbagliato. Mai chiamata Dispose su StreamWriter che è stato creato su uno stream esistente. Chiama Flush() invece.

Quindi assicurati di ripulire il flusso quando necessario. (Come Joe ha sottolineato, ASP.NET dispone la Response.OutputStream per voi, quindi non c'è bisogno di preoccuparsi qui.)

Attenzione: se non gettare lo StreamWriter, allora si fai devi chiamare Flush() quando hai finito di scrivere. In caso contrario, è possibile che i dati vengano ancora memorizzati in memoria in memoria e che non giungano mai al flusso di output.

La mia regola per StreamReader è, fingere di non implementare IDisposable. Lascia perdere quando hai finito.

La mia regola per StreamWriter è, chiama Flush dove altrimenti avresti chiamato Dispose. (Questo significa che dovete usare un try .. finally invece di un using.)