Flutter插件castor的使用方法详解

CastOr 🦫

CastOr 提供了 .castOr<T>(()), .castOrNull<T>() 辅助函数和扩展，用于在处理非类型化数据时安全地转换/强制类型，并提供默认值。该包还提供了 .let<T>() 实现（类似于 Kotlin 的实现）。

此包旨在解决在 Dart 项目中处理空安全时的两个典型问题：

• 使用 as 强制类型转换可能会失败，如果未确保类型前。
• 使用 ! 后缀的空值提升运算符也应避免使用。

考虑以下代码：

void main() {
  dynamic a = 3;
  final String? s;
  try {
    s = a as String;
  } catch (e) {
    s = null;
  }
}

这可以被解决：

import 'package:castor/castor.dart';

void main() {
  dynamic dyn = null;
  final obj = (dyn as Object?);
  // 基本的 [castOr] 总是期望获取输入类型的解包值
  int b = obj.castOr<String>('alternative string').length;
  int c = castOr<int>('alternative string').length;

  // 等效的 [castOrNull] 只接受一个可空值，当强制类型转换错误时
  bool? asHelper = castOrNull<bool>('alternative string').length;
  bool? asExt = obj?.castOrNull();

  int? s = castOrNull<String>('alternative string')?.length;
  /// 和 [a] 一个 Object?
  int s2 = a?.castOr<String>((val) => 'alternative string').length;
  int? s = a?.castOrNull<String>()?.length;
}

目前这样是没问题的，但如果有人删除了 if 子句，这将最终导致崩溃，因为静态分析不会检查这些代码。

Flutter插件castor使用

.castOr 强制类型或提供默认值

你希望确保给定值是正确的类型，而不需要混合使用易出错的 as 关键字。考虑以下代码：

void main() {
  dynamic a = 3;
  final String? s;
  try {
    s = a as String;
  } catch (e) {
    s = null;
  }
}

import 'package:castor/castor.dart';

void main() {
  /// 考虑 [a] 是动态的
  int s2 = castOr<String>('alternative string').length;
  int? s = castOrNull<String>('alternative string')?.length;
  /// 和 [a] 是 Object?
  int s2 = a?.castOr<String>((val) => 'alternative string').length;
  int? s = a?.castOrNull<String>()?.length;
}

推升

使用 ! 进行推升应该避免使用。考虑以下代码：

if (this.a != null) this.a!.length;

目前这样是没问题的，但如果有人删除了 if 子句，这将最终导致崩溃，因为静态分析不会检查这些代码。

其他信息

在编写此包之前，我发现了很多其他替代解决方案，大多数都试图模仿 Kotlin 的 .let 行为和其他用于确保代码中每个地方的空安全的 guard 关键字。

我选择发布这个小工具是因为它的名字很可爱，但更重要的是它对你的代码库影响很小。

关于 Dart 和空安全，当你开始相信 Dart 的空安全时，有三个常见的陷阱：

• 首先是 dynamic 关键字和 ! 后缀的空值提升运算符。两者都应该避免使用，你应更倾向于使用 Object?，虽然不完全等价，但可以简单切换。
• 其次，你应该检查 as 关键字，没有将其封装到 try/catch 块中或用 if (a is b) 控制块前缀。
• 最后，有很多会抛出的方法，你无法通过静态方法避免它们，除非使用像 DCM 这样的工具。

科普

