Flutter服务状态管理注解插件riverpod_stateful_service_annotation的使用

riverpod_stateful_service_annotation 是一个用于简化 Flutter 应用中服务状态管理的注解插件。它通过 @riverpodService 注解帮助开发者更方便地创建和管理服务。

安装

首先，在你的 pubspec.yaml 文件中添加以下依赖：

dependencies:
  flutter:
    sdk: flutter
  riverpod: ^0.14.0 # 确保安装了与riverpod_stateful_service_annotation兼容的版本
  riverpod_stateful_service_annotation: ^0.1.0
  riverpod_stateful_service_generator: ^0.1.0

dev_dependencies:
  build_runner: ^2.0.0

然后运行 flutter pub get 来安装这些依赖。

使用

创建服务类

首先，我们需要创建一个服务类，并使用 @riverpodService 注解来标识该类为一个服务。

import 'package:flutter_riverpod/flutter_riverpod.dart';
import 'package:riverpod_stateful_service_annotation/riverpod_stateful_service_annotation.dart';

// 创建一个简单的计数器服务
@riverpodService
class Counter extends _$Counter {
  // 初始化状态
  @override
  int build() {
    return 0;
  }

  // 增加计数
  void increment() {
    state = state + 1;
  }

  // 减少计数
  void decrement() {
    state = state - 1;
  }
}

在应用中使用服务

接下来，我们可以在应用中使用这个服务。

import 'package:flutter/material.dart';
import 'package:flutter_riverpod/flutter_riverpod.dart';
import 'package:your_project/services/counter_service.dart'; // 导入你的服务

void main() {
  runApp(ProviderScope(child: MyApp()));
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: CounterScreen(),
    );
  }
}

class CounterScreen extends ConsumerWidget {
  @override
  Widget build(BuildContext context, ScopedReader watch) {
    final counter = watch(counterProvider);

    return Scaffold(
      appBar: AppBar(
        title: Text('Counter App'),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            Text('Count: ${counter}'),
            SizedBox(height: 20),
            ElevatedButton(
              onPressed: () => counter.increment(),
              child: Text('Increment'),
            ),
            SizedBox(height: 20),
            ElevatedButton(
              onPressed: () => counter.decrement(),
              child: Text('Decrement'),
            ),
          ],
        ),
      ),
    );
  }
}

构建生成器

最后，确保在项目根目录下运行构建生成器以生成必要的代码：

flutter pub run build_runner build