使用refreshToken颤动firebase自动刷新用户会话

Posted 2023-02-23

技术标签:

【中文标题】使用refreshToken颤动firebase自动刷新用户会话【英文标题】：flutter firebase auto refresh user session with refreshToken 【发布时间】：2020-12-12 01:20:13 【问题描述】：

我希望我的应用程序中的用户保持登录状态。我正在使用带有 IDToken 的 Firebase 身份验证，该身份验证持续 1 小时直到过期。如果会话即将过期，我想每次都自动刷新会话。

到目前为止我在这里读到的https://firebase.google.com/docs/reference/rest/auth/#section-refresh-token 应该可以通过https://securetoken.googleapis.com/v1/token?key=[API_KEY] 实现

这是我现在进行身份验证的完整代码 (flutter)

import 'dart:convert';
import 'package:flutter/material.dart';
import 'package:http/http.dart' as http;
import '../provider/http_exception.dart';
import 'dart:async';
import 'package:shared_preferences/shared_preferences.dart';

class Auth with ChangeNotifier 
  String _token;
  DateTime _expiryDate;
  String _userId;
  Timer _authTimer;
  bool wasLoggedOut = false;
  bool onBoarding = false;

  Future<void> createUser(String email, String firstName, String lastName) async 
    final url = 'https://test45.firebaseio.com/users/$userId.json?auth=$token';
    final response = await http.put(url, body: json.encode(
      'userEmail': email,
      'userIsArtist': false,
      'userFirstName': firstName,
      'userLastName': lastName,
    ));
    print('post ist done');
    print(json.decode(response.body));
  

  bool get isAuth 
    return token != null;
  

  String get userId 
    return _userId;
  

  String get token 
    if (_expiryDate != null &&
        _expiryDate.isAfter(DateTime.now()) &&
        _token != null) 
      return _token;
    
    return null;
  

  Future<void> authenticate(
      String email, String password, String urlSegement) async 
    final url = 'https://identitytoolkit.googleapis.com/v1/accounts:$urlSegement?key=AIzaSyD8pb3M325252dfsDC-4535dfd';

    try 
      final response = await http.post(url,
          body: json.encode(
            'email': email,
            'password': password,
            'returnSecureToken': true,
          ));
      final responseData = json.decode(response.body);
      if (responseData['error'] != null) 
        throw HttpException(responseData['error']['message']);
      
      _token = responseData['idToken'];
      _userId = responseData['localId'];
      _expiryDate = DateTime.now().add(Duration(seconds: int.parse(responseData['expiresIn'])));
      _autoLogout();
     
      notifyListeners();

      final prefs = await SharedPreferences.getInstance();
      final userData = json.encode(
        'token': _token,
        'userId': _userId,
        'expiryDate': _expiryDate.toIso8601String(),
      );
      prefs.setString('userData', userData);
     catch (error) 
      throw error;
    
  

  Future<void> signup(String email, String password) async 
    return authenticate(email, password, 'signUp');
  

  Future<void> signin(String email, String password) async 
    return authenticate(email, password, 'signInWithPassword');
  

  Future<bool> tryAutoLogin() async 
    final prefs = await SharedPreferences.getInstance();
    if(!prefs.containsKey('userData'))
      return false;
    
    final extractedUserData = json.decode(prefs.getString('userData')) as Map<String, Object>;
    final expiryDate = DateTime.parse(extractedUserData['expiryDate']);

    if(expiryDate.isBefore(DateTime.now())) 
      return false;
    

    _token = extractedUserData['token'];
    _userId = extractedUserData['userId'];
    _expiryDate = expiryDate;

    notifyListeners();
    _autoLogout();
    return true;
  


  Future<void> logout() async 
    _token = null;
    _userId = null;
    _expiryDate = null;
    if(_authTimer != null)
      _authTimer.cancel();
      _authTimer = null;
    
    notifyListeners();
    final prefs = await SharedPreferences.getInstance();
    prefs.remove('userData');
  

  void _autoLogout() 
    if(_authTimer != null) 
      _authTimer.cancel();
    
  final timetoExpiry =  _expiryDate.difference(DateTime.now()).inSeconds;
    _authTimer = Timer(Duration(seconds: timetoExpiry), logout);

如何修改我的auth.dart实现自动刷新？

编辑：

