android中okhttp與webview的cookie共享
阿新 • • 發佈:2018-12-05
轉載請註明出處:https://blog.csdn.net/u011038298/article/details/84551136
1.在WebView中同步cookie
import android.os.Build; import android.text.TextUtils; import android.webkit.CookieManager; import android.webkit.CookieSyncManager; import android.webkit.WebView; import java.util.ArrayList; import java.util.List; import okhttp3.Cookie; import okhttp3.HttpUrl; public class CookieUtil { private static CookieUtil instance; private PersistentCookieStore mPersistentCookieStore; public static CookieUtil getInstance() { if (instance == null) { instance = new CookieUtil(); } return instance; } private CookieUtil() { mPersistentCookieStore = new PersistentCookieStore(BaseApplication.getInstance()); } /** * 注意事項: * 1.如果需要傳第三方cookie,請呼叫方法setAcceptThirdPartyCookies * 2.如果這裡有多個cookie,不要使用分號手動拼接,請多次呼叫setCookie方法 * 3.請在呼叫loadUrl方法前執行 * * <p> * * @param webView * @param url */ public void syncCookie(WebView webView, String url) { try { if (!TextUtils.isEmpty(url) && url.startsWith("http")) { // 在上下文中建立單個CookieSyncManager CookieSyncManager.createInstance(BaseApplication.getInstance()); // 獲取單例CookieManager例項 CookieManager cookieManager = CookieManager.getInstance(); // 設定應用程式的WebView例項是否應傳送和接受cookie cookieManager.setAcceptCookie(true); if (Build.VERSION.SDK_INT < Build.VERSION_CODES.LOLLIPOP) { // 刪除所有會話cookie cookieManager.removeSessionCookie(); // 此方法在API級別21中已棄用.WebView會自動處理刪除過期的Cookie。 cookieManager.removeExpiredCookie(); // 刪除所有cookie // cookieManager.removeAllCookie(); } else { if (webView != null) { // 設定是否WebView應允許設定第三方cookie cookieManager.setAcceptThirdPartyCookies(webView, true); } // 刪除所有會話cookie cookieManager.removeSessionCookies(null); // 刪除所有cookie // cookieManager.removeAllCookies(null); } List<Cookie> cookies = mPersistentCookieStore.get(HttpUrl.parse(url)); if (Build.VERSION.SDK_INT < Build.VERSION_CODES.LOLLIPOP) { // 設定原生cookie if (cookies != null && cookies.size() > 0) { for (int i = 0; i < cookies.size(); i++) { Cookie cookie = cookies.get(i); cookieManager.setCookie(url, cookie.name() + "=" + cookie.value()); } } // 設定第三方cookie cookieManager.setCookie(url, String.format("這裡填寫cookie的名稱=%s", "這裡填寫cookie的值")); // 確保當前可通過getCookie API訪問的所有cookie都寫入持久儲存 CookieSyncManager.getInstance().sync(); } else { // 設定原生cookie if (cookies != null && cookies.size() > 0) { for (int i = 0; i < cookies.size(); i++) { Cookie cookie = cookies.get(i); cookieManager.setCookie(url, cookie.name() + "=" + cookie.value(), null); } } // 設定第三方cookie cookieManager.setCookie(url, String.format("這裡填寫cookie的名稱=%s", "這裡填寫cookie的值"),null); // 確保當前可通過getCookie API訪問的所有cookie都寫入持久儲存 cookieManager.flush(); } } } catch (Exception e) { } } /** * 新增cookie * 在WebViewClient的onPageFinished函式中呼叫 * * @param url */ public void addCookie(String url) { try { if (!TextUtils.isEmpty(url) && url.startsWith("http")) { String cookies = CookieManager.getInstance().getCookie(url); if (!TextUtils.isEmpty(cookies)) { HttpUrl httpUrl = HttpUrl.parse(url); List<Cookie> list = new ArrayList<>(); list.add(Cookie.parse(httpUrl, cookies)); mPersistentCookieStore.add(httpUrl, list); } } } catch (Exception ex) { } } /** * 刪除所有cookies */ public void removeAllCookies() { try { // 在上下文中建立單個CookieSyncManager CookieSyncManager.createInstance(BaseApplication.getInstance()); // 獲取單例CookieManager例項 CookieManager cookieManager = CookieManager.getInstance(); // 設定應用程式的WebView例項是否應傳送和接受cookie cookieManager.setAcceptCookie(true); if (Build.VERSION.SDK_INT < Build.VERSION_CODES.LOLLIPOP) { // 刪除所有會話cookie cookieManager.removeSessionCookie(); // 此方法在API級別21中已棄用.WebView會自動處理刪除過期的Cookie。 cookieManager.removeExpiredCookie(); // 刪除所有cookie cookieManager.removeAllCookie(); // 確保當前可通過getCookie API訪問的所有cookie都寫入持久儲存 CookieSyncManager.getInstance().sync(); } else { // 刪除所有會話cookie cookieManager.removeSessionCookies(null); // 刪除所有cookie cookieManager.removeAllCookies(null); // 確保當前可通過getCookie API訪問的所有cookie都寫入持久儲存 cookieManager.flush(); } mPersistentCookieStore.removeAll(); } catch (Exception ex) { } } }
2.PersistentCookieStore 類
import android.content.Context; import android.content.SharedPreferences; import android.text.TextUtils; import java.io.ByteArrayInputStream; import java.io.ByteArrayOutputStream; import java.io.IOException; import java.io.ObjectInputStream; import java.io.ObjectOutputStream; import java.util.ArrayList; import java.util.Collection; import java.util.HashMap; import java.util.List; import java.util.Locale; import java.util.Map; import java.util.concurrent.ConcurrentHashMap; import okhttp3.Cookie; import okhttp3.HttpUrl; public class PersistentCookieStore implements CookieStore { private static final String COOKIE_NAME_PREFIX = "cookie_"; private static final String COOKIE_PREFS = "CookiePrefsProjectName"; private final SharedPreferences cookiePrefs; private final HashMap<String, ConcurrentHashMap<String, Cookie>> cookies; /** * Construct a persistent cookie store. * * @param context Context to attach cookie store to */ public PersistentCookieStore(Context context) { cookiePrefs = context.getSharedPreferences(COOKIE_PREFS, 0); cookies = new HashMap<String, ConcurrentHashMap<String, Cookie>>(); // Load any previously stored cookies into the store Map<String, ?> prefsMap = cookiePrefs.getAll(); for (Map.Entry<String, ?> entry : prefsMap.entrySet()) { if ((entry.getValue()) != null && !((String) entry.getValue()).startsWith(COOKIE_NAME_PREFIX)) { String[] cookieNames = TextUtils.split((String) entry.getValue(), ","); for (String name : cookieNames) { String encodedCookie = cookiePrefs.getString(COOKIE_NAME_PREFIX + 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); } } } } } } private static boolean isCookieExpired(Cookie cookie) { return cookie.expiresAt() < System.currentTimeMillis(); } protected void add(HttpUrl uri, Cookie cookie) { String name = getCookieToken(cookie); boolean hasExpired = cookie.persistent() ? isCookieExpired(cookie) : false; if (!hasExpired) { if (!cookies.containsKey(uri.host())) { cookies.put(uri.host(), new ConcurrentHashMap<String, Cookie>()); } cookies.get(uri.host()).put(name, cookie); } else { if (cookies.containsKey(uri.host())) { cookies.get(uri.host()).remove(name); } else { return; } } // Save cookie into persistent store SharedPreferences.Editor prefsWriter = cookiePrefs.edit(); prefsWriter.putString(uri.host(), TextUtils.join(",", cookies.get(uri.host()).keySet())); prefsWriter.putString(COOKIE_NAME_PREFIX + name, encodeCookie(new SerializableHttpCookie(cookie))); prefsWriter.apply(); } protected String getCookieToken(Cookie cookie) { return cookie.name() + cookie.domain(); } @Override public void add(HttpUrl uri, List<Cookie> cookies) { for (Cookie cookie : cookies) { add(uri, cookie); } } @Override public List<Cookie> get(HttpUrl uri) { ArrayList<Cookie> ret = new ArrayList<Cookie>(); for (Map.Entry<String, ConcurrentHashMap<String, Cookie>> entry : cookies.entrySet()) { Collection<Cookie> cookies = this.cookies.get(entry.getKey()).values(); for (Cookie cookie : cookies) { if (cookie.matches(uri)) { if (isCookieExpired(cookie)) { remove(uri, cookie); } else { ret.add(cookie); } } } } return ret; } @Override public boolean removeAll() { SharedPreferences.Editor prefsWriter = cookiePrefs.edit(); prefsWriter.clear(); prefsWriter.apply(); cookies.clear(); return true; } @Override public boolean remove(HttpUrl uri, Cookie cookie) { String name = getCookieToken(cookie); if (cookies.containsKey(uri.host()) && cookies.get(uri.host()).containsKey(name)) { cookies.get(uri.host()).remove(name); SharedPreferences.Editor prefsWriter = cookiePrefs.edit(); if (cookiePrefs.contains(COOKIE_NAME_PREFIX + name)) { prefsWriter.remove(COOKIE_NAME_PREFIX + name); } prefsWriter.putString(uri.host(), TextUtils.join(",", cookies.get(uri.host()).keySet())); prefsWriter.apply(); return true; } else { return false; } } protected String encodeCookie(SerializableHttpCookie cookie) { if (cookie == null) return null; ByteArrayOutputStream os = new ByteArrayOutputStream(); try { ObjectOutputStream outputStream = new ObjectOutputStream(os); outputStream.writeObject(cookie); } catch (IOException e) { return null; } return byteArrayToHexString(os.toByteArray()); } protected Cookie decodeCookie(String cookieString) { byte[] bytes = hexStringToByteArray(cookieString); ByteArrayInputStream byteArrayInputStream = new ByteArrayInputStream(bytes); Cookie cookie = null; try { ObjectInputStream objectInputStream = new ObjectInputStream(byteArrayInputStream); cookie = ((SerializableHttpCookie) objectInputStream.readObject()).getCookie(); } catch (IOException e) { } catch (ClassNotFoundException e) { } return cookie; } /** * Using some super basic byte array <-> hex conversions so we don't have to rely on any * large Base64 libraries. Can be overridden if you like! * * @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); } /** * Converts hex values from strings to byte arra * * @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; } }
3.SerializableHttpCookie類
import java.io.IOException; import java.io.ObjectInputStream; import java.io.ObjectOutputStream; import java.io.Serializable; import okhttp3.Cookie; public class SerializableHttpCookie implements Serializable { private transient final Cookie cookie; private transient Cookie clientCookie; public SerializableHttpCookie(Cookie cookie) { this.cookie = cookie; } public Cookie getCookie() { Cookie bestCookie = cookie; if (clientCookie != null) { bestCookie = clientCookie; } return bestCookie; } private void writeObject(ObjectOutputStream out) throws IOException { out.writeObject(cookie.name()); out.writeObject(cookie.value()); out.writeLong(cookie.expiresAt()); out.writeObject(cookie.domain()); out.writeObject(cookie.path()); out.writeBoolean(cookie.secure()); out.writeBoolean(cookie.httpOnly()); out.writeBoolean(cookie.hostOnly()); out.writeBoolean(cookie.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; clientCookie = builder.build(); } }
4.okHttp中cookie的實現
OkHttpClient.Builder builder = new OkHttpClient.Builder();
CookieJarImpl cookieJarImpl = new CookieJarImpl(new PersistentCookieStore(context));
builder.cookieJar(cookieJarImpl);
OkHttpClient okHttpClient = builder.build();
5. CookieJarImpl的實現
import java.util.List;
import okhttp3.Cookie;
import okhttp3.CookieJar;
import okhttp3.HttpUrl;
public class CookieJarImpl implements CookieJar {
private CookieStore cookieStore;
public CookieJarImpl(CookieStore cookieStore) {
if (cookieStore == null) new IllegalArgumentException("cookieStore can not be null.");
this.cookieStore = cookieStore;
}
/**
* 服務端給客戶端傳送Cookie時呼叫
*
* @param url
* @param cookies
*/
@Override
public synchronized void saveFromResponse(HttpUrl url, List<Cookie> cookies) {
cookieStore.add(url, cookies);
}
/**
* 當訪問到某個域名時,會通過此方法獲取儲存的Cookie,並且傳送給伺服器
*
* @param url
* @return
*/
@Override
public synchronized List<Cookie> loadForRequest(HttpUrl url) {
return cookieStore.get(url);
}
}
6.CookieStore介面
import java.util.List;
import okhttp3.Cookie;
import okhttp3.HttpUrl;
public interface CookieStore {
void add(HttpUrl uri, List<Cookie> cookie);
List<Cookie> get(HttpUrl uri);
boolean remove(HttpUrl uri, Cookie cookie);
boolean removeAll();
}
okHttp依賴配置(app/build.gradle)
implementation 'com.squareup.okio:okio:1.14.0'
implementation 'com.squareup.okhttp3:okhttp:3.11.0'