Android XMPP通讯自定义Packet&Provider

2024-12-02 16:47:16

摘要

在xmpp通信过程中，asmack中提供的Packet组件是IQ,Message,Presence三种： IQ用于查询 Message用于消息传递 Presence用于状态交互他们都是Packet的子类，实质是用于将消息封装成响应的xml格式来进行数据交换，都有着良好的可扩展性。

简介

我们以开源项目androidpn为例：

androidpn (Android Push Notification)是一个基于XMPP协议的java开源Android push notification实现。它包含了完整的客户端和服务器端。

androidpn包括Server端和Client端，项目名称是androidpn-server和androidpn-client。

事实上，androidpn-server可以支持app运行于iOS，UWP，Windows，Linux等平台，不仅限于android，因此，希望项目的名称改为XPN(Xmpp Push Notification)似乎更加符合其实际场景，我们以后涉及到Android Push Notification统称为XPN。

XNP目前状态

项目自2014年1月就已经停止更新了，此外，asmack项目也停止更新了，作者建议使用openfire官方的smack4.0，不过这样的话引入的jar会特别多，特别大。当然，我们下载到了asmack8.10.0比较新的稳定版本，可以完全用于学习和扩展。

项目相关下载站点

asmack-github.com- asmack项目地址

asmack-asmack.freakempire.de - asmack镜像地址

androidpn(XPN)-github.com - androidpn下载地址

一.关于Packet数据包

Packet是IQ,Message,Presence的父类，用于实现消息组件类型。

消息语义学message

message是一种基本推送消息方法，它不要求响应。主要用于IM、groupChat、alert和notification之类的应用中。
主要属性如下：

type属性，它主要有5种类型：
        normal：类似于email，主要特点是不要求响应；
        chat：类似于qq里的好友即时聊天，主要特点是实时通讯；
        groupchat：类似于聊天室里的群聊；
        headline：用于发送alert和notification；
        error：如果发送message出错，发现错误的实体会用这个类别来通知发送者出错了；

to属性：标识消息的接收方。

from属性：指发送方的名字或标示。为防止地址外泄，这个地址通常由发送者的server填写，而不是发送者。
载荷（payload）：例如body，subject

<message to="lily@jabber.org/contact"
 type="chat" >
  <body> 你好，在忙吗</body>
</message>

出席信息语义学presence

presence用来表明用户的状态，如：online、away、dnd(请勿打扰)等。当改变自己的状态时，就会在stream的上下文中插入一个Presence元素，来表明自身的状态。要想接受presence消息，必须经过一个叫做presence subscription的授权过程。
属性：

type属性，非必须。有以下类别
    subscribe：订阅其他用户的状态
    probe：请求获取其他用户的状态
    unavailable：不可用，离线（offline）状态

to属性：标识消息的接收方。

from属性：指发送方的名字或标示。

载荷（payload）：
    show：
    chat：聊天中
    away：暂时离开
    xa：eXtend Away，长时间离开
    dnd：勿打扰
status：格式自由，可阅读的文本。也叫做rich presence或者extended presence，常用来表示用户当前心情，活动，听的歌曲，看的视频，所在的聊天室，访问的网页，玩的游戏等等。
priority：范围-128~127。高优先级的resource能接受发送到bare JID的消息，低优先级的resource不能。优先级为
<presence from="alice@wonderland.lit/pda">
<show>xa</show>
<status>down the rabbit hole!</status>
</presence>

IQ语义学

一种请求／响应机制，从一个实体从发送请求，另外一个实体接受请求，并进行响应。例如，client在stream的上下文中插入一个元素，向Server请求得到自己的好友列表，Server返回一个，里面是请求的结果。
主要的属性是type。包括:
    Get :获取当前域值。类似于http get方法。
    Set :设置或替换get查询的值。类似于http put方法。
    Result :说明成功的响应了先前的查询。类似于http状态码200。
    Error: 查询和响应中出现的错误。
<iq from="alice@wonderland.lit/pda"
    id="rr82a1z7"
    to="alice@wonderland.lit"
    type="get">
<query xmlns="jabber:iq:roster"/>
</iq>

二.自定义Packet

由于服务器和客户端使用的Packet不同，但是他们交互的数据格式都是xml，因此，这个过程我们理解xml实现过程即可。

1.定义Packet封装对象

由于asmack标签解析的限制，我们不能自定义解析，除非修改源码，这里出于简单，这里只能继承现有标签之一。

我么按照项目代码NotificationIQ为例，这里没有继承Packet，而是继承了IQ

