org.json.JSONTokener should close or provide option to close java.io.Reader

Offen

#836 erstellt am 07.12.2023 4 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 5/5
Geschätzter Aufwand: Über eine Woche
Anfängerfreundlichkeit: 35/100

Issue-Typ: Feature
Klarheit: Größtenteils klar
Aktivitätsstatus: Veraltet
Tech-Stack: java
Bereich: backend-api-design

Rechercherichtung

Start by reading org.json.JSONTokener and the JavaDoc describing responsibility for closing the supplied Reader. Determine whether the intended change is automatic closing or an explicit close option, then inspect existing tests or add coverage for the chosen reader-lifecycle behavior.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

No changes at this time

Hi,

I spent a few days trying to fix an issue where I got the following error:

java.nio.file.FileSystemException: path/to/file: The process cannot access the file because it is being used by another process.

I started using FileLock to try to get a hold on the lock and wait until the lock was released, but unfortunately for this file, it would never be released.

That is because I was using a JSONTokener to tokenize a JSON file using an anonymous FileReader. This stream would never be closed, and therefor the error mentioned above.

Because JSONTokener doesn't provide an API to close the stream provided as parameter, I have to correct my implementation like this:

Obviously after reading the class it is clear how it should be used, since it is clearly written in the JavaDoc that the Reader must be closed by the caller.

I believe this implementation could be improved.

Implement Closeable/AutoClosable on JSONTokener and make JSONTokener throw some sort of exception to explicitly tell the user that the Reader must be closed. And then we could have a cleaner and more explicit implementation like this:

Let me know if my suggestion is outrageous. But I feel at least I should bring it here.

Thank you for your attention. :)

Vorherrschende Sprache: Java
Sterne: 4.7k
Forks: 2.6k
Ø Merge: 6 T. 20 Std.
Gemergte PRs (30 T.): 2

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
Forken Sie das Repository und arbeiten Sie in einem Branch.
Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus stleary/JSON-java

JSONPointer pre-existing bug in toURIFragment() Offen

Fix before the next release

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100

stleary/JSON-java#1082 · Erstellt am 20.9.2026
New JSONPointer tests needed Offen

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 76/100

stleary/JSON-java#1081 · Erstellt am 20.9.2026
JSONML checks childNode instead of the reserved childNodes attribute Offen

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 88/100

stleary/JSON-java#1080 · Erstellt am 19.9.2026
JSONML decodes text entities twice with keepStrings enabled Offen

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 82/100

stleary/JSON-java#1079 · Erstellt am 19.9.2026
JSONObject.toString does not use an Enum's `toString()` but its `name()` Offen

Fix before the next release

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100

stleary/JSON-java#838 · 16 Kommentare · 3 Reaktionen · Erstellt am 11.12.2023

Alle Issues in stleary/JSON-java