2015-10-03 7 views
7

मैं सर्वर एपीआई के साथ संचार को संभालने के लिए रेट्रोफिट का उपयोग कर रहा हूं, प्रमाणीकरण के लिए एपीआई उपयोगकर्ता JSON वेब टोकन। टोकन समय-समय पर समाप्त हो जाता है, और मैं एक रेट्रोफिट क्लाइंट को लागू करने का सबसे अच्छा तरीका ढूंढ रहा हूं जो टोकन को स्वचालित रूप से समाप्त होने पर रीफ्रेश कर सकता है।वेबटोकेंस प्रमाणीकरण के लिए रेट्रोफिट कस्टम क्लाइंट

यह प्रारंभिक कार्यान्वयन मैं के साथ आया था, है:

/** 
* Client implementation that refreshes JSON WebToken automatically if 
* the response contains a 401 header, has there may be simultaneous calls to execute method 
* the refreshToken is synchronized to avoid multiple login calls. 
*/ 
public class RefreshTokenClient extends OkClient { 


private static final int UNAUTHENTICATED = 401; 


/** 
* Application context 
*/ 
private Application mContext; 



public RefreshTokenClient(OkHttpClient client, Application application) { 
    super(client); 
    mContext = application; 
} 


@Override 
public Response execute(Request request) throws IOException { 

    Timber.d("Execute request: " + request.getMethod() + " - " + request.getUrl()); 

    //Make the request and check for 401 header 
    Response response = super.execute(request); 

    Timber.d("Headers: "+ request.getHeaders()); 

    //If we received a 401 header, and we have a token, it's most likely that 
    //the token we have has expired 
    if(response.getStatus() == UNAUTHENTICATED && hasToken()) { 

     Timber.d("Received 401 from server awaiting"); 

     //Clear the token 
     clearToken(); 

     //Gets a new token 
     refreshToken(request); 

     //Update token in the request 
     Timber.d("Make the call again with the new token"); 

     //Makes the call again 
     return super.execute(rebuildRequest(request)); 

    } 

    return response; 
} 


/** 
* Rebuilds the request to be executed, overrides the headers with the new token 
* @param request 
* @return new request to be made 
*/ 
private Request rebuildRequest(Request request){ 

    List<Header> newHeaders = new ArrayList<>(); 
    for(Header h : request.getHeaders()){ 
     if(!h.getName().equals(Constants.Headers.USER_TOKEN)){ 
      newHeaders.add(h); 
     } 
    } 
    newHeaders.add(new Header(Constants.Headers.USER_TOKEN,getToken())); 
    newHeaders = Collections.unmodifiableList(newHeaders); 

    Request r = new Request(
      request.getMethod(), 
      request.getUrl(), 
      newHeaders, 
      request.getBody() 
    ); 

    Timber.d("Request url: "+r.getUrl()); 
    Timber.d("Request new headers: "+r.getHeaders()); 

    return r; 
} 

/** 
* Do we have a token 
*/ 
private boolean hasToken(){ 
    SharedPreferences prefs = PreferenceManager.getDefaultSharedPreferences(mContext); 
    return prefs.contains(Constants.TOKEN); 
} 

/** 
* Clear token 
*/ 
private void clearToken(){ 
    SharedPreferences prefs = PreferenceManager.getDefaultSharedPreferences(mContext); 
    prefs.edit().remove(Constants.TOKEN).commit(); 
} 

/** 
* Saves token is prefs 
*/ 
private void saveToken(String token){ 
    SharedPreferences prefs = PreferenceManager.getDefaultSharedPreferences(mContext); 
    prefs.edit().putString(Constants.TOKEN, token).commit(); 
    Timber.d("Saved new token: " + token); 
} 

/** 
* Gets token 
*/ 
private String getToken(){ 
    SharedPreferences prefs = PreferenceManager.getDefaultSharedPreferences(mContext); 
    return prefs.getString(Constants.TOKEN,""); 
} 




/** 
* Refreshes the token by making login again, 
* //TODO implement refresh token endpoint, instead of making another login call 
*/ 
private synchronized void refreshToken(Request oldRequest) throws IOException{ 

    //We already have a token, it means a refresh call has already been made, get out 
    if(hasToken()) return; 

    Timber.d("We are going to refresh token"); 

    //Get credentials 
    SharedPreferences prefs = PreferenceManager.getDefaultSharedPreferences(mContext); 
    String email = prefs.getString(Constants.EMAIL, ""); 
    String password = prefs.getString(Constants.PASSWORD, ""); 

    //Login again 
    com.app.bubbles.model.pojos.Response<Login> res = ((App) mContext).getApi().login(
      new com.app.bubbles.model.pojos.Request<>(credentials) 
    ); 

    //Save token in prefs 
    saveToken(res.data.getTokenContainer().getToken()); 

    Timber.d("Token refreshed"); 
} 


} 