import org.jivesoftware.smack.packet.IQ;
/**
 * This class represents a notifcatin IQ packet.
 *
 * @author Sehwan Noh (devnoh@gmail.com)
 */
public class NotificationIQ extends IQ {
  private String id;
  private String apiKey;
  private String title;
  private String message;
  private String uri;
  public NotificationIQ() {
  }
  @Override
  public String getChildElementXML() {
    StringBuilder buf = new StringBuilder();
    buf.append("<").append("notification").append(" xmlns=\"").append(
        "androidpn:iq:notification").append("\">");
    if (id != null) {
      buf.append("<id>").append(id).append("</id>");
    }
    buf.append("</").append("notification").append("> ");
    return buf.toString();
  }
  public String getId() {
    return id;
  }
  public void setId(String id) {
    this.id = id;
  }
  public String getApiKey() {
    return apiKey;
  }
  public void setApiKey(String apiKey) {
    this.apiKey = apiKey;
  }
  public String getTitle() {
    return title;
  }
  public void setTitle(String title) {
    this.title = title;
  }
  public String getMessage() {
    return message;
  }
  public void setMessage(String message) {
    this.message = message;
  }
  public String getUri() {
    return uri;
  }
  public void setUri(String url) {
    this.uri = url;
  }
}

其中，getChildElementXml()是IQ的子类，用来拼接成<iq>下的直接点。

