Flutter安全扩展插件 safe_extensions 的使用

safe_extensions 是一个简化处理可空类型的Flutter包，它通过提供默认值和替代方案来避免重复的空值检查。本文将介绍如何在Flutter项目中使用这个插件，并提供完整的示例代码。

目录

• 功能概述
• 平台可用性
• 文档
• 类型默认值
• 使用方法
  • 布尔类型
  • 整数类型
  • 浮点类型
  • 字符串类型
  • 日期时间类型
  • 列表类型
  • 可迭代类型
  • 映射类型
  • 集合类型
• 开始使用
• 问题与贡献

功能概述

safe_extensions 支持以下功能：

• 处理可空类型如 bool, int, double, String, DateTime, Iterable, Map, 和 Set。
• 使用 safeValue 获取器和 safe() 方法指定替代值。
• 不需要平台特定设置，适用于所有Flutter支持的平台。

平台可用性

文档

完整详情请查看 pub.dev API参考。

类型默认值

以下是 safeValue 为每种可空类型提供的默认值：

使用方法

布尔类型

bool? nullableBool;
bool resultSafeValue = nullableBool.safeValue; // 如果 nullableBool 为 null，则返回 false
bool resultSafeMethod = nullableBool.safe(true); // 如果 nullableBool 为 null，则返回 true

整数类型

int? nullableInt;
int resultSafeValue = nullableInt.safeValue; // 如果 nullableInt 为 null，则返回 0
int resultSafeMethod = nullableInt.safe(100); // 如果 nullableInt 为 null，则返回 100

浮点类型

double? nullableDouble;
double resultSafeValue = nullableDouble.safeValue; // 如果 nullableDouble 为 null，则返回 0.0
double resultSafeMethod = nullableDouble.safe(5.5); // 如果 nullableDouble 为 null，则返回 5.5

字符串类型

String? nullableString;
String resultSafeValue = nullableString.safeValue; // 如果 nullableString 为 null，则返回 ""
String resultSafeMethod = nullableString.safe("default"); // 如果 nullableString 为 null，则返回 "default"

日期时间类型

DateTime? nullableDateTime;
DateTime resultSafeValue = nullableDateTime.safeValue; // 如果 nullableDateTime 为 null，则返回 DateTime(1970, 1, 1)
DateTime resultSafeMethod = nullableDateTime.safe(DateTime.now()); // 如果 nullableDateTime 为 null，则返回当前日期

列表类型

List<String>? nullableList;
List<String> resultSafeValue = nullableList.safeValue; // 如果 nullableList 为 null，则返回 []
List<String> resultSafeMethod = nullableList.safe(['1', '2', '3']); // 如果 nullableList 为 null，则返回 ['1', '2', '3']

可迭代类型

Iterable<int>? nullableIterable;
Iterable<int> resultSafeValue = nullableIterable.safeValue; // 如果 nullableIterable 为 null，则返回 []
Iterable<int> resultSafeMethod = nullableIterable.safe([1, 2, 3]); // 如果 nullableIterable 为 null，则返回 [1, 2, 3]

映射类型

Map<String, int>? nullableMap;
Map<String, int> resultSafeValue = nullableMap.safeValue; // 如果 nullableMap 为 null，则返回 {}
Map<String, int> resultSafeMethod = nullableMap.safe({"key": 1}); // 如果 nullableMap 为 null，则返回 {"key": 1}

集合类型

Set<int>? nullableSet;
Set<int> resultSafeValue = nullableSet.safeValue; // 如果 nullableSet 为 null，则返回 {}
Set<int> resultSafeMethod = nullableSet.safe({5, 10}); // 如果 nullableSet 为 null，则返回 {5, 10}

开始使用

在你的 pubspec.yaml 文件中添加依赖项：

dependencies:
  safe_extensions: ^1.1.0

然后，在你的 Dart 文件中导入该包：

import 'package:safe_extensions/safe_extensions.dart';

示例代码

以下是一个完整的 Flutter 应用示例，展示了如何使用 safe_extensions 包：

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

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

class MyApp extends StatefulWidget {
  const MyApp({super.key});

  [@override](/user/override)
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  bool? nullableBool;
  int? nullableInt;
  double? nullableDouble;
  String? nullableString;
  DateTime? nullableDateTime;
  DateTimeRange? nullableDateTimeRange;
  Iterable<int>? nullableIterable;
  Map<String, int>? nullableMap;
  Set<String>? nullableSet;
  Object? nullableObject;

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Safe Extensions Example'),
        ),
        body: Center(
          child: SingleChildScrollView(
            child: Padding(
              padding: const EdgeInsets.all(16.0),
              child: Column(
                mainAxisAlignment: MainAxisAlignment.center,
                crossAxisAlignment: CrossAxisAlignment.start,
                children: [
                  Text('Safe Bool: ${nullableBool.safeValue}'),
                  Text('Safe Bool with Replacement: ${nullableBool.safe(true)}'),
                  const SizedBox(height: 10),
                  Text('Safe Int: ${nullableInt.safeValue}'),
                  Text('Safe Int with Replacement: ${nullableInt.safe(42)}'),
                  const SizedBox(height: 10),
                  Text('Safe Double: ${nullableDouble.safeValue}'),
                  Text('Safe Double with Replacement: ${nullableDouble.safe(3.14)}'),
                  const SizedBox(height: 10),
                  Text('Safe String: "${nullableString.safeValue}"'),
                  Text('Safe String with Replacement: "${nullableString.safe("Hello")}"'),
                  const SizedBox(height: 10),
                  Text('Safe DateTime: ${nullableDateTime.safeValue}'),
                  Text('Safe DateTime with Replacement: ${nullableDateTime.safe(DateTime(2023, 12, 25))}'),
                  const SizedBox(height: 10),
                  Text('Safe DateTimeRange: ${nullableDateTimeRange.safeValue}'),
                  Text('Safe DateTimeRange with Replacement: ${nullableDateTimeRange.safe(DateTimeRange(start: DateTime(2022, 1, 1), end: DateTime(2022, 12, 31)))}'),
                  const SizedBox(height: 10),
                  Text('Safe Iterable: ${nullableIterable.safeValue}'),
                  Text('Safe Iterable with Replacement: ${nullableIterable.safe([1, 2, 3])}'),
                  const SizedBox(height: 10),
                  Text('Safe Map: ${nullableMap.safeValue}'),
                  Text('Safe Map with Replacement: ${nullableMap.safe({"one": 1, "two": 2})}'),
                  const SizedBox(height: 10),
                  Text('Safe Set: ${nullableSet.safeValue}'),
                  Text('Safe Set with Replacement: ${nullableSet.safe({"apple", "banana"})}'),
                  const SizedBox(height: 10),
                  Text('Nullable Object is null: ${nullableObject.isNull}'),
                  Text('Nullable Object is not null: ${nullableObject.isNotNull}'),
                  const SizedBox(height: 10),
                  Text('Safe Object with Replacement: ${nullableObject.safe("Fallback Object")}'),
                ],
              ),
            ),
          ),
        ),
      ),
    );
  }
}