除了明确定义架构中每个组件的职责外,考虑组件如何通信也很重要。这包括规定通信的规则以及组件通信的技术实现。应用的架构应回答以下问题

  • 哪些组件允许与哪些其他组件通信(包括同类型组件)?
  • 这些组件向彼此公开哪些输出?
  • 任何给定层如何与其他层“连接”?

A diagram showing the components of app architecture.

以本图为指南,通信规则如下

组件通信规则
视图
  1. 视图只知道一个视图模型,并且永远不知道任何其他层或组件。创建时,Flutter 将视图模型作为参数传递给视图,将视图模型的数据和命令回调公开给视图。
视图模型
  1. 视图模型属于且仅属于一个视图,该视图可以查看其数据,但模型无需知道视图的存在。
  2. 视图模型知道一个或多个存储库,这些存储库通过视图模型的构造函数传入。
存储库
  1. 存储库可以知道许多服务,这些服务作为参数传入存储库构造函数。
  2. 一个存储库可以被许多视图模型使用,但它无需知道这些视图模型。
服务
  1. 一个服务可以被许多存储库使用,但它无需知道存储库(或任何其他对象)的存在。

依赖注入

#

本指南展示了这些不同组件如何通过输入和输出来相互通信。在每个案例中,两个层之间的通信都通过将组件传入(消耗其数据的组件的)构造函数方法来促进,例如将 Service 传入 Repository

dart
class MyRepository {
  MyRepository({required MyService myService})
          : _myService = myService;

  late final MyService _myService;
}

然而,缺少的一点是对象的创建。在应用程序中,MyService 实例是在哪里创建的,以便它可以传递给 MyRepository?这个问题的答案涉及一种称为依赖注入的模式。

在指南针应用中,依赖注入通过package:provider处理。根据他们在构建 Flutter 应用方面的经验,Google 的团队建议使用 package:provider 来实现依赖注入。

服务和存储库作为 Provider 对象公开给 Flutter 应用程序小部件树的顶层。

dependencies.dart
dart
runApp(
  MultiProvider(
    providers: [
      Provider(create: (context) => AuthApiClient()),
      Provider(create: (context) => ApiClient()),
      Provider(create: (context) => SharedPreferencesService()),
      ChangeNotifierProvider(
        create: (context) => AuthRepositoryRemote(
          authApiClient: context.read(),
          apiClient: context.read(),
          sharedPreferencesService: context.read(),
        ) as AuthRepository,
      ),
      Provider(create: (context) =>
        DestinationRepositoryRemote(
          apiClient: context.read(),
        ) as DestinationRepository,
      ),
      Provider(create: (context) =>
        ContinentRepositoryRemote(
          apiClient: context.read(),
        ) as ContinentRepository,
      ),
      // In the Compass app, additional service and repository providers live here.
    ],
    child: const MainApp(),
  ),
);

服务仅为了能够通过 providerBuildContext.read 方法立即注入到存储库中而暴露,如前面代码片段所示。然后存储库被暴露,以便它们可以根据需要注入到视图模型中。

在小部件树中稍低的位置,对应全屏的视图模型在package:go_router 配置中创建,其中再次使用 provider 来注入所需的存储库。

router.dart
dart
// This code was modified for demo purposes.
GoRouter router(
  AuthRepository authRepository,
) =>
    GoRouter(
      initialLocation: Routes.home,
      debugLogDiagnostics: true,
      redirect: _redirect,
      refreshListenable: authRepository,
      routes: [
        GoRoute(
          path: Routes.login,
          builder: (context, state) {
            return LoginScreen(
              viewModel: LoginViewModel(
                authRepository: context.read(),
              ),
            );
          },
        ),
        GoRoute(
          path: Routes.home,
          builder: (context, state) {
            final viewModel = HomeViewModel(
              bookingRepository: context.read(),
            );
            return HomeScreen(viewModel: viewModel);
          },
          routes: [
            // ...
          ],
        ),
      ],
    );

在视图模型或存储库中,注入的组件应该是私有的。例如,HomeViewModel 类如下所示

home_viewmodel.dart
dart
class HomeViewModel extends ChangeNotifier {
  HomeViewModel({
    required BookingRepository bookingRepository,
    required UserRepository userRepository,
  })  : _bookingRepository = bookingRepository,
        _userRepository = userRepository;

  final BookingRepository _bookingRepository;
  final UserRepository _userRepository;

  // ...
}

私有方法防止视图(可以访问视图模型)直接调用存储库上的方法。

指南针应用的代码演练到此结束。本页仅演练了与架构相关的代码,但并未讲述全部内容。大多数实用工具代码、小部件代码和 UI 样式都被忽略了。请浏览指南针应用存储库中的代码,以获取遵循这些原则构建的健壮 Flutter 应用程序的完整示例。

反馈

#

由于本网站的此部分正在不断完善中,我们欢迎您的反馈