ArdorCode

Javaでテキストをファイルに書き込む

2012-05-19T15:48:00.000+09:00

テキストファイルに書き込むを行うとき必要になる情報は、次の３つであることが多いです。

ファイルパスまたはファイル名
エンコーディング
追加書き込みかどうか

あとは１行ずつ書き込むこともあれば、テキストを一気に書き込んでしまうこともあるでしょう。

今回は、テキストデータをファイルに書き込む方法をご紹介します。

Javaでテキストをファイルに書き込みを行う際には、FileWriter、OutputStreamWriterを使用して、
最終的にバッファリングできる「BufferedWriter」を構築すると効率よく書き込みを行うことができます。

FileWriterは、追加書き込みが指定できるので、既にあるファイルに追加書き込みしたいときに使うことが多いです。
OutputStreamWriterは、エンコーディングが指定できるので、UTF-8のファイルを出力したいときに使えます。

実際のコードは次の通りです。

■TextFileWriter.java

import java.io.BufferedWriter;
import java.io.FileOutputStream;
import java.io.FileWriter;
import java.io.IOException;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import java.io.Writer;

/**
 * {@link TextFileWriter}クラスです。
 * 
 * @author ardor
 * @version 1.0
 */
public class TextFileWriter {
 
 /**
  * 文字型出力ストリーム
  */
 private BufferedWriter writer = null;
 
 /**
  * ファイルパスを指定して、ファイル書き込みインスタンスを構築します。
  * 
  * @param filePath ファイルパス
  * @throws IOException ファイルに書き込みできない場合
  */
 public TextFileWriter(String filePath) throws IOException {
  this(filePath, false);
 }
 
 /**
  * ファイルパスを指定して、ファイル書き込みインスタンスを構築します。
  * 追加書き込みを行う場合は、append に true を指定します。
  * 
  * @param filePath ファイルパス
  * @param append true:追加書き込み、false:新規書き込み
  * @throws IOException ファイルに書き込みできない場合
  */
 public TextFileWriter(String filePath, boolean append) throws IOException {
  Writer fileWriter = new FileWriter(filePath, append);
  writer = new BufferedWriter(fileWriter);
 }
 
 /**
  * ファイルパスとエンコーディングを指定して、ファイル書き込みインスタンスを構築します。
  * 
  * @param filePath ファイルパス
  * @param encoding エンコーディング
  * @throws IOException ファイルに書き込みできない場合
  */
 public TextFileWriter(String filePath, String encoding) throws IOException {
  OutputStream out = new FileOutputStream(filePath);
  Writer outWriter = new OutputStreamWriter(out, encoding);
  writer = new BufferedWriter(outWriter);
 }
 
 /**
  * 指定したテキストをファイルに書き込みます。
  * 
  * @param text テキスト
  * @throws IOException ファイルに書き込みできない場合
  */
 public void write(String text) throws IOException {
  try {
   writer.write(text);
  }
  catch(IOException e) {
   close();
   throw e;
  }
 }
 
 /**
  * 指定したテキストを書き込んで改行します。
  * 
  * @param line テキスト
  * @throws IOException ファイルに書き込みできない場合
  */
 public void writeLine(String line) throws IOException {
  try {
   writer.write(line);
   writer.newLine();
  }
  catch(IOException e) {
   close();
   throw e;
  }
 }
 
 /**
  * 文字型出力ストリームを閉じます。
  */
 public void close() {
  try {
   writer.close();
  }
  catch(Exception e) {
   // NOP
  }
 }
}

コンストラクタをオーバーロードして好きなようにファイルを構築できるようにしてあります。

大きなテキストを書き込みたい場合、通常は任意のタイミングで flush() を呼び出すのですが、 BufferedWriterは、バッファが一杯になったタイミング、またはclose()のタイミングでflush()するので、実装は行っていません。

また主な使い方は次の通りです。

■サンプルコード

  try {
   TextFileWriter writer = new TextFileWriter("SampleUTF-8.txt", "UTF-8");
   writer.writeLine("sample line改行あり");
   writer.writeLine("日本語出力テスト");
   writer.write("sample改行なし");
   writer.close();
  }
  catch(Exception e) {
   e.printStackTrace();
  }

