【Flutter】パッケージの追加方法【初心者向け】

本記事では、Flutterのプロジェクトに外部パッケージを追加する方法について説明します。

パッケージ追加って何？

Flutterを使ってアプリを作成する場合、Flutter公式のSDKに含まれる機能を用いることになります。SDKの中には、当然基本的な機能は揃っています。しかし、「ネットワーク上から落としてきた画像をキャッシュを使って簡単に管理したい」、「スマホの端末内にあるファイルのパスを知りたい」といった場合は自分で複雑なコードを書いたりする必要が出てきます。そういった場合に、3rdパーティ製のパッケージ（外部ライブラリ）を導入することで簡単に解決することができます。

導入手順

パッケージを探す

まずは、pub.devというFlutter/Dart用のライブラリのパブリックリポジトリ（ライブラリがまとめられたサイト）へアクセスします。

TOP画面に検索窓があるので、例としてsqliteを扱えるようなライブラリを検索してみます。すると、次の画像のような結果が表示されます。（2022/02/13時点）

パッケージを選ぶ

検索結果とともに、右側にいくつか指標が表示されます。

• LIKE：いいね数
• PUB POINTS：パッケージの品質
  • ドキュメントが整理されていたり、情報が明確な場合に評価される（公式による説明）
• POPULARITY：人気指数
  • １００％：使用率がパッケージ全体で上位１％
  • 0％：ほとんど使用されていない

一番上のパッケージは、Dart用のもののようですが、最終更新が５年前で最新のDartに対応していないようですので、採用しないほうが良いでしょう。指標から見ても、ほとんど採用されていないことがわかります。

次のsqfliteを見てみると、指標を見る限り良いパッケージと考えられます。今回はこのパッケージを導入してみましょう。

パッケージを導入する

sqfliteのページにアクセスすると、インストールのタブを選択した画面に導入方法が明記されています。

まず、ターミナルから対象のライブラリをインストールします。これは他のパッケージでも共通の手順になります。

$ flutter pub add sqflite

あとは、pubspec.yamlで依存関係を明記し、インポートするだけです。

dependencies:
  ...
  sqflite:

import 'package:sqflite/sqflite.dart';

上手くいかない場合

以下のポイントを再確認しましょう。

flutter pub getコマンドが実行できていますか？

ターミナルからコマンドを再度入力しましょう。もしくは、AndroidStudioを使用している場合であれば、pubspec.yamlのファイルを開くと画面右上にPub getを実行してくれるボタンが表示されていると思いますので、これをクリックしても同じ処理が行われます。

pubspec.yaml に正しく依存関係が記載できていますか？

pub.devで見つけたパッケージのインストール手順に必ず従いましょう。また、記載方法に誤りがないか確認しましょう。

参考：pubspec.yamlでインデントを間違えると反映されない