Android Okhttp完美同步持久Cookie實現免登陸

經過對Retrofit2.0的<Retrofit 2.0 超能實踐，完美支持Https傳輸>基礎入門和案例實踐，掌握了怎麼樣使用Retrofit訪問網絡，加入自定義header，包括加入SSL證書，基本的調試基礎，可是正常的開發中會涉及cookie同步問題，能夠實現一些自動或免登陸登錄問題，接下來進入cookie同步姿式

Cookie

Cookies是一種可以讓網站服務器把少許數據儲存到客戶端的硬盤或內存，或是從客戶端的硬盤讀取數據的一種技術。Cookies是當你瀏覽某網站時，由Web服務器置於你硬盤上的一個很是小的文本文件，它能夠記錄你的用戶ID、密碼、瀏覽過的網頁、停留的時間等信息。當你再次來到該網站時，網站經過讀取Cookies，得知你的相關信息，就能夠作出相應的動做，如在頁面顯示歡迎你的標語，或者讓你不用輸入ID、密碼就直接登陸等等。

從本質上講，它能夠看做是你的身份證。但Cookies不能做爲代碼執行，也不會傳送病毒，且爲你所專有，並只能由提供它的服務器來讀取。保存的信息片段以「名/值」對(name-value pairs)的形式儲存，一個「名/值」對僅僅是一條命名的數據。一個網站只能取得它放在你的電腦中的信息，它沒法從其它的Cookies文件中取得信息，也沒法獲得你的電腦上的其它任何東西。

Cookies中的內容大多數通過了加密處理，所以通常用戶看來只是一些毫無心義的字母數字組合，只有服務器的CGI處理程序才知道它們真正的含義。

Cookie也是http的會話跟蹤技術，也包含web端的session。cookie的做用就是爲了解決HTTP協議無狀態的缺陷所做的努力.

方式一：

自定義cookie

HttpClient中你們都知道加入cookie的方式

AsyncHttpClient client = new AsyncHttpClient(); PersistentCookieStore myCookieStore = new PersistentCookieStore(MainActivity.this); client.setCookieStore(myCookieStore);

所以Retrofit中需自我實現一個PersistentCookieStore 用來儲存OkHttpCookies。

-PersistentCookieStore

