使用 HTTPUrlConnection 时如何保留 cookie？

Posted 2023-02-22

【中文标题】使用 HTTPUrlConnection 时如何保留 cookie？

【英文标题】：How do I persist cookies when using HTTPUrlConnection?

【发布时间】：2012-09-03 04:14:24

【问题描述】：

我已经开始使用推荐的HTTPUrlConnection 并远离DefaultHTTPClient。我无法重新组合在一起的一件事是使用持久性 cookie 存储。我想简单地将自定义 cookie 处理程序/管理器附加到我的连接以存储 cookie。 android 文档并不是很有帮助，因为它将关于 cookie 的主题包含在两行中。

我之前一直在使用 LoopJ 的 PersistentCookieStore，效果很好。

知道如何在 Android 中设置持久性 cookie 存储，并将其附加到我的 HTTPUrlConnection 以自动保存和检索 cookie？

谢谢

【参考方案1】：

我花了几个小时，但我设法自己构建了一个自定义 cookie 存储。

您必须这样做：

public class application extends Application 
    @Override
    public void onCreate() 
        super.onCreate();
       CookieManager cmrCookieMan = new CookieManager(new MyCookieStore(this.objContext), CookiePolicy.ACCEPT_ALL);
       CookieHandler.setDefault(cmrCookieMan);
       
    

这是实际的存储空间：

/*
 * This is a custom cookie storage for the application. This
 * will store all the cookies to the shared preferences so that it persists
 * across application restarts.
 */
class MyCookieStore implements CookieStore 

    /*
     * The memory storage of the cookies
     */
    private Map<URI, List<HttpCookie>> mapCookies = new HashMap<URI, List<HttpCookie>>();
    /*
     * The instance of the shared preferences
     */
    private final SharedPreferences spePreferences;

    /*
     * @see java.net.CookieStore#add(java.net.URI, java.net.HttpCookie)
     */
    public void add(URI uri, HttpCookie cookie) 

        System.out.println("add");
        System.out.println(cookie.toString());

        List<HttpCookie> cookies = mapCookies.get(uri);
        if (cookies == null) 
            cookies = new ArrayList<HttpCookie>();
            mapCookies.put(uri, cookies);
        
        cookies.add(cookie);

        Editor ediWriter = spePreferences.edit();
        HashSet<String> setCookies = new HashSet<String>();
        setCookies.add(cookie.toString());
        ediWriter.putStringSet(uri.toString(), spePreferences.getStringSet(uri.toString(), setCookies));
        ediWriter.commit();

    

   /*
    * Constructor
    * 
    * @param  ctxContext the context of the Activity
    */
    @SuppressWarnings("unchecked")
    public MyCookieStore(Context ctxContext) 

        spePreferences = ctxContext.getSharedPreferences("CookiePrefsFile", 0);
        Map<String, ?> prefsMap = spePreferences.getAll();

        for(Map.Entry<String, ?> entry : prefsMap.entrySet()) 

            for (String strCookie : (HashSet<String>) entry.getValue()) 

                if (!mapCookies.containsKey(entry.getKey())) 

                    List<HttpCookie> lstCookies = new ArrayList<HttpCookie>();
                    lstCookies.addAll(HttpCookie.parse(strCookie));

                    try 

                        mapCookies.put(new URI(entry.getKey()), lstCookies);

                     catch (URISyntaxException e) 

                        e.printStackTrace();

                    

                 else 

                    List<HttpCookie> lstCookies = mapCookies.get(entry.getKey());
                    lstCookies.addAll(HttpCookie.parse(strCookie));

                    try 

                        mapCookies.put(new URI(entry.getKey()), lstCookies);

                     catch (URISyntaxException e) 

                        e.printStackTrace();

                    

                

                System.out.println(entry.getKey() + ": " + strCookie);

            

        

    

    /*
     * @see java.net.CookieStore#get(java.net.URI)
     */
    public List<HttpCookie> get(URI uri) 

        List<HttpCookie> lstCookies = mapCookies.get(uri);

        if (lstCookies == null)
            mapCookies.put(uri, new ArrayList<HttpCookie>());

        return mapCookies.get(uri);

    

    /*
     * @see java.net.CookieStore#removeAll()
     */
    public boolean removeAll() 

        mapCookies.clear();
        return true;

            

    /*
     * @see java.net.CookieStore#getCookies()
     */
    public List<HttpCookie> getCookies() 

        Collection<List<HttpCookie>> values = mapCookies.values();

        List<HttpCookie> result = new ArrayList<HttpCookie>();
        for (List<HttpCookie> value : values)                 
            result.addAll(value);                
        

        return result;

    

    /*
     * @see java.net.CookieStore#getURIs()
     */
    public List<URI> getURIs() 

        Set<URI> keys = mapCookies.keySet();
        return new ArrayList<URI>(keys);

    

    /*
     * @see java.net.CookieStore#remove(java.net.URI, java.net.HttpCookie)
     */
    public boolean remove(URI uri, HttpCookie cookie) 

        List<HttpCookie> lstCookies = mapCookies.get(uri);

        if (lstCookies == null)
            return false;

        return lstCookies.remove(cookie);

    

