Flutter Strava API集成插件strava_client的使用

概述

strava_flutter 是一个用于在Dart/Flutter项目中调用Strava API v3的包。它遵循最新的认证流程，允许开发者轻松地与Strava的各种API进行交互。

警告: 该包正在经历大规模重构，未来更新可能会引入破坏性变更。

支持的API

认证相关API

• authorize
• deauthorize

运动员相关API

• getLoggedInAthlete
• updateLoggedInAthlete (需要profile:write权限)
• getLoggedInAthleteActivities
• getLoggedInAthleteZones
• getGearById
• getStats

俱乐部相关API

• getClubById
• getClubActivitiesById
• getClubMembersById

赛事相关API

• getRunningRaces
• getRunningRaceById

活动相关API

• createActivity
• uploadActivity（包括getUploadById）

  测试了TCX和GPX格式的支持

为了生成TCX文件，可以使用 rw_tcx 包。

段落相关API

• getSegmentById
• getLoggedInAthleteStarredSegments
• getLeaderboardBySegmentId
• starSegment

安装方法

请参考 pub.dev 上提供的安装指南。

Android Pie (9.0, API level 28) 额外步骤

如果遇到net::ERR_CLEARTEXT_NOT_PERMITTED错误，请在AndroidManifest.xml中添加如下配置：

<application
    ...
    android:usesCleartextTraffic="true"
    ...>

使用说明

1. 在Strava设置页面获取客户端密钥，并将“Authorization Callback Domain”设为redirect。

2. 设置URL Scheme以便处理来自Strava认证的重定向URL：

   • 对于Android，在AndroidManifest.xml中添加以下代码：

     <intent-filter>
       <action android:name="android.intent.action.VIEW" />
       <category android:name="android.intent.category.DEFAULT" />
       <category android:name="android.intent.category.BROWSABLE" />
       <data android:scheme="stravaflutter" android:host="redirect" />
     </intent-filter>
     

     同时修改launchMode为singleInstance以确保Firefox下的正常工作。
   • 对于iOS，在info.plist中添加以下内容：

     <key>CFBundleURLTypes</key>
     <array>
       <dict>
         <key>CFBundleTypeRole</key>
         <string>Editor</string>
         <key>CFBundleURLName</key>
         <string>stravaflutter</string>
         <key>CFBundleURLSchemes</key>
         <array>
           <string>stravaflutter</string>
         </array>
       </dict>
     </array>
     

     如果需要启动本地Strava应用进行认证，还需添加：

     <key>LSApplicationQueriesSchemes</key>
     <array>
       <string>strava</string>
     </array>
     

3. 创建secret.dart文件并保存您的client secret和appID：

   final String secret = "[Your client secret]";
   final String clientId = "[Your appID]";
   

4. 在需要使用这些值的地方导入secret.dart。

5. 若要查看调试信息，可以在初始化StravaClient时将isInDebug设为true。

6. 参考示例代码了解具体用法。

示例代码

下面是一个简单的Flutter应用程序示例，演示了如何使用strava_flutter进行用户登录、登出以及显示访问令牌：

import 'dart:async';
import 'package:flutter/material.dart';
import 'package:intl/intl.dart';
import 'package:strava_client/strava_client.dart';
import 'secret.dart';

void main() => runApp(MyApp());

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Strava Flutter',
      theme: ThemeData(primarySwatch: Colors.blue),
      home: StravaFlutterPage(),
    );
  }
}

class StravaFlutterPage extends StatefulWidget {
  @override
  _StravaFlutterPageState createState() => _StravaFlutterPageState();
}

class _StravaFlutterPageState extends State<StravaFlutterPage> {
  final TextEditingController _textEditingController = TextEditingController();
  final DateFormat dateFormatter = DateFormat("HH:mm:ss");
  late final StravaClient stravaClient;

  bool isLoggedIn = false;
  TokenResponse? token;

  @override
  void initState() {
    super.initState();
    stravaClient = StravaClient(secret: secret, clientId: clientId);
  }

