Flutter初心者のRetrofit学習自分用メモ

dependencies:
  retrofit:
  logger://ログ出力
  json_annotation://JSONファイルを扱うやつ
  dio://HTTPリクエストの実行に使用

dev_dependencies:
  retrofit_generator://APIクライアントを自動生成
  build_runner://自動生成させるために必要
  json_serializable://シリアライズ・デシリアライズ部分の処理を自動生成
  freezed://データクラスとそれに必要な機能を自動生成

flutter pub get

import 'package:freezed_annotation/freezed_annotation.dart';

part 'example.freezed.dart';
part 'example.g.dart';

@freezed
class Task with _$Task {
  const factory Task({
    required String id,
    required String name,
  }) = _Task;

  factory Task.fromJson(Map<String, dynamic> json) => _$TaskFromJson(json);
//↑ここでデシリアライズしている！
}

flutter pub run build_runner build --delete-conflicting-outputs

import 'package:dio/dio.dart';
import 'package:retrofit/retrofit.dart';

part 'example_api_client.g.dart';

@RestApi(baseUrl: 'https://api.example.com')
//APIエンドポイントを呼び出すメソッドを定義

abstract class RestClient {
  factory RestClient(Dio dio, {String? baseUrl}) = _RestClient;
  //DioインスタンスとbaseUrlをパラメータとして受け取る

  @GET('/tasks')//APIからデータの取得を行うメソッド
  Future<List<Task>> getTasks();//取得結果が`List<Task>`として返される
  
  //他にもPOSTとかAPI通信で行いたいメソッドをここに入れる…
  
}

flutter pub run build_runner build --delete-conflicting-outputs

http://example.com/page?parameter1=value1&parameter2=value2

import 'package:dio/dio.dart';
import 'package:your_project_name/your_path/rest_client.dart';
import 'package:your_project_name/your_path/task.dart';

class TaskRepository {
  final RestClient _client;//先ほど別ファイルで作成したAPIクライアントを作成

  TaskRepository([RestClient? client])
      : _client = client ?? RestClient(Dio());

  Future<List<Task>> getTasks() async {
    try {
      // APIからタスクを取得し、成功したらそのままリターン
      return await _client.getTasks();
    } catch (e) {
      // エラーが発生した場合は例外をスロー
      throw e;
    }
  }
}

void main() async {
  final repository = TaskRepository(); //先ほど別ファイルで作成したリポジトリを作成

  try {
    // APIを呼び出して結果を取得
    final tasks = await repository.getTasks();
    print(tasks);
  } catch (e) {
    // API呼び出し中にエラーが発生した場合はここでキャッチ
    print('Failed to load tasks: $e');
  }
}