最近在学习XMPP的使用,打算完成一个完整较为完整地Demo示例,经过这个示例掌握xmpp的使用与开发。同时打算在这个示例中学习使用一下其余的开源类库,在此做为记录学习。html
包括服务器端——Openfire,客户端——Spark,XMPP 传输协议的实现——Smack(XMPP是一个协议,协议是须要实现的,Smack起到的就是这样的一个做用,android开发使用的是asmack类库)。三者都是基于Java 语言的实现,所以对于熟悉Java 的开发者来讲不是很难。java
OpenFire介绍android
Openfire 采用Java开发,开源的实时协做(RTC)服务器基于XMPP(Jabber)协议。c#
您可使用它轻易的构建高效率的即时通讯服务器.windows
Openfire安装和使用都很是简单,并利用Web进行管理。单台服务器可支持上万并发用户。服务器
因为是采用开放的XMPP协议,您可使用各类支持XMPP协议的IM客户端软件登录服务.架构
Spark 提供了客户端一个基本的实现,并提出了一个很好的插件架构,这对于开发者来讲不能不说是一个福音。我强烈建议基于插件方式来实现你新增长的功能,而不是去改它的源代码,这样有利于你项目架构,把原始项目的影响降到最低,文章之后的部分也是基于这种插件体系进行开发的并发
smack的Android版本,虽然Smack在PC上能够工做的很好,功能也很强大,但在Android平台上有一些问题,而致使这些问题的缘由是Android精简了Java的类库,以致Smack使用的部分类库在Android平台上没法找到,因此Smack不能直接在Android平台上使用.但在2010年初,有人在code.google.com网站上发布了一个Asmack,其中A库就表明Android中的A,也就是说,这个版本是Smack的Android版本.可以使用下面地址下载Asmack:app
http://code.google.com/p/asmack/downloads/list异步
下载asmack-2010.03.03.jar文件后,直接在Android工程中引用便可
一、输入用户名、密码、服务器地址,能够在搭建好openfire服务器后用spark注册帐号,相似qq,多注册几个做为测试用,我用spark创建帐号名和密码都为test,在此帐号建立2个组,个人好友和大学同窗,同时注册test1-test4的测试帐号,加test为好友,固然这些均可以用代码操做,初始阶段我是这么作快速写代码测试。
二、输入错误的帐号和密码会看到信息展现在登录失败后将错误信息展现出来
三、当输入正确用户名和密码以后,进入mainActivity界面,这里将分组和全部好友以文字形式展示出来
XMPPManager.java
package manager; import org.jivesoftware.smack.*; import org.jivesoftware.smack.provider.ProviderManager; import org.jivesoftware.smackx.GroupChatInvitation; import org.jivesoftware.smackx.PrivateDataManager; import org.jivesoftware.smackx.packet.*; import org.jivesoftware.smackx.provider.*; import org.jivesoftware.smackx.search.UserSearch; import java.util.Collection; import java.util.Iterator; /** * User: Coolwxb * Date: 14-1-13 * Time: 下午5:10 */ public class XMPPManager { private static XMPPManager instance = null; XMPPConnection connection=null; private static String URL = "10.0.0.14"; private static int PORT = 5222; private static String DEVICE = "pc"; private static String USERNAME = "test"; private static String PASSWORD = "test"; private static int SUCCESS=0; private XMPPManager( ){ /** Manages providers for parsing custom XML sub-documents of XMPP packets. Two types of providers exist: IQProvider -- parses IQ requests into Java objects. PacketExtension -- parses XML sub-documents attached to packets into PacketExtension instances. **/ ProviderManager pm = ProviderManager.getInstance(); configure(pm); } /** * 单例方法 * @return */ public static XMPPManager getInstance() { if (instance == null) { instance = new XMPPManager(); } return instance; } /** * 得到connection链接 * @return */ public XMPPConnection getConnection() throws Exception { if (connection == null) throw new Exception("请先初始化xmppconnection"); return connection; } /** * * 登录操做 返回String 来判断登录结果 Code XMPP Error Type 500 interna-server-error WAIT 403 forbidden AUTH 400bad-request MODIFY 404 item-not-found CANCEL 409 conflict CANCEL 501 feature-not-implemented CANCEL 302 gone MODIFY 400 jid-malformed MODIFY 406 no-acceptable MODIFY 405 not-allowed CANCEL 401 not-authorized AUTH 402 payment-required AUTH 404 recipient-unavailable WAIT 302 redirect MODIFY 407 registration-required AUTH 404 remote-server-not-found CANCEL 504 remote-server-timeout WAIT 502 remote-server-error CANCEL 500 resource-constraint WAIT 503 service-unavailable CANCEL 407 subscription-required AUTH 500 undefined-condition WAIT 400 unexpected-condition WAIT 408 request-timeout CANCEL * * @param username * @param password * @param server*/ public String isLogin(String username, String password, String server) { try { ConnectionConfiguration cf = new ConnectionConfiguration( server, PORT, DEVICE); cf.setDebuggerEnabled(true); //开启debug模式 cf.setCompressionEnabled(false); //是否对流进行压缩 cf.setSASLAuthenticationEnabled(false); //是否开启SASL 登录验证 connection = new XMPPConnection(cf); connection.connect(); connection.login(username, password); return SUCCESS+""; } catch (XMPPException e) { return e.getMessage(); } } public void configure(ProviderManager pm) { // Private Data Storage pm.addIQProvider("query", "jabber:iq:private", new PrivateDataManager.PrivateDataIQProvider()); // Time try { pm.addIQProvider("query", "jabber:iq:time", Class.forName("org.jivesoftware.smackx.packet.Time")); } catch (ClassNotFoundException e) { } // XHTML pm.addExtensionProvider("html", "http://jabber.org/protocol/xhtml-im", new XHTMLExtensionProvider()); // Roster Exchange pm.addExtensionProvider("x", "jabber:x:roster", new RosterExchangeProvider()); // Message Events pm.addExtensionProvider("x", "jabber:x:event", new MessageEventProvider()); // Chat State pm.addExtensionProvider("active", "http://jabber.org/protocol/chatstates", new ChatStateExtension.Provider()); pm.addExtensionProvider("composing", "http://jabber.org/protocol/chatstates", new ChatStateExtension.Provider()); pm.addExtensionProvider("paused", "http://jabber.org/protocol/chatstates", new ChatStateExtension.Provider()); pm.addExtensionProvider("inactive", "http://jabber.org/protocol/chatstates", new ChatStateExtension.Provider()); pm.addExtensionProvider("gone", "http://jabber.org/protocol/chatstates", new ChatStateExtension.Provider()); // FileTransfer pm.addIQProvider("si", "http://jabber.org/protocol/si", new StreamInitiationProvider()); // Group Chat Invitations pm.addExtensionProvider("x", "jabber:x:conference", new GroupChatInvitation.Provider()); // Service Discovery # Items pm.addIQProvider("query", "http://jabber.org/protocol/disco#items", new DiscoverItemsProvider()); // Service Discovery # Info pm.addIQProvider("query", "http://jabber.org/protocol/disco#info", new DiscoverInfoProvider()); // Data Forms pm.addExtensionProvider("x", "jabber:x:data", new DataFormProvider()); // MUC User pm.addExtensionProvider("x", "http://jabber.org/protocol/muc#user", new MUCUserProvider()); // MUC Admin pm.addIQProvider("query", "http://jabber.org/protocol/muc#admin", new MUCAdminProvider()); // MUC Owner pm.addIQProvider("query", "http://jabber.org/protocol/muc#owner", new MUCOwnerProvider()); // Delayed Delivery pm.addExtensionProvider("x", "jabber:x:delay", new DelayInformationProvider()); // Version try { pm.addIQProvider("query", "jabber:iq:version", Class.forName("org.jivesoftware.smackx.packet.Version")); } catch (ClassNotFoundException e) { } // VCard pm.addIQProvider("vCard", "vcard-temp", new VCardProvider()); // Offline Message Requests pm.addIQProvider("offline", "http://jabber.org/protocol/offline", new OfflineMessageRequest.Provider()); // Offline Message Indicator pm.addExtensionProvider("offline", "http://jabber.org/protocol/offline", new OfflineMessageInfo.Provider()); // Last Activity pm.addIQProvider("query", "jabber:iq:last", new LastActivity.Provider()); // User Search pm.addIQProvider("query", "jabber:iq:search", new UserSearch.Provider()); // SharedGroupsInfo pm.addIQProvider("sharedgroup", "http://www.jivesoftware.org/protocol/sharedgroup", new SharedGroupsInfo.Provider()); // JEP-33: Extended Stanza Addressing pm.addExtensionProvider("addresses", "http://jabber.org/protocol/address", new MultipleAddressesProvider()); } /** * 返回组信息的容器 * @param roster * @return */ public Iterator<RosterGroup> getGroups(Roster roster) { Collection<RosterGroup> rosterGroups = roster.getGroups(); return rosterGroups.iterator(); } }
这里写了个XMPPManager做为帮助类,主要重要的方法就是对xmppconnection作初始化,可看到configure方法对用xml描述的xmpp包作解析,官方文档是这样对ProviderManager这个类作解释:
Manages providers for parsing custom XML sub-documents of XMPP packets.
Two types of providers exist: IQProvider -- parses IQ requests into Java objects. PacketExtension -- parses XML sub-documents attached to packets
into PacketExtension instances.
LoginActivity.java
package com.example.XMPPDemo; import android.app.Activity; import android.app.ProgressDialog; import android.content.Intent; import android.os.AsyncTask; import android.os.Bundle; import android.util.Log; import android.view.View; import android.widget.Button; import android.widget.EditText; import android.widget.TextView; import manager.XMPPManager; import org.jivesoftware.smack.XMPPConnection; /** * User: Coolwxb * Date: 14-1-13 * Time: 下午5:18 */ public class LoginActivity extends Activity{ private XMPPManager xmppManager; private XMPPConnection xmppConnection; private Button btn_login; private EditText et_username; private EditText et_password; private EditText et_server; private TextView tv_info; ProgressDialog pd; @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.login); et_password = (EditText) findViewById(R.id.et_password); et_username = (EditText) findViewById(R.id.et_username); et_server = (EditText) findViewById(R.id.et_server); tv_info = (TextView) findViewById(R.id.tv_info); btn_login = (Button) findViewById(R.id.btn_login); btn_login.setOnClickListener(new View.OnClickListener() { @Override public void onClick(View v) { login(); } }); } private void login() { new AsyncTask< String, String, String > (){ String username = ""; String password = ""; String server = ""; @Override protected void onPreExecute() { username = et_username.getText().toString().trim(); password = et_password.getText().toString().trim(); server = et_server.getText().toString().trim(); xmppManager = XMPPManager.getInstance(); pd = new ProgressDialog(LoginActivity.this); pd.setTitle("提示"); pd.setMessage("正在登录。。。。"); pd.show(); } @Override protected String doInBackground(String... strings) { return xmppManager.isLogin(username,password,server); } @Override protected void onPostExecute(String info) { pd.dismiss(); if ("0".equals(info)){ //成功登录SUCCESS Intent intent = new Intent(); intent.setClass(LoginActivity.this, MainActivity.class); startActivity(intent); }else { Log.e("error",info); tv_info.setText(info); } } }.execute(null,null,null); } }
这里使用了一个android 的异步线程类AsyncTask,在doInBackground方法中作一些耗时的操做,我试过若是不加入线程中操做的话会出现假死现象,因此在这里我将登录链接放入了线程中.
MainActivity.java
package com.example.XMPPDemo; import android.app.Activity; import android.os.Bundle; import android.util.Log; import android.widget.TextView; import manager.XMPPManager; import org.jivesoftware.smack.Roster; import org.jivesoftware.smack.RosterEntry; import org.jivesoftware.smack.RosterGroup; import java.util.Collection; import java.util.Iterator; /** * User: Coolwxb * Date: 14-1-13 * Time: 下午6:28 */ public class MainActivity extends Activity{ XMPPManager xmppManager; private TextView tv_groupInfo; @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_main); tv_groupInfo = (TextView) findViewById(R.id.tv_groupinfo); xmppManager = XMPPManager.getInstance(); Roster roster = null; try { roster = xmppManager.getConnection().getRoster(); } catch (Exception e) { e.printStackTrace(); } Iterator<RosterGroup> rosterGroupIterator = xmppManager.getGroups(roster); StringBuilder sb = new StringBuilder(); //获取全部组信息 if (rosterGroupIterator.hasNext()){ //若是有分组 while (rosterGroupIterator.hasNext()) { RosterGroup rosterGroup = rosterGroupIterator.next(); String groupName = rosterGroup.getName(); int count = rosterGroup.getEntryCount(); sb.append(rosterGroup.getName()+"\r\n"); } tv_groupInfo.setText("组信息:+\r\n"+sb.toString()); } else{ tv_groupInfo.setText("没有组信息"); } //获取全部人 Collection<RosterEntry> iterator =roster.getEntries(); Iterator<RosterEntry> entryIterator = iterator.iterator(); sb = new StringBuilder(); while (entryIterator.hasNext()) { RosterEntry rosterEntry = entryIterator.next(); sb.append(rosterEntry.getName()+"\r\n"); } String ii = sb.toString(); Log.i("info", ii); tv_groupInfo.append("全部的成员:+\r\n"+ii); } }
MainActivity的界面中我只放入了一个textview,用来显示分组信息和成员。由于在操做开始我用spark向test这个帐号创建了分组和好友,因此会获取到。
登录就介绍到这里,跳转到mainactivity获取组信息和成员信息涉及比较多的经常使用类,打算专门研究下专门写一章。
最后附上一些比较重要的东东,但愿你们会喜欢,同时也但愿你们提出宝贵意见,你们共同进步。
登录源码:
xmpp帮助文档:
asmack jar包
最后吐槽下windows live writer 今天用的好卡。。。卡死3次。。什么心情。。