Android H5 交互Cookie 同步登录状态
其实这个使用场景还是蛮频繁的。原生和H5交互需要登录信息等等内容。都可以通过Cookie 还同步。
这篇文章呢也是对:Android 抛弃原生WebView,使用腾讯X5内核、并加入广告拦截。这篇文章的补充。
当时呢,主要是讲腾讯X5的使用,也提了一下cookie的同步,因为没有说的太详细。个别网友也有反馈。
这里就详细描述一下如何同步Cookie的整个流程。
下面也是直接贴代码了。网络请求大多数人应该是用的OkHttp的吧。
一下就按这个举例了:看代码吧
第一步:实现OkHttp 网络请求,加入持久化管理Cookie的代码
第二步:将PersistentCookieStore自动保存的Cookie获取出来同步
第三步:在代码中去使用
//同步操作需要在webView.loadUrl 之前同步。否则可能会无效
CookieUtilsKt.INSTANCE.syncCookie(this,"需要加载的连接");
WebView webView = new WebView(this);
webView.loadUrl("需要加载的连接");
这样就完成啦!下面吧代码全部贴出来提供参考了
OkHttpUtilsKt
object OkHttpUtilsKt {
val HTTP_READ_TIMEOUT = 10000L// HTTP读取超时时间
val HTTP_CONNECT_TIMEOUT = 10000L// HTTP连接超时时间
val HTTP_MAX_CONNECT_COUNT = 10 // HTTP最大连接数
val HTTP_KEEP_ALIVE_CONNECT_COUNT = 5L // HTTP保持KeepAlive的连接数
val HTTP_MAX_CACHE_SIZE = 10 * 1024 * 1024 //缓存大小10M
val HTTP_CACHE_TEMP_PATH = "temp/cache/" //网络请求临时缓存储存路径
private var mOkHttpClient: OkHttpClient? = null
fun getOkHttpClient() :OkHttpClient? {
if (mOkHttpClient == null){
synchronized(this){
if (mOkHttpClient == null){
mOkHttpClient = getInitOkHttp()
.build()
}
}
}
return mOkHttpClient;
}
/**
* 初始OkHttp网络请求
* master
* @return OkHttpClient
*/
fun getInitOkHttp() : OkHttpClient.Builder {
//设置缓存
//设置缓存文件大小
return OkHttpClient.Builder()
.cache(okhttp3.Cache(File(BaseApplication.getContext()!!.cacheDir,
HTTP_CACHE_TEMP_PATH), HTTP_MAX_CACHE_SIZE.toLong()))
//设置持久化管理Cookie类
.cookieJar(JavaNetCookieJar(CookieManager(PersistentCookieStore.getInstance(BaseApplication.getContext()), CookiePolicy.ACCEPT_ALL)))
.connectTimeout(HTTP_CONNECT_TIMEOUT, TimeUnit.MILLISECONDS)
.readTimeout(HTTP_READ_TIMEOUT, TimeUnit.MILLISECONDS)
.connectionPool(ConnectionPool(HTTP_MAX_CONNECT_COUNT,HTTP_KEEP_ALIVE_CONNECT_COUNT,
TimeUnit.MILLISECONDS))
.addNetworkInterceptor(HttpLoggingInterceptor(HttpLoggingInterceptor.Logger {
//再控制台数据网络请求数据
message: String? -> Log.e("okHttp",message)
}).setLevel(HttpLoggingInterceptor.Level.BODY))
.proxy(Proxy.NO_PROXY);
}
}
CookieUtilsKt
object CookieUtilsKt {
/**
* 同步Cookie
*
* @param context
* @param url
*/
fun syncCookie(context: Context,url : String){
val cookieManager = CookieManager.getInstance()
cookieManager.setAcceptCookie(true)
val httpCookieMap = PersistentCookieStore.getInstance(context).cookies
for ( httpCookie in httpCookieMap){
cookieManager.setCookie(httpCookie.domain,httpCookie.toString())
}
/**
* 如果需要另外特别的cookie参数同步给H5的话 如下:
* 等于号是固定的
* cookieManager.setCookie(url,"key=value")
* 例如我想同步一个参数名(key)叫,size ,值(value)为 1,那么写法如下
* cookieManager.setCookie(url,"size=1")
*/
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.LOLLIPOP){
CookieManager.getInstance().flush()
}else{
CookieSyncManager.createInstance(context)
CookieSyncManager.getInstance().sync();
}
}
/**
* 清除WebView 缓存以及Cookie
*
* @param context
* @param webView
*/
fun clearWebViewCache(context: Context,webView: WebView){
clearCookie(context)
webView.webChromeClient = null
webView.webViewClient = null
webView.settings.javaScriptEnabled = false
webView.clearCache(true)
}
/**
* 清除Cookie
*
* @param context
*/
fun clearCookie(context: Context){
CookieSyncManager.createInstance(context);
val cookieManager = CookieManager.getInstance();
cookieManager.removeAllCookie()
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.LOLLIPOP){
CookieManager.getInstance().flush()
}else{
CookieSyncManager.createInstance(context)
CookieSyncManager.getInstance().sync()
}
}
/*---------------------------如果是没有用腾讯X5WebView,以下方法可以不关注--------------------------------*/
/**
* 同步X5Cookie
*
* @param context
* @param url
*/
fun syncX5Cookie(context: Context,url : String){
val cookieManager = com.tencent.smtt.sdk.CookieManager.getInstance()
cookieManager.setAcceptCookie(true)
val httpCookieMap = PersistentCookieStore.getInstance(context).cookies
for ( httpCookie in httpCookieMap){
cookieManager.setCookie(httpCookie.domain,httpCookie.toString())
}
/**
* 如果需要另外特别的cookie参数同步给H5的话 如下:
* 等于号是固定的
* cookieManager.setCookie(url,"key=value")
* 例如我想同步一个参数名(key)叫,size ,值(value)为 1,那么写法如下
* cookieManager.setCookie(url,"size=1")
*/
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.LOLLIPOP){
com.tencent.smtt.sdk.CookieManager.getInstance().flush()
}else{
com.tencent.smtt.sdk.CookieSyncManager.createInstance(context)
com.tencent.smtt.sdk.CookieSyncManager.getInstance().sync();
}
}
/**
* 清除X5WebView 缓存以及Cookie
*
* @param context
* @param webView
*/
fun clearX5WebViewCache(context: Context,webView: com.tencent.smtt.sdk.WebView){
clearCookie(context)
webView.clearCache(true)
webView.webChromeClient = null
webView.webViewClient = null
webView.settings.javaScriptEnabled = false
}
/**
* 清除X5Cookie
*
* @param context
*/
fun clearX5Cookie(context: Context){
com.tencent.smtt.sdk.CookieSyncManager.createInstance(context);
val cookieManager = com.tencent.smtt.sdk.CookieManager.getInstance();
cookieManager.removeAllCookie()
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.LOLLIPOP){
com.tencent.smtt.sdk.CookieManager.getInstance().flush()
}else{
com.tencent.smtt.sdk.CookieSyncManager.createInstance(context)
com.tencent.smtt.sdk.CookieSyncManager.getInstance().sync()
}
}
}
PersistentCookieStore
/**
* A persistent cookie store which implements the Apache HttpClient CookieStore interface.
* Cookies are stored and will persist on the user's device between application sessions since they
* are serialized and stored in SharedPreferences. Instances of this class are
* designed to be used with AsyncHttpClient#setCookieStore, but can also be used with a
* regular old apache HttpClient/HttpContext if you prefer.
*/
public class PersistentCookieStore implements CookieStore {
private static PersistentCookieStore persistentCookieStore;
private static final String LOG_TAG = "PersistentCookieStore";
private static final String COOKIE_PREFS = "CookiePrefsFile";
private static final String COOKIE_NAME_PREFIX = "cookie_";
private final HashMap<String, ConcurrentHashMap<String, HttpCookie>> cookies;
private final SharedPreferences cookiePrefs;
public static PersistentCookieStore getInstance(Context context){
if (persistentCookieStore == null){
synchronized (PersistentCookieStore.class){
if (persistentCookieStore == null){
persistentCookieStore = new PersistentCookieStore(context);
}
}
}
return persistentCookieStore;
}
/**
* 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, HttpCookie>>();
// Load any previously stored cookies into the store
Map<String, ?> prefsMap = cookiePrefs.getAll();
for(Map.Entry<String, ?> entry : prefsMap.entrySet()) {
if (((String)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) {
HttpCookie decodedCookie = decodeCookie(encodedCookie);
if (decodedCookie != null) {
if(!cookies.containsKey(entry.getKey()))
cookies.put(entry.getKey(), new ConcurrentHashMap<String, HttpCookie>());
cookies.get(entry.getKey()).put(name, decodedCookie);
}
}
}
}
}
}
@Override
public void add(URI uri, HttpCookie cookie) {
String name = getCookieToken(uri, cookie);
// Save cookie into local store, or remove if expired
if (!cookie.hasExpired()) {
if(!cookies.containsKey(uri.getHost()))
cookies.put(uri.getHost(), new ConcurrentHashMap<String, HttpCookie>());
cookies.get(uri.getHost()).put(name, cookie);
} else {
if(cookies.containsKey(uri.toString()))
cookies.get(uri.getHost()).remove(name);
}
// Save cookie into persistent store
SharedPreferences.Editor prefsWriter = cookiePrefs.edit();
prefsWriter.putString(uri.getHost(), TextUtils.join(",", cookies.get(uri.getHost()).keySet()));
prefsWriter.putString(COOKIE_NAME_PREFIX + name, encodeCookie(new SerializableHttpCookie(cookie)));
prefsWriter.commit();
}
protected String getCookieToken(URI uri, HttpCookie cookie) {
return cookie.getName() + cookie.getDomain();
}
@Override
public List<HttpCookie> get(URI uri) {
ArrayList<HttpCookie> ret = new ArrayList<HttpCookie>();
if(cookies.containsKey(uri.getHost()))
ret.addAll(cookies.get(uri.getHost()).values());
return ret;
}
@Override
public boolean removeAll() {
SharedPreferences.Editor prefsWriter = cookiePrefs.edit();
prefsWriter.clear();
prefsWriter.commit();
cookies.clear();
return true;
}
@Override
public boolean remove(URI uri, HttpCookie cookie) {
String name = getCookieToken(uri, cookie);
if(cookies.containsKey(uri.getHost()) && cookies.get(uri.getHost()).containsKey(name)) {
cookies.get(uri.getHost()).remove(name);
SharedPreferences.Editor prefsWriter = cookiePrefs.edit();
if(cookiePrefs.contains(COOKIE_NAME_PREFIX + name)) {
prefsWriter.remove(COOKIE_NAME_PREFIX + name);
}
prefsWriter.putString(uri.getHost(), TextUtils.join(",", cookies.get(uri.getHost()).keySet()));
prefsWriter.commit();
return true;
} else {
return false;
}
}
@Override
public List<HttpCookie> getCookies() {
ArrayList<HttpCookie> ret = new ArrayList<HttpCookie>();
for (String key : cookies.keySet())
ret.addAll(cookies.get(key).values());
return ret;
}
@Override
public List<URI> getURIs() {
ArrayList<URI> ret = new ArrayList<URI>();
for (String key : cookies.keySet())
try {
ret.add(new URI(key));
} catch (URISyntaxException e) {
e.printStackTrace();
}
return ret;
}
/**
* Serializes Cookie object into String
*
* @param cookie cookie to be encoded, can be null
* @return cookie encoded as String
*/
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) {
Log.d(LOG_TAG, "IOException in encodeCookie", e);
return null;
}
return byteArrayToHexString(os.toByteArray());
}
/**
* Returns cookie decoded from cookie string
*
* @param cookieString string of cookie as returned from http request
* @return decoded cookie or null if exception occured
*/
protected HttpCookie decodeCookie(String cookieString) {
byte[] bytes = hexStringToByteArray(cookieString);
ByteArrayInputStream byteArrayInputStream = new ByteArrayInputStream(bytes);
HttpCookie cookie = null;
try {
ObjectInputStream objectInputStream = new ObjectInputStream(byteArrayInputStream);
cookie = ((SerializableHttpCookie) objectInputStream.readObject()).getCookie();
} catch (IOException e) {
Log.d(LOG_TAG, "IOException in decodeCookie", e);
} catch (ClassNotFoundException e) {
Log.d(LOG_TAG, "ClassNotFoundException in decodeCookie", 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;
}
}
SerializableHttpCookie
public class SerializableHttpCookie implements Serializable {
private static final long serialVersionUID = 6374381323722046732L;
private transient final HttpCookie cookie;
private transient HttpCookie clientCookie;
public SerializableHttpCookie(HttpCookie cookie) {
this.cookie = cookie;
}
public HttpCookie getCookie() {
HttpCookie bestCookie = cookie;
if (clientCookie != null) {
bestCookie = clientCookie;
}
return bestCookie;
}
private void writeObject(ObjectOutputStream out) throws IOException {
out.writeObject(cookie.getName());
out.writeObject(cookie.getValue());
out.writeObject(cookie.getComment());
out.writeObject(cookie.getCommentURL());
out.writeObject(cookie.getDomain());
out.writeLong(cookie.getMaxAge());
out.writeObject(cookie.getPath());
out.writeObject(cookie.getPortlist());
out.writeInt(cookie.getVersion());
out.writeBoolean(cookie.getSecure());
out.writeBoolean(cookie.getDiscard());
}
private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException {
String name = (String) in.readObject();
String value = (String) in.readObject();
clientCookie = new HttpCookie(name, value);
clientCookie.setComment((String) in.readObject());
clientCookie.setCommentURL((String) in.readObject());
clientCookie.setDomain((String) in.readObject());
clientCookie.setMaxAge(in.readLong());
clientCookie.setPath((String) in.readObject());
clientCookie.setPortlist((String) in.readObject());
clientCookie.setVersion(in.readInt());
clientCookie.setSecure(in.readBoolean());
clientCookie.setDiscard(in.readBoolean());
}
}