搜索用户

Author: winterSleep

7-搜索用户.md

@@ -0,0 +1,92 @@
+# 搜索用户
+
+搜索好友模块，在XMPPFrameWork模块中暂时未实现，咱们先看一下客户端和服务器的报文交互吧。
+
+关于搜索用户的协议，可以参考 [xep-0055](http://xmpp.org/extensions/xep-0055.html) 协议（主要查看 3. Extensibility 这一节）
+
+## 报文
+
+**以下报文为 Spark 和 openFire 抓包，跟正式的xep-0055协议貌似有些不一致（咱们还是以具体的抓包为准吧）**
+
+1. 首先，为了搜索用户，需要先去服务器询问服务器支持哪种关键字搜索
+
+		<iq id="7OiRr-37" to="search.192.168.1.115" type="get">
+		  <query xmlns="jabber:iq:search"/>
+		</iq>
+	
+2. 服务器返回支持的关键字搜索类型
+
+		<iq id="7OiRr-37" to="[email protected]/mobile" from="search.192.168.1.115" type="result">
+		  <query xmlns="jabber:iq:search">
+		    <FORM_TYPE>jabber:iq:search</FORM_TYPE>
+		    <Username>1</Username>
+		    <Name>1</Name>
+		    <Email>1</Email>
+		  </query>
+		</iq>
+		
+	从报文能看到，服务器支持 Username、Name、Email三种类型的搜索
+	
+3. 发送查询报文到服务器：
+
+		<iq id="7OiRr-38" to="search.192.168.1.115" type="set">
+		  <query xmlns="jabber:iq:search">
+		    <x xmlns="jabber:x:data" type="submit">
+		      <field var="FORM_TYPE" type="hidden">
+		        <value>jabber:iq:search</value>
+		      </field>
+		      <field var="search" type="text-single">
+		        <value>test</value>
+		      </field>
+		      <field var="Username" type="boolean">
+		        <value>1</value>
+		      </field>
+		      <field var="Name" type="boolean">
+		        <value>1</value>
+		      </field>
+		      <field var="Email" type="boolean">
+		        <value>1</value>
+		      </field>
+		    </x>
+		  </query>		  
+		</iq>
+		
+	发送的协议意思为：
+		
+		搜索关键字为："text"，搜索的范围为：Username，Name，Email（可以看到这三个field的value都是为1，如果不想搜索 Email，可以把它设置为0）
+	
+4. 服务器返回搜索结果：
+
+		<iq id="7OiRr-38" to="[email protected]/mobile" from="search.192.168.1.115" type="result">
+		  <query xmlns="jabber:iq:search">
+		    <x xmlns="jabber:x:data" type="result">
+		      <reported>
+		        <field label="JID" var="jid" type="jid-single"/>
+		        <field label="Username" var="Username" type="text-single"/>
+		        <field label="Name" var="Name" type="text-single"/>
+		        <field label="Email" var="Email" type="text-single"/>
+		      </reported>
+		      <item>
+		        <field var="Name">
+		          <value>test1</value>
+		        </field>
+		        <field var="Email">
+		          <value/>
+		        </field>
+		        <field var="Username">
+		          <value>test1</value>
+		        </field>
+		        <field var="jid">
+		          <value>[email protected]</value>
+		        </field>
+		      </item>
+		      <field var="FORM_TYPE" type="hidden"/>
+		    </x>
+		  </query>
+		</iq>
+		
+	服务器返回了搜索结果，并返回了用户相应的其它属性，比如 jid、username、Email等
+	
+## XMPPFrameWork的实现
+
+	XMPPFrameWork 暂时未实现该模块，不过呢，如果你有兴趣的话，可以继承 XMPPModule 类，来做相应的扩展，这个实现起来应该还是不太难的。