【 Dart 】 List の使い方 【 Flutter 】

「Dart の List の使い方を知りたい！」

本記事ではそんな要望にお答えします。

Dart (Flutter) で頻出する、List についての解説記事です。
Listの作成方法から、用意されているメソッドまで、
用意されているほぼ全てを解説します。

辞書的に使える記事となっています。

ぜひ読んで使ってみてください！

List とは

Listとは、ある要素数を持った、順序付けられたオブジェクトの集合です。

Listの集合は角括弧(“[ ]”) で囲って表現されます。

以下は、 文字列(String) のListの例です。

この集合のポイントは、何番目かという数字(インデックス)が
各要素に対応付けられていることです。
これが「順序付けられた」という意味となります。

これをコードで表すと、以下のようになります。
上記Listをfluitsという変数に格納した例となります。

List<String> fruits = ['りんご', 'ぶどう', 'みかん'];

List の横に山括弧で型を指定することで、
そのListに保存するオブジェクトの型を指定することができます。

上記例ではString （文字列）を指定しています。

final fruits = <String>['りんご', 'ぶどう', 'みかん'];

要素の取り出し

Listは順序付けられているので、インデックスを指定して要素を取り出すことができます。
変数名[インデックス] で 要素が取り出せます。

上のfluitsの例で1のインデックスを持つ要素は以下のようにして取り出せます。

print(fruits[1]); // = ぶどう

List の作り方(コンストラクタ)

Listの作り方(Listに用意されているコンストラクタの使い方)を解説していきます。

List.empty

List.empty()で空のListが生成されます。

final emptyList = List<String>.empty();

print(emptyList); // []

List.filled

List.filled で、第1引数にて指定された長さ（要素数）を持つ、
要素がすべて第2引数 のListを生成することができます。

以下は、長さ3, 要素がすべて’りんご’のListを生成している例です。

final apples = List.filled(3, 'りんご'); 

print(apples); // [りんご, りんご, りんご]

final apples = List.filled(3, 'りんご');
apples.length = 2; // 実行時エラー
apples.add('みかん') // 実行時エラー

List.from

List.from で Iterable型を持つ要素からListを生成します。

final Iterable<int> iterable = [1, 2, 3];

final list = List<int>.from(iterable);

print(list); // [1, 2, 3]

List.generate

List.generate で 第1引数の長さを持ち、
第2引数で設定した要素の生成関数に従って生成された要素を持つListを生成します。

final list = List.generate(3, (int index) => index * 2);

print(list); // [0, 2, 4]

List.of

List.of で Iterable型を持つ要素からListを生成します。

final Iterable<int> iterable = [1, 2, 3];

final list = List<int>.of(iterable);

print(list); // [1, 2, 3]

List.unmodifiable

List.unmodifiable で Iterable型を持つ要素からListを生成します。

final Iterable<int> iterable = [1, 2, 3];

final list = List<int>.unmodifiable(iterable);

print(list); // [1, 2, 3]

list[1] = 5;

List のプロパティ

Listに用意されているプロパティを一部解説します。

first

firstプロパティでListの最初の要素を取得します。

final fruits = <String>['りんご', 'ぶどう', 'みかん'];

final result = fruits.first;

print(result); // りんご
 
fruits.first = 'バナナ';  // 要素の上書きも可能

isEmpty

isEmptyプロパティでそのListが空であるかどうかを取得します。
空であればtrueとなります。

final emptyList = List<String>.empty();

final result = emptyList.isEmpty;

print(result); // true

isNotEmpty

isNotEmptyプロパティでそのListが空でないかどうかを取得します。
空でなければtrueとなります。

final fruits = <String>['りんご', 'ぶどう', 'みかん'];

final result = fruits.isNotEmpty;

print(result); // true

last

lastプロパティでそのList の最後の要素を取得します。

final fruits = <String>['りんご', 'ぶどう', 'みかん'];

final result = fruits.last;

print(result);  // 'みかん'

fruits.last = 'バナナ';  // 要素の上書きも可能

length

length プロパティでそのListの長さ(要素数)を取得します。

final fruits = <String>['りんご', 'ぶどう', 'みかん'];

