【Flutter】LineSplitterで改行コードを活用する方法

2024年10月13日
2024年10月13日
Dart

Dart

Table of Contents

対象者

Dart/Flutterでテキスト処理を行う方法を学びたい方
LineSplitterの基本的な使い方に興味がある方
データの末尾に改行コードがある場合の取り扱いに悩んでいる方

はじめに

LineSplitterは、Dartの標準ライブラリで提供されるクラスで、複数行のテキストを分割するために利用されます。特に改行コードの種類に関わらず、正確にテキストを行単位で分割できるため、ファイル処理やストリームデータの処理に役立ちます。本記事では、LineSplitterの基本的な使い方と、改行コードの扱いに関する注意点について詳しく説明します。

基本的な使い方

まず、LineSplitterを使って文字列を行ごとに分割する基本的な例を見てみましょう。

const lineSplitter = LineSplitter();

test('文字分割', () {
  expect(lineSplitter.convert('aa\nbb\ncc'), ['aa', 'bb', 'cc']);
  expect(lineSplitter.convert('aa\r\nbb\r\ncc'), ['aa', 'bb', 'cc']);
});

上記のコードでは、LineSplitterのconvertメソッドを使用して、文字列を改行ごとに分割しています。\nや\r\nなどの異なる改行コードを使っても、LineSplitterが正しく分割してくれます。

次に、Streamとの連携例です。

test('Stream', () {
  final stream = StreamController<String>();
  final streamLineSplitter = lineSplitter.bind(stream.stream);
  expect(
    streamLineSplitter,
    emitsInOrder(['aa', 'bb', emitsDone]),
  );

  stream.add('a');
  stream.add('a\nb');
  stream.add('b');
  stream.close();
});

LineSplitterは、Streamと組み合わせて使用することもできます。ここでは、StreamControllerからのデータをlineSplitter.bind()で変換し、ストリームの各行を正しく分割しています。

【Flutter】Streamのテストの基礎

データ最後の改行コードの扱い

次に、データの最後に改行コードがある場合の扱いについて説明します。この部分でLineSplitterを使う際に混乱しました。

以下のテストケースでは、改行コードがデータの末尾にあるかどうかによって、LineSplitterがどのように動作するかを検証しています。

group('改行で終わっているかどうかを区別するための検証結果', () {
  test('convert: add separator', () {
    expect(lineSplitter.convert('').length, 0);
    expect(lineSplitter.convert('\n').length, 1);
    expect(lineSplitter.convert('a').length, 1);

    expect(lineSplitter.convert('\n').length, 1);
    expect(lineSplitter.convert('\n\n').length, 2);
    expect(lineSplitter.convert('a\n').length, 1);
    expect(lineSplitter.convert('a\n\n').length, 2);
  });
});

例えば、空文字列に対しては分割結果が空になりますが、改行コードを含む文字列が1つでもあれば、LineSplitterはそれを1行として認識します。
しかし、データの最後に改行コードがあるかどうかを区別するので迷いました。1行の文字列がある場合、最後に改行コードの有無にかかわらず、1行として扱われました。しかし、文字列のあとに改行コードが2つあると、それは2行として扱われることが分かりました。

結局、データの末尾に改行を追加することにしました。そうすることで、指定の文字列の最後の改行コードの有無を区別できるようになりました。付け加えた改行コードを無視する処理が必要になりましたが。

Q&A

**Q: LineSplitterで使用するメソッドはなんですか **

convert: Stringを改行コードで分割する
bind: Streamを改行コードで分割して取得する別のStreamを作成する

Q: LineSplitterを使うときに注意すべきポイントは何ですか？

A: データの末尾に改行コードがあるかどうかで分割結果が変わるため、特に空行を含む場合の挙動に注意が必要です。

Q: ストリームと組み合わせる場合の利点は何ですか？

A: Streamと組み合わせることで、大量のデータやリアルタイムのデータを効率的に行ごとに処理することができます。

まとめ

LineSplitterは、Dartでのテキスト処理を簡単かつ効率的に行うための便利なクラスです。特に、異なる改行コードを統一的に扱える点や、ストリームとの連携でリアルタイムのデータ処理が可能な点が大きな魅力です。改行コードの扱いについては注意が必要ですが、適切に使用することで複雑なテキスト処理もシンプルに実装できます。

ソース(main.dartにコピペして動作確認用)

import 'dart:async';
import 'dart:convert';

import 'package:flutter_test/flutter_test.dart';

