简述
QUrlQuery 类提供了一种方法来操纵 URL 查询中的 key-value 对。
详细描述
QUrlQuery 用来解析 URL 中的查询字符串,像下面这样:
上述的查询字符串在 URL 中 被用来传输选项,通常解码为多个 key-value 对。其列表包含了的两个条目,键为“type”和 “color”。QUrlQuery 也适用于从查询的各个组成部分创建一个查询字符串,为了 在 QUrl::setQuery() 中使用。
解析一个查询字符串最常见的方式是在构造函数中始化它,通过传递一个查询字符串。否则,可以使用 setQuery() 函数来设置要解析的查询。该函数也可用于解析具有非标准分割符的查询,在设置它们之后使用 setQueryDelimiters() 函数。
编码的查询字符串可以再次使用 query() 获得,这需要所有的内部存储项,并使用分隔符编码字符串。
编码
QUrlQuery 中的所有 getter 函数均支持一个可选参数QUrl::ComponentFormattingOptions 类型,包括 query(),它决定如何编码数据。除了 QUrl::FullyDecoded,返回值必须被视为一个百分比编码字符串。由于某些值不能在解码形式(如控制字符,字节序列不能被解码为 UTF-8)来表达。出于这个原因,百分比字符总是由字符串“%25”表示。
处理空格和加号 (“+”)
空格应该被编码成加号 ("+")
,而如果字符本身就是加号 ("+")
,则应该被编码成百分比编码格式 (%2B)
然而,互联网规范管理 URL 不认为空格和加号字符等价。
由于这样,QUrlQuery 不会将空格字符编码为 "+"
,也不会将 "+"
解码为一个空格字符。相反,空格字符将在编码形式中呈现 "%20"
。
为了支持这样的 HTML 表单编码,QUrlQuery 既不会将 "%2B"
序列解码为一个加号,也不会编码一个加号。事实上,任何键、值、查询字符串中的 "%2B"
或 "+"
序列完全像写的一样 (除了 "%2b"
到 "%2B"
大写转换)。
全解码
使用 QUrl:: FullyDecoded 格式化,所有百分比编码序列将被完全解码,并且 '%'
字符用于表示本身。应小心使用 QUrl::FullyDecoded,因为可能会导致数据丢失。
这种格式化模式应该只在这种情况下使用:当在不期望百分比编码的上下文中处理呈献给用户的文本时。
注意: QUrlQuery setters 和 query 函数不支持对应 QUrl::DecodedMode 解析,所以使用 QUrl::FullyDecoded 获得 keys 列表可能导致在对象不能找到 keys 。
非标准分隔符
默认情况下,QUrlQuery 使用等号 ("=")
来分隔 key 和 value,符号 ("&")
分割彼此的 key-value 对 。通过调用 setQueryDelimiters(),可以改变 QUrlQuery 用于解析和重构查询的分隔符。
非标准分隔符在 RFC 3986
的“sub-delimiters”中:
sub-delims = “!” / “$” / “&” / “’” / “(” / “)”
/ “*” / “+” / “,” / “;” / “=”
不支持使用其他字符,可能会导致意外的行为。QUrlQuery 不验证是否传递了一个有效的分隔符。
使用
想必大家对知乎都很熟悉了,假如我们要搜索关于“Qt”的相关内容,通常会在搜索栏中输入关键字“Qt”,然后点击【搜索】按钮进行查找。
这时,观察浏览器中的网址,URL 如下:
如果要构造一个这样的 URL,按照传统方式,一般是手动拼接字符串:
// 基本 URL
QString baseUrl = "http://www.zhihu.com/search?";
// 设置发送的数据
QByteArray bytes;
bytes.append("type=content&");
bytes.append(QString("q=%1").arg("Qt")); // Qt 作为变量输入
// 组合 URL
baseUrl += bytes;
QUrl url(baseUrl);
qDebug() << url;
显然可以实现,但相比之下,QUrlQuery 更为简单、方便。而且QUrlQuery 还提供了很多其他便利的接口。
QUrlQuery
使用 addQueryItem:
// 基本 URL
QString baseUrl = "http://www.zhihu.com/search";
QUrl url(baseUrl);
// key-value 对
QUrlQuery query;
query.addQueryItem("type", "content");
query.addQueryItem("q", "Qt");
url.setQuery(query);
qDebug() << url;
使用 setQueryItems:
// 基本 URL
QString baseUrl = "http://www.zhihu.com/search";
QUrl url(baseUrl);
QUrlQuery query;
// key-value 对
QPair<QString, QString> pair;
pair.first = "type";
pair.second = "content";
QPair<QString, QString> pair2;
pair2.first = "q";
pair2.second = "Qt";
QList<QPair<QString, QString> > items;
items << pair << pair2;
query.setQueryItems(items);
url.setQuery(query);
qDebug() << url;
使用 setQuery:
// 基本 URL
QString baseUrl = "http://www.zhihu.com/search";
QUrl url(baseUrl);
// 查询字符串
QUrlQuery query;
query.setQuery("type=content&q=Qt");
url.setQuery(query);
qDebug() << url;
分隔符
默认情况下,各个 key-value 对之间的分隔符为 '&'
,而 key-value 之间的分隔符为 '='
。
QChar pair = query.queryPairDelimiter(); // '&'
QChar value = query.queryValueDelimiter(); // '='
如果要改变默认的分隔符,使用 setQueryDelimiters():
query.setQueryDelimiters('(', ')');
这时,URL 就会变为这样:
查询
查询所有的 key-value 对:
QList<QPair<QString, QString> > list = query.queryItems();
// (QPair("type","content"), QPair("q","Qt"))
查询指定 key 对应的 value:
QString value = query.queryItemValue("q");
// "Qt"
查询 key-value 对合并的字符串:
QString queryString = url.query();
// "type=content&q=Qt"
查询指定 key 是否存在:
bool exist = query.hasQueryItem("q");
// true
如果存在返回 true, 否则返回 false.
删除
删除指定 key 对应的 key-value 对:
query.removeQueryItem("q");
清空当前存储的所有 key-value 对:
query.clear();
是否为空
如果 QUrlQuery 对象不包含 key-value 对,则返回 true;否则,返回 false。
query.isEmpty();