final result = fruits.length; 

print(result); // 3

reversed

reversed プロパティでそのList を逆順にしたIterableを返します。

final fruits = <String>['りんご', 'ぶどう', 'みかん'];

final result = fruits.reversed;  

print(result); // (みかん, ぶどう, りんご)

single

singleプロパティで そのListの要素が一つだけか判定し、一つだけならその要素を取得します。

final fruits = <String>['りんご'];

final result = fruits.single;

print(result); // りんご

List のメソッド

Listに用意されているプロパティを一部解説します。

add

addメソッドにより、Listの一番最後に引数の要素が追加されます。

final fruits = <String>['りんご', 'ぶどう', 'みかん'];

fruits.add('バナナ');

print(fruits);  // [りんご, ぶどう, みかん, バナナ]

addAll

addAll メソッドにより、Listの一番最後に引数のIterableがすべて追加されます。

final fruits = <String>['りんご', 'ぶどう', 'みかん'];

final Iterable<String> iterableFruits = ['バナナ', 'マンゴー'];

fruits.addAll(iterableFruits);

print(fruits); // [りんご, ぶどう, みかん, バナナ, マンゴー]

any

any メソッドは、要素ごとに引数の関数を実行し、
一つでもtrueとなるものがあればtrueを返します。

final fruits = <String>['りんご', 'ぶどう', 'みかん'];

final result = fruits.any((element) => element == 'ぶどう');

print(result); // true

asMap

asMapメソッドは、Listをインデックスと要素の組にした、要素の追加等ができない
Map型のオブジェクトを返します。

final fruits = <String>['りんご', 'ぶどう', 'みかん'];

final result = fruits.asMap();

print(result); // {0: りんご, 1: ぶどう, 2: みかん}

clear

clearメソッドにより、Listのすべての要素を削除され、要素数が0となります。

final fruits = <String>['りんご', 'ぶどう', 'みかん'];

fruits.clear();

print(fruits);  // []

contains

containsメソッドは、引数のオブジェクトがListの要素に含まれているかどうかをbool型で返します。

final fruits = <String>['りんご', 'ぶどう', 'みかん'];

final result = fruits.contains('ぶどう');

print(result); // true

elementAt

elementAtメソッドは、引数のインデックスのListの要素を返します。

final fruits = <String>['りんご', 'ぶどう', 'みかん'];

final result = fruits.elementAt(1);

print(result); // ぶどう

every

everyメソッドは、要素ごとに引数の関数を実行し、
すべてtrueであればtrueを返します。

final list = <int>[2, 4, 6];

final result = list.every((element) => element.isEven);

print(result); // true

expand

expandメソッドは、Listの要素を0個、または複数の要素を持つIterableに変換し、
そのそれぞれの境界を無くしたIterableとして保持します。

final list = <int>[1, 2, 3];

final iterable =
    list.expand((element) => [element, element]);

print(iterable); // (1, 1, 2, 2, 3, 3)

fillRange

fillRangeメソッドにより、第1引数以上、第2引数未満のインデックスを持つ要素が、
第3引数の値で上書きされます。

final list = <int>[1, 2, 3, 4, 5];

list.fillRange(1, 3, 7);

print(list); // [1, 7, 7, 4, 5]

firstWhere

firstWhereメソッドは、第1引数の関数の実行結果がtrueとなる最初の要素を返します。
trueとなるものがなかった場合、orElseに設定した関数が呼ばれます。

final list = <int>[1, 2, 3, 4, 5];

final result1 = list.firstWhere((element) => element > 3);

print(result1); // 4

final result2 = list.firstWhere((element) => element > 5, orElse: () => 0);

print(result2); // 0

fold

foldメソッドは、第1引数に初期値とし、
第2引数の関数をその関数の以前の実行結果（初回は初期値）とlistの要素で実行し、
すべての要素で実行されるまで繰り返し、得られた実行結果を返します。

final list = <int>[1, 2, 3, 4, 5];

final result = list.fold<int>(
  0,
  (previousValue, element) => previousValue + element,
); // 15

print(result);

followedBy