void main() {
  const lineSplitter = LineSplitter();

  group('基本', () {
    test('文字分割', () {
      expect(lineSplitter.convert('aa\nbb\ncc'), ['aa', 'bb', 'cc']);
      expect(lineSplitter.convert('aa\r\nbb\r\ncc'), ['aa', 'bb', 'cc']);
    });
    test('Stream', () {
      final stream = StreamController<String>();

      final streamLineSplitter = lineSplitter.bind(stream.stream);
      expect(
        streamLineSplitter,
        emitsInOrder(['aa', 'bb', emitsDone]),
      );

      stream.add('a');
      stream.add('a\nb');
      stream.add('b');
      stream.close();
    });
  });

  group('改行で終わっているかどうかを区別するための検証結果', () {
    test('convert: add separator', () {
      expect(lineSplitter.convert('').length, 0);
      expect(lineSplitter.convert('\n').length, 1);
      expect(lineSplitter.convert('a').length, 1);

      expect(lineSplitter.convert('\n').length, 1);
      expect(lineSplitter.convert('\n\n').length, 2);
      expect(lineSplitter.convert('a\n').length, 1);
      expect(lineSplitter.convert('a\n\n').length, 2);
    });

    test('bind complicated case', () {
      final controller = StreamController<String>();
      final stream = lineSplitter.bind(controller.stream);
      expectLater(
        stream,
        emitsInOrder([
          'Ready.',
          'Set',
          'Go!1',
          '',
          'Go!2',
          '',
          '',
          'Go!3',
          emitsDone,
        ]),
      );

      controller
        ..add('Ready.\nSe')
        ..add('t\nGo!1\n')
        ..add('\nGo!2\n\n')
        ..add('\nGo!3\n')
        ..close();
    });
  });

  group('検証中', () {
    test('convert', () {
      final result = lineSplitter.convert('aaa\nbb');
      expect(result.length, 2);
      expect(result[0], 'aaa');
      expect(result[1], 'bb');
    });

    test('convert: LineSplitter at end', () {
      final result = lineSplitter.convert('aaa\nbb\n');
      expect(result.length, 2);
      expect(result[0], 'aaa');
      expect(result[1], 'bb');
    });

    test('convert: two LineSplitter at end', () {
      final result = lineSplitter.convert('aaa\nbb\n\n');
      expect(result.length, 3);
      expect(result[0], 'aaa');
      expect(result[1], 'bb');
      expect(result[2], '');
    });

    test('convert: two LineSplitter at start', () {
      final result = lineSplitter.convert('\n\naaa\nbb');
      expect(result.length, 4);
      expect(result[0], '');
      expect(result[1], '');
      expect(result[2], 'aaa');
      expect(result[3], 'bb');
    });

    test('convert: add separator', () {
      expect(lineSplitter.convert('').length, 0);
      expect(lineSplitter.convert('\n').length, 1);
      expect(lineSplitter.convert('a').length, 1);

      expect(lineSplitter.convert('\n').length, 1);
      expect(lineSplitter.convert('\n\n').length, 2);
      expect(lineSplitter.convert('a\n').length, 1);
      expect(lineSplitter.convert('a\n\n').length, 2);
    });

    test('trim', () {
      expect(''.trim().length, 0);
      expect(' '.trim().length, 0);
      expect('\n'.trim().length, 0);
      expect('\n\n'.trim().length, 0);
    });

    test('bind', () {
      final controller = StreamController<String>();
      final stream = lineSplitter.bind(controller.stream);
      expectLater(
        stream,
        emitsInOrder(['Ready.', 'Set', 'Go!', emitsDone]),
      );
      controller
        ..add('Ready.\nSet\nGo!')
        ..close();
    });

    test('bind complicated case', () {
      final controller = StreamController<String>();
      final stream = lineSplitter.bind(controller.stream);
      expectLater(
        stream,
        emitsInOrder([
          'Ready.',
          'Set',
          'Go!1',
          '',
          'Go!2',
          '',
          '',
          'Go!3',
          emitsDone,
        ]),
      );

      controller
        ..add('Ready.\nSe')
        ..add('t\nGo!1\n')
        ..add('\nGo!2\n\n')
        ..add('\nGo!3\n')
        ..close();
    });

    test('length', () {
      expect(''.length, 0);
      expect('\n'.trim().length, 0);
      expect('\r\n'.trim().length, 0);

      expect('\n'.trim().isEmpty, true);
      expect('\r\n'.trim().isEmpty, true);
    });
  });
}