【讨论】：

这还没有经过彻底的测试，但我会随着我的进展进行编辑。请提出改进​​建议。

有时我想知道我是否疯狂地期待像持久性 cookie 这样基本的东西被包含在 SDK 中......如果我能提出任何改进建议，我一定会回帖。

通过这个实现，它会将 cookie 添加到它们来自的确切 URI，这意味着它们不会被发送到该主机上的任何其他 URI。我建议将传递的 URI 替换为仅包含主机名的新 URI，以使其行为符合预期。例如：在当前的实现中，如果您访问 yourdomain.com/pageOne.htm，则在您访问 yourdomain.com/pageTwo.htm 时不会发送任何 cookie 集，因为 URI 不同。实现应将 URI 参数缩减为仅 yourdomain.com 以使其行为符合 (I) 预期。

Cookie 不会在每次删除、添加或更新时同步到 SharedPreferences。这样，当应用被杀死然后重新启动时，刚刚创建的cookie存储将与应用被杀死之前的相同。

我发现了这种方法的致命问题。 HttpCookie.toString() 不会生成可以使用 HttpCookie.parse() 再次解析的字符串。 toString() 省略了 Version 参数，因为它被设计为在 Cookie: 标头中发送。如果 parse() 没有看到 Version 参数，它会忽略其余参数，因为它旨在解析 Set-Cookie/Set-Cookie2 标头。可悲的是，编写此 API 的人犯了这么多错误（使 cookie 不可序列化，没有为其他标头提供格式化 cookie 的方法，将其设置为静态方法的唯一方法等）跨度>

【参考方案2】：

我使用了上面的答案，但将我的 add 方法更改为以下方法以处理来自同一 URI 的多个 cookie（这个带有 GAE 的 cookie 存储将会话令牌和记忆令牌视为来自同一 URI 的两个单独的 cookie某种原因）：

public void add(URI uri, HttpCookie cookie) 


    List<HttpCookie> cookies = mapCookies.get(uri);
    if (cookies == null) 
        cookies = new ArrayList<HttpCookie>();
        mapCookies.put(uri, cookies);
    
    cookies.add(cookie);

    Editor ediWriter = spePreferences.edit();
    HashSet<String> setCookies = new HashSet<String>();
    setCookies.add(cookie.toString());
    HashSet<String> emptyCookieSet = new HashSet<String>();
    if(spePreferences.contains(uri.toString()))
        emptyCookieSet = (HashSet<String>) spePreferences.getStringSet(uri.toString(), emptyCookieSet);
        if(!emptyCookieSet.isEmpty())
            if(!emptyCookieSet.contains(cookie.toString()))
            emptyCookieSet.add(cookie.toString());
            ediWriter.putStringSet(uri.toString(), emptyCookieSet);
            
        
    
    else
        ediWriter.putStringSet(uri.toString(), setCookies);
    
    ediWriter.commit();
 

并访问和创建组合 cookie：

MyCookieStore store = new MyCookieStore(this.context, false);
String cookie = TextUtils.join(",", store.get(new URI(URLString)));

附加到连接：

URL urlToRequest = new URL(stringPath);
HttpURLConnection urlConnection = (HttpURLConnection) urlToRequest.openConnection();
urlConnection.setRequestProperty("Cookie", cookie); 

【参考方案3】：

在下面的链接中查看实现。它像原来的 java.net.InMemoryCookieStore 实现一样按主机名保存 cookie。

此外它还包含一个 SerializableHttpCookie 以便能够将完整的 HashMap 序列化为 SharedPreferences。

https://gist.github.com/jacobtabak/78e226673d5a6a4c4367

【参考方案4】：

很多自定义CookieStore的实现都存在一些基本问题。

第一个问题是HttpCookie 序列化成字符串——HttpCookie.toString() 方法对此是不可接受的，因为它的结果不适合HttpCookie.parse(String header) 方法。

第二个问题：大部分CookieStore的实现（例如here）没有考虑HttpCookie.maxAge字段的格式。这是 cookie live 的秒数。但如果你只是坚持它的价值，一段时间后又不坚持它，那就错了。您必须将maxAge 字段转换为"expire_at" 之类的内容并将其持久化而不是maxAge。