WebObjects：CSVレスポンスの実装

Webアプリケーションにおいて，データベースの内容をCSVデータにしてユーザにダウンロードさせたい場合があるかと思います。ここではWebObjectsの環境で作成するWebアプリでの実装例として，ボタンクリックに対するWebブラウザへのレスポンスをCSVデータとすることで，WebブラウザでCSVデータをダウンロードさせる実装例を示します。

【処理の概要】
WebObjectsのアクションメソッドの戻り値としてコンポーネントクラスのインスタンスを返すと，WebObjectsがそのクラスのappendToResponseメソッドを呼び出してWebブラウザへのレスポンスを作成します。この仕組みを使ってCSVデータを返すために，CSVデータを返すためのコンポーネントクラスを作り，メンバ変数にCSVデータセットしてappendToResponseメソッドが呼ばれればCSVレスポンスが作られるようにします。

【実装手順】
１）コンポーネントの作成
CSVデータを返すコンポーネントを作成します。
これは通常のHTMLを返すコンポーネントの新規作成と同じで，開発環境Xcodeの「新規ファイル」ダイアログから「WebObjects」→「Component」を選んで「次へ」ボタンで進み，ターゲットを「Application Server」にしてファイル名にコンポーネント名を入力して完了ボタンで作成を実行します。
ここでは仮に，コンポーネント名を「CSVExport」と指定することにします。

２）CSVデータを保持するメンバ変数と初期化メソッドの作成
CSVExport.javaにて，CSVデータとファイル名を保持するメンバ変数と，これに値を設定する初期化メソッドを実装します。

private String mFileName;
private String mCSVData;

public void init (
　　String fileName,
　　String csvData)
{
　　mFileName = fileName;
　　mCSVData　= csvData;
}

３）appendToResponseのオーバーライド
CSVExport.javaにて「appendToResponse」メソッドを定義すると，Application.javaやSession.javaで定義したappendToResponseメソッドがオーバーライドされます。CSVデータを返す場合のappendToResponseメソッドは以下のようになります。このメソッドでは，出力するCSVファイルをExcelで開くことができるように，文字コードを「Windows-31J/MS932」に指定しています。

public void appendToResponse (
　　WOResponse res,
　　WOContext　cont)
{
　　res.setContextEncoding("MS932");
　　super.appendToResponse(res, cont);
　　if (mFileName != null && mCSVData != null) {
　　　　res.setHeader("public", "Cache-Control");
　　　　res.setHeader("public", "Pragma");
　　　　res.setHeader("text/csv;charset=Windows-31J", "Content-Type");
　　　　res.setHeader("attachment;filename=\""+mFileName+".csv\"", "Content-Disposition");
　　　　res.setHeader(new Long(mCSVData.length()).toString(), "Content-Length");
　　　　res.setContent(mCSVData);
　　　　res.setStatus(res.HTTP_STATUS_OK);
　　}
}

上記コードのうち，

res.setHeader("public", "Cache-Control");
res.setHeader("public", "Pragma");

はIEのダウンロード問題に対処したものです。
以上でCSVExportコンポーネントの実装は完了です。

４）アクションメソッドからの呼び出し
Webアプリ上でボタンを押すと，CSVExportコンポーネントによりCSVファイルがダウンロードされるようにします。
WebアプリのCSVダウンロードボタンを配置したページのコンポーネントクラスにおいて，ボタンを押したときに呼ばれるアクションメソッドを用意して，その戻り値としてCSVExportクラスインスタンスを返すようにします。アクションメソッドは以下のようになります。

public CSVExport exportAction ()
{
　　CSVExport nextPage = null;
　　String fileName = buildFileName();　// ファイル名生成.
　　String csvData = buildCSVData();　　// CSVデータ生成.
　　if (csvData != null && 0 < csvData.length()) {
　　　　nextPage = (CSVExport)pageWithName("CSVExport");
　　　　nextPage.init(fileName, csvData);
　　}
　　return nextPage;
}

