Flutter条件切换插件switch_when的使用

Getting Started

Add dependency

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

dependencies:
  switch_when: ^0.0.1 #请使用pub上的最新版本

Use Library

导入库

在需要使用该库的地方导入包：

import 'package:switch_when/switch_when.dart';

使用函数

根据不同的情况使用不同的方法。对于一般的情况，可以使用when或whenValue方法。如果需要返回结果为非空安全类型，可以使用whenSafe或whenValueSafe方法。

示例代码：

@override
void initState() {
  _curtainAnimationImage = TweenImageWidget(
    ImagesEntry(1, 20, "equipmentcontrol_pic_curtain%s".toAssetImg()),
    durationMilliseconds: 5000,
    repeat: false,
  );
  super.initState();
}

函数

// 不安全
T? whenString<T>(String value, Map<String, ValueGetter<T>> conditionMap)
T? whenInt<T>(int value, Map<int, ValueGetter<T>> conditionMap)
T? whenDouble<T>(double value, Map<double, ValueGetter<T>> conditionMap) 
T? whenBool<T>(bool value, List<Tuple2<bool, ValueGetter<T>>> conditionList)
T? whenValue<V, T>(V value, Map<V, ValueGetter<T>> conditionMap)
T? when<T>(Map<bool, ValueGetter<T>> conditionMap)
T? whenTrue<T>(Map<ValueGetter<bool>, ValueGetter<T>> conditionMap)

// 安全
T whenStringSafe<T>(String value, Map<String, ValueGetter<T>> conditionMap, {ValueGetter<T>? defaultValue}) 
T whenIntSafe<T>(int value, Map<int, ValueGetter<T>> conditionMap, {ValueGetter<T>? defaultValue})
T whenDoubleSafe<T>(double value, Map<double, ValueGetter<T>> conditionMap, {ValueGetter<T>? defaultValue}) 
T? whenBoolSafe<T>(bool value, List<Tuple2<bool, ValueGetter<T>>> conditionList, {ValueGetter<T>? defaultValue}) 
T whenValueSafe<V, T>(V value, Map<V, ValueGetter<T>> conditionMap, {ValueGetter<T>? defaultValue}) 
T whenSafe<T>(Map<bool, ValueGetter<T>> conditionMap, {ValueGetter<T>? defaultValue})
T whenTrueSafe<T>(Map<ValueGetter<bool>, ValueGetter<T>> conditionMap, {ValueGetter<T>? defaultValue}) 

示例代码

T? whenString

用于替换switch方法，因为某些场景下Case表达式必须为常量； 如果value存在于conditionMap的keys中，则执行其对应的ValueGetter方法。

示例：

int? index = whenString<int>("banana🍌", {
  "water" + "melon": () {
    return 1;
  },
  "apple": () {
    return 2;
  },
  "orange": () {
    return 3;
  },
  "banana" + "🍌": () {
    return 4;
  },
  "grape": () {
    return 5;
  },
});

T? whenInt

用于替换switch方法，因为某些场景下Case表达式必须为常量； 如果value存在于conditionMap的keys中，则执行其对应的ValueGetter方法。

示例：

String? status = whenInt<String>(1, {
  1: () {
    return "good";
  },
  1 + 1: () {
    return "nice";
  },
  int.parse("3"): () {
    return "better";
  },
});

T? whenDouble

用于替换switch方法，因为某些场景下Case表达式必须为常量； 如果value存在于conditionMap的keys中，则执行其对应的ValueGetter方法。

示例：

String? status = whenDouble<String>(2.0, {
  0.1: () {
    return "good";
  },
  1.0 + 1: () {
    return "nice";
  },
  double.parse("3.2"): () {
    return "better";
  },
});

T? whenBool

用于替换switch方法，因为某些场景下Case表达式必须为常量。 如果value存在于conditionList的Tuple2.item1中，则执行其对应的ValueGetter方法。

示例：

double? degree = whenBool<double>(false, [
  Tuple2(
    "is Long String".length > 10,
    () {
      return 0.0;
    },
  ),
  Tuple2(
    100 / 10 == 0,
    () {
      return 1.0;
    },
  ),
  Tuple2(
    "apple".contains("a"),
    () {
      return 2.0;
    },
  ),
]);
return degree;

T? whenValue

switch方法的超级进化版，所有基本类型的值都可以比较，包括List、Map、Set和Iterable。 只需要value存在于conditionMap的keys中，其对应的ValueGetter方法将被执行。

示例：

String? kind = whenValue<List, String>(
  ["apple", "orange"],
  {
    ["cat", "dog"]: () {
      return "pets";
    },
    ["apple", "orange"]: () {
      return "fruits";
    },
    ["red", "white", "black"]: () {
      return "colors";
    },
  },
);

T? when

Kotlin版本的switch方法的when函数。 只要在conditionMap的keys中找到第一个为真的值，就会立即执行其对应的ValueGetter方法并返回相应的值。 如果没有找到，则返回null；如果需要默认值，可以在Map末尾添加一个键等于true的MapEntry。

示例：

String? winner = when<String>({
  "Dart is Language".contains("UI"): () {
    return "Flutter";
  },
  "Flutter is UI Framework".contains("UI"): () {
    return "Flutter";
  },
});

T? whenTrue

Kotlin版本的switch方法的when函数，其条件表达式会被计算。 只要在conditionMap的keys中出现的第一个执行结果为真，就会立即执行其对应的ValueGetter方法，并返回相应的值。 如果没有找到，则返回null；如果需要默认值，可以在Map末尾添加一个键等于true的MapEntry。

示例：

String? something = whenTrue<String>({
  () {
    if (1 + 100 * 1000 < 2000) {
      return false;
    } else if ("Who is my lovely baby?".length > 10) {
      return true;
    } else {
      return false;
    }
  }: () {
    return "Test OK";
  },
  () {
    return int.tryParse("3.14*") != null;
  }: () {
    return "PI get";
  }
});

Example Demo

testWhenValue() {
  String? kind = whenValue<List, String>(
    ["apple", "orange"],
    {
      ["cat", "dog"]: () {
        return "pets";
      },
      ["apple", "orange"]: () {
        return "fruits";
      },
      ["red", "white", "black"]: () {
        return "colors";
      },
    },
  );
  return kind;
}

testWhenString() {
  int howManyFruits = 2;
  int? index = whenString<int>("banana🍌", {
    "water" + "melon".more(): () {
      return 1;
    },
    "apple".more(): () {
      return 2;
    },
    howManyFruits <= 1 ? "orange" : "oranges": () {
      return 3;
    },
    "banana" + "🍌": () {
      return 4;
    },
    "grape": () {
      return 5;
    },
  });
  return index;
}

testWhen() {
  String? winner = when<String>({
    "Dart is Language".contains("UI"): () {
      return "Flutter";
    },
    "Flutter is UI Framework".contains("UI"): () {
      return "Flutter";
    },
  });
  return winner;
}

testWhenDoubleSafe() {
  String status = whenDoubleSafe<String>(
    2.1,
    {
      0.1: () {
        return "good";
      },
      1.0 + 1: () {
        return "nice";
      },
      double.parse("3.2"): () {
        return "better";
      },
    },
    defaultValue: () => "other",
  );
  expect(status, "other");
};