搜索插件、代码仓与 APP 分类

插件详情v2.2.0

result_dart

dart 的结果。这是基于 Kotlin Result 和 Swift Result 的实现。

AndroidiOSWebmacOSWindowsLinux
近 30 天下载
6.3万
喜欢数
175
Pub 分数
160

安装插件

flutter pub add result_dart

插件介绍

基于插件公开信息、社区数据与项目使用情况整理的选型参考。

Result Dart 是一个受 Kotlin 和 Swift 的 Result 类型启发的 Dart 包,提供了一种安全的方式来处理可能成功或失败的操作。它封装了成功的值(Ok)或错误(Err),促进显式的错误处理,减少对异常的依赖。该包通过鼓励开发者显式处理成功和失败情况,提升了代码的可读性和可靠性。它与 Dart 的 async/await 语法无缝集成,并支持 map、flatMap 和 fold 等函数式编程模式。

适合场景

  • 处理 API 响应
  • 使用错误状态管理异步操作
  • 用显式的结果处理替换 try-catch 块
  • 使用清晰的成功/失败路径实现业务逻辑
  • 提高易出错函数的可测试性

主要特点

  • 不可变的结果类型
  • 功能组合器(map、flatMap、fold)
  • 显式错误和成功状态
  • 与 async/await 的无缝集成
  • 空值安全支持

适合对象

  • 寻求更安全错误处理的开发人员
  • 强调函数式编程的项目
  • 采用类似模式匹配工作流的团队
  • 需要强大状态管理的应用程序
  • 熟悉 Kotlin 或 Swift 的 Dart 开发人员

使用建议

  • 开发者初识 Result 类型模式的学习曲线
  • 简单情况下的潜在冗余
  • 在真正异常的情况下,不能替代异常
  • 可能需要在紧密耦合的代码中添加额外的样板代码

原始 README

以下为关联源码仓库的 README 原文快照,最新内容请访问源码仓库。

RESULT_DART


This package aims to create an implemetation of Kotlin's and Swift's Result class and own operators. Inspired by `multiple_result` package, the `dartz` package and the `fpdart` package.
Explore the docs »

Report Bug · Request Feature


Version Pub Points Flutterando Analysis

Pub Publisher



Table of Contents
  1. About The Project
  2. Getting Started
  3. How to Use
  4. Features
  5. Contributing
  6. Contact
  7. Acknowledgements


About The Project



Overruns are common in design, and modern architectures always designate a place to handle failures. This means dramatically decreasing try/catch usage and keeping treatments in one place. But the other layers of code need to know about the two main values [Success, Failure]. The solution lies in the Result class pattern implemented in Kotlin and Swift and now also in Dart via this package(result_dart).

This project is distributed under the MIT License. See LICENSE for more information.

(back to top)

Migrate 1.1.1 to 2.0.0

This version aims to reduce the Result boilerplate by making the Failure type Exception by default. This will free the Result from having to type Failure, making the declaration smaller.

// Old
Result<int, Exception> myResult = Success(42);

// NEW
Result<int> myResult = Success(42);

if there is a need to type it, use ResultDart<Success, Failure>:

// Old
Result<int, String> myResult = Success(42);

// NEW
ResultDart<int, String> myResult = Success(42);

Getting Started

To get result_dart working in your project follow either of the instructions below:

a) Add result_dart as a dependency in your Pubspec.yaml:

  dependencies:
    result_dart: x.x.x

b) Use Dart Pub:

  dart pub add result_dart

How to Use

In the return of a function that you want to receive an answer as Sucess or Failure, set it to return a Result type;

Result getSomethingPretty();

then add the Success and the Failure types.

Result<String> getSomethingPretty() {

}

In the return of the above function, you just need to use:

// Using Normal instance
return Success('Something Pretty');

// import 'package:result_dart/functions.dart'
return successOf('Something Pretty');

// Using extensions
return 'Something Pretty'.toSuccess();

or

// Using Normal instance
return Failure(Exception('something ugly happened...'));

// import 'package:result_dart/functions.dart'
return failureOf('Something Pretty');

// Using extensions
return 'something ugly happened...'.toFailure();

The function should look something like this:


Result<String> getSomethingPretty() {
    if(isOk) {
        return Success('OK!');
    } else {
        return Failure(Exception('Not Ok!'));
    }
}

or when using extensions, like this:


Result<String> getSomethingPretty() {
    if(isOk) {
        return 'OK!'.toSuccess();
    } else {
        return Exception('Not Ok!').toFailure();
    }
}

IMPORTANT NOTE: The toSuccess() and toFailure() methods cannot be used on a Result object or a Future. If you try, will be throw a Assertion exception.


Handling the Result with fold:

