Android XMPP通信カスタムPackett&Provider


要約
xmpp通信において、asmackで提供されるPacketコンポーネントはIQ、Message、Prsenceの3つである。IQは、メッセージ伝達のためにMessageを照会するために使用される。状態インタラクションのために使用される。彼らはいずれもPacketのサブクラスであり、実質的には、メッセージを応答のためにカプセル化するためのxmlフォーマットであり、データ交換が良好な拡張性を有する。
概要
私たちはオープンソースプロジェクトのandroid pnを例にします。
Android Push Notificationは、XMPPプロトコルに基づくJavaオープンソースAndroid push notificationで実現されます。これは完全なクライアントとサーバ端末を含んでいます。
Android pnはServer端とClient端を含んでいます。プロジェクト名はandroid pn-serverとandroid pn-clientです。
実際には、Android Push Notificationと呼ばれる、Android Push Notificationに関連して、Android Push Notificationと呼ばれるようになります。
XNP現在の状態
プロジェクトは2014年1月から更新を中止しました。また、asmackプロジェクトも更新を中止しました。作者はオプンファイレ公式のsmak 4.0を使用することを提案していますが、このようにするとjarが特に多く、特に大きいです。もちろん、私たちはasmack 8.10.0の比較的新しい安定バージョンをダウンロードしました。学習と拡張に完全に使用できます。
プロジェクト関連のダウンロードサイト
asmack-github.com-asmackプロジェクトアドレス
asmack-asmack.freakemare.de-asmackミラーアドレス
android pn(XPN)-github.com-android pnダウンロードアドレス
一.Packetのパケットについて
Packetは、IQ、Message、Presenceの親クラスであり、メッセージ・コンポーネント・タイプを実現するために使用される。
メッセージ・スピーチ・メッセージ。
メッセージメッセージは、応答を要求しない基本的な送信方法である。主にIM、group Chat、alert、notificationなどの応用に用いられます。
主な属性は以下の通りです。
    type属性は主に5種類あります。
        normal:emailに似ています。主な特徴は応答を要求しないことです。
        chat:qqの友達と似ています。主な特徴はリアルタイム通信です。
        グループチャット:チャットルームでのグループトークのようなもの。
        headline:alertとnotificationを送信するために使用されます。
        error:メッセージ送信でエラーが発生したら、エラーを発見したエンティティはこのカテゴリで送信者にエラーを通知します。
ト属性:メッセージの受信者を識別する。
from属性:送信者の名前または表示を指します。アドレスの流出を防ぐために、このアドレスは送信者のserverで記入されます。送信者ではありません。
負荷(payload):例えば、body、subject

<message to="[email protected]/contact" 
 type="chat" > 
  <body>   ,   </body> 
</message>
情報語義学presenceに出席する
presenceはオンライン、away、dndなどのユーザーの状態を表します。自分の状態を変えると、streamのコンテキストにプリセット要素を挿入して、自分の状態を表現します。presenceメッセージを受け取るには、presence subscriptionという授権プロセスを経なければなりません。
属性:
type属性は、必須ではありません。以下の種類があります
    subscribe:他のユーザーの状態を購読します。
    probe:他のユーザの状態の取得を要求します。
    unavailable:利用できません。オフライン状態です。
ト属性:メッセージの受信者を識別する。
from属性:送信者の名前または表示を指します。
負荷(payload):
    ショー:
    チャット中
    away:しばらく出発します
    xa:eXted Away、長い間離れます。
    dnd:お邪魔しないでください
status:フォーマットは自由で、読めるテキストです。また、rich presenceまたはexteded presenceとも呼ばれ、ユーザーの現在の気持ち、活動、聴く曲、見るビデオ、あるチャットルーム、訪問するウェブページ、遊ぶゲームなどを表しています。
prority:範囲-128~127。高優先度のレスポンスは、bare JIDに送信されたメッセージを受け入れることができ、低優先度のレスポンスはできません。優先度は
<presence from=「[email protected]//pda」>
  xa
  down the rabbit hole!

IQ語義学
要求/応答機構は、あるエンティティから送信要求を受け、別のエンティティから要求を受けて応答する。例えば、clientはstreamのコンテキストに一つの要素を挿入し、Serverに自分の友達リストを得るように要求し、Serverは一つを返します。中には要求の結果があります。
主な属性はタイプです。含む:
    Get:現在のドメイン値を取得します。http get方法と似ています。
    Set:getクエリの値を設定または置換します。http put方法と似ています。
    Result:以前のクエリに応答したという説明に成功しました。http状態コード200と似ています。
    Err:クエリと応答にエラーが発生しました。
<iq from=「[email protected]//pda」 
    id=「R 82 a 1 z 7」
    ト=「[email protected]」 
    type=「get」>
 
二.カスタム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 ([email protected])
 */
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;
  }
}
このうち、get_Child_ElemenntXml()は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ではPacketPaserUtils類では以下のように呼びます。

 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);
            }
          }