Dart/Flutter 模式

Flutter 模式 是做什麼的？

使用時機

在以下情況使用此技能：

• 開始一個新的 Flutter 功能，需要狀態管理、導航或資料存取的慣用模式
• 審查或編寫 Dart 程式碼，需要關於空安全、密封類型或非同步組合的指導
• 設置新的 Flutter 專案，在 BLoC、Riverpod 或 Provider 之間做選擇
• 實現安全的 HTTP 客戶端、WebView 整合或本地儲存
• 為 Flutter 小部件、Cubits 或 Riverpod providers 編寫測試
• 使用身份驗證守衛配置 GoRouter

運作方式

此技能提供按關注點組織的、可直接複製貼上的 Dart/Flutter 程式碼模式：

1. 空安全 — 避免 !，優先使用 ?./??/模式匹配
2. 不可變狀態 — 密封類別、freezed、copyWith
3. 非同步組合 — 並發 Future.wait、await 之後的安全 BuildContext
4. 小部件架構 — 提取到類別（而非方法）、const 傳播、範圍重建
5. 狀態管理 — BLoC/Cubit 事件、Riverpod notifiers 和衍生 providers
6. 導航 — 使用帶有反應式身份驗證守衛的 GoRouter（通過 refreshListenable）
7. 網路 — 使用帶有攔截器的 Dio，一次重試守衛的令牌重新整理
8. 錯誤處理 — 全域捕獲、ErrorWidget.builder、Crashlytics 配置
9. 測試 — 單元測試（BLoC 測試）、小部件測試（ProviderScope 覆蓋）、假物件優於模擬

範例

// 密封狀態 — 防止出現不可能狀態
sealed class AsyncState<T> {}
final class Loading<T> extends AsyncState<T> {}
final class Success<T> extends AsyncState<T> { final T data; const Success(this.data); }
final class Failure<T> extends AsyncState<T> { final Object error; const Failure(this.error); }

// 帶有反應式身份驗證重定向的 GoRouter
final router = GoRouter(
  refreshListenable: GoRouterRefreshStream(authCubit.stream),
  redirect: (context, state) {
    final authed = context.read<AuthCubit>().state is AuthAuthenticated;
    if (!authed && !state.matchedLocation.startsWith('/login')) return '/login';
    return null;
  },
  routes: [...],
);

// 帶有安全 firstWhereOrNull 的 Riverpod 衍生 provider
@riverpod
double cartTotal(Ref ref) {
  final cart = ref.watch(cartNotifierProvider);
  final products = ref.watch(productsProvider).valueOrNull ?? [];
  return cart.fold(0.0, (total, item) {
    final product = products.firstWhereOrNull((p) => p.id == item.productId);
    return total + (product?.price ?? 0) * item.quantity;
  });
}

---

實用、生產就緒的 Dart 和 Flutter 應用程式模式。在可能的情況下保持函式庫無關，並明確涵蓋最常見的生態系統套件。

---

1. 空安全基礎

優先使用模式而非驚嘆號運算子

// 差 — 如果為 null 則在運行時崩潰
final name = user!.name;

// 好 — 提供備用值
final name = user?.name ?? 'Unknown';

// 好 — Dart 3 模式匹配（複雜情況首選）
final display = switch (user) {
  User(:final name, :final email) => '$name <$email>',
  null => 'Guest',
};

// 好 — 提前返回守衛
String getUserName(User? user) {
  if (user == null) return 'Unknown';
  return user.name; // 檢查後提升為非空
}

避免過度使用 late

// 差 — 將空錯誤推遲到運行時
late String userId;

// 好 — 使用可空類型並顯式初始化
String? userId;

// 可以 — 僅在第一次訪問前保證初始化時使用 late
// （例如，在任何小部件交互之前的 initState() 中）
late final AnimationController _controller;

@override
void initState() {
  super.initState();
  _controller = AnimationController(vsync: this, duration: const Duration(milliseconds: 300));
}

---

2. 不可變狀態

用於狀態層次結構的密封類別

sealed class UserState {}

final class UserInitial extends UserState {}

final class UserLoading extends UserState {}

final class UserLoaded extends UserState {
  const UserLoaded(this.user);
  final User user;
}

final class UserError extends UserState {
  const UserError(this.message);
  final String message;
}

// 詳盡的 switch — 編譯器強制執行所有分支
Widget buildFrom(UserState state) => switch (state) {
  UserInitial() => const SizedBox.shrink(),
  UserLoading() => const CircularProgressIndicator(),
  UserLoaded(:final user) => UserCard(user: user),
  UserError(:final message) => ErrorText(message),
};

使用 Freezed 實現零樣板不可變性

import 'package:freezed_annotation/freezed_annotation.dart';

part 'user.freezed.dart';
part 'user.g.dart';