public abstract class IQ extends Packet {
  private Type type = Type.GET;
  public IQ() {
    super();
  }
  public IQ(IQ iq) {
    super(iq);
    type = iq.getType();
  }
  /**
   * Returns the type of the IQ packet.
   *
   * @return the type of the IQ packet.
   */
  public Type getType() {
    return type;
  }
  /**
   * Sets the type of the IQ packet.
   *
   * @param type the type of the IQ packet.
   */
  public void setType(Type type) {
    if (type == null) {
      this.type = Type.GET;
    }
    else {
      this.type = type;
    }
  }
  public String toXML() {
    StringBuilder buf = new StringBuilder();
    buf.append("<iq ");
    if (getPacketID() != null) {
      buf.append("id=\"" + getPacketID() + "\" ");
    }
    if (getTo() != null) {
      buf.append("to=\"").append(StringUtils.escapeForXML(getTo())).append("\" ");
    }
    if (getFrom() != null) {
      buf.append("from=\"").append(StringUtils.escapeForXML(getFrom())).append("\" ");
    }
    if (type == null) {
      buf.append("type=\"get\">");
    }
    else {
      buf.append("type=\"").append(getType()).append("\">");
    }
    // Add the query section if there is one.
    String queryXML = getChildElementXML();
    if (queryXML != null) {
      buf.append(queryXML);
    }
    // Add the error sub-packet, if there is one.
    XMPPError error = getError();
    if (error != null) {
      buf.append(error.toXML());
    }
    buf.append("</iq>");
    return buf.toString();
  }
  /**
   * Returns the sub-element XML section of the IQ packet, or <tt>null</tt> if there
   * isn't one. Packet extensions <b>must</b> be included, if any are defined.<p>
   *
   * Extensions of this class must override this method.
   *
   * @return the child element section of the IQ XML.
   */
  public abstract String getChildElementXML();
  /**
   * Convenience method to create a new empty {@link Type#RESULT IQ.Type.RESULT}
   * IQ based on a {@link Type#GET IQ.Type.GET} or {@link Type#SET IQ.Type.SET}
   * IQ. The new packet will be initialized with:<ul>
   *   <li>The sender set to the recipient of the originating IQ.
   *   <li>The recipient set to the sender of the originating IQ.
   *   <li>The type set to {@link Type#RESULT IQ.Type.RESULT}.
   *   <li>The id set to the id of the originating IQ.
   *   <li>No child element of the IQ element.
   * </ul>
   *
   * @param iq the {@link Type#GET IQ.Type.GET} or {@link Type#SET IQ.Type.SET} IQ packet.
   * @throws IllegalArgumentException if the IQ packet does not have a type of
   *   {@link Type#GET IQ.Type.GET} or {@link Type#SET IQ.Type.SET}.
   * @return a new {@link Type#RESULT IQ.Type.RESULT} IQ based on the originating IQ.
   */
  public static IQ createResultIQ(final IQ request) {
    if (!(request.getType() == Type.GET || request.getType() == Type.SET)) {
      throw new IllegalArgumentException(
          "IQ must be of type 'set' or 'get'. Original IQ: " + request.toXML());
    }
    final IQ result = new IQ() {
      public String getChildElementXML() {
        return null;
      }
    };
    result.setType(Type.RESULT);
    result.setPacketID(request.getPacketID());
    result.setFrom(request.getTo());
    result.setTo(request.getFrom());
    return result;
  }
  /**
   * Convenience method to create a new {@link Type#ERROR IQ.Type.ERROR} IQ
   * based on a {@link Type#GET IQ.Type.GET} or {@link Type#SET IQ.Type.SET}
   * IQ. The new packet will be initialized with:<ul>
   *   <li>The sender set to the recipient of the originating IQ.
   *   <li>The recipient set to the sender of the originating IQ.
   *   <li>The type set to {@link Type#ERROR IQ.Type.ERROR}.
   *   <li>The id set to the id of the originating IQ.
   *   <li>The child element contained in the associated originating IQ.
   *   <li>The provided {@link XMPPError XMPPError}.
   * </ul>
   *
   * @param iq the {@link Type#GET IQ.Type.GET} or {@link Type#SET IQ.Type.SET} IQ packet.
   * @param error the error to associate with the created IQ packet.
   * @throws IllegalArgumentException if the IQ packet does not have a type of
   *   {@link Type#GET IQ.Type.GET} or {@link Type#SET IQ.Type.SET}.
   * @return a new {@link Type#ERROR IQ.Type.ERROR} IQ based on the originating IQ.
   */
  public static IQ createErrorResponse(final IQ request, final XMPPError error) {
    if (!(request.getType() == Type.GET || request.getType() == Type.SET)) {
      throw new IllegalArgumentException(
          "IQ must be of type 'set' or 'get'. Original IQ: " + request.toXML());
    }
    final IQ result = new IQ() {
      public String getChildElementXML() {
        return request.getChildElementXML();
      }
    };
    result.setType(Type.ERROR);
    result.setPacketID(request.getPacketID());
    result.setFrom(request.getTo());
    result.setTo(request.getFrom());
    result.setError(error);
    return result;
  }
  /**
   * A class to represent the type of the IQ packet. The types are:
   *
   * <ul>
   *   <li>IQ.Type.GET
   *   <li>IQ.Type.SET
   *   <li>IQ.Type.RESULT
   *   <li>IQ.Type.ERROR
   * </ul>
   */
  public static class Type {
    public static final Type GET = new Type("get");
    public static final Type SET = new Type("set");
    public static final Type RESULT = new Type("result");
    public static final Type ERROR = new Type("error");
    /**
     * Converts a String into the corresponding types. Valid String values
     * that can be converted to types are: "get", "set", "result", and "error".
     *
     * @param type the String value to covert.
     * @return the corresponding Type.
     */
    public static Type fromString(String type) {
      if (type == null) {
        return null;
      }
      type = type.toLowerCase();
      if (GET.toString().equals(type)) {
        return GET;
      }
      else if (SET.toString().equals(type)) {
        return SET;
      }
      else if (ERROR.toString().equals(type)) {
        return ERROR;
      }
      else if (RESULT.toString().equals(type)) {
        return RESULT;
      }
      else {
        return null;
      }
    }
    private String value;
    private Type(String value) {
      this.value = value;
    }
    public String toString() {
      return value;
    }
  }
}

最终可生成如下结构的数据

<iq from="">
 <nofitication xlns="">
<iq>

我们在项目中的使用很简单

xmppManager.getConnection().sendPacket(<NotificationIQ>niq)

当然，上面只是实现了object->xml，接下来我们实现xml->data

2.实现IQProvider

先来看看IQProvider源码

public interface IQProvider {

  /**
   * Parse the IQ sub-document and create an IQ instance. Each IQ must have a
   * single child element. At the beginning of the method call, the xml parser
   * will be positioned at the opening tag of the IQ child element. At the end
   * of the method call, the parser <b>must</b> be positioned on the closing tag
   * of the child element.
   *
   * @param parser an XML parser.
   * @return a new IQ instance.
   * @throws Exception if an error occurs parsing the XML.
   */
  public IQ parseIQ(XmlPullParser parser) throws Exception;
}

实现自定义的解析工具

