okhttp 原始碼解析 - 網路協議的實現 - HTTP 之 cookie 管理

水牛發表於2017-03-13

HTTP原始碼協議Cookie

okhttp 原始碼解析 - 網路協議的實現 - HTTP 之 cookie 管理 — Paste_Image.png

注: 主要參考HTTP cookies 詳解,筆記做成思維導圖

RFC2965-HTTP State Management Mechanism

okhttp原始碼中的實現

根據構造可以看出,基本是按照cookie規範來的

private Cookie(String name, String value, long expiresAt, String domain, String path,
      boolean secure, boolean httpOnly, boolean hostOnly, boolean persistent) {
    this.name = name;
    this.value = value;
    this.expiresAt = expiresAt;//過期時間
    this.domain = domain;//域
    this.path = path;//子路徑匹配
    this.secure = secure;//是否僅應用於https
    this.httpOnly = httpOnly;//是否禁止javascript操作cookie
    this.hostOnly = hostOnly;//是否針對特定主機
    this.persistent = persistent;//是否持久化
  }

  Cookie(Builder builder) {
    if (builder.name == null) throw new NullPointerException("builder.name == null");
    if (builder.value == null) throw new NullPointerException("builder.value == null");
    if (builder.domain == null) throw new NullPointerException("builder.domain == null");

    this.name = builder.name;
    this.value = builder.value;
    this.expiresAt = builder.expiresAt;
    this.domain = builder.domain;
    this.path = builder.path;
    this.secure = builder.secure;
    this.httpOnly = builder.httpOnly;
    this.persistent = builder.persistent;
    this.hostOnly = builder.hostOnly;
  }複製程式碼

三,二,一,走

BridgeInterceptor的intercept方法中

  List<Cookie> cookies = cookieJar.loadForRequest(userRequest.url());
    if (!cookies.isEmpty()) {
      requestBuilder.header("Cookie", cookieHeader(cookies));
//給request設定cookie,List<Cookie> cookies由cookieJar.loadForRequest方法返回,該方式由開發者實現.
    }

    if (userRequest.header("User-Agent") == null) {
      requestBuilder.header("User-Agent", Version.userAgent());
    }

    Response networkResponse = chain.proceed(requestBuilder.build());

    HttpHeaders.receiveHeaders(cookieJar, userRequest.url(), networkResponse.headers());
//從response中解析出cookies,字串變成List<Cookie>,交給cookiejar介面處理

    Response.Builder responseBuilder = networkResponse.newBuilder()
        .request(userRequest);複製程式碼

header中格式類似下面
Set-Cookie:name1=value1;name2=value2 ;expires=date;domain=domain ;path=path ;secure;httpOnly

從response中拿到headers
從headers中拿到"Set-Cookie"對應的內容(String)
將拿到的String根據cookie字串特點解析,並構建Cookie類

HttpHeaders.receiveHeaders

public static void receiveHeaders(CookieJar cookieJar, HttpUrl url, Headers headers) {
    if (cookieJar == CookieJar.NO_COOKIES) return;

    List<Cookie> cookies = Cookie.parseAll(url, headers);//關鍵的解析方法在這裡面
    if (cookies.isEmpty()) return;

    cookieJar.saveFromResponse(url, cookies);//解析出的cookies交給cookieJar,讓它去決定怎麼儲存
  }複製程式碼


public static List<Cookie> parseAll(HttpUrl url, Headers headers) {
    List<String> cookieStrings = headers.values("Set-Cookie");//可以解析headers中多個Set-Cookie欄位
    List<Cookie> cookies = null;

    for (int i = 0, size = cookieStrings.size(); i < size; i++) {
      Cookie cookie = Cookie.parse(url, cookieStrings.get(i));//Set-Cookie:後方的cookie內容的核心解析方法:
      if (cookie == null) continue;
      if (cookies == null) cookies = new ArrayList<>();
      cookies.add(cookie);
    }

    return cookies != null
        ? Collections.unmodifiableList(cookies)
        : Collections.<Cookie>emptyList();
  }複製程式碼

對照著cookie規範來看

