Flutter资源管理插件disposer的使用

欢迎使用Disposable包

disposer 是一个简单的接口，用于管理所有需要被释放的实例。

示例

以下是一个基本的 DataSource 类的示例，该类实现了 Disposable 接口：

import 'dart:async';
import 'package:disposer/disposer.dart';

class DataSource with Disposable {
  final streamController = StreamController.broadcast();
  
  @override
  void dispose() {
    streamController.close();
  }
}

多级依赖示例

以下是一个多级依赖的示例，展示了如何在多个类之间管理资源的释放：

import 'dart:async';
import 'package:disposer/disposer.dart';

void main() {
  final LocalDataSource localDataSource = LocalDataSource();
  final RemoteDataSource remoteDataSource = RemoteDataSource();
  final DataRepository dataRepository = DataRepository(
    localDataSource: localDataSource,
    remoteDataSource: remoteDataSource,
  );
  final DataUsecase dataUsecase = DataUsecase(repository: dataRepository);
  dataUsecase.dispose();

  // 输出:
  /*
    [log] LocalDataSource Disposed
    [log] RemoteDataSource Disposed
    [log] DataRepository Disposed
    [log] DataUsecase Disposed
  */
}

class LocalDataSource with Disposable {
  final streamController = StreamController.broadcast();

  @override
  void dispose() {
    streamController.close();
    super.dispose();
  }
}

class RemoteDataSource with Disposable {
  final streamController = StreamController.broadcast();

  @override
  void dispose() {
    streamController.close();
    super.dispose();
  }
}

class DataRepository with Disposable {
  DataRepository({
    required this.localDataSource,
    required this.remoteDataSource,
  });

  @override
  List<Disposable> get disposables => [
        localDataSource,
        remoteDataSource,
      ];

  final LocalDataSource localDataSource;
  final RemoteDataSource remoteDataSource;
}

class DataUsecase with Disposable {
  DataUsecase({
    required this.repository,
  });

  @override
  List<Disposable> get disposables => [
        repository,
      ];

  final DataRepository repository;
}

特性生成器

未来生成器创建新的清洁架构特性

文件夹结构

开始使用特性生成器

第一种方法

激活全局 pub 包。使用这种方法，你可以在全局范围内使用特性生成器。

激活：

dart pub global activate disposer

使用：

disposer --name NewFeature --output lib/src/features

第二种方法

将 disposer 作为依赖项添加到你的项目中。

在 pubspec.yaml 文件中添加：

dependencies:
  disposer: ^0.0.7

使用：

flutter pub run disposer --name NewFeature --output lib/src/features

特性命名约定：

-n example
--name example
-n Example
--name Example
-n ExampleFeature
--name ExampleFeature

输出参数是可选的，默认路径是：lib/features。

示例：

-o lib/src/features
--output lib/src/features

完整示例代码

以下是一个完整的示例代码，展示了如何在 Flutter 应用中使用 disposer：

import 'dart:async';
import 'package:disposer/disposer.dart';
import 'package:flutter/material.dart';

void main() {
  final LocalDataSource localDataSource = LocalDataSource();
  final RemoteDataSource remoteDataSource = RemoteDataSource();
  final DataRepository dataRepository = DataRepository(
    localDataSource: localDataSource,
    remoteDataSource: remoteDataSource,
  );
  final DataUsecase dataUsecase = DataUsecase(repository: dataRepository);
  dataUsecase.dispose();

  // 输出:
  /*
    [log] LocalDataSource Disposed
    [log] RemoteDataSource Disposed
    [log] DataRepository Disposed
    [log] DataUsecase Disposed
  */

  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({Key? key}) : super(key: key);

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Disposer Example',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: const MyHomePage(title: 'Disposer Example'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({Key? key, required this.title}) : super(key: key);

  final String title;

  @override
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> with Disposable {
  @override
  void initState() {
    super.initState();
  }

  @override
  void dispose() {
    super.dispose();
  }

  @override
  List<Disposable> get disposables => [];

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            const Text(
              'This is an example of using disposer in a Flutter app.',
            ),
          ],
        ),
      ),
    );
  }
}

class LocalDataSource with Disposable {
  final streamController = StreamController.broadcast();

  @override
  void dispose() {
    streamController.close();
    super.dispose();
  }
}

class RemoteDataSource with Disposable {
  final streamController = StreamController.broadcast();

  @override
  void dispose() {
    streamController.close();
    super.dispose();
  }
}

class DataRepository with Disposable {
  DataRepository({
    required this.localDataSource,
    required this.remoteDataSource,
  });

  @override
  List<Disposable> get disposables => [
        localDataSource,
        remoteDataSource,
      ];

  final LocalDataSource localDataSource;
  final RemoteDataSource remoteDataSource;
}

class DataUsecase with Disposable {
  DataUsecase({
    required this.repository,
  });

  @override
  List<Disposable> get disposables => [
        repository,
      ];

  final DataRepository repository;
}

通过以上示例，你可以看到如何在 Flutter 应用中使用 disposer 来管理和释放资源。希望这对你有所帮助！