如 cmets 中所述，我正在与提供者合作，我有以下功能来检索令牌：

update(String token, id, List<items> itemsList) 
    authToken = token;
    userId = id;

在我的每个 API 调用中，我已经使用了 auth 参数：

var url = 'https://test45.firebaseio.com/folder/$inside/$ym.json?auth=$authToken';

我只需要有人可以告诉我如何使用刷新令牌修改我的代码。

提前致谢！

编辑：

我尝试实现它，但我得到一个无限循环，请帮助：

String get token 
    if (_expiryDate != null &&
        _expiryDate.isAfter(DateTime.now()) &&
        _token != null) 
      return _token;
    
    refreshSession();
  

  Future<void> refreshSession() async 
        final url = 'https://securetoken.googleapis.com/v1/token?key=5437fdjskfsdk38438?grant_type=refresh_token?auth=$token';
      
      try 
      final response = await http.post(url,
          body: json.encode(
  'token_type': 'Bearer',
          ));
      final responseData = json.decode(response.body);
      if (responseData['error'] != null) 
        throw HttpException(responseData['error']['message']);
      
      _token = responseData['id_token'];
      _userId = responseData['user_id'];
      _expiryDate = DateTime.now().add(Duration(seconds: int.parse(responseData['expires_in'])));
      _autoLogout();
     
      notifyListeners();

      final prefs = await SharedPreferences.getInstance();
      final userData = json.encode(
        'token': _token,
        'userId': _userId,
        'expiryDate': _expiryDate.toIso8601String(),
      );
      prefs.setString('userData', userData);
     catch (error) 
      throw error;

【问题讨论】：

您为什么不使用提供的SDK for Firebase Auth，它会为您管理一切？好吧，基本上不，我从教育中学到了颤振，他们向我们展示了如何处理其余的 api 和 http 请求。您知道要为自动刷新更改什么吗？我不知道，但我相信如果您像大多数其他人一样使用 SDK，会很多容易。我的应用程序真的很远，没有使用任何 Firebase SDK，无论是实时数据库、firebase 存储还是身份验证，只直接使用 api。如果可能的话，我想暂时保留它而不使用它如果您按照@DougStevenson 的建议切换到 Firebase SDK 方法会更好 【参考方案1】：

我编辑了你的 refresh_token() 函数。

首先，您应该在带有链接的 Firebase 项目中使用您的 Web api 密钥。您还应该保存刷新令牌。如果你像这样发帖，它会起作用。如果不起作用，请在我提交时尝试在您的身体上不使用 json.encode() 功能。

Future<void> refreshSession() async 
  final url =
      'https://securetoken.googleapis.com/v1/token?key=$WEB_API_KEY'; 
  //$WEB_API_KEY=> You should write your web api key on your firebase project.
  
  try 
    final response = await http.post(
      url,
      headers: 
        "Accept": "application/json",
        "Content-Type": "application/x-www-form-urlencoded"
      ,
      body: json.encode(
        'grant_type': 'refresh_token',
        'refresh_token': '[REFRESH_TOKEN]', // Your refresh token.
      ),
      // Or try without json.encode.
      // Like this:
      // body: 
      //   'grant_type': 'refresh_token',
      //   'refresh_token': '[REFRESH_TOKEN]',
      // ,
    );
    final responseData = json.decode(response.body);
    if (responseData['error'] != null) 
      throw HttpException(responseData['error']['message']);
    
    _token = responseData['id_token'];
    _refresh_token = responseData['refresh_token']; // Also save your refresh token
    _userId = responseData['user_id'];
    _expiryDate = DateTime.now()
        .add(Duration(seconds: int.parse(responseData['expires_in'])));
    _autoLogout();

    notifyListeners();

    final prefs = await SharedPreferences.getInstance();
    final userData = json.encode(
      'token': _token,
      'refresh_token': _refresh_token,
      'userId': _userId,
      'expiryDate': _expiryDate.toIso8601String(),
    );
    prefs.setString('userData', userData);
   catch (error) 
    throw error;

这是我编辑的完整 auth.dart 文件。

import 'dart:convert';
import 'package:flutter/material.dart';
import 'package:http/http.dart' as http;
import '../provider/http_exception.dart';
import 'dart:async';
import 'package:shared_preferences/shared_preferences.dart';