static Cookie parse(long currentTimeMillis, HttpUrl url, String setCookie) {
    int pos = 0;
    int limit = setCookie.length();
    int cookiePairEnd = delimiterOffset(setCookie, pos, limit, ';');

    int pairEqualsSign = delimiterOffset(setCookie, pos, cookiePairEnd, '=');
    if (pairEqualsSign == cookiePairEnd) return null;

    String cookieName = trimSubstring(setCookie, pos, pairEqualsSign);//拿到name
    if (cookieName.isEmpty() || indexOfControlOrNonAscii(cookieName) != -1) return null;

    String cookieValue = trimSubstring(setCookie, pairEqualsSign + 1, cookiePairEnd);//拿到value
    if (indexOfControlOrNonAscii(cookieValue) != -1) return null;

    long expiresAt = HttpDate.MAX_DATE;//預設有效期很長
    long deltaSeconds = -1L;
    String domain = null;
    String path = null;
    boolean secureOnly = false;
    boolean httpOnly = false;
    boolean hostOnly = true;
    boolean persistent = false;//預設為會話cookie

//解析name=value;後面的幾個屬性
    pos = cookiePairEnd + 1;
    while (pos < limit) {
      int attributePairEnd = delimiterOffset(setCookie, pos, limit, ';');//拿到後一個分號的

      int attributeEqualsSign = delimiterOffset(setCookie, pos, attributePairEnd, '=');
      String attributeName = trimSubstring(setCookie, pos, attributeEqualsSign);//拿到屬性名
//拿到屬性值
      String attributeValue = attributeEqualsSign < attributePairEnd
          ? trimSubstring(setCookie, attributeEqualsSign + 1, attributePairEnd)
          : "";

//一個個匹配並賦值
      if (attributeName.equalsIgnoreCase("expires")) {
        try {
          expiresAt = parseExpires(attributeValue, 0, attributeValue.length());
          persistent = true;
        } catch (IllegalArgumentException e) {
          // Ignore this attribute, it isn't recognizable as a date.
        }
      } else if (attributeName.equalsIgnoreCase("max-age")) {
        try {
          deltaSeconds = parseMaxAge(attributeValue);
          persistent = true;
        } catch (NumberFormatException e) {
          // Ignore this attribute, it isn't recognizable as a max age.
        }
      } else if (attributeName.equalsIgnoreCase("domain")) {
        try {
          domain = parseDomain(attributeValue);
          hostOnly = false;
        } catch (IllegalArgumentException e) {
          // Ignore this attribute, it isn't recognizable as a domain.
        }
      } else if (attributeName.equalsIgnoreCase("path")) {
        path = attributeValue;
      } else if (attributeName.equalsIgnoreCase("secure")) {
        secureOnly = true;
      } else if (attributeName.equalsIgnoreCase("httponly")) {
        httpOnly = true;
      }

      pos = attributePairEnd + 1;
    }

//拿過期時間
    // If 'Max-Age' is present, it takes precedence over 'Expires', regardless of the order the two
    // attributes are declared in the cookie string.
    if (deltaSeconds == Long.MIN_VALUE) {
      expiresAt = Long.MIN_VALUE;
    } else if (deltaSeconds != -1L) {
      long deltaMilliseconds = deltaSeconds <= (Long.MAX_VALUE / 1000)
          ? deltaSeconds * 1000
          : Long.MAX_VALUE;
      expiresAt = currentTimeMillis + deltaMilliseconds;
      if (expiresAt < currentTimeMillis || expiresAt > HttpDate.MAX_DATE) {
        expiresAt = HttpDate.MAX_DATE; // Handle overflow & limit the date range.
      }
    }

    // If the domain is present, it must domain match. Otherwise we have a host-only cookie.
    if (domain == null) {
      domain = url.host();//有規定domain,就按domain的規則,沒有,就嚴格匹配host
    } else if (!domainMatch(url, domain)) {//域不匹配,set cookie無效,棄之
      return null; // No domain match? This is either incompetence or malice!
    }

    // If the path is absent or didn't start with '/', use the default path. It's a string like
    // '/foo/bar' for a URL like 'http://example.com/foo/bar/baz'. It always starts with '/'.
    if (path == null || !path.startsWith("/")) {
      String encodedPath = url.encodedPath();
      int lastSlash = encodedPath.lastIndexOf('/');
      path = lastSlash != 0 ? encodedPath.substring(0, lastSlash) : "/";
    }

    return new Cookie(cookieName, cookieValue, expiresAt, domain, path, secureOnly, httpOnly,
        hostOnly, persistent);
  }複製程式碼

