Warum kopiert BufferedInputStream ein Feld in eine lokale Variable, anstatt das Feld direkt zu verwenden?

Wenn ich den Quellcode von lese java.io.BufferedInputStream.getInIfOpen(), bin ich verwirrt darüber, warum er Code wie diesen geschrieben hat:

/**
 * Check to make sure that underlying input stream has not been
 * nulled out due to close; if not return it;
 */
private InputStream getInIfOpen() throws IOException {
    InputStream input = in;
    if (input == null)
        throw new IOException("Stream closed");
    return input;
}

Warum wird der Alias ​​verwendet, anstatt die Feldvariable indirekt wie unten zu verwenden:

/**
 * Check to make sure that underlying input stream has not been
 * nulled out due to close; if not return it;
 */
private InputStream getInIfOpen() throws IOException {
    if (in == null)
        throw new IOException("Stream closed");
    return in;
}

Kann jemand eine vernünftige Erklärung geben?

Wenn Sie diesen Code außerhalb des Kontexts betrachten, gibt es keine gute Erklärung für diesen "Alias". Es ist einfach redundanter Code oder schlechter Codestil.

Der Kontext ist jedoch, dass BufferedInputStreames sich um eine Klasse handelt, die in Unterklassen unterteilt werden kann und in einem Multithread-Kontext arbeiten muss.

Der Hinweis ist, dass in inis deklariert FilterInputStreamist protected volatile. Das bedeutet , dass eine Chance besteht, dass eine Unterklasse in und assign erreichen konnte nullzu in. Angesichts dieser Möglichkeit ist der "Alias" tatsächlich vorhanden, um eine Rennbedingung zu verhindern.

Betrachten Sie den Code ohne den "Alias"

private InputStream getInIfOpen() throws IOException {
    if (in == null)
        throw new IOException("Stream closed");
    return in;
}

1. Thread A ruft auf getInIfOpen()
2. Thread A wertet aus in == nullund sieht das innicht null.
3. Gewinde B Abtretungsempfänger nullzu in.
4. Thread A wird ausgeführt return in. Was zurückkehrt, nullweil aa volatile.

Der "Alias" verhindert dies. Jetzt inwird nur einmal von Thread A gelesen. Wenn Thread B nullnach Thread A zuweistin , spielt dies keine Rolle. Thread A löst entweder eine Ausnahme aus oder gibt einen (garantierten) Wert ungleich Null zurück.

Dies liegt daran, dass die Klasse BufferedInputStreamfür die Verwendung mit mehreren Threads ausgelegt ist.

Hier sehen Sie die Deklaration von in, die in die übergeordnete Klasse gestellt wird FilterInputStream:

protected volatile InputStream in;

Da dies der protectedFall ist , kann sein Wert von jeder Unterklasse von FilterInputStreameinschließlich BufferedInputStreamund seinen Unterklassen geändert werden . Außerdem wird es deklariert volatile. Wenn also ein Thread den Wert der Variablen ändert, wird diese Änderung sofort in allen anderen Threads wiedergegeben. Diese Kombination ist schlecht, da die Klasse BufferedInputStreamnicht steuern oder wissen kann, wann sie ingeändert wird. Somit kann der Wert sogar zwischen der Prüfung auf Null und der return-Anweisung in geändert werden BufferedInputStream::getInIfOpen, wodurch die Prüfung auf Null effektiv unbrauchbar wird. Durch das ineinmalige Lesen des Werts zum Zwischenspeichern in der lokalen Variablen inputist die Methode BufferedInputStream::getInIfOpenvor Änderungen durch andere Threads geschützt, da lokale Variablen immer einem einzelnen Thread gehören.

Es gibt ein Beispiel in BufferedInputStream::close, das inauf null gesetzt ist:

public void close() throws IOException {
    byte[] buffer;
    while ( (buffer = buf) != null) {
        if (bufUpdater.compareAndSet(this, buffer, null)) {
            InputStream input = in;
            in = null;
            if (input != null)
                input.close();
            return;
        }
        // Else retry in case a new buf was CASed in fill()
    }
}

Wenn BufferedInputStream::closees von einem anderen Thread aufgerufen wird, während BufferedInputStream::getInIfOpenes ausgeführt wird, würde dies zu der oben beschriebenen Race-Bedingung führen.

Dies ist ein so kurzer Code, der sich jedoch in einer Umgebung mit mehreren Threads theoretisch indirekt nach dem Vergleich ändern kann, sodass die Methode etwas zurückgeben kann, das sie nicht überprüft hat (sie kann zurückkehren nullund genau das tun, was sie beabsichtigt war) verhindern).

Ich glaube, das Erfassen der Klassenvariablen inin der lokalen Variablen inputsoll inkonsistentes Verhalten verhindern, wenn ines während der getInIfOpen()Ausführung von einem anderen Thread geändert wird.

Beachten Sie, dass der Eigentümer von indie übergeordnete Klasse ist und diese nicht als markiert final.

Dieses Muster wird in anderen Teilen der Klasse repliziert und scheint eine vernünftige defensive Codierung zu sein.