“Castor” 在法语中是 “海狸” 的意思。这就是为什么你会在某些地方找到海狸符号 🦫。

             ██  ██████████████▓▓██  ████
           ██▒▒██▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒██▒▒▒▒██
           ██▒▒██▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒██▒▒▒▒██
             ██▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒██
           ██▒▒▒▒▒▒██▒▒▒▒██▒▒▒▒▒▒▒▒▒▒▒▒▓▓
         ██▒▒▒▒▒▒▒▒██▒▒▒▒██▒▒▒▒▒▒▒▒▒▒▒▒██
       ██▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒██
     ██▒▒▒▒▒▒▒▒▒▒▓▓▓▓▓▓▓▓▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒██
     ██▒▒▒▒▒▒▒▒▒▒▒▒▓▓▓▓▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▓▓▒▒██  ░░
     ██▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▓▓▒▒██
     ██▒▒▒▒██▒▒▒▒▒▒██▒▒▒▒▒▒▒▒▒▒██▒▒▒▒▒▒▒▒▒▒▒▒██
     ██▒▒▒▒▓▓██████████████████▓▓▒▒▒▒▒▒▒▒▒▒▓▓▒▒██
     ▓▓▒▒▒▒▒▒▓▓██    ██    ██▓▓▒▒▒▒▒▒▒▒▒▒▒▒▒▒▓▓▒▒██
     ██▒▒▒▒▒▒▒▒██    ██    ██▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒██
     ██▒▒▒▒▒▒▒▒██    ██    ██▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▓▓▒▒▒▒▒▒██
     ██▓▓▒▒▒▒▒▒▒▒██████████▒▒▒▒▒▒▒▒▒▒██▒▒▒▒▒▒▒▒▓▓▒▒▒▒▒▒██
       ██▓▓▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▓▓██░░██▒▒▒▒▒▒▒▒▒▒▓▓▒▒██
         ████▓▓▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▓▓██░░▒▒▒▒██▒▒▒▒▒▒▒▒▒▒▓▓▒▒██
             ████▓▓▒▒▓▓██████▓▓██░░▒▒██████▒▒▒▒▒▒▒▒▒▒▒▒▒▒██    ████████
                 ██▓▓██▒▒▒▒▓▓██░░▒▒██▓▓▒▒▒▒██▒▒▒▒██▒▒▓▓▒▒██  ██▒▒▒▒▒▒▒▒██
                 ██▒▒▒▒▒▒▓▓██░░▒▒▒▒▒▒██▓▓▒▒▒▒▒▒▓▓██▒▒▒▒▓▓▒▒██▒▒▓▓▓▓▒▒▓▓▒▒██
                 ██▓▓▓▓▓▓██░░▒▒▒▒▒▒██▓▓██▓▓▓▓▓▓██▓▓▒▒▒▒▒▒▒▒██▓▓▒▒▓▓▓▓▓▓▓▓██
                 ██████████▒▒▒▒▒▒██▓▓▓▓▓▓██████▓▓▒▒▒▒▓▓▒▒▒▒██▓▓▓▓▓▓▓▓▒▒▓▓██
                 ██▓▓██░░░░██▒▒▒▒██▓▓▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▓▓▒▒██▓▓▓▓▓▓▓▓▓▓▓▓██
                 ██▓▓▓▓██░░░░████▒▒██▒▒▒▒▓▓▒▒▒▒▒▒▓▓▒▒▒▒▒▒▒▒██▓▓▒▒▓▓▓▓▓▓████
                   ██▓▓▓▓████▓▓▓▓██▒▒██▒▒▒▒▓▓▒▒▒▒▒▒▒▒▒▒▒▒██▓▓▓▓▓▓▓▓████
                   ██▓▓▓▓▓▓▓▓▒▒▒▒▒▒██▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▓▓██▓▓▓▓▒▒████
                 ██████▓▓▓▓▓▓▓▓▒▒▒▒▒▒▒▒▒▒▒▒▒▒▓▓██████████████████
               ██░░░░░░██▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓██░░░░░░░░░░░░████████
             ██▒▒██▒▒▒▒▒▒██▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓██▒▒▒▒▒▒██▒▒██▒▒▒▒██
             ██▓▓██████████████▓▓████████████████████████████▓▓
 credits : https://textart.sh/topic/beaver

更多

• 关于 .let 关键字的讨论 https://github.com/dart-lang/language/issues/2703
• 空安全模式 https://github.com/dart-lang/language/blob/main/accepted/3.0/patterns/feature-specification.md

示例代码

import 'package:castor/castor.dart';

dynamic fetchDynamicValue([dynamic input]) {
  return input;
}

class Url {
  Url._();
  static Url? tryParse(String url) {
    return url.isEmpty ? null : Url._();
  }
}

void main() {
  final myValue = fetchDynamicValue() as Object?;

  /// 你得到一个意外的值，并且你想确保类型正确
  /// 或提供另一个值。
  myValue?.castOrNull<int>()?.isOdd;

  /// 你也可以通过提供一个替代值来映射它
  /// 或提供另一个值。
  myValue?.castOrNull<int>((it) => 32)?.isOdd;
  final int myNum = (null as Object?).castOr((it) => 32);

  /// 或者即使解包并在任何情况下提供一个默认值，
  /// 这个方法重复了优雅的 `??` 操作符，如果你计划
  /// 链接调用，这是一个有用的助手。
  (null as Object?).castOr<int>((it) => 32).isOdd;
  final int myNumBis = (null as Object?).castOr((it) => 32);

  /// 当输入值是一个动态值时，你不应该尝试使用 `castOr`
  /// 作为扩展，因为它将会
  final dynamic myDynamicRef = fetchDynamicValue();
  castOr<int>(myDynamicRef, (it) => 32).isOdd;
  castOrNull<int>(myDynamicRef)?.isOdd;

  /// 你也可以将样本值转换为另一种类型。
  /// 这在链式方法调用时非常有用。
  (myValue)
      // 将这个值映射为一个 int 的集合
      ?.castOr<Set<int>>((it) => {it is int ? it : 43})
      // 并将其取回为一个 int
      .castOr<int>((it) => it?.toList().elementAtOrNull(0) ?? 34)
      // 你可以在这里提供几乎任何转换
      .isFinite;

  /// 你也可以将值转换为另一种类型
  final result = 42.castOr<Set<int>>((i) => {i ?? 45});

  /// 经典情况是你必须处理可空值和可空参数，考虑以下示例...
  /// ```dart
  ///   Uri? valueTransformer(String? url) {
  ///     final thisUri = url;
  ///     if (thisUri == null) return null;
  ///     return Uri.tryParse(thisUrl);
  ///   }
  /// ```
  final String? urlString = '...';
  final url1 = urlString?.let<Url>(Url.tryParse);
  final Url? url2 = urlString?.let(Url.tryParse); // 注意推断
}