Flutter性能监控与分析插件truesight_core的使用

特性

• JSON处理
• 与后端兼容的数据过滤类型
• 将HTTP响应转换为各种格式

安装

要安装该包：

flutter pub add truesight_core

如何使用

JSON处理

该包定义了以下JSON数据类型：

• JsonBoolean：用于bool类型
• JsonDate：用于DateTime类型
• JsonList：用于List<Object>类型
• JsonNumber：用于num类型
• JsonObject：用于Object类型
• JsonString：用于String类型

模型定义

例如：

class User extends DataModel {
    //
    JsonBoolean isAdmin = JsonBoolean("isAdmin");

    JsonString username = JsonString("username");

    JsonDate dateOfBirth = JsonDate("dateOfBirth");
    //
}

使用：

JsonType fieldName = JsonType("jsonFieldName");

将对象转换为JSON和从JSON转换：

User.fromJSON(Map<String, dynamic> json); // 从JSON创建User对象

final Map<String, dynamic> json = User.toJSON(); // 转换为Dart Map

final String jsonString = User.toString(); // 转换为JSON字符串

高级过滤器

过滤器类型：

• DateFilter：用于日期类型的字段
• StringFilter：用于string类型的字段
• NumberFilter：用于数值类型的字段
• GuidFilter：用于Guid类型的键字段（主键或外键）
• IdFilter：用于整数Id类型的键字段

过滤器类示例

class UserFilter extends DataFilter {
    StringFilter username = StringFilter();

    DateFilter dateOfBirth = DateFilter();

    // 默认字段

    int skip;

    int take;

    String? orderBy;

    OrderType? orderType;
}

排序类型

有两种排序类型：

OrderType.asc; // 升序

OrderType.desc; // 降序

HTTPRepository

仓库是一个包含调用后端控制器/API组对应API的方法的类。

创建仓库示例

[@singleton](/user/singleton) // 这是GetIt注解 => 使该类成为单例实例
class AccountRepository extends HttpRepository {
  // 这告诉仓库使用拦截器来转换每个请求
  [@override](/user/override)
  bool get useInterceptor => true;

  // 这是与`useInterceptor = true`一起使用的拦截器包装器
  [@override](/user/override)
  InterceptorsWrapper interceptorsWrapper = globalInterceptorsWrapper;

  // 基础URL，例如：https://example.com
  // 应使用`flutter_dotenv`配置apiBaseUrl，
  [@override](/user/override)
  String get baseUrl => dotenv.apiBaseUrl;

  AccountRepository() : super("api/prefix");

  Future<AppUser> login(String username, String password) {
    return post(
      url("login"),
      data: {
        "username": username,
        "password": password,
      },
    ).then(
      (Response response) => response.body<AppUser>(AppUser),
    );
  }

  Future<AppUser> getProfile() {
    return post(
      url("get"),
      data: {},
    ).then(
      (Response response) => response.body<AppUser>(AppUser),
    );
  }

  Future<Map<String, dynamic>> refreshToken() {
    return post(
      url("refresh-token"),
      data: {},
    ).then(
      (Response response) => response.data,
    );
  }
}

此文档概述了Truesight包在Dart和Flutter中的核心功能，包括其JSON处理能力、过滤类型以及处理HTTP响应的方法，并提供了安装和使用说明。

完整示例代码

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

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

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

class User extends DataModel {
  JsonBoolean isAdmin = JsonBoolean("isAdmin");
  JsonString username = JsonString("username");
  JsonDate dateOfBirth = JsonDate("dateOfBirth");
}

class UserFilter extends DataFilter {
  StringFilter username = StringFilter();
  DateFilter dateOfBirth = DateFilter();
  int skip;
  int take;
  String? orderBy;
  OrderType? orderType;
}

[@singleton](/user/singleton)
class AccountRepository extends HttpRepository {
  [@override](/user/override)
  bool get useInterceptor => true;
  [@override](/user/override)
  InterceptorsWrapper interceptorsWrapper = globalInterceptorsWrapper;
  [@override](/user/override)
  String get baseUrl => dotenv.apiBaseUrl;

  AccountRepository() : super("api/prefix");

  Future<AppUser> login(String username, String password) {
    return post(
      url("login"),
      data: {
        "username": username,
        "password": password,
      },
    ).then(
      (Response response) => response.body<AppUser>(AppUser),
    );
  }

  Future<AppUser> getProfile() {
    return post(
      url("get"),
      data: {},
    ).then(
      (Response response) => response.body<AppUser>(AppUser),
    );
  }

  Future<Map<String, dynamic>> refreshToken() {
    return post(
      url("refresh-token"),
      data: {},
    ).then(
      (Response response) => response.data,
    );
  }
}