このアクションメソッドをWebページのWOSubmitButtonなどにバインドすることにより，ユーザのボタン押下でCSVデータをWebブラウザからダウンロードすることができます。

５）CSVデータ生成メソッドの実装の概要
CSVデータの作成についてはJavaの「StringBuffer」クラスで組み立てるのが一般的かと思います。
CSVのデータフォーマットの仕様についてはRFC4180（日本語訳）を参照してください。
この実装方法で巨大なCSVファイルを扱う場合，最後にtoStringメソッドでStringインスタンスを生成するときに，文字列データに必要なメモリサイズが倍になってしまうので，メモリ不足に注意しましょう。WebObjectsのメモリ不足対策はこちら。

private String buildCSVData ()
{
　　StringBuffer buff = new StringBuffer();
　　buff.append("カラム1-1");
　　buff.append(",");　　　　// カンマ挿入.
　　buff.append("\"");　　　　// ダブルクォーテーション（二重引用符）挿入.
　　buff.append("カラム1-2");
　　buff.append("\"");
　　buff.append("\r\n");　　　// 改行(CRLF)挿入.
　　buff.append("カラム2-1");
　　buff.append(",");
　　buff.append("\"");
　　buff.append("カラム2-2");
　　buff.append("\"");
　　buff.append("\r\n");

　　return buff.toString();
}

※CSVの「数値/数値」をExcelで日付にしないために
ここで実装したしたCSVレスポンスのデータをユーザがダウンロードしてExcelで開いて閲覧・編集する場合，フィールドデータの形式が「数値/数値」または「数値-数値」で，数値が日付として解釈できる範囲内の場合，Excelはこれを勝手に日付データとして取り込んでしまいます。
これに対する対処法として，CSVレスポンスデータを組み立てるときにフィールドデータの先頭に半角スペースを入れる，というのが最も手っ取り早い対処法かと思います。先頭に半角スペースを入れた「 数値/数値」のデータをExcelに読み込ませると，Excelはこのデータの先頭の半角スペースを削除して日付ではなく文字列としてデータを取り込みます。
参考：Excel で文字列または数値が意図しない表示形式に変換される（Microsoftサポートオンライン）

※上記コードでは，整形のため全角スペースを使用している部分があります。
【著作権表記】上記コードを含む本ブログのプログラムコードは，私的利用可，商用利用可，改変しての利用可です。利用の際に作者に許諾を得る必要はありません。

■関連情報
CSVの仕様：RFC4180（日本語訳）
Java：Shift_JISのエイリアスの変更について
Microsoftサポートオンライン：IEのダウンロードの問題
Java：CSVパーサを作る[その１][その２][その３]
WebObjects：[API Reference(javadoc)][ADC Tools][サポート]

■関連書籍をAmazonで検索：[WebObjects 和書 洋書]
●コーディングの掟 現場でよく見る不可解なJavaコードを一掃せよ!

　　　←この記事が役に立ったという方はクリックお願いします。

---

Java：MySQLに金額を格納する

データベースで金額を格納するのに適したデータ型として，MySQLでは「DECIMAL」型があります。FLOATやDOUBLEのような浮動小数点数の型では，小数点以下の値は近似値となりますが，DECIMALでは小数点以下の値も含めて正確に保存するために，MySQL5.0.3以前では数値を文字列に，5.0.3以降ではバイナリデータに変換して保存しています。「DEC」「NUMERIC」「FIXED」はDECIMALの別名です。
DECIMALフィールドの宣言は「DECIMAL(M,D)」です。Mはフィールド全体の桁数，DはMのうち小数点以下の桁数（スケール）を表します。DECIMALの最大桁数（DECIMAL(M,D)のMの値）は，MySQL5.0.3より前は1～254桁まで，5.0.6からは1～65桁までです。また，小数点以下の桁数（DECIMAL(M,D)のDの値）は0～30桁までです。（出典１）（出典２）

