Flutter服务集成插件jh_services的使用

Flutter服务集成插件jh_services的使用

jh_services 是一个Flutter插件，提供了处理Flutter应用程序中常见任务的服务集合，例如共享偏好设置、网络请求、图像和文件选择以及检查互联网连接状态。

功能

• 共享偏好设置服务 (Shared Preferences Service)：管理本地存储。
• 网络服务 (Network Service)：处理带有自定义配置的网络请求。
• 图像选择服务 (Image Picker Service)：从设备的图库或相机中选择图像。
• 文件选择服务 (File Picker Service)：从设备的文件系统中选择文件。
• 连接性服务 (Connectivity Service)：检查互联网连接状态并监听变化。

安装

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

dependencies:
  jh_services: ^0.1.1

使用方法

1. 设置服务定位器 (Setup Service Locator)

在使用任何服务之前，需要在Flutter应用程序中设置服务定位器。通常在 main.dart 文件中完成：

import 'package:flutter/material.dart';
import 'package:jh_services/jh_services.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  setupServiceLocator(
    sharedPrefsConfig: SharedPrefsConfig(),
    connectivityConfig: ConnectivityConfig(),
    networkConfig: NetworkConfig(
      baseUrl: 'https://api.example.com',
      defaultHeaders: {
        'Content-Type': 'application/json',
        // 其他必要的头部信息
      },
    ),
  );

  runApp(MyApp());
}

2. 初始化服务 (Initialize Services)

确保在使用服务之前进行初始化。这通常在 main.dart 文件中设置服务定位器之后完成：

Future<void> main() async {
  WidgetsFlutterBinding.ensureInitialized();

  setupServiceLocator(
    sharedPrefsConfig: SharedPrefsConfig(),
    connectivityConfig: ConnectivityConfig(),
    networkConfig: NetworkConfig(
      baseUrl: 'https://api.example.com',
      defaultHeaders: {
        'Content-Type': 'application/json',
        // 其他必要的头部信息
      },
    ),
  );

  runApp(MyApp());
}

3. 使用服务 (Using the Services)

共享偏好设置服务 (Shared Preferences Service)

import 'package:jh_services/jh_services.dart';

final sharedPrefsService = serviceLocator<SharedPrefsService>();

// 保存字符串值
await sharedPrefsService.saveString('key', 'value');

// 获取字符串值
String? value = sharedPrefsService.getString('key');

网络服务 (Network Service)

import 'package:jh_services/jh_services.dart';

final networkService = serviceLocator<NetworkService>();

// 发送GET请求
final response = await networkService.get('/endpoint');

// 发送POST请求
final postResponse = await networkService.post('/endpoint', data: {'key': 'value'});

// 发送带有FormData的POST请求
final formDataResponse = await networkService.post(
  '/upload',
  data: {
    'file': await convertImageToMultipartFile(image), // 示例：使用FormData
  },
  isFormData: true,
);

异常处理 (Exception Handling)

jh_services 在使用Dio进行网络请求时提供了一个强大的错误处理机制。每个类型的网络错误都会抛出一个 ServerException，其中包含错误消息、具体错误类型和状态码。

错误处理示例 (Example of Handling Exceptions)

try {
  final response = await networkService.get('/endpoint');
  print(response);
} on ServerException catch (e) {
  // 处理异常
  print('Error: ${e.errorModel.message}');
  print('Status Code: ${e.errorModel.statusCode}');
}

图像选择服务 (Image Picker Service)

import 'package:jh_services/jh_services.dart';

final imagePickerService = serviceLocator<ImagePickerService>();

// 选择图像
final imagePath = await imagePickerService.pickImage();

文件选择服务 (File Picker Service)

import 'package:jh_services/jh_services.dart';

final filePickerService = serviceLocator<FilePickerService>();

// 选择单个文件
final filePath = await filePickerService.pickSingleFile(allowedExtensions: ['pdf', 'docx']);

// 选择多个文件
final filePaths = await filePickerService.pickMultipleFiles();

连接性服务 (Connectivity Service)

import 'package:jh_services/jh_services.dart';

final connectivityService = serviceLocator<ConnectivityService>();

// 检查当前连接状态
final isConnected = await connectivityService.isConnected();

完整示例Demo

以下是一个完整的示例应用，展示了如何使用 jh_services 插件中的各种服务：

import 'package:flutter/material.dart';
import 'package:jh_services/jh_services.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  // 设置服务定位器
  setupServiceLocator(
    sharedPrefsConfig: SharedPrefsConfig(),
    connectivityConfig: ConnectivityConfig(),
    networkConfig: NetworkConfig(
      baseUrl: "https://jsonplaceholder.typicode.com", // 示例API
    ),
  );

  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: MyHomePage(),
    );
  }
}

class MyHomePage extends StatefulWidget {
  [@override](/user/override)
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  final connectivityService = serviceLocator<ConnectivityService>();
  final sharedPrefsService = serviceLocator<SharedPrefsService>();
  final networkService = serviceLocator<NetworkService>();

  bool isConnected = false;
  String? apiData;

  [@override](/user/override)
  void initState() {
    super.initState();
    _checkConnectivity();
    _fetchApiData();
  }

  Future<void> _checkConnectivity() async {
    isConnected = await connectivityService.isConnected();
    setState(() {});
  }

  Future<void> _fetchApiData() async {
    try {
      final response = await networkService.get('/posts/1'); // 获取假数据
      apiData = response['title']; // 假设响应中有'title'字段
    } on ServerException catch (e) {
      apiData = e.errorModel.message;
    }
    setState(() {});
  }

  Future<void> _saveData() async {
    await sharedPrefsService.saveString('exampleKey', 'exampleValue');
  }

  void _getData() {
    String? value = sharedPrefsService.getString('exampleKey');
    print('Saved value: $value');
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: Text('jh_services Example')),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            Text(
                'Connectivity Status: ${isConnected ? "Connected" : "Not Connected"}'),
            SizedBox(height: 20),
            ElevatedButton(
              onPressed: _saveData,
              child: Text('Save Data'),
            ),
            ElevatedButton(
              onPressed: _getData,
              child: Text('Retrieve Data'),
            ),
            SizedBox(height: 20),
            Text('API Data: ${apiData ?? "Loading..."}'),
          ],
        ),
      ),
    );
  }
}