@freezed
class User with _$User {
  const factory User({
    required String id,
    required String name,
    required String email,
    @Default(false) bool isAdmin,
  }) = _User;

  factory User.fromJson(Map<String, dynamic> json) => _$UserFromJson(json);
}

// 使用
final user = User(id: '1', name: 'Alice', email: '[email protected]');
final updated = user.copyWith(name: 'Alice Smith'); // 不可變更新
final json = user.toJson();
final fromJson = User.fromJson(json);

---

3. 非同步組合

使用 Future.wait 進行結構化並發

Future<DashboardData> loadDashboard(UserRepository users, OrderRepository orders) async {
  // 並發執行 — 不要順序等待
  final (userList, orderList) = await (
    users.getAll(),
    orders.getRecent(),
  ).wait; // Dart 3 記錄解構 + Future.wait 擴展

  return DashboardData(users: userList, orders: orderList);
}

串流模式

// Repository 為實時數據暴露反應式串流
Stream<List<Item>> watchCartItems() => _db
    .watchTable('cart_items')
    .map((rows) => rows.map(Item.fromRow).toList());

// 在小部件層 — 宣告式，無需手動訂閱
StreamBuilder<List<Item>>(
  stream: cartRepository.watchCartItems(),
  builder: (context, snapshot) => switch (snapshot) {
    AsyncSnapshot(connectionState: ConnectionState.waiting) =>
        const CircularProgressIndicator(),
    AsyncSnapshot(:final error?) => ErrorWidget(error.toString()),
    AsyncSnapshot(:final data?) => CartList(items: data),
    _ => const SizedBox.shrink(),
  },
)

Await 後的 BuildContext

// 關鍵 — 在 StatefulWidget 中任何 await 之後務必檢查 mounted
Future<void> _handleSubmit() async {
  setState(() => _isLoading = true);
  try {
    await authService.login(_email, _password);
    if (!mounted) return; // ← 使用 context 前的守衛
    context.go('/home');
  } on AuthException catch (e) {
    if (!mounted) return;
    ScaffoldMessenger.of(context).showSnackBar(SnackBar(content: Text(e.message)));
  } finally {
    if (mounted) setState(() => _isLoading = false);
  }
}

---

4. 小部件架構

提取到類別，而非方法

// 差 — 返回小部件的私有方法，阻礙最佳化
Widget _buildHeader() {
  return Container(
    padding: const EdgeInsets.all(16),
    child: Text(title, style: Theme.of(context).textTheme.headlineMedium),
  );
}

// 好 — 單獨的小部件類別，啟用 const、元素重用
class _PageHeader extends StatelessWidget {
  const _PageHeader(this.title);
  final String title;

  @override
  Widget build(BuildContext context) {
    return Container(
      padding: const EdgeInsets.all(16),
      child: Text(title, style: Theme.of(context).textTheme.headlineMedium),
    );
  }
}

const 傳播

// 差 — 每次重建都產生新實例
child: Padding(
  padding: EdgeInsets.all(16.0),       // 非 const
  child: Icon(Icons.home, size: 24.0), // 非 const
)

// 好 — const 阻止重建傳播
child: const Padding(
  padding: EdgeInsets.all(16.0),
  child: Icon(Icons.home, size: 24.0),
)

範圍重建

// 差 — 每次計數器變化時整個頁面都重建
class CounterPage extends ConsumerWidget {
  @override
  Widget build(BuildContext context, WidgetRef ref) {
    final count = ref.watch(counterProvider); // 重建所有內容
    return Scaffold(
      body: Column(children: [
        const ExpensiveHeader(), // 不必要地重建
        Text('$count'),
        const ExpensiveFooter(), // 不必要地重建
      ]),
    );
  }
}

// 好 — 隔離需要重建的部分
class CounterPage extends StatelessWidget {
  const CounterPage({super.key});

  @override
  Widget build(BuildContext context) {
    return const Scaffold(
      body: Column(children: [
        ExpensiveHeader(),        // 從不重建 (const)
        _CounterDisplay(),        // 僅此部分重建
        ExpensiveFooter(),        // 從不重建 (const)
      ]),
    );
  }
}

class _CounterDisplay extends ConsumerWidget {
  const _CounterDisplay();

  @override
  Widget build(BuildContext context, WidgetRef ref) {
    final count = ref.watch(counterProvider);
    return Text('$count');
  }
}

---

5. 狀態管理：BLoC/Cubit

// Cubit — 同步或簡單的非同步狀態
class AuthCubit extends Cubit<AuthState> {
  AuthCubit(this._authService) : super(const AuthState.initial());
  final AuthService _authService;

  Future<void> login(String email, String password) async {
    emit(const AuthState.loading());
    try {
      final user = await _authService.login(email, password);
      emit(AuthState.authenticated(user));
    } on AuthException catch (e) {
      emit(AuthState.error(e.message));
    }
  }