/** * Created by LIUYONGKUI on 2016-06-09. */ public class PersistentCookieStore { private static final String LOG_TAG = "PersistentCookieStore"; private static final String COOKIE_PREFS = "Cookies_Prefs"; private final Map<String, ConcurrentHashMap<String, Cookie>> cookies; private final SharedPreferences cookiePrefs; public PersistentCookieStore(Context context) { cookiePrefs = context.getSharedPreferences(COOKIE_PREFS, 0); cookies = new HashMap<>(); //將持久化的cookies緩存到內存中 即map cookies Map<String, ?> prefsMap = cookiePrefs.getAll(); for (Map.Entry<String, ?> entry : prefsMap.entrySet()) { String[] cookieNames = TextUtils.split((String) entry.getValue(), ","); for (String name : cookieNames) { String encodedCookie = cookiePrefs.getString(name, null); if (encodedCookie != null) { Cookie decodedCookie = decodeCookie(encodedCookie); if (decodedCookie != null) { if (!cookies.containsKey(entry.getKey())) { cookies.put(entry.getKey(), new ConcurrentHashMap<String, Cookie>()); } cookies.get(entry.getKey()).put(name, decodedCookie); } } } } } protected String getCookieToken(Cookie cookie) { return cookie.name() + "@" + cookie.domain(); } public void add(HttpUrl url, Cookie cookie) { String name = getCookieToken(cookie); //將cookies緩存到內存中 若是緩存過時 就重置此cookie if (!cookie.persistent()) { if (!cookies.containsKey(url.host())) { cookies.put(url.host(), new ConcurrentHashMap<String, Cookie>()); } cookies.get(url.host()).put(name, cookie); } else { if (cookies.containsKey(url.host())) { cookies.get(url.host()).remove(name); } } //講cookies持久化到本地 SharedPreferences.Editor prefsWriter = cookiePrefs.edit(); prefsWriter.putString(url.host(), TextUtils.join(",", cookies.get(url.host()).keySet())); prefsWriter.putString(name, encodeCookie(new OkHttpCookies(cookie))); prefsWriter.apply(); } public List<Cookie> get(HttpUrl url) { ArrayList<Cookie> ret = new ArrayList<>(); if (cookies.containsKey(url.host())) ret.addAll(cookies.get(url.host()).values()); return ret; } public boolean removeAll() { SharedPreferences.Editor prefsWriter = cookiePrefs.edit(); prefsWriter.clear(); prefsWriter.apply(); cookies.clear(); return true; } public boolean remove(HttpUrl url, Cookie cookie) { String name = getCookieToken(cookie); if (cookies.containsKey(url.host()) && cookies.get(url.host()).containsKey(name)) { cookies.get(url.host()).remove(name); SharedPreferences.Editor prefsWriter = cookiePrefs.edit(); if (cookiePrefs.contains(name)) { prefsWriter.remove(name); } prefsWriter.putString(url.host(), TextUtils.join(",", cookies.get(url.host()).keySet())); prefsWriter.apply(); return true; } else { return false; } } public List<Cookie> getCookies() { ArrayList<Cookie> ret = new ArrayList<>(); for (String key : cookies.keySet()) ret.addAll(cookies.get(key).values()); return ret; } /** * cookies 序列化成 string * * @param cookie 要序列化的cookie * @return 序列化以後的string */ protected String encodeCookie(OkHttpCookies cookie) { if (cookie == null) return null; ByteArrayOutputStream os = new ByteArrayOutputStream(); try { ObjectOutputStream outputStream = new ObjectOutputStream(os); outputStream.writeObject(cookie); } catch (IOException e) { Log.d(LOG_TAG, "IOException in encodeCookie", e); return null; } return byteArrayToHexString(os.toByteArray()); } /** * 將字符串反序列化成cookies * * @param cookieString cookies string * @return cookie object */ protected Cookie decodeCookie(String cookieString) { byte[] bytes = hexStringToByteArray(cookieString); ByteArrayInputStream byteArrayInputStream = new ByteArrayInputStream(bytes); Cookie cookie = null; try { ObjectInputStream objectInputStream = new ObjectInputStream(byteArrayInputStream); cookie = ((OkHttpCookies) objectInputStream.readObject()).getCookies(); } catch (IOException e) { Log.d(LOG_TAG, "IOException in decodeCookie", e); } catch (ClassNotFoundException e) { Log.d(LOG_TAG, "ClassNotFoundException in decodeCookie", e); } return cookie; } /** * 二進制數組轉十六進制字符串 * * @param bytes byte array to be converted * @return string containing hex values */ protected String byteArrayToHexString(byte[] bytes) { StringBuilder sb = new StringBuilder(bytes.length * 2); for (byte element : bytes) { int v = element & 0xff; if (v < 16) { sb.append('0'); } sb.append(Integer.toHexString(v)); } return sb.toString().toUpperCase(Locale.US); } /** * 十六進制字符串轉二進制數組 * * @param hexString string of hex-encoded values * @return decoded byte array */ protected byte[] hexStringToByteArray(String hexString) { int len = hexString.length(); byte[] data = new byte[len / 2]; for (int i = 0; i < len; i += 2) { data[i / 2] = (byte) ((Character.digit(hexString.charAt(i), 16) << 4) + Character.digit(hexString.charAt(i + 1), 16)); } return data; }

- OkHttpCookies

須要實現序列化的 OkHttpCookies 用來持久OkHttpCookies

/** * Created by LIUYONGKUI on 2016-05-20. */ public class OkHttpCookies implements Serializable { private transient final Cookie cookies; private transient Cookie clientCookies; public OkHttpCookies(Cookie cookies) { this.cookies = cookies; } public Cookie getCookies() { Cookie bestCookies = cookies; if (clientCookies != null) { bestCookies = clientCookies; } return bestCookies; } private void writeObject(ObjectOutputStream out) throws IOException { out.writeObject(cookies.name()); out.writeObject(cookies.value()); out.writeLong(cookies.expiresAt()); out.writeObject(cookies.domain()); out.writeObject(cookies.path()); out.writeBoolean(cookies.secure()); out.writeBoolean(cookies.httpOnly()); out.writeBoolean(cookies.hostOnly()); out.writeBoolean(cookies.persistent()); } private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException { String name = (String) in.readObject(); String value = (String) in.readObject(); long expiresAt = in.readLong(); String domain = (String) in.readObject(); String path = (String) in.readObject(); boolean secure = in.readBoolean(); boolean httpOnly = in.readBoolean(); boolean hostOnly = in.readBoolean(); boolean persistent = in.readBoolean(); Cookie.Builder builder = new Cookie.Builder(); builder = builder.name(name); builder = builder.value(value); builder = builder.expiresAt(expiresAt); builder = hostOnly ? builder.hostOnlyDomain(domain) : builder.domain(domain); builder = builder.path(path); builder = secure ? builder.secure() : builder; builder = httpOnly ? builder.httpOnly() : builder; clientCookies =builder.build(); }

}

-自定義CookieManger

實現有一個自定義的CookieManger來管理cookies,實現以K-V結構獲取set,getCookier

public class CookieManger implements CookieJar { public static String APP_PLATFORM = "app-platform"; private static Context mContext; private static PersistentCookieStore cookieStore; public CookieManger(Context context) { mContext = context; if (cookieStore == null ) { cookieStore = new PersistentCookieStore(mContext); } } @Override public void saveFromResponse(HttpUrl url, List<Cookie> cookies) { if (cookies != null && cookies.size() > 0) { for (Cookie item : cookies) { cookieStore.add(url, item); } } } @Override public List<Cookie> loadForRequest(HttpUrl url) { List<Cookie> cookies =cookieStore.get(url); return cookies; } static class Customer { private String userID; private String token; public Customer(String userID, String token) { this.userID = userID; this.token = token; } public String getUserID() { return userID; } public void setUserID(String userID) { this.userID = userID; } public String getToken() { return token; } public void setToken(String token) { this.token = token; } }

- Retrofit加入cookie

OkHttpClient okHttpClient = new OkHttpClient.Builder() .addNetworkInterceptor( new HttpLoggingInterceptor().setLevel(HttpLoggingInterceptor.Level.HEADERS)) .cookieJar(new CookieManger(context)) .addInterceptor(loginInterceptor) .connectTimeout(DEFAULT_TIMEOUT, TimeUnit.SECONDS) .build(); Retrofit retrofit = new Retrofit.Builder() .client(okHttpClient) .build();

總結

實現加入cookies持久，實現免登錄基本步驟

1 實現可序列化的OkHttpcookies

2 實現儲存OkHttpcookies的PersistentCookieStore

3 實現cookies管理工具CookieManger

4 構建OKHttpClient

5 Retrofit加入自定義的okHttpClient

6直接調用RetrofitClient

方式二：

方法一可能對某些網站不兼容，能夠藉助retfoit的攔截器實現

用來加入cookie

public class ReadCookiesInterceptor implements Interceptor { @Override public Response intercept(Chain chain) throws IOException { Request.Builder builder = chain.request().newBuilder(); HashSet<String> preferences = (HashSet) Preferences.getDefaultPreferences().getStringSet(Preferences.PREF_COOKIES, new HashSet<>()); for (String cookie : preferences) { builder.addHeader("Cookie", cookie); Log.v("OkHttp", "Adding Header: " + cookie); // This is done so I know which headers are being added; this interceptor is used after the normal logging of OkHttp } return chain.proceed(builder.build()); }

}

用來保存Cookies

public class SaveCookiesInterceptor implements Interceptor { @Override public Response intercept(Chain chain) throws IOException { Response originalResponse = chain.proceed(chain.request()); if (!originalResponse.headers("Set-Cookie").isEmpty()) { HashSet<String> cookies = new HashSet<>(); for (String header : originalResponse.headers("Set-Cookie")) { cookies.add(header); } Preferences.getDefaultPreferences().edit() .putStringSet(Preferences.PREF_COOKIES, cookies) .apply(); } return originalResponse; }

}

okhttp

OkHttpClient okHttpClient = new OkHttpClient(); okHttpClient.interceptors().add(new ReadCookiesInterceptor()); okHttpClient.interceptors().add(new SaveCookiesInterceptor());

Retrofit

Retrofit retrofit = new Retrofit.Builder() .client(okHttpClient) .build();