public class NotificationIQProvider implements IQProvider {
  public NotificationIQProvider() {
  }
  @Override
  public IQ parseIQ(XmlPullParser parser) throws Exception {
    NotificationIQ notification = new NotificationIQ();
    for (boolean done = false; !done;) {
      int eventType = parser.next();
      if (eventType == 2) {
        if ("id".equals(parser.getName())) {
          notification.setId(parser.nextText());
        }
        if ("apiKey".equals(parser.getName())) {
          notification.setApiKey(parser.nextText());
        }
        if ("title".equals(parser.getName())) {
          notification.setTitle(parser.nextText());
        }
        if ("message".equals(parser.getName())) {
          notification.setMessage(parser.nextText());
        }
        if ("uri".equals(parser.getName())) {
          notification.setUri(parser.nextText());
        }
      } else if (eventType == 3
          && "notification".equals(parser.getName())) {
        done = true;
      }
    }
    return notification;
  }
}

项目中使用方法

ProviderManager.getInstance().addIQProvider("notification",
              "androidpn:iq:notification",
              new NotificationIQProvider());

在asmack中PacketParserUtils类中会进行如下调用

 Object provider = ProviderManager.getInstance().getIQProvider(elementName, namespace);
          if (provider != null) {
            if (provider instanceof IQProvider) {
              iqPacket = ((IQProvider)provider).parseIQ(parser);
            }
            else if (provider instanceof Class) {
              iqPacket = (IQ)PacketParserUtils.parseWithIntrospection(elementName,
                  (Class<?>)provider, parser);
            }
          }

基于Android ContentProvider的总结详解

1.适用场景1) ContentProvider为存储和读取数据提供了统一的接口2) 使用ContentProvider,应用程序可以实现数据共享3) android内置的许多数据都是使用ContentProvider形式,供开发者调用的(如视频,音频,图片,通讯录等)2.相关概念介绍1)ContentProvider简介当应用继承ContentProvider类,并重写该类用于提供数据和存储数据的方法,就可以向其他应用共享其数据.虽然使用其他方法也可以对外共享数据,但数据访问方式会因数据存储的
基于Android AppWidgetProvider的使用介绍

AppWidgetProvider 用来在HOME页面显示插件实现步骤:1.为AppWidget提供一个元布局文件AppWigdetProvider_Provider.xml,用来显示Widget的界面.2.创建一个类继承自AppWidgetProvider,并覆写里面的相关的方法.3.为WidgetProvider创建一个引用的布局文件,或者直接用main.xml.4.在程序中注册Manifest.xml. 代码如下: 1.在res/xml/文件夹下创建AppWigdetProvider_P
Android中自定义ContentProvider实例

//以下为TestBaidu MainActivity如下: 复制代码代码如下: package cn.testbaidu; import android.net.Uri; import android.os.Bundle; import android.view.View; import android.view.View.OnClickListener; import android.widget.Button; import android.app.Activity; import an
浅谈Android Content Provider的使用

Content Provider:一个组件,必须放在应用的主包或应用的子包之下: 组件的配置需要在清单文件中进行配置:content provider需要在application节点中进行配置:内容提供者在应用中的作用是对外共享数据(任意类型的数据)使用的,别的程序可以对数据进行CRUD,如通讯录:如果采用文件的方式对外共享数据,会因为文件的类型不同而需要使用不同的api访问方式导致访问繁杂,而内容提供者提供了统一的api对数据进行操作:<provider android:name=".P
Android开发之ContentProvider的使用详解

前言 Content Provider为存储数据和获取数据提供了统一的接口,它可以完成在不同应用程序下的数据共享,而在上一篇文章Android开发之SQLite的使用方法讲到的SQLite只能在同一个程序中共享数据.另外android为一些常见的数据,比如说音频,视频,图片,通讯录等提供了Content Provider,这样我们就可以很方便的对这些类型的数据操作了.使用ContentProvider的好处是开发人员不需要考虑数据内部是怎么存储的,比如说如果我们想利用Conten
基于Android 监听ContentProvider 中数据变化的相关介绍