Javaの拡張for文でテキストファイルを１行ずつ読み込む方法

2012-05-13T23:23:00.000+09:00

前回、「Javaでテキストファイルの読み込みを行う」をご紹介しました。
この方法で処理できる場合は良いですが、大きなテキストファイルの内容を１行ずつ読み込んで処理したい時や
CSVを１行ずつ読み込んで処理したい時があります。

テキストファイルを１行ずつ読み込む時は、一般的に　BufferedReader.readLine()　を使います。

しかし、この方法でプログラムを組むと、ソースが長くなり読みにくくなる人が多いと思います。
テキストファイルを読み込む処理と、テキスト内容を処理する部分をちゃんと分けて書けるとソースが読みやすくなりますが、
直感的に読みにくくなってしまうのがJavaの弱点ではないかと思います。

そこで、拡張for文を使って完結に、読みやすいソースをご紹介します。

Javaで次のようなコードを目指します！
（他の言語では、何もしなくてもこれで読めてしまうことが多いです。Pythonとか。）

File file = new File("sample.txt");
for (String line : file) {
 // テキストファイルの１行に対する処理を記述する
 System.out.println(line);
}

上記のように書けると便利だと思いませんか？

Javaでも同じようなソースコードを書くことが可能です。
拡張for文は、次の２つのインターフェースを実装するクラスを扱うことができます。

java.lang.Iterable
java.util.Iterator

ListやMapなどのコレクションを扱う際によく利用するインターフェースですね。
これを実装したファイル読み込みクラスを作ってしまえばいいのです。

では実際のソースコードをご紹介します。

■TextLineReader.java

import java.io.BufferedReader;
import java.io.FileInputStream;
import java.io.FileReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.Reader;
import java.util.Iterator;

/**
 * {@link TextLineReader}クラスです。
 * 
 * @author ardor
 * @version 1.0
 */
public class TextLineReader implements Iterable<String> {
 
 /**
  * ファイルパス
  */
 private String filePath = null;
 
 /**
  * エンコーディング
  */
 private String encoding = null;
 
 /**
  * 指定したファイルをデフォルトエンコーディングで読む込むクラスを構築します。
  * 
  * @param filePath ファイルパス
  */
 public TextLineReader(String filePath) {
  this(filePath, null);
 }
 
 /**
  * 指定したファイルを指定エンコーディングで読み込むクラスを構築します。
  * 
  * @param filePath ファイルパス
  * @param encoding エンコーディング
  * @throws IOException ファイルが読み込めない場合
  */
 public TextLineReader(String filePath, String encoding) {
  // ファイルパス
  this.filePath = filePath;
  
  // エンコーディング
  this.encoding = encoding;
 }
 
 /**
  * テキストファイルの１行を読み込む{@link Iterator}を返します。
  * 
  * @return テキストファイル１行の反復子
  */
 @Override
 public Iterator<String> iterator() {
  try {
   return createIterator(filePath, encoding);
  }
  catch (IOException e) {
   throw new RuntimeException(e);
  }
 }
 
 /**
  * テキストファイルの１行を読み込む{@link Iterator}を返します。
  * 
  * @param filePath ファイルパス
  * @param encoding エンコーディング
  * @return テキストファイル１行の反復子
  * @throws IOException
  */
 protected Iterator<String> createIterator(String filePath, String encoding) throws IOException {
  Reader reader = null;
  if (encoding == null) {
   // 文字型入力ストリームクラス
   // デフォルトエンコーディングで読み込み
   reader = new FileReader(filePath); 
  }
  else {
   // 文字型入力ストリームクラス
   // エンコーディング指定で読み込み
   InputStream inputStream = new FileInputStream(filePath);
   reader = new InputStreamReader(inputStream, encoding);
  }
  return new TextLineBuffer(reader);
 }
 
