Flutter集成ETICON服务插件eticon_api的使用

简介

ETICON API 是一个用于处理HTTP请求的库。自2.0.0版本以来，该库进行了重大更新，将网络请求的实现从http替换为Dio。这使得它能够更好地与不同的服务进行交互，并提供了更丰富的功能，如多部分表单数据上传、全局错误处理等。

查看俄语文档

目录

• 初始化
• 方法
  • GET
  • POST
  • DELETE
  • PUT
  • PATCH
• 响应类型
• 头部信息
• 授权
• 刷新令牌
• 发送MultiPart-Formdata
• 测试模式
• 链接到服务器存储

初始化

在应用启动时初始化API，可以设置多个URL以支持不同服务的请求。

void main() async {
   await Api.init(urls: ['https://example.com/']);
   runApp(MyApp());
}

还可以为特定错误代码添加全局错误处理逻辑：

void main() async {
   await Api.init(urls: ['https://example.com/'],
   onAllError: (err) {
         if (err.code == 401) Get.offAll(() => AuthScreenProvider());}
   );
   runApp(MyApp());
}

方法

GET

用于获取资源。

Future<void> getRequest() async {
     try{
       Map<String, dynamic> response = await Api.get('product', query: {"id": 5});
     } on APIException catch(error){
       print('ERROR CODE: ${error.code}');
     }
   }

POST

用于创建新资源。

Future<void> postRequest() async {
     try{
       Map<String, dynamic> response = await Api.post('product', body: {"id": 5});
     } on APIException catch(error){
       print('ERROR CODE: ${error.code}');
     }
   }

DELETE

用于删除资源。

Future<void> deleteRequest() async {
     try{
       Map<String, dynamic> response = await Api.delete(method: 'product', query: {"id": 5}, isAuth: true);
     } on APIException catch(error){
       print('ERROR CODE: ${error.code}');
     }
   }

PUT

用于更新资源。

Future<void> putRequest() async {
     try{
       Map<String, dynamic> response = await Api.put('product', body: {"id": 5}, isAuth: true);
     } on APIException catch(error){
       print('ERROR CODE: ${error.code}');
     }
   }

PATCH

用于部分更新资源。

Future<void> patchRequest() async {
     try{
       Map<String, dynamic> response = await Api.patch('product', body: {"id": 5}, isAuth: true);
     } on APIException catch(error){
       print('ERROR CODE: ${error.code}');
     }
   }

响应类型

可以通过ResponseType.map_data来获取仅包含Map<String, dynamic>类型的响应体。

头部信息

可以通过Api.setHeaders()设置全局头部信息。

Api.setHeaders({"Content-type": 'application/json'});

对于单独请求也可以通过参数设置头部信息，如果存在相同键名的全局头部信息，则会被覆盖。

授权

可以通过api.setToken('{your_token}')设置授权令牌，自动保存到设备内存中。

api.setToken('{your_token}');

刷新令牌

类似于授权令牌的操作，可以设置和获取刷新令牌。

Api.setRefreshToken('{your_refresh_token}');

发送MultiPart-Formdata

支持文件上传。

var formData = FormData.fromMap({
   'name': 'wendux',
   'age': 25,
   'file': await MultipartFile.fromFile('./text.txt',filename: 'upload.txt')
});
response = await Api.post('/info', data: formData);

测试模式

开启后会显示详细的请求信息，并禁用所有错误处理器。

await Api.init(urls: ['https://example.com/'], globalTestMode: true);

链接到服务器存储

可以在初始化时指定存储URL。

await Api.init(urls: ['https://example.com/'], storageUrl: 'https://example.com/storage/');

示例Demo

下面是一个完整的示例项目结构，演示了如何使用eticon_api插件。

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

void main() async {
  // 初始化API
  await Api.init(urls: ['https://example.com/']);
  runApp(MyApp());
}

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

class MyHomePage extends StatefulWidget {
  @override
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  Future<void> getRequest() async {
    try {
      final Map<String, dynamic> response = await Api.get(
        method: 'product',
      );
      // 处理响应数据
      print(response);
    } on APIException catch (error) {
      print('ERROR CODE: ${error.code}');
    }
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('ETICON API Example'),
      ),
      body: Center(
        child: GestureDetector(
          onTap: getRequest,
          child: Container(
            width: 150,
            height: 150,
            color: Colors.black,
            child: Center(
              child: Text(
                "Tap me to make a request",
                style: TextStyle(color: Colors.white),
              ),
            ),
          ),
        ),
      ),
    );
  }
}

以上就是关于Flutter集成ETICON服务插件eticon_api的基本使用指南，希望对您有所帮助！如果有任何问题或需要进一步的帮助，请随时提问。