Flutter数据交互插件scolengo_api的使用

unofficial Dart API Wrapper 用于Skolengo教育管理系统。这个插件受到了 scolengo-api 的启发。

由于我没有访问整个API的权限，某些功能或字段可能缺失。如果您发现任何问题或有改进的地方，欢迎贡献您的代码。

示例

此示例应该可以在命令行中运行。

授权时卡住的情况

• 添加 urlLauncher: (url) => print(url) 到 Authenticator
• 将给定的URL粘贴到一个已经打开开发者工具并位于网络页面的浏览器中
• 复制第二个请求的URL（sko-app://sign-in-callback?code=...）
• 打开一个新的浏览器标签页，并将URL粘贴进去，将 sko-app:// 替换为 localhost:3000/
• 它应该可以正常工作。
• 我们不能使用 localhost:3000 作为 redirectUri，因为这会导致CAS错误。

import 'dart:convert';
import 'dart:io';

import 'package:openid_client/openid_client_io.dart';
import 'package:scolengo_api/src/models/School/school.dart';
import 'package:scolengo_api/src/skolengo.dart';

void main() async {
  final Credential credentials;
  final School school;

  final client = Skolengo.unauthenticated();
  final schools = await client.searchSchool('Lycée ...');
  school = schools.data[0];
  credentials = await createCredentials(school);

  // 这里可以保存凭证和学校信息为JSON格式

  final client = Skolengo.fromCredentials(credentials, school);

  // 现在您可以使用客户端了
}

Future<Credential> createCredentials(School school, [Skolengo? client]) async {
  client ??= Skolengo.unauthenticated();
  final oidclient = await client.getOIDClient(school);
  final f = Flow.implicit(oidclient);
  final authenticator = Authenticator(
    oidclient,
    redirectUri: Uri.parse('skoapp-prod://sign-in-callback'),
  );
  return authenticator.authorize();
}

如果您想在Flutter应用中使用此插件，请根据 openid_client 文档更改 createCredentials 函数。

缓存API响应

该库提供了一个非常灵活的接口，让您能够实现自己的缓存提供者。由于某些请求需要很长时间才能完成，因此缓存结果可能是个好主意，无论是内存、JSON文件、数据库或其他方式。

有关更多详细信息，请查看 cache_provider.dart 中的注释。

示例

使用JSON文件存储响应的缓存提供者

这是一个不太好的想法，示例不完整且是在匆忙中编写，但应该能大致说明如何构建这些结构。

class FSCacheProvider extends CacheProvider {
  Map<String, String> _index = {};

  [@override](/user/override)
  Future<String> get(String key) async {
    return await File(filename(key)).readAsString();
  }

  [@override](/user/override)
  bool raw() => false;

  [@override](/user/override)
  void set(String key, String value) {
    _index[filename(key)] = DateTime.now().toIso8601String();
    File('./cache/index.json').createSync(recursive: true);
    File('./cache/index.json').writeAsString(jsonEncode(_index));
    File(filename(key))
      ..createSync(recursive: true)
      ..writeAsString(value);
  }

  [@override](/user/override)
  Future<bool> shouldUseCache(String key) async {
    // TODO 比较日期
    return _index.keys.contains(filename(key));
  }

  String filename(String url) {
    return './cache${Uri.parse(url).path}/${Uri.parse(url).query}.json';
  }

  init() {
    _index = File('./cache/index.json').existsSync()
        ? jsonDecode(File('./cache/index.json').readAsStringSync())
            .map<String, String>(
                (key, value) => MapEntry(key as String, value as String))
        : {};
    File('.cache/index.json').createSync(recursive: true);
  }
}