QNetworkCookieJar Class

成员函数文档

[explicit] QNetworkCookieJar::QNetworkCookieJar(QObject *parent = nullptr)

创建一个 QNetworkCookieJar 对象，并将父对象设置为parent 。

该 Cookie 存储器初始化为空。

[virtual noexcept] QNetworkCookieJar::~QNetworkCookieJar()

销毁此 Cookie 容器对象，并丢弃其中存储的所有 Cookie。在 `QNetworkCookieJar ` 的默认实现中，Cookie 不会保存到磁盘上。

若需将 Cookie 保存到磁盘，则必须继承自 `QNetworkCookieJar ` 类，并自行将 Cookie 保存到磁盘。

[protected] QList<QNetworkCookie> QNetworkCookieJar::allCookies() const

返回存储在此 Cookie 存储器中的所有 Cookie。该函数适用于派生类将 Cookie 保存到磁盘，以及实现 Cookie 过期和其他策略。

另请参阅 setAllCookies() 和cookiesForUrl()。

[virtual] QList<QNetworkCookie> QNetworkCookieJar::cookiesForUrl(const QUrl &url) const

返回在向url 发送请求时需添加的 Cookie。该函数由默认的QNetworkAccessManager::createRequest() 调用，后者会将该函数返回的 Cookie 添加到即将发送的请求中。

如果发现多个同名但路径不同的 Cookie，则路径较长的会优先于路径较短的返回。换言之，该函数会按路径长度从大到小对 Cookie 进行排序后返回。

默认的QNetworkCookieJar 类仅实现了非常基础的安全策略（它确保 Cookie 的域名和路径与响应中的相匹配）。若要通过自定义算法增强安全策略，请重写 cookiesForUrl() 方法。

另请参阅 setCookiesFromUrl() 和QNetworkAccessManager::setCookieJar()。

[virtual] bool QNetworkCookieJar::deleteCookie(const QNetworkCookie &cookie)

从Cookie存储中删除与cookie 具有相同标识符的Cookie。

如果删除了该 Cookie，则返回true ；否则返回 false。

另请参阅 QNetworkCookie::hasSameIdentifier()。

[virtual] bool QNetworkCookieJar::insertCookie(const QNetworkCookie &cookie)

将cookie 添加到此Cookie存储中。

如果已添加cookie ，则返回true ；否则返回 false。

如果 Cookie 存储中已存在具有相同标识符的 Cookie，则会将其覆盖。

[protected] void QNetworkCookieJar::setAllCookies(const QList<QNetworkCookie> &cookieList)

将此 Cookie 存储器中保存的 Cookie 内部列表设置为cookieList 。该函数适用于派生类，以便通过重写setCookiesFromUrl() 方法来实现从永久存储中加载 Cookie，或实现其自身的 Cookie 接受策略。

另请参阅 allCookies() 和setCookiesFromUrl()。

[virtual] bool QNetworkCookieJar::setCookiesFromUrl(const QList<QNetworkCookie> &cookieList, const QUrl &url)

将列表cookieList 中的 Cookie 添加到此 Cookie 存储中。在插入之前，Cookie 会经过规范化处理。

如果为url 设置了一个或多个 Cookie，则返回true ；否则返回 false。

如果 Cookie 存储池中已存在该 Cookie，则会被cookieList 中的 Cookie 覆盖。

默认的QNetworkCookieJar 类仅实现了非常基础的安全策略（它确保 Cookie 的域名和路径与响应中的相匹配）。若要通过自定义算法增强安全策略，请重写 setCookiesFromUrl() 方法。

此外，QNetworkCookieJar 没有设定 Cookie 存储池的最大容量。请重写此函数以丢弃较旧的 Cookie，从而为新的 Cookie 腾出空间。

另请参阅 cookiesForUrl()、QNetworkAccessManager::setCookieJar() 和QNetworkCookie::normalize()。

[virtual] bool QNetworkCookieJar::updateCookie(const QNetworkCookie &cookie)

如果该 Cookie 存储区中存在与cookie 标识符相同的 Cookie，则会对其进行更新。此函数使用insertCookie()。

如果cookie 已被更新，则返回true ；如果 Cookie 池中没有与cookie 标识符匹配的 Cookie，则返回 false。

另请参阅 QNetworkCookie::hasSameIdentifier()。

[virtual protected] bool QNetworkCookieJar::validateCookie(const QNetworkCookie &cookie, const QUrl &url) const

如果cookie 的域名和路径有效，则返回 `true `；否则返回 `false`。url 参数用于确定 Cookie 中指定的域名是否被允许。