FCA 库

FCA 库为 FCA 项目提供了核心构建模块和实用工具。它包括状态管理、依赖注入、网络操作、错误处理和 UI 辅助组件的核心组件。

特性

• BLoC 组件：用于 BLoC 和 BLoC 消费者的基类。
• 实体：应用程序中使用的通用数据实体。
• 依赖注入：用于管理依赖关系的工具。
• 错误处理：用于处理各种错误场景的类。
• 网络工具：用于管理和检查网络请求及连接性的组件。
• UI 辅助：用于显示 UI 组件的实用函数。

安装

在 pubspec.yaml 文件中添加以下依赖：

dependencies:
    fca: ^0.0.7

使用

BLoC 组件

• base_bloc.dart：包含 BLoC 的基实现。
• base_consumer.dart：提供一个用于 BLoC 的基消费者。

示例

import 'package:fca/fca.dart';

class MyBloc extends BaseBloc<MyEvent, MyState> {}

依赖注入

• dependency.dart：包含依赖注入设置和工具。

示例

import 'package:fca/fca.dart';

Dependency.addRepository(MyRepository());

UI 辅助

• show_loading.dart：提供显示加载指示器的函数。
• show_snackbar.dart：提供显示自定义 Snackbar 的函数。

示例

import 'package:fca/fca.dart';

void someFunction(BuildContext context) {
  showLoading(context);
  showSnackBar(context, '操作完成！');
}

错误处理

• failure.dart：定义了 Failure 类来处理错误场景。
• response_exception.dart：定义了 ResponseException 来处理 HTTP 错误。
• server_exception.dart：定义了 ServerException 来处理服务器相关的错误。

网络工具

• connection_checker.dart：提供使用 ConnectionChecker 及其实现进行网络连接检查。
• intercepted_client.dart：实现了 InterceptedClient 以管理带有令牌处理的 HTTP 请求。

示例

import 'package:fca/fca.dart';
import 'package:http/http.dart' as http;

class MyClient extends InterceptedClient {
  MyClient(http.Client client, String authorizationType)
      : super(client: client, authorizationType: authorizationType);

  [@override](/user/override)
  Future<String> getToken() async {
    // 实现获取令牌的逻辑
    return 'your-token';
  }

  [@override](/user/override)
  Future<void> refreshToken() async {
    // 实现刷新令牌的逻辑
  }

  [@override](/user/override)
  String modifyJsonResponse(String responseBody) {
    // 实现 JSON 响应修改的逻辑
    return responseBody;
  }
}

使用案例

• usecase.dart：定义了 UseCase 类和 NoParams 类以管理业务逻辑操作。

许可证

该项目受 MIT 许可证保护，详情请参阅 LICENSE 文件。

---

## 示例


# FCA 示例

本示例演示如何使用 `fca` 包构建遵循 Clean Architecture 原则的 Flutter 应用程序。

## 项目结构

`fca` 包提供了一个结构化的项目布局，包含三个主要层：

- **领域层**：包含业务逻辑、实体和用例。
- **数据层**：管理数据源、存储库和数据模型。
- **展示层**：处理 UI、小部件和状态管理。

## 分步指南

### 1. 设置项目

首先，在 `pubspec.yaml` 文件中添加 `fca` 包：

```yaml
dependencies:
    fca: ^1.0.0

运行 flutter pub get 以安装该包。

2. 创建用例

在领域层中，创建一个用例来定义核心业务逻辑：

class GetUserProfile implements UseCase<User, NoParams>{
  final UserRepository repository;

  GetUserProfile(this.repository);

  [@override](/user/override)
  Future<User> execute(NoParams params) {
    return repository.getUserById();
  }
}

3. 实现存储库

在数据层中，实现存储库以处理数据获取：

class UserRepositoryImpl implements UserRepository {
  final UserRemoteDataSource remoteDataSource;

  UserRepositoryImpl(this.remoteDataSource);

  [@override](/user/override)
  Future<User> getUserById(String userId) {
    return remoteDataSource.fetchUser(userId);
  }
}

4. 使用 BLoC 管理状态

在展示层中，使用 BLoC 来管理状态：

class UserBloc extends Bloc<UserEvent, UserState> {
  final GetUserProfile getUserProfile;

  UserBloc(this.getUserProfile) : super(UserInitial());

  [@override](/user/override)
  Stream<UserState> mapEventToState(UserEvent event) async* {
    if (event is GetUserEvent) {
      yield UserLoading();
      final user = await getUserProfile.execute(event.userId);
      yield UserLoaded(user);
    }
  }
}

5. 构建 UI

最后，创建 UI 以显示用户信息：

class UserProfilePage extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return BlocProvider(
      create: (_) => UserBloc(GetUserProfile(UserRepositoryImpl())),
      child: Scaffold(
        appBar: AppBar(title: Text('用户信息')),
        body: BlocBuilder<UserBloc, UserState>(
          builder: (context, state) {
            if (state is UserLoading) {
              return CircularProgressIndicator();
            } else if (state is UserLoaded) {
              return Text('你好，${state.user.name}');
            } else {
              return Text('加载用户信息出错');
            }
          },
        ),
      ),
    );
  }
}

6. 运行应用

一切准备就绪后，运行您的 Flutter 应用，并导航到 UserProfilePage 查看 Clean Architecture 的实际效果。

完整示例代码

完整的实现请参阅此包 example 目录中的完整源代码。