Flutter代码检查与分析插件gits_inspector的使用

Flutter代码检查与分析插件gits_inspector的使用

插件介绍

Gitss Inspector 是一个简单的用于 Gitss HTTP 检查器的内嵌应用。 它拦截并保存应用程序中的所有 HTTP 请求和响应，并提供了一个 UI 用于查看这些内容。它受到了 Alice、Chuck 和 Chucker 的的启发。

支持功能

• 每个 HTTP 调用的详细日志（HTTP 请求，HTTP 响应）
• 观察 HTTP 调用的 UI
• 将 HTTP 调用保存到 Sqflite
• HTTP 调用通知
• 支持 Dart 中最常用的 HTTP 客户端
• 摇晃以打开观察器
• HTTP 调用搜索

使用方法

// 注册 GitsInspector
locator.registerLazySingleton(
    () => GitsInspector(
      showNotification: true, // 默认为 true
      showInspectorOnShake: true, // 默认为 true
      saveInspectorToLocal: true, // 默认为 true
      notificationIcon: '[@mipmap](/user/mipmap)/ic_launcher', // 默认为 '[@mipmap](/user/mipmap)/ic_launcher' 只适用于 Android
    ),
);

// 注册 GitssHttp 并激活观察器
locator.registerLazySingleton(
    () => GitssHttp(
      timeout: 30000,
      showLog: true,
      gitssInspector: locator(), // 添加此行以激活观察器在 Gitss Http 中
    ),
);

为了帮助导航到 gitss inspector 页面，需要通过 setNavigatorState 方法设置 navigator 状态，推荐在启动页面如 SplashPage 上进行。

class SplashPage extends StatefulWidget {
  const SplashPage({Key? key}) : super(key: key);

  [@override](/user/override)
  State<SplashPage> createState() => _SplashPageState();
}

class _SplashPageState extends State<SplashPage> {
  [@override](/user/override)
  void initState() {
    super.initState();
    locator<GitsInspector>().setNavigatorState(N Navigator.of(context)); // 添加此行以从本地通知或摇晃中导航
    ...
  }
  ...
}

示例代码

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

final inspector = GitsInspector(
  notificationIcon: '[@mipmap](/user/mipmap)/ic_launcher',
  saveInspectorToLocal: true,
  showInspectorOnShake: true,
  showNotification: true,
);

final http = GitssHttp(
  gitssInspector: inspector,
);

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

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: const MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}

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

  final String title;

  [@override](/user/override)
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  [@override](/user/override)
  void initState() {
    super.initState();
    inspector.setNavigatorState(Navigator.of(context));
  }

  bool isLoading = false;
  String? error;
  Response? response;

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            const Text(
              'Send HTTP call',
            ),
            if (isLoading)
              const CircularProgressIndicator()
            else if (response != null || error != null)
              Text(
                error ?? response?.body ?? '',
                style: Theme.of(context).textTheme.bodySmall,
              ),
            const SizedBox(height: 8),
            ElevatedButton(
              onPressed: () async {
                try {
                  final response = await http.get(
                    Uri.parse('https://jsonplaceholder.typicode.com/users/1'),
                  );
                  setState(() {
                    this.response = response;
                    error = null;
                  });
                } on GitsException catch (e) {
                  setState(() {
                    error = e.toGitsFailure().toString();
                  });
                } catch (e) {
                  setState(() {
                    error = e.toString();
                  });
                }
              },
              child: const Text('Send HTTP'),
            ),
          ],
        ),
      ),
    );
  }
}