followedByメソッドは、引数のIterableをListの最後に結合したIterableを返します。

final fruits = <String>['りんご', 'ぶどう', 'みかん'];

final Iterable<String> iterableFruits = ['バナナ', 'マンゴー'];

final result = fruits.followedBy(iterableFruits);

print(result); // (りんご, ぶどう, みかん, バナナ, マンゴー)

forEach

forEachメソッドは、Listのそれぞれの要素に対し引数の関数を実行します。

final list = <int>[1, 2, 3];

list.forEach((element) {
  final number = element * 2;
  print(number);
}); // 2 4 6

final list = <int>[1, 2, 3];

for (final element in list) {
  final number = element * 2;
  print(number);
} // 2 4 6

getRange

getRangeメソッドは、第1引数以上のインデックスを持ち、第2引数未満のインデックスを持つ
要素達を新たなIterableとして返します。

final fruits = <String>['りんご', 'ぶどう', 'みかん', 'もも', 'かき'];

final result = fruits.getRange(1, 3);

print(result); // (ぶどう, みかん)

indexOf

indexOfメソッドは、
第1引数の要素をListの要素の中で検索して最初に見つかったもののインデックスを返します。

final fruits = <String>['りんご', 'ぶどう', 'みかん', 'もも', 'かき'];

final result = fruits.indexOf('ぶどう');

print(result); // 1

indexWhere

indexWhereメソッドは、第1引数の関数の実行結果がtrueとなる要素を探索し、
最初にtrueとなったもののインデックスを返します。

final fruits = <String>['りんご', 'ぶどう', 'みかん', 'もも', 'かき'];

final result = fruits.indexWhere((element) => element == 'ぶどう');

print(result); // 1

insert

insertメソッドによって、第1引数のインデックスに第2引数の要素が挿入されます。

final fruits = <String>['りんご', 'ぶどう', 'みかん'];

fruits.insert(1, 'バナナ');

print(fruits); // [りんご, バナナ, ぶどう, みかん]

insertAll

insertAllメソッドによって、第1引数のインデックスに第2引数のIterableが挿入されます。

final fruits = <String>['りんご', 'ぶどう', 'みかん'];

final Iterable<String> iterable = ['バナナ', 'パイナップル'];

fruits.insertAll(1, iterable);

print(fruits); // [りんご, バナナ, パイナップル, ぶどう, みかん]

join

joinメソッドは、Listの要素を文字列(String)化し、それらを結合した文字列(String)を返します。

final fruits = <String>['りんご', 'ぶどう', 'みかん'];

final result = fruits.join();

print(result); // りんごぶどうみかん

final fruits = <String>['りんご', 'ぶどう', 'みかん'];

final result = fruits.join('と');

print(result); // りんごとぶどうとみかん

lastIndexOf

lastIndexOfメソッドは、
第1引数の要素をListの要素の中で検索して最後に見つかったもののインデックスを返します。

final fruits = <String>['りんご', 'ぶどう', 'みかん', 'ぶどう'];

final result = fruits.lastIndexOf('ぶどう');

print(result); // 3

lastIndexWhere

lastIndexWhereメソッドは、第1引数の関数の実行結果がtrueとなる要素を探索し、
最後にtrueとなったもののインデックスを返します。

final fruits = <String>['りんご', 'ぶどう', 'みかん', 'ぶどう'];

final result = fruits.lastIndexWhere((element) => element == 'ぶどう');

print(result); // 3

lastWhere

lastWhereメソッドは、第1引数の関数の実行結果がtrueとなる最後の要素を返します。
trueとなるものがなかった場合、orElseに設定した関数が呼ばれます。

final list = <int>[1, 2, 3, 4, 5];

final result1 = list.lastWhere(
  (element) => element > 3,
);

print(result1); // 5

final result2 = list.lastWhere(
  (element) => element > 5,
  orElse: () => 0,
);

print(result2); // 0

map

mapメソッドは、Listの要素を引数の関数で変換した結果の集合のIterableを返します。

final list = <int>[1, 2, 3];

final result = list.map((element) => element * 2);

print(result); // (2, 4, 6)

reduce