  void logout() {
    _authService.logout();
    emit(const AuthState.initial());
  }
}

// 在小部件中
BlocBuilder<AuthCubit, AuthState>(
  builder: (context, state) => switch (state) {
    AuthInitial() => const LoginForm(),
    AuthLoading() => const CircularProgressIndicator(),
    AuthAuthenticated(:final user) => HomePage(user: user),
    AuthError(:final message) => ErrorView(message: message),
  },
)

---

6. 狀態管理：Riverpod

// 自動銷毀的非同步 provider
@riverpod
Future<List<Product>> products(Ref ref) async {
  final repo = ref.watch(productRepositoryProvider);
  return repo.getAll();
}

// 具有複雜突變的 Notifier
@riverpod
class CartNotifier extends _$CartNotifier {
  @override
  List<CartItem> build() => [];

  void add(Product product) {
    final existing = state.where((i) => i.productId == product.id).firstOrNull;
    if (existing != null) {
      state = [
        for (final item in state)
          if (item.productId == product.id) item.copyWith(quantity: item.quantity + 1)
          else item,
      ];
    } else {
      state = [...state, CartItem(productId: product.id, quantity: 1)];
    }
  }

  void remove(String productId) =>
      state = state.where((i) => i.productId != productId).toList();

  void clear() => state = [];
}

// 衍生 provider（選擇器模式）
@riverpod
int cartCount(Ref ref) => ref.watch(cartNotifierProvider).length;

@riverpod
double cartTotal(Ref ref) {
  final cart = ref.watch(cartNotifierProvider);
  final products = ref.watch(productsProvider).valueOrNull ?? [];
  return cart.fold(0.0, (total, item) {
    // firstWhereOrNull（來自 collection 套件）在缺少產品時避免了 StateError
    final product = products.firstWhereOrNull((p) => p.id == item.productId);
    return total + (product?.price ?? 0) * item.quantity;
  });
}

---

7. 使用 GoRouter 導航

final router = GoRouter(
  initialLocation: '/',
  // 每當身份驗證狀態改變時，refreshListenable 重新評估重定向
  refreshListenable: GoRouterRefreshStream(authCubit.stream),
  redirect: (context, state) {
    final isLoggedIn = context.read<AuthCubit>().state is AuthAuthenticated;
    final isGoingToLogin = state.matchedLocation == '/login';
    if (!isLoggedIn && !isGoingToLogin) return '/login';
    if (isLoggedIn && isGoingToLogin) return '/';
    return null;
  },
  routes: [
    GoRoute(path: '/login', builder: (_, __) => const LoginPage()),
    ShellRoute(
      builder: (context, state, child) => AppShell(child: child),
      routes: [
        GoRoute(path: '/', builder: (_, __) => const HomePage()),
        GoRoute(
          path: '/products/:id',
          builder: (context, state) =>
              ProductDetailPage(id: state.pathParameters['id']!),
        ),
      ],
    ),
  ],
);

---

8. 使用 Dio 進行 HTTP 請求

final dio = Dio(BaseOptions(
  baseUrl: const String.fromEnvironment('API_URL'),
  connectTimeout: const Duration(seconds: 10),
  receiveTimeout: const Duration(seconds: 30),
  headers: {'Content-Type': 'application/json'},
));

// 新增身份驗證攔截器
dio.interceptors.add(InterceptorsWrapper(
  onRequest: (options, handler) async {
    final token = await secureStorage.read(key: 'auth_token');
    if (token != null) options.headers['Authorization'] = 'Bearer $token';
    handler.next(options);
  },
  onError: (error, handler) async {
    // 防止無限重試循環：每個請求僅嘗試刷新一次
    final isRetry = error.requestOptions.extra['_isRetry'] == true;
    if (!isRetry && error.response?.statusCode == 401) {
      final refreshed = await attemptTokenRefresh();
      if (refreshed) {
        error.requestOptions.extra['_isRetry'] = true;
        return handler.resolve(await dio.fetch(error.requestOptions));
      }
    }
    handler.next(error);
  },
));

// 使用 Dio 的 Repository
class UserApiDataSource {
  const UserApiDataSource(this._dio);
  final Dio _dio;

  Future<User> getById(String id) async {
    final response = await _dio.get<Map<String, dynamic>>('/users/$id');
    return User.fromJson(response.data!);
  }
}

---

9. 錯誤處理架構

// 全域錯誤捕獲 — 在 main() 中設定
void main() {
  FlutterError.onError = (details) {
    FlutterError.presentError(details);
    crashlytics.recordFlutterFatalError(details);
  };

  PlatformDispatcher.instance.onError = (error, stack) {
    crashlytics.recordError(error, stack, fatal: true);
    return true;
  };

  runApp(const App());
}

// 用於生產環境的自訂 ErrorWidget
class App extends StatelessWidget {
  // 已截斷以進行翻譯...
}