CSVを扱うシステムで考慮すべきこと

大井俊之

2024年05月08日

※当記事は2023年1月に執筆した記事で、情報は当時のものになります。

はじめに

こんにちは。大井です。
今回はCSV（Comma-Separated Values）のお話をさせていただきます。

私は2000年代からエンジニアをやっており、システムの連携などにCSVを多用してきました。
そして2020年代の現在においても、JSONやXMLを押し退けてCSVが採用されるケースがあり、若手が設計で躓きそうになる場面もいくつか見て来ました。

本記事では、CSVを扱った経験のある社内メンバーから、半ば常識化している「CSVを扱うシステムで考慮すべきこと」をまとめてみました。

もし、Creating Shared Valueが気になって閲覧されたのであれば、株式会社メンバーズ CSV戦略コンサルティング・CSV型プロモーション実行支援を是非ご覧ください。

CSVは各社が色々な形で実装してきた結果、様々な形式が混在するようになりました。
RFC-4180に記載されているCSVフォーマットもInformationalであり、標準化されているわけではありません。
「CSVフォーマット」という概念では、共通の認識にならないのです。

「CSVフォーマットで送るから取り込んでください」という要望だけでは設計・実装できません。
細部を詰めていく必要があるため、難しくなりがちなのです。

では、CSVフォーマットにおいて気をつけるべき点を列挙していきます。
使用するフレームワークやライブラリが綺麗に処理してくれるようなものもありますので、そういったものは「テスト観点で漏れないか」を意識すると良いです。

使用する記号は、ダブルクオート or シングルクオート
表示する条件は、常にあり or 常になし or 改行やカンマを含むなどの必要な時だけ or カラム毎に定義する
囲み文字内に囲み文字が入る場合のエスケープ方法
- 例：ダブルクオートを ""のように二重化してエスケープ（Excelのエスケープ）
- 例：\でエスケープ（Linuxでよく使われるエスケープ）

CSVを「人が編集するか」が、CSVを扱うシステムでは大きなポイントとなります。
人が編集するのであれば、そこで発生する問題も考慮しなければなりません。
ほとんどのケースでExcelが利用されるため、Excelの挙動を考えることなります。

例えば、編集の過程でフォーマットが変わり意図しない値となったり、Excelのバリデーションに引っかかるケースなどがあるため、対策が必要となります。
以下に具体的に列挙していきます。

前ゼロ埋めの数字は、前ゼロが消えてしまう場合がある
- 例：IDを英字で始まりに変更する（固定プレフィックスAをつけて、A012345という形式にする）
- 例：電話番号をハイフンを入れた形式とする（000-000-0000）
- 桁数の多い数字は、指数化される場合がある

昨今のシステム開発では、CSVファイルを扱うのは主流ではないと思います。
本記事の通り、開発者目線では曖昧な部分もあり考慮すべき点も多く、API連携やJSON・XMLなどを採用する方が多いでしょう。

しかし、ユーザー目線では、Excelで直感的に編集でき扱いやすいということも事実です。
しばらくの間は、引き続きCSVの需要はあるのではないでしょうか。

この記事が役に立てば幸いです。

大井俊之

2019年中途入社。若手の多い中、経験値で勝負しています。現在はテクニカルディレクターとして上流工程を中心に開発案件を担当。シェル芸大好き。

Be Engineer, More Agile

最新の技術トレンド、実践例、アジャイルな開発チームをつくるためのノウハウ・ナレッジなどを中心に提供してまいります。