Flutter未知功能探索插件inspection的使用

Inspection 插件简介

Inspection 是一个用于在Flutter和Dart中验证输入的插件，它提供了类似于Laravel框架的验证方式。通过这个插件，你可以轻松地对用户输入进行各种条件和规则的验证。

安装方法

1. 修改 pubspec.yaml 文件

添加以下内容到你的项目的 pubspec.yaml 文件中：

dependencies:
  inspection: ^0.0.13

2. 获取依赖包

可以通过命令行安装依赖包：

$ flutter pub get

或者，如果你的编辑器支持 flutter pub get，可以直接在编辑器中执行该命令。

3. 在 Dart 代码中导入 Inspection 包

import 'package:inspection/inspection.dart';

基本用法

假设你有一个表单，并且希望对用户的输入进行验证。以下是几个使用 Inspection 进行验证的例子：

使用 helper function 验证

TextFormField(
  validator: (input) => inspection(input, 'required|numeric|between:2000,6000|contains:22,33,55|ends_with:0'),
),

使用 Inspection 类验证

TextFormField(
  validator: (input) => Inspection().inspect(input, 'required|float'),
),

使用 List 形式的规则验证

TextFormField(
  validator: (input) => inspection(input, ['required','float']),
),

或者

TextFormField(
  validator: (input) => inspect(input, ['required','float']),
),

配置选项

你可以设置属性名称、自定义错误信息以及选择语言环境。例如：

TextFormField(
  validator: (input) => inspect(input, 'required|float', message: 'my custom message here !'),
),

支持的验证规则

多语言支持

目前 Inspection 支持两种语言：英语（代码为 en）和波斯语（代码为 fa）。你可以通过以下方式设置语言环境：

TextFormField(
  validator: (input) => Inspection(inspectionLocale : 'fa').inspect(input, 'required|in:farid,farhad'),
),

或者

TextFormField(
  validator: (input) => Inspection().inspect(input, 'required|in:farid,farhad', locale:'fa'),
),

自定义规则

你可以通过继承 Inspection 类来创建自定义规则。例如：

class CustomInspection extends Inspection {
  String myCustomRule(ruleString, inspectionCase) {
    switch (ruleString) {
      case 'myCustomRule':
        // Your conditional codes here or copy from a Rule class and change it to your own.
        return MyCustomeRuleClass(inspectionCase).stringValidation();
    }
    return null;
  }
}

示例代码

下面是一个完整的示例，展示了如何在 Flutter 应用中使用 Inspection 插件进行表单验证：

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

void main() => runApp(MyApp());

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    final appTitle = 'Form Validation Demo';

    return MaterialApp(
      title: appTitle,
      home: Scaffold(
        appBar: AppBar(
          title: Text(appTitle),
        ),
        body: MyCustomForm(),
      ),
    );
  }
}

// 创建一个 Form widget。
class MyCustomForm extends StatefulWidget {
  @override
  MyCustomFormState createState() {
    return MyCustomFormState();
  }
}

// 创建一个对应的 State 类。
// 此类保存与表单相关的数据。
class MyCustomFormState extends State<MyCustomForm> {
  // 创建一个全局唯一的 key，用于唯一标识 Form widget 并允许对其进行验证。
  //
  // 注意：这是一个 GlobalKey<FormState>,
  // 而不是 GlobalKey<MyCustomFormState>。
  final _formKey = GlobalKey<FormState>();

  @override
  Widget build(BuildContext context) {
    // 构建一个 Form widget，使用上面创建的 _formKey。
    return Form(
      key: _formKey,
      child: Column(
        crossAxisAlignment: CrossAxisAlignment.start,
        children: <Widget>[
          TextFormField(
            validator: (value) =>
                Inspection().inspect(value, 'iran_mobile'), // 使用 Inspection 插件进行验证
          ),
          Padding(
            padding: const EdgeInsets.symmetric(vertical: 16.0),
            child: ElevatedButton(
              onPressed: () {
                // 如果表单验证通过，则显示 Snackbar 提示信息。
                if (_formKey.currentState!.validate()) {
                  ScaffoldMessenger.of(context).showSnackBar(
                    SnackBar(content: Text('Processing Data')),
                  );
                }
              },
              child: Text('Submit'),
            ),
          ),
        ],
      ),
    );
  }
}

以上就是关于 Inspection 插件的基本介绍和使用方法。希望这些信息对你有所帮助！如果你有任何问题或建议，请随时告诉我。