 /**
  * {@link TextLineBuffer}クラスです。
  * テキストファイルを１行ずつ読み込みます。
  * 
  * @author ardor
  * @version 1.0
  */
 class TextLineBuffer implements Iterator<String>{
  
  /**
   * テキストファイル読み込みバッファ
   */
  private BufferedReader buff = null;
  
  /**
   * 文字型入力ストリームを指定してファイル読み込みクラスを構築します。
   * 
   * @param reader 文字型入力ストリーム
   */
  public TextLineBuffer(Reader reader) {
   buff = new BufferedReader(reader);
  }
  
  /**
   * ファイルが読み込み可能か返します。
   * 
   * @return true:読み込み可能、fa;se:読み込み不可能
   */
  @Override
  public boolean hasNext() {
   boolean hasNext = false;
   try {
    // 入力ストリームが読み込み可能か取得
    hasNext = buff.ready();
   } 
   catch (IOException e) {
    // 例外のため入力ストリームをクローズ
    close();
    throw new RuntimeException(e);
   }
   // 入力ストリームをクローズ
   if (!hasNext) {
    close();
   }
   return hasNext;
  }
  
  /**
   * ファイルの１行を読み込んで返します。
   * 
   * @return テキストファイルの１行
   */
  @Override
  public String next() {
   String next = null;
   try {
    // １行読み込み
    next = buff.readLine();
   } 
   catch (IOException e) {
    // 例外のため入力ストリームをクローズ
    close();
    throw new RuntimeException(e);
   }
   // 入力ストリームをクローズ
   if (next == null) {
    close();
   }
   return next;
  }
  
  /**
   * テキストファイルの１行削除は行いません。
   * 未対応
   */
  @Override
  public void remove() {
   // removeする処理は実装しない
  }
  
  /**
   * 入力ストリームをクローズします。
   */
  private void close() {
   try {
    buff.close();
   }
   catch(Exception e) {
    // クローズ時の例外は何も行わない
   }
  }
 }
}

登場クラスは２つあります。
利用者が新しくnewするクラスは、TextLineReaderクラスです。
コンストラクタには、ファイルパス、エンコーディングを指定します。
これは前回ご紹介したクラスのメソッドでもお馴染みで、ファイルを読み込むための最低限の情報です。

また、TextLineReaderは、Iterableを実装します。
実装メソッドであるpublic Iterator iterator()では、ファイルを１行ずつ読み込んで返すクラスを返します。
ファイルを１行ずつ読み込んで返すクラスは、TextLineBufferというインナークラスです。
（Iteratorさえ実装してあるクラスならインナークラスでなくても可能です。）

Iteratorの実装メソッドは、hasNext()とnext()のみ実装しました。

それぞれ、BufferedReaderから取得できる値を返せばＯＫです。
また、読み込み終わったらちゃんとクローズ処理も行います。

途中で例外が発生することがあるかもしれません！
しかし、インターフェースの実装メソッドからは、例外をスローできないため、
RuntimeExceptionにラップしてスローします。
ここは必要に応じて、専用のRuntimeException派生例外クラスを作るといいかもしれませんね。
例えば、IORuntimeExceptionクラスとか。

以上で、拡張for文でテキストファイルを１行ずつ読み込みことができます。
使い方は次の通り。

  TextLineReader texts = new TextLineReader("sample.text", "UTF-8");
  for (String line : texts) {
   System.out.println(line);
  }

これで、ファイルを読み込んだ時の処理が綺麗に実装できると思います。
間違っている箇所等ありましたらコメントを頂けるとうれしいです。

Javaでテキストファイルの読み込みを行う

2012-05-08T22:46:00.000+09:00

Javaでテキストファイルを読み込む場合は、Reader関連のクラスを利用します。
InputStream関連は、イメージデータなどのバイトデータを扱うクラスです。
テキストを扱うには向いていないので注意が必要です。

テキストファイルには、エンコーディングがあります。
（日本語でWindowsを利用している場合には、Shift-JISやMS932が多いです。）

テキストを読み込む場合には、エンコーディングを意識して読み込む必要があります。
Javaでは、エンコーディングの指定を省略した場合、デフォルトエンコーディングが利用されます。

