android Okhttp和OkHttp3持久化cookie

最新推荐文章于 2021-12-03 18:38:09 发布
最新推荐文章于 2021-12-03 18:38:09 发布
阅读量3.6k 收藏 2
点赞数 1
分类专栏： android开发 文章标签： android cookie 持久化
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/lmq121210/article/details/77006184
版权

对于Okhttp和Okhttp3分别有两种方法持久化cookie

Okhttp持久化

我们可以CookieManager来持久化，我们需要手动创建PersistentCookieStore类实现CookieStore接口，如下：

package com.app.test.brigdeproject.cookiemanage;
import android.content.Context;
import android.content.SharedPreferences;
import android.text.TextUtils;
import android.util.Log;

import java.io.*;
import java.net.CookieStore;
import java.net.HttpCookie;
import java.net.URI;
import java.net.URISyntaxException;
import java.util.*;
import java.util.concurrent.ConcurrentHashMap;

/**
 * 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.
 */
/**
 * Created by ${liumengqiang} on 2017/8/9.
 */
public class PersistentCookieStore implements CookieStore {

    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;

    /**
     * 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 &lt;-&gt; 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实现序列化接口：

package com.app.test.brigdeproject.cookiemanage;

/**
 * Created by ${liumengqiang} on 2017/8/9.
 */
import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.io.Serializable;
import java.net.HttpCookie;

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());
    }
}

此时只要在代码中调用即可：

 okHttpClient.setCookieHandler(new CookieManager(
                new PersistentCookieStore(context), CookiePolicy.ACCEPT_ALL));

Okhttp3持久化

对于OKhttp3封装的都很好了 ，首先在app gradle中添加如下代码：

    compile 'com.github.franmontiel:PersistentCookieJar:v1.0.1'

如果添加库失败的话，可以在你的工程build中添加如下代码：

allprojects {
    repositories {
        jcenter()
        maven { url "https://jitpack.io" }
    }
}

然后 我们：

PersistentCookieJar cookieJar = new PersistentCookieJar(new SetCookieCache(), new                             SharedPrefsCookiePersistor(getApplicationContext()));

然后cookieJar

OkHttpClient okHttpClient = new OkHttpClient.Builder()
                .cookieJar(cookieJar)
                .build();

可以看到 ， 这个第三方自动帮我们保存了cookies，如果我们想获取，通过SharedPrefsCookiePersistor类的loadAll方法即可获取cookies。

Okhttp和Okhttp3通用持久化方法

对于这一种方法 ，实际上就是添加拦截器，创建一个类实现Interceptor接口，该方法我们可以获取自动保存cookies，并且给head设置cookies，自由度较大。比如下代码：

package com.app.test.brigdeproject.intercptor;

import com.squareup.okhttp.Interceptor;
import com.squareup.okhttp.Response;

import java.io.IOException;
import java.util.HashSet;
import java.util.List;

/**
 * This Interceptor add all received Cookies to the app DefaultPreferences.
 * Your implementation on how to save the Cookies on the Preferences MAY VARY.
 * 
 * Created by ${liumengqiang} on 2017/8/8.
 */

public class ReceivedCookiesInterceptor implements Interceptor {
    @Override
    public Response intercept(Chain chain) throws IOException {
        Response originalResponse = chain.proceed(chain.request());
        List<String> cookieList =  originalResponse.headers("Set-Cookie");
        if(cookieList != null) {
            for(String s:cookieList) {//Cookie的格式为:cookieName=cookieValue;path=xxx
                //保存你需要的cookie数据
            }
        }

        return originalResponse;
    }
}

欢迎各位小伙伴指正。

以下文章借鉴：
http://blog.csdn.net/lyhhj/article/details/51345386#reply
http://blog.csdn.net/lyhhj/article/details/51345386
http://www.cnblogs.com/zhujiabin/p/6207913.html
http://blog.csdn.net/qq_32583189/article/details/53819286