Returns the result of onSuccess for the encapsulated value if this instance represents Success or the result of onError function for the encapsulated value if it is Failure.

void main() {
    final result = getSomethingPretty();
     final String message = result.fold(
        (success) {
          // handle the success here
          return "success";
        },
         (failure) {
          // handle the failure here
          return "failure";
        },
    );

}
Handling the Result with getOrThrow

Returns the success value as a throwing expression.

void main() {
    final result = getSomethingPretty();

    try {
     final value = result.getOrThrow();
    } on Exception catch(e){
      // e
    }
}

Handling the Result with getOrNull

Returns the value of [Success] or null.

void main() {
    final result = getSomethingPretty();
    result.getOrNull();
}

Handling the Result with getOrElse

Returns the encapsulated value if this instance represents Success or the result of onFailure function for the encapsulated a Failure value.

void main() {
    final result = getSomethingPretty();
    result.getOrElse((failure) => 'OK');
}

Handling the Result with getOrDefault

Returns the encapsulated value if this instance represents Success or the defaultValue if it is Failure.

void main() {
    final result = getSomethingPretty();
    result.getOrDefault('OK');
}

Handling the Result with exceptionOrNull

Returns the value of [Failure] or null.

void main() {
    final result = getSomethingPretty();
    result.exceptionOrNull();
}
Transforming a Result
Mapping success value with map

Returns a new Result, mapping any Success value using the given transformation.

void main() {
    final result = getResult()
        .map((e) => MyObject.fromMap(e));

    result.getOrNull(); //Instance of 'MyObject' 
}
Mapping failure value with mapError

Returns a new Result, mapping any Error value using the given transformation.

void main() {
    final result = getResult()
        .mapError((e) => MyException(e));

    result.exceptionOrNull(); //Instance of 'MyException'

}
Chain others [Result] by any Success value with flatMap

Returns a new Result, mapping any Success value using the given transformation and unwrapping the produced Result.


Result<String, MyException> checkIsEven(String input){
    if(input % 2 == 0){
        return Success(input);
    } else {
        return Failure(MyException('isn`t even!'));
    }
}

void main() {
    final result = getNumberResult()
        .flatMap((s) => checkIsEven(s));
}
Chain others [Result] by Failure value with flatMapError

Returns a new Result, mapping any Error value using the given transformation and unwrapping the produced Result.


void main() {
    final result = getNumberResult()
        .flatMapError((e) => checkError(e));
}
Resolve [Result] by Failure value with recover

Returns the encapsulated Result of the given transform function applied to the encapsulated a Failure or the original encapsulated value if it is success.


void main() {
    final result = getNumberResult()
        .recover((f) => Success('Resolved!'));
}
Conditionally resolve [Result] by Failure value with recoverWhen

Returns the encapsulated Result of the given transform function applied to the encapsulated a Failure only if the test predicate returns true. Otherwise, returns the original Failure unchanged. If this is a Success, returns it unchanged.

void main() {
    final result = getNumberResult()
        .recoverWhen(
          (f) => f is TimeoutException,
          (f) => Success('Recovered from timeout!'),
        );
    // Only recovers TimeoutException, other failures propagate unchanged
}
Inspect a [Result] with tap

Performs the given action on the Result regardless of whether it is a Success or Failure. Returns the original Result unchanged. Useful for debugging and logging intermediate states in a chain.

void main() {
    final result = getNumberResult()
        .tap((r) => print('Step 1: $r'))
        .flatMap((s) => validateNumber(s))
        .tap((r) => print('Step 2: $r'));
}
Filter a Success value with filter

Returns this Result if it is a Failure or if the predicate returns true for the encapsulated Success value. Otherwise, returns a Failure created by orElse.

void main() {
    final result = getNumberResult()
        .filter(
          (n) => n > 0,
          (n) => Exception('$n is not positive'),
        );
}
Combine two [Result]s with zip

Combines this Result with another into a single Result containing a Record of both success values. If either is a Failure, returns the first Failure encountered.

void main() {
    final name = Success<String, Exception>('Jacob');
    final age = Success<int, Exception>(25);

    final combined = name.zip(age);
    // Success(('Jacob', 25))

    combined.map((record) {
      final (n, a) = record;
      return 'Name: $n, Age: $a';
    });
}
Flatten a nested [Result] with flatten

Unwraps a ResultDart<ResultDart<S, F>, F> into a ResultDart<S, F>, removing one level of nesting.

void main() {
    final nested = Success<ResultDart<int, String>, String>(Success(42));
    final flat = nested.flatten();
    // Success(42)
}
Add a pure Success value with pure

Change the [Success] value.

