Wie ignoriere ich alle Daten von einem InputStream, ohne statische Analyse-Tools auszulösen?

Question

Ich habe eine InputStream, die zu Standout eines anderen Prozesses angefügt ist. Manchmal muss ich Daten aus dem Stream protokollieren und manchmal nicht. Selbst wenn mir die Ausgabe egal ist, muss ich sie trotzdem lesen, damit der andere Prozess wegen eines vollen Ausgabepuffers nicht blockiert. Ich verwende den folgenden Code, um selektiv den Ausgang log:

InputStream is = ...; 
boolean report = ...; 
InputStreamReader isr = new InputStreamReader(is); 
BufferedReader br = new BufferedReader(isr); 
if (report) { 
    String line = null; 
    while ((line = br.readLine()) != null) { 
     Debug.println(line); 
    } 
} else { 
    while (br.readLine() != null) { 
    } 
} 

jedoch in der zweiten while Schleife, FindBugs Benachrichtigungen (RV_DONT_JUST_NULL_CHECK_READLINE), die ich rufe readLine und nur prüft wird, ob es null ist, nichts zu tun mit das Ergebnis. Seine Analyse ist korrekt, aber ich möchte wollen nichts mit dem Ergebnis in diesem Fall tun. Gibt es eine idiomatische Methode, alle Daten aus einem Stream zu konsumieren und zu ignorieren, sodass FindBugs nicht wie ein Fehler aussieht?

Answer 1

können Sie vermeiden String Objekte zu konstruieren, die die gerade weggeworfen erhalten durch skip auf dem InputStream verwenden. (InputStreamReader und BufferedReader haben auch skip Methoden, aber wenn Sie schauen, den gesamten Strom zu überspringen, werden Sie nicht wirklich brauchen, um die Zeichendecodierung Merkmale von InputStreamReader oder der Line-Erkennung und Puffer-Management-Funktionen von BufferedReader.)

while (is.skip(Long.MAX_VALUE) == Long.MAX_VALUE) { 
} 

Es ist unwahrscheinlich, dass die Schleife wird immer mehr als einmal laufen - Sie würden 8 Exabyte aus dem Stream lesen müssen zuerst - aber die Schleife gibt es eine andere FindBugs zu bezwingen Warnung (SR_NO_CHECKED), die, wenn Sie skip nennen geschieht ohne den Rückgabewert zu überprüfen.

---

die SuppressWarnings Anmerkung Mit dem Compiler ist unwirksam zum Schweigen zu bringen, weil es nicht die Compiler sind, die über den ungenutzten Rückgabewert besorgt sind. Die Annotation wird nicht im kompilierten Code gespeichert, daher können Bytecode-Analysatoren wie FindBugs sie nicht sehen. Darüber hinaus gilt in diesem Fall keine der Warnungen, die SuppressWarnings unterdrückt; insbesondere gilt unused nicht, da Rückgabewerte sind nicht unter den Dingen, die der Compiler überprüft.

Anstelle der integrierten Java-Funktion SuppressWarnings können Sie jedoch versuchen, einen anderen Unterdrückungsmechanismus zu verwenden, der von dem Tool zur statischen Analyse bereitgestellt wird, das die Warnung generiert. Im Fall von FindBugs ist dies die SuppressFBWarnings Annotation.

Um den Umfang der Unterdrückung von Warnungen zu minimieren, können Sie den Code zur Generierung von Warnungen in einer eigenen Methode isolieren. Zum Beispiel:

@SuppressFBWarnings("RV_DONT_JUST_NULL_CHECK_READLINE") 
private void consumeWholeStream(BufferedReader br) throws IOException { 
    while (br.readLine() != null) { 
    } 
} 

Dann können Sie diese Methode im gegebenen Kontext verwenden:

if (report) { 
    String line = null; 
    while ((line = br.readLine()) != null) { 
     Debug.println(line); 
    } 
} else { 
    consumeWholeStream(br); 
} 

Der Nachteil ist, dass dies die FindBugs Anmerkung jar auf Ihre Build-Abhängigkeiten hinzu. Es wird jedoch nicht zu den Laufzeit Abhängigkeiten des Programms hinzugefügt.

Answer 2

Versuchen Sie es mit der @SuppressWarnings-Notation.

prüfen Link Excluding warnings using @SuppressWarnings

Einige Hinweise dazu:.

„Ohne die Anmerkung, würde der Compiler beschweren sich, dass die lokale Variable s nie verwendet wird, mit der Anmerkung, der Compiler leise diese Warnung ignoriert lokal an die foo-Methode. Dies ermöglicht es, die Warnungen an anderen Orten der gleichen Übersetzungseinheit oder des gleichen Projekts zu behalten. "

Answer 3

InputStream is = ...; 
boolean report = ...; 
InputStreamReader isr = new InputStreamReader(is); 
BufferedReader br = new BufferedReader(isr); 
String line; 
while ((line = br.readLine()) != null) { 
    if (report) { 
     Debug.println(line); 
    } 
}