デフォルトエンコーディングを確認するには、次のコードを実行してください。

 public static void main(String args[]) {
  System.out.println(System.getProperty("file.encoding"));
 }

デフォルトエンコーディングで処理する場合は、FileReaderを使います。
エンコーディングを指定する場合には、FileInputStreamを作成してから、InputStreamReaderを使います。

テキストはバッファリングして読み込む方が、効率が良くなります。

テキストを読み込む処理は、次の通りです。

■TextFileReader.java

import java.io.BufferedReader;
import java.io.FileInputStream;
import java.io.FileReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.Reader;

/**
 * {@link TextFileReader}クラスです。
 * テキストファイルを読み込みます。
 * 
 * @author ardor
 * @version 1.0
 */
public class TextFileReader {
 
 /**
  * 指定したファイルをデフォルトエンコーディングで読み込み、
  * テキストを返します。
  * 
  * @param filePath ファイルパス
  * @return ファイル内容
  * @throws IOException ファイルが読み込めない場合
  */
 public String readText(String filePath) throws IOException {
  // 文字型入力ストリームクラス
  // デフォルトエンコーディングで読み込み
  Reader reader = new FileReader(filePath);
  
  // ファイルを読み込んで、テキストを返す
  return readText(reader);
 }
 
 /**
  * 指定したファイルを指定エンコーディングで読み込み、
  * テキストを返します。
  * 
  * @param filePath ファイルパス
  * @param encoding エンコーディング
  * @return ファイル内容
  * @throws IOException ファイルが読み込めない場合
  */
 public String readText(String filePath, String encoding) throws IOException {
  // 文字型入力ストリームクラス
  // エンコーディング指定で読み込み
  InputStream inputStream = new FileInputStream(filePath);
  Reader reader = new InputStreamReader(inputStream, encoding);
  
  // ファイルを読み込んで、テキストを返す
  return readText(reader);
 }
 
 /**
  * 文字型入力ストリームからテキストを読み込んで返します。
  * 
  * @param in 文字型入力ストリーム
  * @return テキスト
  * @throws IOException 文字型入力ストリームが読み込めない場合
  */
 private String readText(Reader in) throws IOException {
  // 文字型入力ストリームを構築
  BufferedReader reader = new BufferedReader(in);
  
  // テキストバッファ
  StringBuffer buff = new StringBuffer(100);
  
  try {
   // テキスト読み込み処理
   char[] cbuf = new char[1024];
   int len = 0;
   while (0 <= (len = reader.read(cbuf))) {
    buff.append(cbuf, 0, len);
   }   
  }
  finally {
   // 文字型入力ストリームをクローズ
   // BufferedReader.close()を呼び出すとコンストラクタに
   // 指定したReaderをクローズする
   close(reader);
  }
  return buff.toString();
 }
 
 /**
  * 文字型入力ストリームをクローズします。
  * 
  * @param reader 文字型入力ストリーム
  */
 private void close(Reader reader) {
  try {
   reader.close();
  }
  catch(Exception e) {
   // クローズ時の例外は何も行わない
  }
 }
}

文字型入力ストリームは必ずクローズしてください。
ストリームを開いたままにすると無駄なインスタンスが残ってしまいます。

使い方は、次の通り。

  TextFileReader reader = new TextFileReader();
  try {
   System.out.println(reader.readText("sample.txt", "UTF-8"));
  }
  catch (IOException e) {
   e.printStackTrace();
  }

JavaでXMLプロパティの読み書きを行う

2012-05-03T21:28:00.001+09:00

Javaのプロパティファイルは、手動でASCIIコードに変換するか、プロパティエディタを利用しないと扱えない。
特に日本語をプロパティファイルに書き込みたい場合は苦労します。

そこでプロパティファイルをXMLで定義してしまえば、ASCIIコード変換もプロパティエディタも必要ありません。

XMLにするとパースが面倒と思われますが、パースする必要もありません。

JavaでXMLプロパティを扱う方法をご紹介します。