void main() {
    final result = getSomethingPretty().pure(10);

    String? mySuccessResult;
    if (result.isSuccess()) {
      mySuccessResult = result.getOrNull(); // 10
    }
}
Add a pure Failure value with pureError

Change the [Failure] value.

void main() {
    final result = getSomethingPretty().pureError(10);
    if (result.isFailure()) {
       result.exceptionOrNull(); // 10
    }
}
Swap a Result with swap

Swap the values contained inside the [Success] and [Failure] of this [Result].

void main() {
    Result<String, int> result =...;
    Result<int, String> newResult = result.swap();
}
Unit Type

Some results do not need a specific return. Use the Unit type to signal an empty return.

    Result<Unit>
Help with functions that return their parameter:

NOTE: use import 'package:result_dart/functions.dart'

Sometimes it is necessary to return the parameter of the function as in this example:

final result = Success(0);

String value = result.when((s) => '$s', (e) => e);
print(string) // "0";

We can use the identity function or its acronym id to facilitate the declaration of this type of function that returns its own parameter and does nothing else:

final result = Success(0);

// changed `(e) => e` by `id`
String value = result.when((s) => '$s', id);
print(string) // "0";
Use AsyncResult type:

AsyncResult<S, E> represents an asynchronous computation. Use this component when working with asynchronous Result.

AsyncResult has some of the operators of the Result object to perform data transformations (Success or Failure) before executing the Future.

All Result operators is available in AsyncResult

AsyncResult<S, E> is a typedef of Future<Result<S, E>>.


AsyncResult<String> fetchProducts() async {
    try {
      final response = await dio.get('/products');
      final products = ProductModel.fromList(response.data);
      return Success(products);
    } on DioError catch (e) {
      return Failure(ProductException(e.message));
    }
}

...

final state = await fetch()
    .map((products) => LoadedState(products))
    .mapLeft((failure) => ErrorState(failure))


(back to top)

Features

  • ✅ Result implementation.
  • ✅ Result`s operators(map, flatMap, mapError, flatMapError, swap, when, fold, getOrNull, exceptionOrNull, isSuccess, isError).
  • ✅ AsyncResult implementation.
  • ✅ AsyncResult`s operators(map, flatMap, mapError, flatMapError, swap, when, fold, getOrNull, exceptionOrNull, isSuccess, isError).
  • ✅ Auxiliar functions (id, identity, success, failure).
  • ✅ Unit type.
  • ✅ tap operator for debugging and logging.
  • ✅ filter operator for conditional Success-to-Failure conversion.
  • ✅ zip operator for combining two Results using Dart 3 Records.
  • ✅ flatten operator for unwrapping nested Results.
  • ✅ recoverWhen operator for conditional recovery by predicate.

(back to top)

Best Practices

Scoped Recovery

When chaining many operations with recover, errors from earlier steps may be accidentally recovered. To avoid this, group related operations into their own functions:

// ❌ Avoid: recover may catch unrelated errors
fetchUser()
  .flatMap(fetchOrders)
  .flatMap(validateOrders)
  .recover(fallbackOrders)  // may recover a fetchUser error!
  .flatMap(processOrders);

// ✅ Prefer: scope the recovery to the relevant operations
AsyncResult<Orders> getValidOrders() {
  return fetchUser()
    .flatMap(fetchOrders)
    .flatMap(validateOrders)
    .recover(fallbackOrders); // only recovers validation/fetch errors
}

getValidOrders()
  .flatMap(processOrders);

Alternatively, use recoverWhen to recover only specific error types:

fetchUser()
  .flatMap(fetchOrders)
  .flatMap(validateOrders)
  .recoverWhen(
    (f) => f is ValidationException,
    (f) => fallbackOrders(),
  )
  .flatMap(processOrders);
Custom Exceptions with StackTrace

The Failure type is a generic container and does not capture stack traces. If you need stack traces for debugging, capture them in your custom Exception classes:

class AppException implements Exception {
  final String message;
  final StackTrace stackTrace;

  AppException(this.message) : stackTrace = StackTrace.current;

  @override
  String toString() => 'AppException: $message\n$stackTrace';
}

This way, the stack trace travels with the error through the Result chain, and tap can be used to inspect it:

fetchData()
  .tap((r) => print(r))  // prints "Failure(AppException: ...)" with stack
  .flatMap(process);

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the appropriate tag. Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Remember to include a tag, and to follow Conventional Commits and Semantic Versioning when uploading your commit and/or creating the issue.

(back to top)

Contact

Flutterando Community

(back to top)

Acknowledgements

Thank you to all the people who contributed to this project, whithout you this project would not be here today.


(back to top)

Maintaned by


Built and maintained by Flutterando.

所属分类

依赖

依赖清单 1 项

源码仓库

使用此插件的项目