reduceメソッドは、2つの要素を処理して1つの値に変換する、引数の関数を繰り返し、
最終的に出力された値を返します。

final list = <int>[1, 2, 3];

final result = list.reduce((value, element) => value + element);

print(result); // 6

remove

removeメソッドは、
引数のオブジェクトをListの中から探索し、最初に見つかったものを削除してtrueを返します。
見つからなかった場合、falseを返します。

final fruits = <String>['りんご', 'ぶどう', 'みかん'];

final result = fruits.remove('ぶどう');

print(result); // true

print(fruits); // [りんご, みかん]

removeAt

removeAtメソッドは、引数のインデックスの要素を削除し、削除した要素を返します。

final fruits = <String>['りんご', 'ぶどう', 'みかん'];

final result = fruits.removeAt(1);

print(result); // ぶどう

print(fruits); // [りんご, みかん]

removeLast

removeLastメソッドは、Listの最後の要素を削除し、削除した要素を返します。

final fruits = <String>['りんご', 'ぶどう', 'みかん'];

final result = fruits.removeLast();

print(result); // みかん

print(fruits); // [りんご, ぶどう]

removeRange

removeRangeメソッドによって、
第1引数以上、第2引数未満のインデックスを持つ要素が削除されます。

final fruits = <String>['りんご', 'ぶどう', 'みかん', 'もも', 'びわ'];

fruits.removeRange(1, 3);

print(fruits); // [りんご, 'もも', 'びわ']

removeWhere

removeWhereメソッドによって、引数の関数の実行結果がtrueとなる要素が削除されます。

final list = [1, 2, 3, 4, 5];

list.removeWhere((element) => element.isEven);

print(list); // [1, 3, 5]

replaceRange

replaceRange メソッドによって、
第1引数以上、第2引数未満のインデックスを持つ要素が削除され、
第1引数の位置に第3引数のIterable が挿入されます。

final fruits = <String>['りんご', 'ぶどう', 'みかん', 'もも', 'びわ'];

final Iterable<String> iterable = ['バナナ', 'パイナップル'];

fruits.replaceRange(1, 4, iterable);

print(fruits); // [りんご, バナナ, パイナップル, びわ]

retainWhere

retainWhereメソッドによって、引数の関数の結果がfalseとなる要素が削除されます。

final list = <int>[1, 2, 3, 4, 5];

list.retainWhere((element) => element > 3);

print(list); // [4, 5]

setAll

setAllメソッドによって、
第1引数のインデックスから、第2引数のIterableの要素で要素が上書きされます。

final fruits = <String>['りんご', 'ぶどう', 'みかん', 'もも', 'びわ'];

final Iterable<String> iterable = ['バナナ', 'パイナップル'];

fruits.setAll(1, iterable);

print(fruits); // [りんご、バナナ、パイナップル、もも、びわ]

setRange

setRangeメソッドによって、
第1引数以上、第2引数未満のインデックスの要素が、
第3引数のIterableの要素の一部で上書きされます。

final fruits = <String>['りんご', 'ぶどう', 'みかん', 'もも', 'びわ'];

final Iterable<String> iterable = ['バナナ', 'パイナップル', 'メロン'];

fruits.setRange(1, 3, iterable);

print(fruits); // [りんご、バナナ、パイナップル、もも、びわ]

final fruits = <String>['りんご', 'ぶどう', 'みかん', 'もも', 'びわ'];

final Iterable<String> iterable = ['バナナ', 'パイナップル', 'メロン'];

fruits.setRange(1, 3, iterable, 1);

print(fruits); // [りんご, パイナップル, メロン, もも, びわ]

shuffle

shuffleメソッドによってリストの要素の順番がランダムに入れ替わります。

final fruits = <String>['りんご', 'ぶどう', 'みかん', 'もも', 'びわ'];

fruits.shuffle();

print(fruits); // [もも, ぶどう, みかん, びわ, りんご]

singleWhere

singleWhereメソッドは、
第1引数の関数の実行結果がtrueとなる要素が1つだけだった場合、その要素を返します。
複数存在する場合はエラーとなります。
trueとなるものがなかった場合、orElseに設定した関数が呼ばれます。