MySQLにJavaプログラムからJDBCアダプタ（MySQL Connector/J）経由でアクセスする場合，データベースのDECIMAL型のフィールドは，JDBCによりJavaの「BigDecimal」クラスインスタンスに置き換えられます。
BigDecimalクラスでは，BigDecimalどうしでの四則演算のほか，小数点以下の桁数操作や丸め処理を行うことができます。BigDecimalで指定できる丸め処理は以下になります。

パラメータ	名称	説明
ROUND_UP	切り上げ	計算結果に端数があれば，端数を切り捨てて最小桁を+1（負の値のときは-1）します。
ROUND_DOWN	切り捨て	計算結果に端数があれば，端数を単に切り捨てます。
ROUND_CEILING	正の無限大	計算結果が正の値のときは切り上げ，負の値のときは切り捨てを行います。その結果，誤差は必ず正の方向に現れます。この指定は負の方向に誤差が出てはならない場合に指定します。
ROUND_FLOOR	負の無限大	計算結果が正の値のときは切り捨て，負の値のときは切り上げを行います。その結果，誤差は必ず負の方向に現れます。この指定は正の方向に誤差が出てはならない場合に指定します。
ROUND_HALF_UP	四捨五入	計算結果の端数が0.5より小さいときは切り捨て，0.5より大きいときは切り上げ，0.5のときは切り上げを行います。 注：連続して計算を行う場合には，四捨五入のみを指定して計算すると，計算結果の累積誤差が大きくなる欠点があります。そのため五捨六入と交互またはランダムに切り替えて誤差を抑えるなどの工夫が必要です。
ROUND_HALF_DOWN	五捨六入	計算結果の端数が0.5より小さいときは切り捨て，0.5より大きいときは切り上げ，0.5のときは切り捨てを行います。
ROUND_HALF_EVEN	最近接偶数への丸め	計算結果の端数が0.5より小さいときは切り捨て，0.5より大きいときは切り上げ，0.5のときは結果が偶数になるように切り上げまたは切り捨てを行います。 具体的には「0.5→0（切捨），1.5→2（切上），2.5→2（切捨），3.5→4（切上），4.5→4（切捨），5.5→6（切上）…」といった値になります。 連続して計算を行う場合に，累積誤差が出にくい丸め処理です。
ROUND_UNNECESSARY	丸め無し	計算結果で端数が生じる場合はArithmeticException例外をスローします。

●BigDecimalでの数値の比較
BigDecimal同士で数値を比較する場合，equalsメソッドでは数値としては同じでもスケールが違う値，たとえば「1」「1.0」「1.00」は別の値として判定されてしまいます。
これらを同じ値として比較判定する場合はcompareToメソッドを使います。

●BigDecimalでのゼロ値の判定
BigDecimalに設定された値がゼロかどうかを判定する場合，予めゼロ値を設定したBigDecimalとcompareToメソッドで比較判定する方法もありますが，それ以外に，BigDecimalのsignumメソッドが0を返すかどうかでも判定できます。signumメソッドは値が負の場合は-1，ゼロの場合は0，正の場合は1を返します。
予めゼロ値が設定されているBigDecimalとcompareToで比較したい場合は，Java1.5以降で「BigDecimal.ZERO」が定義されています。

■関連情報
MySQL：5.0.3以降のDECIMAL データ タイプの変更（MySQL5.1：22章：精密計算）
MySQLの数値型：[4.1][5.1]
MySQL Connector/J：JDBCで値を受け渡すときのJavaの型：[5.0][5.1]
端数処理：（Wikipedia）

■関連書籍をAmazonで検索：[MySQL][Java][JDBC]
●MySQL徹底入門 第3版 ～5.5新機能対応～ （kindle本）



　　　←この記事が役に立ったという方はクリックお願いします。

---