开源项目之Android 推送框架(androidpn)

androidpn为Android应用提供消息通知推送支持， 它本质上服务器端基于 Openfire，客户端基于 asmack，这二者都最 XMPP  IM 开源实现里的二个基本组件，应该说 androidpn 只是把二者更多地结合起来用于做 Push的场景。

整个项目包括：一个基于xmpp的通知服务器和一个客户端工包，项目如图：

关于服务器端向Android客户端的推送，主要有三种方式：1.客户端定时去服务端取或者保持一个长Socket，从本质讲这个不叫推送，这是去服务端拽数据。但是实现简单，主要缺点：耗电等2.Google的C2DM，具体不细说，缺点，服务器在国外，你懂得，不是很稳定。3.XMPP协议，它是一种基于XML的传递协议，具有很强的灵活性和可扩展性。它的特点是将复杂性从客户端转移到了服务器端。听说GTalk、QQ、IM等都用这个协议。

先来看下客户端所包含的类：

public class ConnectivityReceiver extends BroadcastReceiver { // 网络变化广播接收器
public class Constants {  //包含静态数据
public class InvalidFormatException extends RuntimeException { // 运行时所产生的错误处理
public class LogUtil { //信息输出
public class NotificationDetailsActivity extends Activity { // 活动通知详细视图显示
public class NotificationIQ extends IQ { //
public class NotificationIQProvider implements IQProvider {
public class NotificationPacketListener implements PacketListener {// 这类通知传入的任何指示，异步数据包的接收。
public final class NotificationReceiver extends BroadcastReceiver { //推送通知消息的广播接收器
public class NotificationService extends Service { //后台运行并响应来自服务器的事件推送通知服务
public class NotificationSettingsActivity extends PreferenceActivity { // 设置信息
public class Notifier { //通知用户
public class PersistentConnectionListener implements ConnectionListener { //监控连接关闭和重新连接事件监听器类
public class PhoneStateChangeListener extends PhoneStateListener { //监听手机状态
public class ReconnectionThread extends Thread { // 连接服务器
public final class ServiceManager { //管理的notificatin服务，加载配置
public class XmppManager { // 管理客户端和服务器之间的连接

客户端包含了第三方库asmack.jar。

打开raw/androidpn.properties文件，配置好目标平台，如下：

apiKey=1234567890
xmppHost=192.168.0.5
xmppPort=5222

xmppPort=5222 是服务器的xmpp服务监听端口
xmppHost=192.168.0.5 服务器

再来看看服务端的源码：

其中org.androidpn.server.dao，org.androidpn.server.model和org.androidpn.server.service为使用hibernate链接数据库并实现简单的用户登录认证，开发中可以用我们自己的认证模块替换。剩下的包就是推送的主体实现。逐个包来看：

1.org.androidpn.server.util包中的类用来加载resources中的配置文件，在配置文件中可指定监听端口和ssl证书目录等属性。

public class Config {  //读取配置信息
public class ConfigManager { //应用程序配置信息管理

2.org.androidpn.server.xmpp包里面定义了一些异常类型，主要是包含有入口类XmppServer，这个类用来启动和停止server程序。

public class PacketException extends RuntimeException {  //分组失败业务所产生的运行时异常
public class UnauthenticatedException extends Exception { //如果用户未认证用户做特定的操作时引发。
public class UnauthorizedException extends Exception { //如果用户未认证用户做特定的操作时引发。
public class XmppServer { //使用Spring配置的服务器

3.org.androidpn.server.xmpp.auth包里面是认证的一些类，我们自己的认证模块可以在这里与androidpn进行结合。

public class AuthToken {  //封装用户认证token 名字、域名
public class AuthManager {  //用户认证管理

4.org.androidpn.server.xmpp.codec是XMPP协议的XML文件解析包，server收到和发送的消息都要通过这个包来进行xmpp协议编码和解码。

public class XmppCodecFactory implements ProtocolCodecFactory { //编码/解码器，用于解析的XMPP。
public class XmppDecoder extends CumulativeProtocolDecoder { //协议解码
public class XmppEncoder implements ProtocolEncoder { //协议编码

5.org.androidpn.server.xmpp.handler包主要是对消息的处理，我们可以针对不同的消息类型定义自己的handler。

public class IQAuthHandler extends IQHandler { //认证协议接口

public abstract class IQHandler { //抽象类，处理路由包
public class IQRegisterHandler extends IQHandler { //处理注册协议
public class IQRosterHandler extends IQHandler {
public class PresenceUpdateHandler { //处理协议

6.org.androidpn.server.xmpp.net包负责维护与client之间的持久连接，并实现了一些传输方式供发送xmpp消息时使用。

public class Connection { //一个XMPP连接服务器的实例
public interface ConnectionCloseListener { // 连接关闭监听
public class IoBufferWriter extends Writer { //输入输出处理
public class StanzaHandler { //处理传入的XML节
public class XmppIoHandler implements IoHandler { //创建新的会话，销毁会话，并提供接收XML节

7.org.androidpn.server.xmpp.presence里面只包含PresenceManager类，用来维护client的在线状态。

public class PresenceManager { //管理用户

8.org.androidpn.server.xmpp.push包里面的NotificationManager类包含有向client发送消息的接口。

public class NotificationManager { //管理用户发送notifcations

9.org.androidpn.server.xmpp.router包负责将收到的信息包发送到相应的handler进行处理，是一个路由包。

public class IQRouter { //IQ数据包路由到其相应的处理
public class MessageRouter { //路由信息包到其相应的处理程序
public class PacketDeliverer { //包发送到连接的会话
public class PacketRouter { //处理传入的数据包，并将它们路由到其相应的处理程序
public class PresenceRouter { //数据包路由

10.org.androidpn.server.xmpp.session包定义了用来表示持久链接的session，每个session包含一条连接的状态信息。

public class ClientSession extends Session {  //一个会话（服务端和客户端）
public abstract class Session { //会话抽象（服务端和客户端）
public class SessionManager { //会话管理

11.org.androidpn.server.xmpp.ssl是对连接进行ssl认证的工具包。

public class SSLConfig {  //ssl配置
public class SSLKeyManagerFactory { //负责产生ssl管理 实例
public class SSLTrustManagerFactory { //SSL信任管理器工厂类

12.org.androidpn.server.container  是对用户管理包

public class AdminConsole {配置端口上启动一个实例并加载管理控制台Web应用程序

13.org.androidpn.server.dao 数据库包

public interface UserDao { //用户数据库接口

14.org.androidpn.server.dao.hibernate   对象关系映射框架

public class UserDaoHibernate extends HibernateDaoSupport implements UserDao { //使用Spring的Hibernate模块

15.org.androidpn.server.model  对象模式

public class User implements Serializable {  //封装了用户类

16.org.androidpn.server.service 提供用户操作以及异常处理

public class ServiceLocator { //查找服务对象
public class UserExistsException extends Exception {//如果用户在保存过程中发生违反唯一约束。
public class UserNotFoundException extends Exception { //用户无法加载
public interface UserService { //用户服务管理接口

17.org.androidpn.server.service.impl 提供用户服务接口

public class UserServiceImpl implements UserService { //用户服务接口

18.org.dom4j.io 输出输入流工具包

public class XMPPPacketReader { //读取dom4j文档

19.org.jivesoftware.openfire.net 

public class MXParser extends org.xmlpull.mxp1.MXParser { //解析器验证文件

20.org.jivesoftware.openfire.nio

public class XMLLightweightParser { //一个轻量级的XML解析器

21.org.jivesoftware.util

public class PropertyEventDispatcher { //事件调配
public interface PropertyEventListener { //事件监听
public class XMLWriter extends XMLFilterImpl implements LexicalHandler { //xml编辑

服务端搭建：点击bin目录下得run.bat，直接搭好服务，在浏览器上输入 http://127.0.0.1:7070  就进入管理界面。
server发送消息的整个流程主要是：
1. NotificationManager的push接口被调用。2.使用SessionManager在当前session集合中查找相应的client链接。3.定义自己的XMPP消息格式并组装。4.通过相应session，向client发送消息。在这个流程中我们需要修改的是步骤3，也就是需要定义和组装自己的xmpp消息，以便于将适当的信息传到客户端并便于客户端解析。一个简单的消息组装例子如下：

private IQ createMessageIQ(String title, String message, String userId,
            String json) {
        Element notification = DocumentHelper.createElement(QName.get(
                "message", INQURIE_NAMESPACE));
        notification.addElement("title").setText(title);
        notification.addElement("text").setText(message);
        notification.addElement("userId").setText(userId);
        notification.addElement("json").setText(json);
        IQ iq = new IQ();
        iq.setType(IQ.Type.set);
        iq.setChildElement(notification);
        return iq;
    }

要注意的是在创建element的时候，传入的namespace要和client解析使用的namespace相匹配。

server端接收和处理消息的流程是：
1.connection收到packet，使用tsc.push.server.xmpp.codec解码。
2.router根据packet的namespace等信息，将packet路由到相应的handler。
3.handler进行处理。
相应的router和handler类在androidpn中都有例子可以参考，这里就不贴代码了。开发中只要根据client发送消息的格式，定义自己的router和handler类，然后在PacketRouter中注册router，在IQRouter中注册handler即可。
Client部分的主要包结构如下：
Client这边包含有消息的收发，解析以及持久连接的发起，重连等功能呢，十分强大，我们开发时完全不用管底层的连接，也不用担心断线，可以专注于业务部分的开发。
同时，代码结构也很简单。去除android的Service和BroadCast类以及一些工具类和常量类不谈：
1.NotificationIQ,NotificationIQProvider,NotificationPacketListener三个类负责对收到的Notification格式的消息进行解析和处理，
2.XmppManager是主控制器，NotificationService通过这个类，在后台维护androidpn连接。
3.PersistentConnectionListener，PhoneStateChangeListener，ReconnectionThread.java三个类则负责监听手机的状态并进行断线重连。
我们自定义消息时需要定义3个类：在***IQ中定义消息的实体，在***IQProvider中将消息转化为***IQ实体，在***PacketListener中对实体进行处理，具体的实现可参考NotificationIQ,NotificationIQProvider,NotificationPacketListener三个类。在定义这些类之后，还需要在XmppManager中将这3个类中注册到connection中，代码如下：

connection.connect();Log.i(LOGTAG, "XMPP connected successfully");
ProviderManager.getInstance().addIQProvider("message",Constants.NOTIFICATION_NAMESPACE,new NotificationIQProvider());
 
                 PacketFilter packetFilter = new PacketTypeFilter(
                            NotificationIQ.class);
                    // packet listener
                    PacketListener packetListener = xmppManager
                            .getNotificationPacketListener();
                    connection.addPacketListener(packetListener, packetFilter);

需要注意的是，注册***IQProvider时，传入的namespace需要和服务端组装消息时使用的namespace一致，才能正确的收到。
学习的目标是成熟！
项目源码以及相关文档下载