Flutter辅助工具插件dto_helpers的使用

Flutter辅助工具插件dto_helpers的使用

DTO(Data Transfer Objects) validators 包用于Dart语言。 支持所有平台。 dto_helpers 包为Dart应用程序中的Data Transfer Objects (DTOs) 提供了一套强大的验证器，确保各种数据类型的完整性，包括字符串、数字、枚举、布尔值和列表。

开始使用 🚀

通过将 dto_helpers 添加到依赖项列表来增强您的Flutter或Dart项目：

dependencies:
  ...
  dto_helpers:

特性 ✨

• 字符串验证器：确保数据符合特定的字符串标准。
• 列表验证器：验证列表大小和嵌套列表元素。
• 数字验证器：确认数值数据的完整性、范围和符号。
• 枚举验证器：检查数据是否匹配预定义的枚举值之一。
• 布尔验证器：准确验证布尔值。

使用方法

要利用 dto_helpers，声明一个扩展了 DTOValidate 的DTO类。以下是一个 SignInDTO 的示例：

import 'package:dto_helpers/dto_helpers.dart';

class SignInDTO extends DTOValidate {
  late String name;
  int? signInCode;

  SignInDTO({required this.name, this.signInCode});

  // 工厂构造函数用于JSON反序列化
  factory SignInDTO.fromJson(dynamic json) {
    return SignInDTO(name: json['name'], signInCode: json['signInCode']);
  }

  // 调用此方法以创建空的DTO
  SignInDTO.empty();

  @override
  ValidationResult validate(dynamic json) {
    return super.validateAll([
      IsString(
        value: json['name'],
        propertyName: 'name' // 提供有意义的错误消息
      ),
      IsNumber(
        value: json['signInCode'],
        isOptional: true, // 表示可选字段
        propertyName: 'signInCode'
      )
    ]);
  }
}

// 示例使用：
final json = {'name': 'John Doe', 'signInCode': 12345}; // 来自网络请求的JSON
final ValidationResult validationResult = SignInDTO.empty().validate(json);
if (!validationResult.isValid) {
  throw Exception('验证错误 ${validationResult.message}');
}

SignInDTO signInDTO = SignInDTO.fromJson(json);

验证器

每个属性验证类如 IsString、IsNumber、IsBoolean、IsList 和 IsEnum 可以按如下方式使用：

// 每个类都有一个名为 `validate` 的方法，该方法会根据给定的选项计算验证结果。

final result = IsString(value: qrCode).validate();

IsString

确保数据是字符串，并进行大量检查，例如电子邮件验证、URL检查、大小写敏感性等，以实现全面的字符串验证。

IsString(
    value,
    isOptional, // 如果值为空，则忽略验证
    isEmail,
    contains,
    notContains,
    isUrl,
    isAlpha,
    isAlphanumeric,
    isBase64,
    isCreditCard,
    isDate,
    isJSON,
    isLowercase,
    isUppercase,
    isUUID,
    isIP,
    isIn, // String[]
    maxLen,
    minLen,
    propertyName // 如果传递了 propertyName，则会在验证失败时构建一条消息
)

IsNumber

确保数值数据在特定范围内，并满足条件，例如正数或能被特定数字整除。

IsNumber(
    value,
    isOptional, // 如果值为空，则忽略验证
    propertyName, // 如果传递了 propertyName，则会在验证失败时构建一条消息
    isNegative,
    isPositive,
    isDivisibleBy,
    max,
    min
)

IsNumber(
  value: json['someNumber'],
  min: 0,
  max: 100,
  propertyName: 'someNumber'
)

IsEnum

验证提供的数据是否与指定的枚举值之一匹配。

enum UserRole { admin, user, guest }

IsEnum(
  value: json['role'],
  values: UserRole.values,
  propertyName: 'role'
)

IsBoolean

检查数据是否为布尔值。

IsBoolean(
  value: json['isActive'],
  propertyName: 'isActive'
)

IsList

确保提供的列表数据满足大小要求，并对每个元素应用额外的验证器。

IsList(
    value,
    maxSize,
    minSize,
    nested, // 此属性应为一个函数，应用于数组中的每个元素。函数应返回任何一种 `propertValidate` 类型，如 `IsString`, `IsNumber`, `IsBoolean`, `IsEnum` 或 `IsList`。请参见下面的示例
    isOptional, // 如果值为空，则忽略验证
    propertyName // 如果传递了 propertyName，则会在验证失败时构建一条消息
)

IsList(
  value: json['tags'],
  minSize: 1,
  nested: (element) => IsString(value: element, maxLen: 20),
  propertyName: 'tags'
)