class Auth with ChangeNotifier 
  String _token;
  String _refresh_token;
  DateTime _expiryDate;
  String _userId;
  Timer _authTimer;
  bool wasLoggedOut = false;
  bool onBoarding = false;

  Future<void> createUser(String email, String firstName, String lastName) async 
    final url = 'https://test45.firebaseio.com/users/$userId.json?auth=$token';
    final response = await http.put(url, body: json.encode(
      'userEmail': email,
      'userIsArtist': false,
      'userFirstName': firstName,
      'userLastName': lastName,
    ));
    print('post ist done');
    print(json.decode(response.body));
  

  bool get isAuth 
    return token != null;
  

  String get userId 
    return _userId;
  

  String get token 
    if (_expiryDate != null &&
        _expiryDate.isAfter(DateTime.now()) &&
        _token != null && _refresh_token!=null) 
      return _token;
    
    refreshSession();
    return null;
  

  Future<void> authenticate(
      String email, String password, String urlSegement) async 
    final url = 'https://identitytoolkit.googleapis.com/v1/accounts:$urlSegement?key=AIzaSyD8pb3M325252dfsDC-4535dfd';

    try 
      final response = await http.post(url,
          body: json.encode(
            'email': email,
            'password': password,
            'returnSecureToken': true,
          ));
      final responseData = json.decode(response.body);
      if (responseData['error'] != null) 
        throw HttpException(responseData['error']['message']);
      
      _token = responseData['idToken'];
      _refresh_token = responseData['refreshToken'];
      _userId = responseData['localId'];
      _expiryDate = DateTime.now().add(Duration(seconds: int.parse(responseData['expiresIn'])));
      _autoLogout();
     
      notifyListeners();

      final prefs = await SharedPreferences.getInstance();
      final userData = json.encode(
        'token': _token,
        'refresh_token': _refresh_token,
        'userId': _userId,
        'expiryDate': _expiryDate.toIso8601String(),
      );
      prefs.setString('userData', userData);
     catch (error) 
      throw error;
    
  

  Future<void> signup(String email, String password) async 
    return authenticate(email, password, 'signUp');
  

  Future<void> signin(String email, String password) async 
    return authenticate(email, password, 'signInWithPassword');
  

  Future<bool> tryAutoLogin() async 
    final prefs = await SharedPreferences.getInstance();
    if(!prefs.containsKey('userData'))
      return false;
    
    final extractedUserData = json.decode(prefs.getString('userData')) as Map<String, Object>;
    final expiryDate = DateTime.parse(extractedUserData['expiryDate']);

    if(expiryDate.isBefore(DateTime.now())) 
      return false;
    

    _token = extractedUserData['token'];
    _refresh_token = extractedUserData['refresh_token'];
    _userId = extractedUserData['userId'];
    _expiryDate = expiryDate;

    notifyListeners();
    _autoLogout();
    return true;
  


  Future<void> logout() async 
    _token = null;
    _refresh_token = null;
    _userId = null;
    _expiryDate = null;
    if(_authTimer != null)
      _authTimer.cancel();
      _authTimer = null;
    
    notifyListeners();
    final prefs = await SharedPreferences.getInstance();
    prefs.remove('userData');
  

  void _autoLogout() 
    if(_authTimer != null) 
      _authTimer.cancel();
    
  final timetoExpiry =  _expiryDate.difference(DateTime.now()).inSeconds;
    _authTimer = Timer(Duration(seconds: timetoExpiry), logout);
  
  
  


Future<void> refreshSession() async 
  final url =
      'https://securetoken.googleapis.com/v1/token?key=$WEB_API_KEY'; 
  //$WEB_API_KEY=> You should write your web api key on your firebase project.
  
  try 
    final response = await http.post(
      url,
      headers: 
        "Accept": "application/json",
        "Content-Type": "application/x-www-form-urlencoded"
      ,
      body: json.encode(
        'grant_type': 'refresh_token',
        'refresh_token': '[REFRESH_TOKEN]', // Your refresh token.
      ),
      // Or try without json.encode.
      // Like this:
      // body: 
      //   'grant_type': 'refresh_token',
      //   'refresh_token': '[REFRESH_TOKEN]',
      // ,
    );
    final responseData = json.decode(response.body);
    if (responseData['error'] != null) 
      throw HttpException(responseData['error']['message']);
    
    _token = responseData['id_token'];
    _refresh_token = responseData['refresh_token']; // Also save your refresh token
    _userId = responseData['user_id'];
    _expiryDate = DateTime.now()
        .add(Duration(seconds: int.parse(responseData['expires_in'])));
    _autoLogout();

    notifyListeners();

    final prefs = await SharedPreferences.getInstance();
    final userData = json.encode(
      'token': _token,
      'refresh_token': _refresh_token,
      'userId': _userId,
      'expiryDate': _expiryDate.toIso8601String(),
    );
    prefs.setString('userData', userData);
   catch (error) 
    throw error;