final fruits = <String>['りんご', 'ぶどう', 'みかん', 'もも', 'ぶどう'];

final result = fruits.singleWhere((element) => element == 'もも');

print(result); // もも

// final result2 = fruits.singleWhere((element) => element == 'ぶどう'); // 実行時エラー

final result3 = fruits.singleWhere(
  (element) => element == 'マンゴー',
  orElse: () => 'なし',
);

print(result3); // なし

skip

skipメソッドは、
引数に指定された数の要素が、Listの始めから削除されたIterableを返します。

final fruits = <String>['りんご', 'ぶどう', 'みかん', 'もも', 'かき'];

final result = fruits.skip(2);

print(result); // (みかん, もも, かき)

skipWhile

skipWhileメソッドは、
Listの要素の最初から引数の関数の実行結果がfalseとなるまで、
引数の関数の実行結果がtrueを返す要素を削除したIterableを返します。

final list = <int>[1, 2, 3, 4, 5];

final result = list.skipWhile((value) => value < 3);

print(result); // (3, 4, 5)

sort

sortメソッドは、
引数の関数の結果に応じてListの要素の順番を入れ替えます。

final list = <int>[1, 3, 5, 2, 4];

list.sort((a, b) => b.compareTo(a));

print(list); // [5, 4, 3, 2, 1]

sublist

subListメソッドは、
第1引数以上、第2引数未満のインデックスの要素で作られたListを返します。
第2引数が省略された場合、Listの最後の要素までで作成されたListを返します。

final fruits = <String>['りんご', 'ぶどう', 'みかん', 'もも', 'かき'];

final subFruits1 = fruits.sublist(1, 3);

print(subFruits1); // [ぶどう, みかん]

final subFruits2 = fruits.sublist(1);

print(subFruits2); // [ぶどう, みかん, もも, かき]

take

takeメソッドは、
Listの始めの要素から引数に指定された数の要素で作成されたIterableを返します。

final fruits = <String>['りんご', 'ぶどう', 'みかん', 'もも', 'かき'];

final result = fruits.take(3);

print(result); // (りんご, ぶどう, みかん)

takeWhile

takeWhileメソッドは、
Listの要素の最初から引数の関数の実行結果がfalseとなるまで、
引数の関数の実行結果がtrueを返す要素で作成されたIterableを返します。

final list = <int>[1, 2, 3, 4, 5];

final result = list.takeWhile((value) => value < 3);

print(result); // (1, 2)

toList

toListメソッドは、自身をListに変換したものを返します。
引数のgrowableをfalseにすることで、Fixed-length listとすることができます。

toSet

toSetメソッドは自身をSetに変換したものを返します。
Listの要素の中に重複があれば、それらの1つだけを残すよう要素が削除されます。

final fruits = <String>['りんご', 'ぶどう', 'みかん', 'もも', 'ぶどう'];

final result = fruits.toSet();

print(result); // {りんご, ぶどう, みかん, もも}

toString

toStringメソッドは、
Listを文字列化したものを返します。

final fruits = <String>['りんご', 'ぶどう', 'みかん', 'もも', 'かき'];

final result = fruits.toString();

print(result); // [りんご, ぶどう, みかん, もも, かき]

where

whereメソッドは、
引数の関数の実行結果がtrueとなる要素で作られたIterableを返します。

final list = <int>[1, 2, 3, 4, 5];

final result = list.where((element) => element > 3);

print(result); // (4, 5)

whereType

whereTypeメソッドは、
<>で指定した型を持つListの要素で作られたIterableを返します。

final list = [1, 2.4, 'a', 4.5, 5];

final result = list.whereType<int>();

print(result); // (1, 5)

まとめ

Dart (Flutter) で頻出する、List についての解説しました。
Listの作成方法から、用意されているメソッドまで、
用意されているほぼ全てを解説しました。

いかがだったでしょうか？

ほぼ全てに実行例のコードをつけていますので、
辞書的に本記事を使っていただければと思います。

ぜひ、本記事をあなたのアプリ開発に役立ててください。

本記事があなたのアプリ開発の一助となれば幸いです。

編集後記（2022/10/20）