cookieJar.saveFromResponse(url, cookies);複製程式碼

追蹤原始碼可以看到,cookieJar是由OkHttpClient傳遞過來的,是由OkHttpClient.Builder.cookieJar(cookieJar)傳進來,具體由使用者實現.OkHttpClient.Builder提供了預設實現:

cookieJar = CookieJar.NO_COOKIES;複製程式碼

其實現為:

public interface CookieJar {
  /** A cookie jar that never accepts any cookies. */
  CookieJar NO_COOKIES = new CookieJar() {
    @Override public void saveFromResponse(HttpUrl url, List<Cookie> cookies) {
    }

    @Override public List<Cookie> loadForRequest(HttpUrl url) {
      return Collections.emptyList();
    }
  };


  void saveFromResponse(HttpUrl url, List<Cookie> cookies);


  List<Cookie> loadForRequest(HttpUrl url);
}複製程式碼

非常簡單了,就是CookieJar介面的loadForRequest方法,預設是返回null,如果管理,需要使用者自己實現

BridgeInterceptor的intercept方法中

  List<Cookie> cookies = cookieJar.loadForRequest(userRequest.url());
    if (!cookies.isEmpty()) {
      requestBuilder.header("Cookie", cookieHeader(cookies));
//給request設定cookie,List<Cookie> cookies由cookieJar.loadForRequest方法返回,該方式由開發者實現.
    }複製程式碼

從上面的原始碼分析可以看出,cookie管理中,cookie解析和cookie設定兩個部分都不用我們操心,框架幫我們做了,我們要做的是實現cookieJar來定製cookie的儲存.

我們很容易就可以知道,有三種情況

不要cookie
會話cookie: cookie只存在記憶體中,客戶端/瀏覽器一關閉,cookie就沒了
持久cookie: cookie寫到硬碟上,下次客戶端再開啟時可以從上面讀取,然後新增到request中

分別的實現

okhttp已經內建了,就是CookieJar.NO_COOKIES

new CookieJar() {  
    private final HashMap<String, List<Cookie>> cookieStore = new HashMap<String, List<Cookie>>();  

    @Override  
    public void saveFromResponse(HttpUrl url, List<Cookie> cookies) {  
        cookieStore.put(url.host(), cookies);  
    }  

    @Override  
    public List<Cookie> loadForRequest(HttpUrl url) {  
        List<Cookie> cookies = cookieStore.get(url.host());  
        return cookies != null ? cookies : new ArrayList<Cookie>();  
    }  
})複製程式碼


private class CookiesManager implements CookieJar {
        private final PersistentCookieStore cookieStore = new PersistentCookieStore(getApplicationContext());

        @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;
        }
    }複製程式碼

PersistentCookieStore 的實現

