DZone
Thanks for visiting DZone today,
Edit Profile
  • Manage Email Subscriptions
  • How to Post to DZone
  • Article Submission Guidelines
Sign Out View Profile
  • Post an Article
  • Manage My Drafts
Newsletter
Log In / Join
Refcards Trend Reports
Events Video Library
Refcards
Trend Reports

Events

View Events Video Library

Related

  • Using Java Class Extension Library for Data-Oriented Programming - Part 2
  • Using Java Class Extension Library for Data-Oriented Programming
  • JQueue: A Library to Implement the Outbox Pattern
  • How to Convert CSV to XML in Java

Trending

  • A Reference Architecture for Constrained AI-Assisted Design
  • Key ML Classification Metrics You Need to Understand
  • Post-Quantum TLS for Cloud APIs and Microservices
  • Why 200 OK Is the Most Dangerous Lie in Enterprise Integration

Draft This article hasn't been published, so readers can't see it.

In moderation This article is waiting for review, so readers can't see it yet.

Deleted This article has been deleted, so readers can't see it.

  1. DZone
  2. Coding
  3. Languages
  4. OpenCSV: Properly Handling Backslashes

OpenCSV: Properly Handling Backslashes

OpenCSV is a popular library for handing CSV data in Java projects, but there's a slight problem when dealing with backslashes. Let's see what it is and how to fix it.

By 
Vatsal Mevada
·
Nov. 16, 17 · Tutorial
Post on X (opens in a new tab) Share on LinkedIn (opens in a new tab)
26.3K Views

Join the DZone community Save articles, join the discussion, and download Refcards and Trend Reports with a free account.

Join for free Already a member? Log in

OpenCSV is one of the popular Java libraries out there used for handling CSV data. In this post, I will discuss one specific issue that I recently faced with this library.

The Problem

Here is a minimal code snippet for writing and reading CSV data using OpenCSV:

String dataValue = "test";

//writing  
StringWriter writer = new StringWriter();

try (CSVWriter csvwriter = new CSVWriter(writer)) {
    String[] originalData = new String[2];
    originalData[0] = dataValue;
    originalData[1] = dataValue;
    System.out.println("Original data: " + originalData[0] + "," + originalData[1]);
    csvwriter.writeNext(originalData);
} catch (IOException e) {
    throw new RuntimeException(e);
}
System.out.println("Written data: " + writer.toString());

//reading
try (CSVReader csvReader = new CSVReader(new StringReader(writer.toString()))) {
    String[] readData = csvReader.readNext();
    System.out.println("Read data: " + readData[0] + "," + readData[1]);
} catch (IOException e) {
    throw new RuntimeException(e);
}


The output of the above snippet gives us:

Original data: test,test
Written data: "test","test"

Read data: test,test


Which is as expected. Well, life is good with OpenCSV until you encounter a backslash character ('\\') in your CSV data.

So let's try running the same snippet with dataValue having a backslash character:

String dataValue = "t\\est";


Output:

Original data: t\est,t\est
Written data: "t\est","t\est"

Read data: test,test


Note that the backslash character is gone in the read CSV data.

The Root Cause

By default, CSVReader uses the backslash ('\\') as its escape character. Meanwhile,
CSVWriter uses a double quote('"') as the escape character.

Because of this, at the time of writing, the backslash characters lead to improper escaping. At the time of reading, a single backslash character will be ignored by the CSVParser, as it is the escape character.

The Solution

By default, CSVReader uses CSVParser for parsing CSV data. OpenCSV provides another parser (RFC4180Parser) that strictly follows RFC4180 standards.

Using RFC4180Parser, the CSVReader will use a double quote ('"') as the escape character, making it consistent with CSVWriter.

We need to replace the reading part of the above-mentioned snippet with the following code:

RFC4180Parser rfc4180Parser = new RFC4180ParserBuilder().build();
CSVReaderBuilder csvReaderBuilder = new CSVReaderBuilder(new StringReader(writer.toString()))
                .withCSVParser(rfc4180Parser);
try (CSVReader csvReader = csvReaderBuilder.build()) {
    String[] readData = csvReader.readNext();
    System.out.println("Read data: " + readData[0] + "," + readData[1]);
} catch (IOException e) {
    throw new RuntimeException(e);
}


Output:

Original data: t\est,t\est
Written data: "t\est","t\est"

Read data: t\est,t\est


P.S.: Apache Commons CSV is a good alternative to OpenCSV.

The library version used for the code snippets was OpenCSV 4.0.

CSV Snippet (programming) Data (computing) Library Java (programming language) Parser (programming language) POST (HTTP)

Published at DZone with permission of Vatsal Mevada. See the original article here.

Opinions expressed by DZone contributors are their own.

Related

  • Using Java Class Extension Library for Data-Oriented Programming - Part 2
  • Using Java Class Extension Library for Data-Oriented Programming
  • JQueue: A Library to Implement the Outbox Pattern
  • How to Convert CSV to XML in Java

Partner Resources

×

Comments

Loading comments

The comments didn't load

Please try again in a moment.

Likes

Loading

The next likes didn't load. Please try again.

The likes didn't load

Please try again in a moment.

See who liked this

Log in or join DZone for free to see who liked this article.

Log in Join for free
  • RSS
  • X
  • Facebook

ABOUT US

  • About DZone
  • Support and feedback
  • Community research

ADVERTISE

  • Advertise with DZone

CONTRIBUTE ON DZONE

  • Article Submission Guidelines
  • Become a Contributor
  • Core Program
  • Visit the Writers' Zone

LEGAL

  • Terms of Service
  • Privacy Policy

CONTACT US

  • 3343 Perimeter Hill Drive
  • Suite 215
  • Nashville, TN 37211
  • [email protected]

Let's be friends:

  • RSS
  • X
  • Facebook