Dart パッケージとライブラリ管理
プロジェクトの規模が大きくなると、コードを複数のファイルやモジュールに分割することが不可欠です。
この章では、Dart のパッケージ管理システム pub、依存関係設定ファイル pubspec.yaml、import/export 構文、およびカスタムライブラリの作成方法について説明します。
pubspec.yaml 構成
pubspec.yaml はすべての Dart プロジェクトの中心的な設定ファイルであり、プロジェクトのメタデータと依存関係を宣言します。
典型的な pubspec.yaml ファイルの構造は次のとおりです:
例
name: my_dart_app # プロジェクト名(必須、小文字+アンダースコア)
description: Dart のサンプルプロジェクト# プロジェクト説明
version: 1.0.0 # バージョン番号
# publish_to: none # pub.dev に公開したくない場合は、この行のコメントを解除します
environment:
sdk: '>=3.0.0 <4.0.0' # Dart SDK のバージョン範囲
dependencies:
# プロジェクトの実行時に依存するサードパーティパッケージ
http: ^1.1.0 # HTTP クライアント
path: ^1.8.0 # パスツール
dev_dependencies:
# 開発時のみ必要な依存関係(テスト、コードチェックなど)
test: ^1.24.0 # テストフレームワーク
lints: ^2.0.0 # 公式 lint ルール
# オプション:実行可能ファイルのエントリポイント
# executables:
# my_app: main
バージョン番号の記述方法の説明:
| 記述方法 | 意味 | 例 |
|---|---|---|
| ^1.1.0 | 1.1.0 から 2.0.0(含まない)まで互換 | 最も一般的で推奨される |
| 1.1.0 | 正確なバージョン | あまり柔軟ではない |
| >=1.1.0 <1.5.0 | バージョン範囲 | 正確に制御する必要がある場合に使用 |
| any | 任意のバージョン | 推奨されない |
^(キャレット)は Dart のデフォルトのバージョン制約方法です。^1.1.0 は >=1.1.0 <2.0.0 と同等です。つまり、マイナーバージョンとパッチバージョンは自動的にアップグレードできますが、メジャーバージョンはアップグレードできません(メジャーバージョンのアップグレードには破壊的変更が含まれる可能性があります)。
依存関係のインストール
$ dart pub get # 安装依赖 $ dart pub upgrade # 升级依赖到最新兼容版本 $ dart pub outdated # 查看哪些依赖有更新
pub.dev で依存関係を探す
pub.dev は Dart と Flutter の公式パッケージリポジトリであり、npm(JavaScript)や PyPI(Python)に似ています。
あなたはhttps://pub.dev上で、数万に及ぶ Dart パッケージを検索および閲覧できます。
よく使われるサードパーティパッケージの例:
| パッケージ名 | 用途 | 説明 |
|---|---|---|
| http | HTTP リクエスト | 公式がメンテナンスする HTTP クライアント |
| path | パス操作 | クロスプラットフォームのパス処理ツール |
| test | ユニットテスト | 公式テストフレームワーク |
| json_serializable | JSON シリアライズ | JSON 変換コードを自動生成 |
| dio | HTTP クライアント | http より強力なサードパーティ HTTP ライブラリ |
| riverpod | 状態管理 | Flutter プロジェクトで人気の状態管理ソリューション |
例
http パッケージを追加して使用する:
// http: ^1.1.0
// 次に実行:dart pub get
import 'package:http/http.dart' as http;
void main() async {
// GET リクエストを送信
var url = Uri.parse('https://www.example.com');
var response = await http.get(url);
print('ステータスコード: ${response.statusCode}');
print('レスポンスボディの長さ: ${response.body.length} 文字');
}
import インポート構文
import は、Dart ファイル内で他のライブラリのコードを取り込むために使用します。
Dart は複数のインポート方法をサポートしており、それぞれ異なるシナリオに適しています。
Dart 組み込みライブラリのインポート
例
import 'dart:math'; // 数学ライブラリ(乱数、三角関数など)
import 'dart:convert'; // エンコード変換ライブラリ(JSON、Base64 など)
import 'dart:io'; // I/O ライブラリ(ファイル、ネットワークなど)
void main() {
// dart:math の関数を使用
print('円周率: $pi');
print('2 の 10 乗: ${pow(2, 10)}');
// dart:convert の関数を使用
var jsonStr = '{"name": "サンプル", "age": 10}';
var decoded = jsonDecode(jsonStr);
print('解析後の JSON: $decoded');
print('ユーザー名: ${decoded['name']}');
}
圆周率: 3.141592653589793
2 的 10 次方: 1024
解析后的 JSON: {name: サンプル, age: 10}
用户名: サンプル
サードパーティパッケージのインポート
例
import 'package:http/http.dart';
import 'package:path/path.dart' as p;
ローカルファイルのインポート
例
import 'src/utils.dart'; // 同じディレクトリ内のサブディレクトリ
import '../models/user.dart'; // 親ディレクトリ内のファイル
import 'constants.dart'; // 同じディレクトリ内のファイル
import の修飾子
| 修飾子 | 構文 | 用途 |
|---|---|---|
| プレフィックス(as) | import 'lib.dart' as myLib; | ライブラリに別名を付け、名前の衝突を避ける |
| 一部のみインポート(show) | import 'lib.dart' show foo, bar; | 指定した名前のみインポートする |
| 一部を除外(hide) | import 'lib.dart' hide foo; | 指定した名前以外のすべてをインポートする |
| 遅延ロード(deferred as) | import 'lib.dart' deferred as lib; | 必要に応じてロードし、起動時間を短縮する |
例
さまざまなインポート修飾子の実際の使い方:
import 'dart:math' as math; // プレフィックスインポート:pow() ではなく math.pow() を使用
import 'dart:math' show pi, sqrt; // pi と sqrt のみインポート
import 'dart:math' hide Random; // Random 以外のすべてをインポート
void main() {
// 標準インポート
print('sin(0) = ${sin(0)}');
// プレフィックスインポート:プレフィックス経由でアクセスする必要がある
print('cos(0) = ${math.cos(0)}');
// show インポート:pi と sqrt のみ使用可能
print('π = $pi');
print('sqrt(16) = ${sqrt(16)}');
// print(sin(0)); // エラー:sin はインポートされていない
// hide インポート:Random は使用不可、他はすべて使用可能
print('max(3, 7) = ${max(3, 7)}');
// Random(); // エラー:Random は除外されている
}
sin(0) = 0.0 cos(0) = 1.0 π = 3.141592653589793 sqrt(16) = 4.0 max(3, 7) = 7
show と hide は便利さのためだけではありません。コード品質のためのツールでもあります。show を使用すると依存関係がより明確になります。このファイルがライブラリのどのシンボルを使用しているかを一目で確認できます。
export エクスポート構文
export は、他のライブラリの公開 API を再公開するために使用され、主にアグリゲーションライブラリの作成に使用されます。
次のようなファイル構造があるとします:
lib/ ├── my_package.dart # 入口文件(聚合导出) ├── src/ │ ├── models/ │ │ └── user.dart # User 类 │ ├── services/ │ │ └── api_service.dart # API 服务 │ └── utils/ │ └── helpers.dart # 工具函数
例
export を使用してアグリゲーションライブラリのエントリを作成:
// アグリゲーションエクスポート:すべての公開 API を統一的に公開
export 'src/models/user.dart';
export 'src/services/api_service.dart';
// helpers の一部のみエクスポート
export 'src/utils/helpers.dart' show formatDate, validateEmail;
これにより、利用者は1つのファイルをインポートするだけで済みます:
例
import 'package:my_package/my_package.dart';
void main() {
// export されたすべてのクラスを直接使用できる
var user = User('サンプル');
var api = ApiService();
}
カスタムライブラリの作成
カスタムライブラリの作成に特別な構文は必要ありません。各 Dart ファイルが1つのライブラリです。
ただし、library キーワードを使用してライブラリ名を明示的に宣言したり、part/part of を使用して大規模なライブラリを分割したりできます。
library を使用したライブラリ名の宣言
例
// library はライブラリ名を宣言(任意だが、ドキュメント化に役立つ)
library calculator;
/// 加算演算
int add(int a, int b) => a + b;
/// 減算演算
int subtract(int a, int b) => a - b;
/// 乗算演算
int multiply(int a, int b) => a * b;
/// 除算演算。除数が0の場合は例外をスローする
double divide(int a, int b) {
if (b == 0) {
throw ArgumentError('除数は0にできません');
}
return a / b;
}
part を使用した大規模ライブラリの分割
ライブラリのコードが長すぎる場合、part を使用して複数の物理ファイルに分割できますが、それらは論理的には依然として同じライブラリに属します。
例
メインファイルは part を宣言:
// メインライブラリファイル
library user_system;
// このライブラリを構成する他のファイルを宣言する
part 'src/user_model.dart';
part 'src/user_service.dart';
part 'src/user_validator.dart';
// ライブラリレベルの公開 API
String libraryVersion = '1.0.0';
例
part ファイルは part of を宣言:
// part of は自分がどのライブラリに属するかを宣言
part of '../user_system.dart';
// メインライブラリの libraryVersion にアクセスできる
class User {
String name;
User(this.name);
void printVersion() {
print('サンプル User モジュールバージョン: $libraryVersion');
}
}
part/part of は現代の Dart 開発ではあまり使われず、多くのチームは import/export を使用してコードを整理することを好みます。part の欠点は、part ファイル間で全てのプライベートメンバーが共有され、カプセル化が壊れることです。明確なニーズがない限り、import/export を使用することをお勧めします。
Dart コアライブラリ概要
| ライブラリ名 | インポート方法 | 主な機能 |
|---|---|---|
| dart:core | 自動インポート | 基本型、コレクション、例外など |
| dart:math | import 'dart:math'; | 数学定数と関数 |
| dart:convert | import 'dart:convert'; | JSON、UTF-8、Base64 のエンコード/デコード |
| dart:io | import 'dart:io'; | ファイル、ネットワーク、プロセス操作 |
| dart:async | import 'dart:async'; | Future、Stream などの非同期ツール |
| dart:collection | import 'dart:collection'; | その他のコレクション型(Queue など) |
| dart:developer | import 'dart:developer'; | デバッグおよび性能分析ツール |
dart:core は自動的にインポートされるため、import 'dart:core' と書かなくても int、String、List、Map などの基本型を使用できます。
その他の拡張