Add encoding parameter in StaxEventItemReader [BATCH-2795]

[spring-projects-issues]

Mahmoud Ben Hassine opened BATCH-2795 and commented

The StaxEventItemReader does not provide a parameter to use a particular encoding when reading the XML input. It should provide an "encoding" parameter just like the FlatFileItemReader does for flat files.

---

Affects: 4.1.1

Reference URL: https://stackoverflow.com/questions/54868274/invalid-utf8-encoding-on-processing-xml-file

Referenced from: pull request #728

[spring-projects-issues]

Mahmoud Ben Hassine commented

The problem reported in the SO thread (see reference URL) is probably not due to this issue, but it has contributed to the creation of this feature request when I was analysing things on SB side.

Another SO question asking for this feature: https://stackoverflow.com/questions/56909623/is-there-a-way-to-specify-character-encoding-when-using-the-staxeventitemreader

[spring-projects-issues]

Jawwad Farooq commented

Mahmoud Ben Hassine any expected plan when this feature will be released?

[spring-projects-issues]

Mahmoud Ben Hassine commented

This is planned for the next version 4.3.0 but we did not set a release date yet. Please watch the issue for any updates.

[jdomigon]

Hi. Just migrated from spring-batch 3.0.10 to 4.3.5.

We've detected problems in the encoding read from XML files. The root cause is that the new implementation of StaxEventItemReader has an encoding field, defaulted to the platform default encoding.

Then xmlInputFactory.createXmlEventReader is called passing this encoding.

This precludes the reader from autodetecting the encoding from the input file (usually in the XML header).

¿Woudn't it possible to recover the option to autodetect the file encoding? (probably, allowing "null" on that field would be enough)

[fmbenhassine]

@jdomigon Thank you for your comment. I see your point. We will try to find the best way to allow auto-detecting the encoding from the input file when addressing #4101. Thank you.