如果ContentProvider的访问者需要知道ContentProvider中的数据的变化情况,可以在ContentProvider发生数据变化时调用getContentResolver().notifyChange(uri,null)来通知注册在此URI上的访问者. 复制代码代码如下: public class PersonContentProvider extends ContentProvider[ public Uri insert(Uri uri,ContentValues va
Android XMPP通讯自定义Packet&Provider

摘要在xmpp通信过程中,asmack中提供的Packet组件是IQ,Message,Presence三种: IQ用于查询 Message用于消息传递 Presence用于状态交互他们都是Packet的子类,实质是用于将消息封装成响应的xml格式来进行数据交换,都有着良好的可扩展性. 简介我们以开源项目androidpn为例: androidpn (Android Push Notification)是一个基于XMPP协议的java开源Android push notification实现
Android即时通讯设计(腾讯IM接入和WebSocket接入)

目录一.前言二.腾讯IM接入 1.准备工作 2.初始化工作用户登录 3.群聊相关 4.消息收发相关三.WebSocket接入 1.WebSocket介绍 2.服务端相关 3.客户端相关四.列表设计的一些细节 1.handle的使用 2.消息的获取和RecycleView的刷新 3.关于消息item的设计细节五.项目使用的接口和地址六.总结一.前言之前项目的群聊是用数据库直接操作的,体验很差,消息很难即时反馈,所以最后考虑到了使用腾讯的IM完成群聊的接入,不过中途还是有点小坎坷的
Android开发使用自定义View将圆角矩形绘制在Canvas上的方法

本文实例讲述了Android开发使用自定义View将圆角矩形绘制在Canvas上的方法.分享给大家供大家参考,具体如下: 前几天,公司一个项目中,头像图片需要添加圆角,这样UI效果会更好看,于是写了一个小的demo进行圆角的定义,该处主要是使用BitmapShader进行了渲染(如果要将一张图片裁剪成椭圆或圆形显示在屏幕上,也可以使用BitmapShader来完成). BitmapShader类完成渲染图片的基本步骤如下: 1.创建BitmapShader类的对象 /** * Call this
Android开发框架之自定义ZXing二维码扫描界面并解决取景框拉伸问题

先给大家展示下效果图: 扫描内容是下面这张,二维码是用zxing库生成的由于改了好几个类,还是去年的事都忘得差不多了,所以只能上这个类的代码了,主要就是改了这个CaptureActivity.java package com.zxing.activity; import java.io.IOException; import java.util.Vector; import android.app.Activity; import android.content.Intent; import
Android编程实现自定义渐变颜色效果详解

本文实例讲述了Android编程实现自定义渐变颜色效果.分享给大家供大家参考,具体如下: 你是否已经厌恶了纯色的背景呢?那好,Android提供给程序员自定义渐变颜色的接口,让我们的界面炫起来吧. xml定义渐变颜色首先,你在drawable目录下写一个xml,代码如下 <?xml version="1.0" encoding="utf-8"?> <shape xmlns:android="http://schemas.android.
Android使用xml自定义图片实例详解

Android使用xml自定义图片实例详解实现效果图: 白色圆角图片 bg_round_rectangle_white.xml <?xml version="1.0" encoding="utf-8"?> <shape xmlns:android="http://schemas.android.com/apk/res/android" android:shape="rectangle"> <!-
Android编程实现自定义手势的方法详解

本文实例讲述了Android编程实现自定义手势的方法.分享给大家供大家参考,具体如下: 之前介绍过如何在Android程序中使用手势,主要是系统默认提供的几个手势,这次介绍一下如何自定义手势,以及如何对其进行管理. 先介绍一下Android系统对手势的管理,Android系统允许应用程序把用户的手势以文件的形式保存以前,以后要使用这些手势只需要加载这个手势库文件即可,同时Android系统还提供了诸如手势识别.查找及删除等的函数接口,具体如下: 一.加载手势库文件: staticGestureL
Android开发之自定义CheckBox

要实现的效果如下考虑到关键是动画效果,所以直接继承View.不过CheckBox的超类CompoundButton实现了Checkable接口,这一点值得借鉴. 下面记录一下遇到的问题,并从源码的角度解决. 问题一: 支持 wrap_content 由于是直接继承自View,wrap_content需要进行特殊处理. View measure流程的MeasureSpec: /** * A MeasureSpec encapsulates the layout requirements pass
Android 中okhttp自定义Interceptor（缓存拦截器）

Android 中okhttp自定义Interceptor(缓存拦截器) 前言: 新公司项目是没有缓存的,我的天,坑用户流量不是么.不知道有人就喜欢一个界面没事点来点去的么.怎么办?一个字"加". 由于项目的网络请求被我换成了retrofit.而retrofit的网络请求默认基于okhttp okhttp的缓存由返回的header 来决定.如果服务器支持缓存的话返回的headers里面会有这一句 "Cache-Control","max-age=time&
Android编程ProgressBar自定义样式之动画模式实现方法

本文实例讲述了Android编程ProgressBar自定义样式之动画模式实现方法.分享给大家供大家参考,具体如下: 忘记在哪里看到的那位仁兄写的,就是通过用动画效果来实现的,现在顺便也把他写出来,希望那位仁兄不要见怪. 效果: 和之前的一样,在布局文件中: <ProgressBar android:id="@+id/progressBar3" android:layout_width="wrap_content" android:layout_height=

Android XMPP通讯自定义Packet&Provider

相关推荐

随机推荐