Flutter国际象棋客户端插件lichess_client的使用

Flutter 国际象棋客户端插件 lichess_client 的使用

如果你需要一个完整的 Lichess 客户端，请参考 lichess_client_dio。

Lichess API 接口的 Dart 实现

这是一个定义了与 Lichess API 交互的签名（接口）的库。它还定义了所有必需的数据模型。该库完全用 Dart 编写，并使用代码生成。

你很可能不会直接寻找这个库，它是为了解除 API 接口对 HTTP 库的依赖而创建的，它像一个“平台接口”包。

注意：这不是官方的 Lichess 项目。它由志愿者维护。

安装

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

dependencies:
  lichess_client: ^<最新版本>

导入库：

import 'package:lichess_client/lichess_client.dart';

自定义客户端

你可以自定义 LichessClient 类来实现自己的功能：

class MyCustomLichessClient implements LichessClient {
  // TODO: 实现/重写方法。
}

LichessClient 是一个抽象类，定义了所有签名，因此你可以扩展或实现它。

现在你可以做自己的实现并重用数据模型。

这也可以用于模拟 LichessClient 类。

贡献

除了代码生成之外，不允许在这个包中添加其他依赖项。只有更改、添加或删除与 Lichess API 相对应的签名的贡献才是允许的。如果你想实现一些东西，请创建一个新的依赖于这个包的包。我们还提供了一个使用 Dio 作为 HTTP 客户端的实现 package。

代码生成

这个包使用代码生成来处理数据模型：

# 获取依赖项。
dart pub get

# 生成代码，如果你不想监视文件变化，可以将 'watch' 替换为 'build'。
dart run build_runner watch --delete-conflicting-outputs

完成后，添加任何模型或签名并发送 PR。

完整示例

以下是一个完整的示例，展示了如何使用 lichess_client 插件。

import 'dart:io';

import 'package:lichess_client/lichess_client.dart';

// 自定义账户服务
class MyCustomAccountService implements AccountService {
  /// 自定义的账户服务实现...
  
  [@override](/user/override)
  void noSuchMethod(Invocation invocation) => super.noSuchMethod(invocation);
}

// 自定义关系服务
class MyCustomRelationsService implements RelationsService {
  /// 自定义的关系服务实现...
  
  [@override](/user/override)
  void noSuchMethod(Invocation invocation) => super.noSuchMethod(invocation);
}

// 自定义用户服务
class MyCustomUsersService implements UsersService {
  /// 自定义的用户服务实现...
  
  [@override](/user/override)
  void noSuchMethod(Invocation invocation) => super.noSuchMethod(invocation);
}

// 自定义团队服务
class MyCustomTeamsService implements TeamsService {
  /// 自定义的团队服务实现...
  
  [@override](/user/override)
  void noSuchMethod(Invocation invocation) => super.noSuchMethod(invocation);
}

// 自定义电视服务
class MyCustomTvService implements TvService {
  /// 自定义的电视服务实现...
  
  [@override](/user/override)
  void noSuchMethod(Invocation invocation) => super.noSuchMethod(invocation);
}

// 自定义谜题服务
class MyCustomPuzzlesService implements PuzzlesService {
  /// 自定义的谜题服务实现...
  
  [@override](/user/override)
  void noSuchMethod(Invocation invocation) => super.noSuchMethod(invocation);
}

// 自定义游戏服务
class MyCustomGamesService implements GamesService {
  /// 自定义的游戏服务实现...
  
  [@override](/user/override)
  void noSuchMethod(Invocation invocation) => super.noSuchMethod(invocation);
}

// 自定义棋盘服务
class MyCustomBoardService implements BoardService {
  /// 自定义的棋盘服务实现...
  
  [@override](/user/override)
  void noSuchMethod(Invocation invocation) => super.noSuchMethod(invocation);
}

// 自定义 OAuth 服务
class MyCustomOAuthService implements OAuthService {
  /// 自定义的 OAuth 服务实现...
  
  [@override](/user/override)
  void noSuchMethod(Invocation invocation) => super.noSuchMethod(invocation);
}

// 自定义 Lichess 客户端
class MyCustomLichessClient extends LichessClient {
  [@override](/user/override)
  AccountService get account => MyCustomAccountService();

  [@override](/user/override)
  Future<void> close({bool force = false}) async {
    stdout.write('因为不能下载 RAM。');
  }

  [@override](/user/override)
  RelationsService get relations => MyCustomRelationsService();

  [@override](/user/override)
  UsersService get users => MyCustomUsersService();

  [@override](/user/override)
  TeamsService get teams => MyCustomTeamsService();

  [@override](/user/override)
  TvService get tv => MyCustomTvService();

  [@override](/user/override)
  PuzzlesService get puzzles => MyCustomPuzzlesService();

  [@override](/user/override)
  GamesService get games => MyCustomGamesService();

  [@override](/user/override)
  BoardService get board => MyCustomBoardService();

  [@override](/user/override)
  OAuthService get oauth => MyCustomOAuthService();
}

void main() {
  _tryRunAndThrowGhostImplementation();
}

Future<void> _tryRunAndThrowGhostImplementation() async {
  final MyCustomLichessClient customClient = MyCustomLichessClient();
  await customClient.account.getEmailAddress();
}