【讨论】：

非常感谢您的代码，非常感谢！所以我改变了这个'refresh_token'：'[REFRESH_TOKEN]'，到这个'refresh_token'：_refresh_token，代码看起来不错，但我得到错误缺少授权类型。请帮忙另外，如果我在 if (responseData['error'] != null) 行之前打印刷新令牌的内容，我会收到刷新令牌，但是在错误中我们有 MISSING GRANT TYPE 您是否也发送了此值？ 'grant_type'：'refresh_token'。因为它必须使用刷新令牌发送。并且不要改变任何东西。如果你像 'grant_type':'your refresh token' 这样发送它，我将无法工作。我是这样做的： body: json.encode( 'grant_type': 'refresh_token', 'refresh_token': refresh_token, // 你的刷新令牌。)，但如果你保持它喜欢你有，它没有任何区别，仍然是同样的错误。请帮助:( 嗯，出了点问题，但我听不懂。如果您有空，我可以通过 AnyDesk 或类似远程连接程序的方式与您联系。给我发邮件 fkurt97@gmail.com。【参考方案2】：

您需要保存刷新令牌。按照此主题使用刷新令牌刷新您的 IDToken：https://firebase.google.com/docs/reference/rest/auth#section-refresh-token

对 API 进行任何调用时，请使用函数来检索 IDToken。此函数必须检查当前 IDToken 是否仍然有效，如果没有，则请求一个新的（使用提供的链接）。

【讨论】：

您能否将我的 auth.dart 函数修改为可行的解决方案？你只需要修改你的get token。如果令牌无效（您已经在检查），请调用刷新 API，类似于您为身份验证所做的操作。好吧，和我的身份验证一样的功能只使用securetoken.googleapis.com/v1/token?key=[API_KEY] 吗？ json 体在那里看起来如何？（对不起我的英语，如果你能以我的功能为例，我想我可以从中学习最简单的方法你能给我一个工作的例子吗？在我的情况下，我在理解、接收和更改刷新令牌方面遇到问题。 @racr0x 我还编辑了我的问题，以显示我目前如何通过每次 api 调用和提供者接收 idtoken 你能修改我的 auth.dart 吗？那将是惊人的！【参考方案3】：

我认为Dio 库适合你

dio = Dio();
dio.options.baseUrl = URL_API_PROD;
dio.interceptors.add(InterceptorsWrapper(
  onRequest: (Options option) async
    
    //getToken() : you can check token expires and renew in this function
    await getToken().then((result) 
      token = result;
    );
    option.headers = 
      "Authorization": "Bearer $token"
    ;
  
));

Response response = await dio.get('/api/users');

【讨论】：

你好，谢谢你的方法。您还可以向我展示如何使用securetoken.googleapis.com/v1/token?key=[API_KEY] 使用其余api吗？我试图实现它，但是，我没有得到任何好的结果。如果你能告诉我就好了好吧，伙计们，我尝试自己实现 api 函数，我得到一个无限循环，但我认为我非常接近解决方案，请帮助，代码在我的问题中不需要使用dio。您可以只使用 http。【参考方案4】：

body 需要字符串...因此将 refreshSession() 中的 body 更改为 body: 'grant_type=refresh_token&refresh_token=[YOUR REFRESH TOKEN]',。

您需要在发送 http.post 请求之前从 SharedPreferences 加载“refreshToken”。

【讨论】：

以上是关于使用refreshToken颤动firebase自动刷新用户会话的主要内容，如果未能解决你的问题，请参考以下文章

Firebase 使用 idToken 或 refreshToken 登录

颤动中特定设备的Firebase消息通知

颤动中的Firebase分页

使用firebase时颤动的Gradle问题

如何在颤动中使用facebook执行firebase身份验证[重复]

如何在颤动中自动注销firebase用户？