Flutter自定义HTTP请求插件ummobile_custom_http的使用

Flutter自定义HTTP请求插件ummobile_custom_http的使用

初始化

在初始化时，可以定义基础URL和静态授权。

// 简单初始化
final http = UMMobileCustomHttp(baseUrl: 'https://jsonplaceholder.typicode.com');

// 带有认证的初始化
final http = UMMobileCustomHttp(
  baseUrl: 'https://jsonplaceholder.typicode.com',
  auth: Auth(
    token: () => 'YOUR_TOKEN',
    tokenType: 'Bearer',
    headername: 'Authorization',
  ),
);

HTTP请求调用

要发起请求，你需要使用以custom开头的函数。

final http = UMMobileCustomHttp(baseUrl: 'https://jsonplaceholder.typicode.com');

// 发起GET请求
await http.customGet(path: '/posts/1');

// 发起POST请求
await http.customPost(path: '/posts/1', body: {});

// 发起DELETE请求
await http.customDelete(path: '/posts/1');

你还可以传递一个映射器函数来格式化响应体并返回特定类型。

final http = UMMobileCustomHttp(baseUrl: 'https://jsonplaceholder.typicode.com');

// 返回一个Post实例
await http.customGet<Post>(
  path: '/posts/1',
  mapper: (json) => Post(
    userId: json['userId'],
    id: json['id'],
    title: json['title'],
    body: json['body'],
  ),
);

异常处理

如果发生错误，将抛出HttpCallException。该异常包含一个type属性，可以是以下列表中的一个：

• ClientError: 当状态码在300到499之间时。
• ServerError: 当状态码在500到599之间时。
• ConnectionError: 当发生无法指定的连接错误时。
• ServerDown: 当无法连接到后端时。
• ClientOffline: 当无法连接到yahoo.com时。
• ExpiredToken: 当访问令牌过期且需要刷新时。
• Unauthorized: 当授权发生错误时。
• Other: 当任何其他Exception发生时。

你可以这样使用异常：

final http = UMMobileCustomHttp(baseUrl: 'https://jsonplaceholder.typicode.com');
try {
  await http.customGet(path: '/posts/1');
} on ConnectionErrorException catch(e) {
  if(e.type == HttpException.ClientOffline) {
    // 显示客户端无网络连接
  }
} on ClientErrorException catch(e) {
  if(e.type == HttpException.ExpiredToken) {
    // 显示令牌已过期
  }
}

示例

以下是一个完整的示例，展示了如何使用ummobile_custom_http插件进行HTTP请求。

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

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: Text('UMMobile Custom HTTP Example')),
        body: Center(child: MyHttpExample()),
      ),
    );
  }
}

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

class _MyHttpExampleState extends State<MyHttpExample> {
  String _response = 'Waiting for response...';

  void _makeHttpRequest() async {
    final http = UMMobileCustomHttp(
      baseUrl: 'https://jsonplaceholder.typicode.com',
      auth: Auth(
        token: () => 'YOUR_TOKEN',
        tokenType: 'Bearer',
        headername: 'Authorization',
      ),
    );

    try {
      final response = await http.customGet<Post>(
        path: '/posts/1',
        mapper: (json) => Post(
          userId: json['userId'],
          id: json['id'],
          title: json['title'],
          body: json['body'],
        ),
      );
      setState(() {
        _response = 'Response received: $response';
      });
    } on HttpCallException catch (e) {
      setState(() {
        _response = 'Error: ${e.message}';
      });
    }
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Column(
      mainAxisAlignment: MainAxisAlignment.center,
      children: [
        ElevatedButton(
          onPressed: _makeHttpRequest,
          child: Text('Make HTTP Request'),
        ),
        SizedBox(height: 20),
        Text(_response),
      ],
    );
  }
}

class Post {
  final int userId;
  final int id;
  final String title;
  final String body;

  Post({required this.userId, required this.id, required this.title, required this.body});
}