用SharedPreferences來儲存
注: 參考OkHttp3實現Cookies管理及持久化

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 SerializableOkHttpCookies(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(SerializableOkHttpCookies 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 = ((SerializableOkHttpCookies) 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;
    }
  }複製程式碼

更任性一點

既然List 是我返回給框架的,那麼我可以改動,或者手動新增一個全新的cookie,這個就不展開了.

總結

okhttp對cookie的實現中,做了兩件事:
按照規範把response header中的"set-cookie"欄位解析成List
把cookieJar返回的List設定到請求頭中.

需要使用者做的事是定義cookie的儲存方式:
是不儲存,還是儲存在記憶體,還是持久化到硬碟,方式是通過實現CookieJar介面

封裝到極致的網路庫:

HttpUtilForAndroid

okhttp 原始碼解析 – http 協議的實現 – 重定向
2019-03-01
HTTP原始碼協議
Andriod 網路框架 OkHttp 原始碼解析
2018-10-18
框架HTTP原始碼
consul 原始碼解析（一）raft 協議實現
2018-03-04
原始碼Raft協議
計算機網路之十二：HTTP協議
2019-07-12
計算機網路HTTP協議
極光HTTP之什麼是網路協議
2021-09-11
HTTP協議
網路通訊協議-HTTP協議詳解！
2024-02-15
協議HTTP
OkHttp 知識梳理(4) - OkHttp 之快取原始碼解析
2018-03-26
HTTP快取原始碼
網路管理協議
2019-11-25
協議
網路基礎之HTTP協議
2021-08-15
HTTP協議
HTTP 協議完全解析
2019-02-12
HTTP協議
[服務端與網路]http協議與http狀態碼
2019-02-21
服務端HTTP協議
OkHttp原始碼深度解析
2020-03-25
HTTP原始碼
Http網路協議包 (快速理解)
2020-12-06
HTTP協議
網路安全網路協議知識點中，http協議是什麼？
2020-12-28
協議HTTP
02 前端HTTP協議(圖解HTTP) 之簡單的HTTP協議
2018-09-04
前端HTTP協議圖解
網路協議 - TCP/IP、HTTP、HTTPS、HTTP2.0
2018-05-31
協議TCPHTTP
http協議/cookie詳解/session詳解
2018-05-04
HTTP協議CookieSession
Netty 原始碼中對 Redis 協議的實現
2018-08-09
Netty原始碼Redis協議
網路協議之:haproxy的Proxy Protocol代理協議
2022-06-01
協議Protocol
徹底理解OkHttp - OkHttp 原始碼解析及OkHttp的設計思想
2018-12-20
HTTP原始碼
04 前端HTTP協議(圖解HTTP) 之 HTTP狀態碼
2018-09-04
前端HTTP協議圖解
玩轉直播系列之RTMP協議和原始碼解析（2）
2021-05-17
協議原始碼
OkHttp3原始碼解析(一)之請求流程
2018-09-10
HTTP原始碼
Retrofit原始碼解析之網路請求
2020-09-30
原始碼
Volley 原始碼解析之網路請求
2018-12-21
原始碼
物聯網協議之MQTT原始碼分析(二)
2019-05-12
協議MQQT原始碼
物聯網協議之MQTT原始碼分析(一)
2019-05-12
協議MQQT原始碼
網路通訊協議自動轉換之thrift到http
2019-03-01
協議HTTP
網路協議之:socket協議詳解之Datagram Socket
2022-04-01
協議
01 前端HTTP協議(圖解HTTP) 之網路基礎
2018-09-03
前端HTTP協議圖解
網路基礎之網路協議
2019-03-19
協議
ios網路協議從http變成https
2023-01-14
iOS協議HTTP
HTTP協議之:HTTP/1.1和HTTP/2
2021-08-26
HTTP協議
網路安全協議之IPsec
2021-11-21
協議
Okhttp的Interceptor攔截器原始碼解析
2019-07-23
HTTP原始碼
網路協議之:socket協議詳解之Unix domain Socket
2022-04-06
協議AI
計算網路之MSTP協議與VRRP協議
2023-11-15
協議VR
QT使用 http 協議通訊的實現示例
2024-05-03
QTHTTP協議
HTTP協議Cookie和Session有什麼區別
2020-12-20
HTTP協議CookieSession

okhttp 原始碼解析 - 網路協議的實現 - HTTP 之 cookie 管理

cookie介紹

cookie 規範

okhttp原始碼中的實現

Cookie類的構造

cookie互動流程的客戶端實現

BridgeInterceptor的intercept方法中

跟隨cookie流程,先看從response中解析的過程

HttpHeaders.receiveHeaders

Cookie.parseAll

Cookie.parse: 核心方法

從response中解析出的List的儲存

再看request中新增cookie的方法

自定義cookie的管理策略

客戶端的cookie策略

分別的實現

不要cookie

會話cookie:

持久化cookie

PersistentCookieStore 的實現

更任性一點

總結

封裝到極致的網路庫:

相關文章