Android入门——OkHttp3之Cookies管理及持久化
Coding_Beginner的博客
02-14 1500
持久化管理cookie的几种方法： （一）特简单！直接使用PersistentCookieJar开源库：https://github.com/franmontiel/PersistentCookieJar 1. 配置 （1）在 project 的 gradle 中添加 JitPack 存储库： maven { url "https://jitpack.io" } allproje...
Okhttp cookie获取、持久化存储、设置到webview（腾讯tbs浏览器）
qq_38881740的博客
11-01 1375
Okhttp cookie获取、持久化存储、设置到webview（腾讯tbs浏览器） 1、Okhttp获取cookie 其实okhttp提供了cookie管理的接口CookieJar，我们只需要继承CookieJar即可 每次okhttp发起请求都会调用：加载saveFromResponse方法，将cookie放、返回给我们；每次请求返回是都会调用loadForRequest方法，我们将自己保存的cookie带入即可； //保存cookie @Override public void saveF
okhttp请求简单封装和cookie管理
03-31
eclipse平台的，一个okhttp请求简单封装和cookie管理，比较简便好理解，可以立即使用
okhttp3与旧版本okhttp的区别分析
热门推荐
robert的专栏
05-06 1万+
OkHttp的基本使用 HTTP GET OkHttpClient client = new OkHttpClient(); String doGet(String url) throws IOException {   Request request = new Request.Builder().url(url).build();   Response response = cl
Android中OKHttp保存Cookie并传入WebView
It's just a matter of time.
01-14 8017
Cookie是服务器为客户端分配的一个键值对的表，和session不同的是cookie存储在客户端。服务器通过Response.addCookie()为客户端添加Cookie数据，再从Request.getCookie()中获取数据。 在Android开发中，有时我们需要调用http的接口登录帐号，然后使用cookie作为登录标记来进行网页浏览。此时就需要从http请求中取到cookie数据并保存起来，在使用webView进行页面访问时再将cookie数据设置到webview上。本文以OKH
使用OKHttp模拟登陆知乎，兼谈OKHttp中Cookie的使用！
weixin_30265103的博客
08-09 436
本文主要是想和大家探讨技术，让大家学会Cookie的使用，切勿做违法之事！很多Android初学者在刚开始学习的时候，或多或少都想自己搞个应用出来，把自己学的十八般武艺全都用在这个APP上，其实这个想法很好，项目驱动学习，效率更高，这是大学老师教给我的。可是一个APP，如果纯粹搞成一个本地应用，会变得很没有意思，所以我们一般还是做网络应用，网络应用涉及到网络服务器的搭建，数据的采集等等太过于耗...
okhttp cookie
abc81163788的博客
11-24 216
package cn.x.request; import java.util.ArrayList; import java.util.HashMap; import java.util.List; import okhttp3.Call; import okhttp3.Cookie; import okhttp3.CookieJar; import okhttp3.HttpUrl; import okhttp3.OkHttpClient; import okhttp3.Request; import o
android-cookie-store：用于HttpURLConnection和OkHttp的Android InMemory和持久性Cookie存储，具有易于在Android WebViews中同步cookie的扩展
02-03
源代码将展示如何实现内存和持久化Cookie存储，以及如何与WebView进行交互。示例代码可能包括如何在实际项目中集成和使用这个库的步骤。文档部分可能包含API参考、使用指南和常见问题解答，帮助开发者更好地理解和...
OkHttp3中默认不保持Cookie的解决方法
08-27
在OkHttp3中，默认的`CookieJar`实现并不会自动处理Cookie的保存和加载。因此，为了保持Cookie，我们需要创建一个自定义的`CookieJar`并实现两个关键方法： 1. `saveFromResponse(HttpUrl url, List<Cookie> ...
Android使用OkHttp携带Cookie请求数据,并对Cookie进行持久化管理
圣西罗的红与黑
06-30 2890
1.在Application中初始化okhttp. OkHttpUtil.initOkHttp(this); 2.设置cookieJar参数 public static void initOkHttp(Context context) { okHttpClient = new OkHttpClient.Builder() .connectTimeo
okhttp3 和 okhttp2 jar
01-06
包含 okhttp-3.4.1.jar和okio-1.9.0.jar 以及 okhttp-2.7.5.jar和okio-1.7.0.jar 用于okhttp开发使用
安卓开发之OkHttp持久化Cookie
niulinbiao的博客
09-17 844
文章预览前言一、OkHttp持久化Cookie分析二、例子2.1、效果 前言 OkHttp持久化Cookie使用的是OkHttp3–CookieJar 持久化Cookie 参考文章 https://www.jianshu.com/p/f1df12ceaedc https://www.jianshu.com/p/1a222a9394ce okhttp3依赖： implementation("com.squareup.okhttp3:okhttp:4.9.0") 添加网络权限 <uses-permiss
Android okhttp cookie持久化方法
ai-exception的博客
09-03 1621
cookie的作用 当app需要保持用户登陆状态等，这个时候我们通常就要进行对cookie的管理来实现。如果你使用的是okhttp网络请求，那么就可以直接对cookie进行持久化管理。 使用okhttp3进行cookie的持久化处理 主要原理是使用okhttp3中新增的Cookiejar这个接口，通过这个接口我们可以直接进行cookie的持久化管理，代码如下： 首先实现cookieJ...
okhttp请求使用cookie
skh2015java的博客
12-03 2181
okhttp使用cookie
android okhttp3 okio,OkHttp和Okio
weixin_30638387的博客
05-28 756
OkHttp和Okio文本将介绍OkHttp和Okio基本使用OkHttpHTTP 是现在APP访问网络最流行的方式。通过它我们可以交换数据和媒体信息。而高效的使用HTTP可以让你的加载数据更快并且节省带宽。OkHttp就是一种HTTP客户端连接，它有如下特性：HTTP/2多路复用Socket到同一个主机，共享链接。采用连接池技术，可以有效的减少Http链接数量。无缝集成GZIP压缩技术。支持Re...
Okhttp的cookie和拦截器
hanshengjian的专栏
09-11 799
在okhttp中应用cookie十分简单。只需要重写cookiejar即可。 OkHttpClient okHttpClient = new OkHttpClient.Builder() .addInterceptor(hostSelectionInterceptor) .cookieJar(new CookieJar() { ...
使用OkHttp调用接口,并获取Cookie和设置Cookie
huarenguo的博客
08-23 9791
直接上代码 @RequestMapping("/login") public R login(){ //请求路径 String url=""; OkHttpClient client = new OkHttpClient(); String anString = ""; String cookie = null; //组装键值，params为键值，name为属性名 Reques
OkHttp 自带cookie
weixin_51022898的博客
07-15 848
okhttp3带cookie请求 Request经常都要携带Cookie，上面说过request创建时可以通过header设置参数，Cookie也是参数之一。就像下面这样： Request request = new Request.Builder() .url(url) .header(“Cookie”, “xxx”) .build(); 然后可以从返回的response里得到新的Cookie，你可能得想办法把Cookie保存起来。 但是OkHttp可以不用我们管理Cookie，自动携带，保存和更新Coo
okhttp与cookie
qq_31860607的博客
09-06 373
http://blog.csdn.net/fangaoxin/article/details/6952954/ http://www.jianshu.com/p/ba5eab576cf7
Android模拟登录保存Cookie的持久化方法详解
4. **保存cookie**：使用SharedPreferences或者SQLite数据库等Android提供的持久化存储机制，将cookie的名称、值和过期时间等信息存储起来。 5. **下次请求时使用cookie**：在下一次需要登录态的请求中，设置...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值