読み込むXMLプロパティの形式は次の通りです。

■sample.properties


<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">

コメント
value001
プロパティ値

エンコーディングは「UTF-8(デフォルト)」にしてあります。

キーの指定は、entryタグのkey属性に記述します。
値の指定は、entryタグで囲まれたvalueに記述します。

値は、改行することも可能です。ただし、改行コードが値に含まれるので注意してください。

XMLプロパティを読み込んでプロパティインスタンスにする方法は次の通りです。

■XMLプロパティ読み込み

 /**
  * 指定したXMLプロパティファイルをロードして返します。
  * 
  * @param filePath XMLプロパティファイルパス
  * @return プロパティクラス
  * @throws IOException プロパティファイルが読み込めない場合
  */
 public Properties loadXMLProperties(String filePath) throws IOException {
  // プロパティクラスインスタンス
  Properties properties = new Properties();
  // 入力ストリーム構築
  InputStream in = new FileInputStream(filePath);
  // XML形式のプロパティファイルをロード
  // 入力ストリームはloadFromXMLでクローズされる
  properties.loadFromXML(in);
  // プロパティインスタンスを返す
  return properties;
 }

メソッド内で、 FileInputStreamを構築していますが、クローズする必要はありません。
loadFromXML(in)メソッド内でクローズされます。

次に書き込む方法です。

■XMLプロパティ書き込み

 /**
  * プロパティをXMLプロパティファイルで保存します。
  * 
  * @param properties プロパティクラス
  * @param filePath XMLプロパティファイルパス
  * @param comments コメント(任意) または null
  * @throws IOException XMLファイルとして書き込みできない場合
  */
 public void storeXMLProperties(Properties properties, String filePath, String comments) throws IOException {
  OutputStream os = null;
  try {
   // 出力ストリーム構築
   os = new FileOutputStream(filePath);
   // XML形式のプロパティファイルを出力
   properties.storeToXML(os, comments);
  }
  catch (IOException e) {
   // 例外を通知
   throw e;
  }
  finally {
   // 出力ストリームをクローズ
   os.close();
  }
 }

storeToXMLメソッド内では、FileOutputStreamをクローズしていないので、自分でクローズします。
例のソースコードでは、エンコーディングを指定していないので、UTF-8(デフォルト)になります。
他の文字コードを指定する場合には、storeToXML(OutputStream os, String comment, String encoding)にエンコーディングを指定してください。

クラスの全行は次の通りです。

■XMLProperties.java

import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.Properties;

/**
 * {@link XMLProperties}クラスです。
 * 
 * 
 * @author ardor
 * @version 1.0
 */
public class XMLProperties {
 
 /**
  * 指定したXMLプロパティファイルをロードして返します。
  * 
  * @param filePath XMLプロパティファイルパス
  * @return プロパティクラス
  * @throws IOException プロパティファイルが読み込めない場合
  */
 public Properties loadXMLProperties(String filePath) throws IOException {
  // プロパティクラスインスタンス
  Properties properties = new Properties();
  // 入力ストリーム構築
  InputStream in = new FileInputStream(filePath);
  // XML形式のプロパティファイルをロード
  // 入力ストリームはloadFromXMLでクローズされる
  properties.loadFromXML(in);
  // プロパティインスタンスを返す
  return properties;
 }
 
 /**
  * プロパティをXMLプロパティファイルで保存します。
  * 
  * @param properties プロパティクラス
  * @param filePath XMLプロパティファイルパス
  * @param comments コメント(任意) または null
  * @throws IOException XMLファイルとして書き込みできない場合
  */
 public void storeXMLProperties(Properties properties, String filePath, String comments) throws IOException {
  OutputStream os = null;
  try {
   // 出力ストリーム構築
   os = new FileOutputStream(filePath);
   // XML形式のプロパティファイルを出力
   properties.storeToXML(os, comments);
  }
  catch (IOException e) {
   // 例外を通知
   throw e;
  }
  finally {
   // 出力ストリームをクローズ
   os.close();
  }
 }
}