मैं गहराई से रेट्रोफिट/OkHttpClient की वास्तुकला पता नहीं है, लेकिन जहां तक ​​मैं समझता हूँ निष्पादित विधि कई से कई बार कहा जा सकता है धागे, OkClientCalls के बीच साझा किया गया है केवल एक उथली प्रतिलिपि बनाई जाती है। refreshToken() में synchronized में refreshToken() में प्रवेश करने के लिए कई धागे से बचने के लिएविधि का उपयोग कर रहा हूं और एकाधिक लॉगिन कॉल कर सकता हूं, मुझे रीफ्रेश की आवश्यकता होती है केवल एक थ्रेड को रीफ्रेश करना चाहिए और अन्य नवीनीकृत टोकन का उपयोग करेंगे।

मैंने इसे अभी तक गंभीरता से परीक्षण नहीं किया है, लेकिन इसके लिए मैं देख सकता हूं कि यह ठीक काम कर रहा है। हो सकता है कि किसी को पहले से ही यह समस्या हो और उसका समाधान साझा कर सके, या यह समान/समान समस्या वाले किसी के लिए सहायक हो सकता है।

धन्यवाद।

उत्तर

7

किसी को भी है कि इस को खोजने के लिए, आप OkHttp Interceptors के साथ जाने या प्रमाणक एपीआई

का उपयोग इस रेट्रोफिट GitHub पेज

public void setup() { 
    OkHttpClient client = new OkHttpClient(); 
    client.interceptors().add(new TokenInterceptor(tokenManager)); 

    Retrofit retrofit = new Retrofit.Builder() 
      .addConverterFactory(GsonConverterFactory.create()) 
      .client(client) 
      .baseUrl("http://localhost") 
      .build(); 
} 

private static class TokenInterceptor implements Interceptor { 
    private final TokenManager mTokenManager; 

    private TokenInterceptor(TokenManager tokenManager) { 
     mTokenManager = tokenManager; 
    } 

    @Override 
    public Response intercept(Chain chain) throws IOException { 
     Request initialRequest = chain.request(); 
     Request modifiedRequest = request; 
     if (mTokenManager.hasToken()) { 
      modifiedRequest = request.newBuilder() 
        .addHeader("USER_TOKEN", mTokenManager.getToken()) 
        .build(); 
     } 

     Response response = chain.proceed(modifiedRequest); 
     boolean unauthorized = response.code() == 401; 
     if (unauthorized) { 
      mTokenManager.clearToken(); 
      String newToken = mTokenManager.refreshToken(); 
      modifiedRequest = request.newBuilder() 
        .addHeader("USER_TOKEN", mTokenManager.getToken()) 
        .build(); 
      return chain.proceed(modifiedRequest); 
     } 
     return response; 
    } 
} 

interface TokenManager { 
    String getToken(); 
    boolean hasToken(); 
    void clearToken(); 
    String refreshToken(); 
} 

आप अनुरोध ब्लॉक करने के लिए जब तक प्रमाणीकरण है चाहते हैं से एक नमूना है चाहिए किया गया है, आप मेरे उत्तर में किए गए एक ही सिंक्रनाइज़ेशन तंत्र का उपयोग कर सकते हैं क्योंकि इंटरसेप्टर कई धागे

+1

पर एक साथ चल सकते हैं और यदि आप आरएक्स का उपयोग करना चाहते हैं: http://stackoverflow.com/questions/25546934/retrofit-rxjava-and सत्र-आधारित-सेवाएं – Than

+0

@ सर्जीओ: अद्भुत जवाब के लिए धन्यवाद। हालांकि मेरी टिप्पणी आपके प्रश्न में मौजूद कोड के संदर्भ में है। बस उत्सुक है, अगर आपने 'रेट्रोफिट' का उपयोग करके फिर से लॉगिन करके 'रीफ्रेश टोकन' को सिंक्रोनस किया है, तो उसने 'नेटवर्कऑनमेन थ्रेड अपवाद' को फेंक दिया नहीं है, क्योंकि रेट्रोफिट द्वारा सिंक्रोनस कॉल मुख्य थ्रेड पर है और एंड्रॉइड नेटवर्क कॉल की अनुमति नहीं देता है मुख्य धागे पर? अग्रिम में धन्यवाद। –

+0

@ShobhitPuri हाय, 'refreshToken' विधि' execute' के अंदर बुलाया जाता है और इस विधि को रेट्रोफिट लाइब्रेरी द्वारा पृष्ठभूमि में बुलाया जाता है, अब विवरण याद नहीं है। लेकिन यह करना सुरक्षित है। –

संबंधित मुद्दे