  FutureOr<void> showErrorMessage(dynamic error, dynamic stackTrace) async {
    if (error is Fault) {
      await showDialog(
        context: context,
        builder: (context) => AlertDialog(
          title: Text("Did Receive Fault"),
          content: Text(
            "Message: ${error.message}\n-----------------\nErrors:\n${(error.errors ?? []).map((e) => "Code: ${e.code}\nResource: ${e.resource}\nField: ${e.field}\n").join("\n----------\n")}",
          ),
        ),
      );
    }
  }

  void testAuthentication() {
    ExampleAuthentication(stravaClient).testAuthentication(
      [
        AuthenticationScope.profile_read_all,
        AuthenticationScope.read_all,
        AuthenticationScope.activity_read_all
      ],
      "stravaflutter://redirect",
    ).then((token) {
      setState(() {
        isLoggedIn = true;
        this.token = token;
      });
      _textEditingController.text = token.accessToken;
    }).catchError(showErrorMessage);
  }

  void testDeauth() {
    ExampleAuthentication(stravaClient).testDeauthorize().then((value) {
      setState(() {
        isLoggedIn = false;
        this.token = null;
        _textEditingController.clear();
      });
    }).catchError(showErrorMessage);
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text("Flutter Strava Plugin"),
        actions: [
          Icon(
            Icons.radio_button_checked_outlined,
            color: isLoggedIn ? Colors.white : Colors.red,
          ),
          SizedBox(width: 8,)
        ],
      ),
      body: Container(
        padding: const EdgeInsets.symmetric(horizontal: 16),
        child: Column(
          crossAxisAlignment: CrossAxisAlignment.start,
          children: [_login(), _apiGroups()],
        ),
      ),
    );
  }

  Widget _login() {
    return Column(
      crossAxisAlignment: CrossAxisAlignment.start,
      children: [
        Row(
          mainAxisAlignment: MainAxisAlignment.spaceBetween,
          children: [
            ElevatedButton(
              child: Text("Login With Strava"),
              onPressed: testAuthentication,
            ),
            ElevatedButton(
              child: Text("De Authorize"),
              onPressed: testDeauth,
            )
          ],
        ),
        SizedBox(height: 8,),
        TextField(
          minLines: 1,
          maxLines: 3,
          controller: _textEditingController,
          decoration: InputDecoration(
            border: OutlineInputBorder(),
            label: Text("Access Token"),
            suffixIcon: TextButton(
              child: Text("Copy"),
              onPressed: () {
                Clipboard.setData(ClipboardData(text: _textEditingController.text))
                  .then((value) => ScaffoldMessenger.of(context).showSnackBar(SnackBar(content: Text("Copied!"))));
              },
            ),
          ),
        ),
        Divider()
      ],
    );
  }

  Widget _apiGroups() {
    return IgnorePointer(
      ignoring: !isLoggedIn,
      child: AnimatedOpacity(
        opacity: isLoggedIn ? 1.0 : 0.4,
        duration: Duration(milliseconds: 200),
        child: Column(
          mainAxisSize: MainAxisSize.min,
          children: [
            ListTile(title: Text("Athletes"), trailing: Icon(Icons.chevron_right),),
            ListTile(title: Text("Clubs"), trailing: Icon(Icons.chevron_right),),
            ListTile(title: Text("Gears"), trailing: Icon(Icons.chevron_right),),
            ListTile(title: Text("Routes"), trailing: Icon(Icons.chevron_right),),
            ListTile(title: Text("Running Races"), trailing: Icon(Icons.chevron_right),),
            ListTile(title: Text("Segment Efforts"), trailing: Icon(Icons.chevron_right),),
            ListTile(title: Text("Segments"), trailing: Icon(Icons.chevron_right),),
            ListTile(title: Text("Streams"), trailing: Icon(Icons.chevron_right),),
            ListTile(title: Text("Uploads"), trailing: Icon(Icons.chevron_right),)
          ],
        ),
      ),
    );
  }
}

以上就是关于strava_flutter插件的基本介绍及其在Flutter项目中的使用方法。希望这对您有所帮助！如果您有任何问题或需要实现其他API功能，请随时提出新问题。