Skip to content

Latest commit

 

History

History
445 lines (373 loc) · 17 KB

LeanCloud红包集成文档.md

File metadata and controls

445 lines (373 loc) · 17 KB

LeanCloud红包集成文档

1. redpacketlibrary-aar简介

redpacketlibrary-aar，在LeanCloud SDK 的基础上提供了收发红包和零钱页的功能。

2. 红包相关文件说明

  • libs ：包含了红包所需要的jar包。

    • alipaySdk-20160516支付宝支付
    • glide-3.6.1图片加载库
    • volley-1.0.19请求框架

  • res ：包含了红包SDK和聊天页面中的资源文件。（红包SDK相关以lc_开头）

  • redpacket ：此包包含红包发送接收的工具类

    • GetSignInfoCallback 获取签名接口回调
    • GetGroupMemberCallback 获取群里面的人数（app开发者需要自己处理）的接口回调。
    • GetUserInfoCallback 根据用户id获取用户信息接口回调（打开专属红包所需，回调可以根据需要自己处理）
    • RedPacketUtils 发送打开红包相关的工具类

  • message ：

    • LCIMRedPacketMessage 自定义红包消息
    • LCIMRedPcketAckMessage 自定义通知消息，用于领取了红包之后，回执消息发给红包者。 用于群/个人领取了红包之后，1、接受者先向本地插入一条“你领取了XX的红包”，然后发送一条空消息（不在聊天界面展示），发送红包者收到消息之后，向本地插入一条“XX领取了你的红包”，2、如果接受者和发送者是一个人就直接向本地插入一条“你领取了自己的红包”
    • InputRedPacketClickEvent 红包按钮点击事件

  • viewholder ：

    • ChatItemRedPacketHolder 红包消息处理机制
    • ChatItemRedPacketAckHolder 回执消息UI展示提供者
    • ChatItemRedPacketEmptyHolder 空消息用于隐藏和自己不相关的消息

    注意: redpacketlibrary-aar只支持AndroidStudio。

    注意: 拆红包添加音效，需要在assets中引入open_packet_sound.mp3(文件名必须为此名，暂时支持mp3和wav格式)。

3. 集成步骤

###3.1 添加对红包工程的依赖

  • leanchat-android的build.gradle中
    compile files('libs/alipaySdk-20160516.jar')
    compile files('libs/glide-3.6.1.jar')
    compile files('libs/volley-1.0.19.jar')
    compile project(':redpacketlibrary-aar')// 红包sdk
  • leanchat-android的setting.gradle中
    include ':leanchat', ':redpacketlibrary-aar'

3.2 leanchat-android清单文件中注册红包相关组件

    <uses-sdk
        android:minSdkVersion="15"/>
 
    <!--红包相关界面 start-->
    <activity
            android:name="com.yunzhanghu.redpacketui.ui.activity.RPRedPacketActivity"
            android:screenOrientation="portrait"
            android:windowSoftInputMode="adjustPan|stateVisible" />
    <activity
            android:name="com.yunzhanghu.redpacketui.ui.activity.RPDetailActivity"
            android:screenOrientation="portrait"
            android:windowSoftInputMode="adjustPan" />

    <activity
            android:name="com.yunzhanghu.redpacketui.ui.activity.RPRecordActivity"
            android:screenOrientation="portrait"
            android:windowSoftInputMode="adjustPan" />

    <activity
            android:name="com.yunzhanghu.redpacketui.ui.activity.RPWebViewActivity"
            android:screenOrientation="portrait"
            android:windowSoftInputMode="adjustResize|stateHidden" />
    <activity
            android:name="com.yunzhanghu.redpacketui.ui.activity.RPChangeActivity"
            android:configChanges="orientation|keyboardHidden|screenSize"
            android:screenOrientation="portrait"
            android:windowSoftInputMode="adjustResize|stateHidden" />
    <activity
            android:name="com.yunzhanghu.redpacketui.ui.activity.RPBankCardActivity"
            android:screenOrientation="portrait"
            android:windowSoftInputMode="adjustPan|stateHidden" />
    <activity
            android:name="com.yunzhanghu.redpacketui.ui.activity.RPGroupMemberActivity"
            android:screenOrientation="portrait"
            android:windowSoftInputMode="adjustPan|stateHidden" />
    <activity
            android:name="com.alipay.sdk.app.H5PayActivity"
            android:configChanges="orientation|keyboardHidden|navigation|screenSize"
            android:exported="false"
            android:screenOrientation="behind"
            android:windowSoftInputMode="adjustResize|stateHidden" />
     <!-- 转账页面 -->
     <activity
            android:name="com.yunzhanghu.redpacketui.ui.activity.RPTransferActivity"
            android:screenOrientation="portrait"
            android:theme="@style/horizontal_slide"
            android:windowSoftInputMode="adjustPan|stateVisible"/>
      <!-- 转账详情页面 -->
      <activity
            android:name="com.yunzhanghu.redpacketui.ui.activity.RPTransferDetailActivity"
            android:screenOrientation="portrait"
            android:theme="@style/horizontal_slide"
            android:windowSoftInputMode="adjustPan|stateHidden"/>
    <!--红包相关界面 end-->

3.3 初始化红包上下文

  • App中初始化红包上下文。
    import com.yunzhanghu.redpacketsdk.RedPacket;
    import com.yunzhanghu.redpacketui.RedPacketUtil;
    
    @Override
    public void onCreate() {
        // 初始化红包操作
        RedPacket.getInstance().initContext(ctx);
        // 控制红包SDK中Log打印
        RedPacket.getInstance().setDebugMode(true);
      	// 注册红包相关消息
        AVIMMessageManager.registerAVIMMessageType(LCIMRedPacketMessage.class);
        AVIMMessageManager.registerAVIMMessageType(LCIMRedPacketAckMessage.class);
        AVIMMessageManager.registerAVIMMessageType(LCIMTransferMessage.class);
    }

3.4 初始化红包Token和用户信息

  • MainActivity获取个人信息成功后请求签名（同步群组信息成功之后）并初始化红包token
    import com.yunzhanghu.redpacketui.RedPacketUtil;    

    RedPacketUtils.getInstance().setRefreshSign(MainActivity.this,mockUrl);

    注意:当商户接的时候，需要自己开发该接口，接口格式可以去官网查看(yunzhanghu.com)；Demo里给的是测试接口

3.5 ProfileFragment添加零钱页的入口

  • 在需要添加零钱的页面调用下面的方法
    RPChangeActivity（零钱页面），跳转到零钱页面需要用户头像(userAcatar)和用户名(userName)。具体的形式在RedPacketUtils的toChangeActivity方法中有展示。
      
   public void toChangeActivity(Context mContext,String userName,String userAvatar) {               
      Intent intent = new Intent(mContext, RPChangeActivity.class);  
      RedPacketInfo redPacketInfo = new RedPacketInfo();
      redPacketInfo.fromNickName = userName;
      redPacketInfo.fromAvatarUrl = userAvatar;
      intent.putExtra(RPConstant.EXTRA_RED_PACKET_INFO, redPacketInfo);
      intent.putExtra(RPConstant.EXTRA_TOKEN_DATA, getTokenData());
      mContext.startActivity(intent);
    }

4. 关于群、单聊红包的释义

4.1 ConversationFragment中、在扩展栏中增加红包按钮

  • 增加按钮的方法参考addRedPacketView

  • 添加单聊红包入口

单聊发红包页面RPRedPacketActivity（chatType为1），需要参数有发送人头像，发送人的用户名，单聊的chatType值，接收者id。
实例如下所示

    private void gotoSingleRedPacket(final String peerId) {
        int chatType = RPConstant.CHATTYPE_SINGLE;
        int membersNum = 0;
        String tpGroupId = "";
        String selfName = LeanchatUser.getCurrentUser().getUsername();
        String selfAvatar = LeanchatUser.getCurrentUser().getAvatarUrl();
        RedPacketUtils.selectRedPacket(ConversationFragment.this, peerId,  
        selfName, selfAvatar, chatType, tpGroupId, membersNum,  
        REQUEST_CODE_SEND_RED_PACKET);
    }
  • 添加群聊红包入口
群聊发红包页面为RPRedPacketActivity（chatType为2），需要参数有发送人头像，发送人的用户名，chatType值，群id,群成员数量。
实例如下所示：

    private void gotoGroupRedPacket() {
      final String fromNickname =  
                   LeanchatUser.getCurrentUser().getUsername();
      final String fromAvatarUrl =        
                   LeanchatUser.getCurrentUser().getAvatarUrl();
      final String toUserId = LeanchatUser.getCurrentUserId();
    /**
     * 发送专属红包用的,获取群组成员
     */
    RedPacketUtils.getInstance().initRpGroupMember(imConversation.getMembers(), new                                              
                                                   GetGroupMemberCallback() {
       @Override
       public void groupInfoSuccess(final List<RPUserBean> rpUserList) {
        /**
         * 获取群成员消息成功调用
         */
         RPGroupMemberUtil.getInstance().setGroupMemberListener(new                                                                                                                   
                                                       NotifyGroupMemberCallback() {
           @Override
           public void getGroupMember(String s, GroupMemberCallback callback) {
              callback.setGroupMember(rpUserList);
            }
          });
        }

        @Override
        public void groupInfoError() {

        }
      });
    imConversation.getMemberCount(new AVIMConversationMemberCountCallback() {
        @Override
        public void done(Integer integer, AVIMException e) {
          int chatType = RPConstant.CHATTYPE_GROUP;
          String tpGroupId = imConversation.getConversationId();
          int membersNum = integer;
          RedPacketUtils.selectRedPacket(ConversationFragment.this,       
          toUserId, fromNickname, fromAvatarUrl, chatType, tpGroupId,    
          membersNum, REQUEST_CODE_SEND_RED_PACKET);
        }
      });
    }
  • 发送红包之后数据展示
    @Override
    public void onActivityResult(int requestCode, int resultCode, Intent data) {
      super.onActivityResult(requestCode, resultCode, data);
      if (Activity.RESULT_OK == resultCode) {
        switch (requestCode) {
          case REQUEST_CODE_SEND_RED_PACKET:
            processReadPack(data);
            break；
        }
      }
    }

    /**
     * 发送红包之后设置红包消息的数据
     * @param data
     */
    private void processReadPack(Intent data) {
      if (data != null) {
        String greetings = data.getStringExtra(RPConstant.EXTRA_RED_PACKET_GREETING);
        String redPacketId = data.getStringExtra(RPConstant.EXTRA_RED_PACKET_ID);
        String sponsorName = getResources().getString(R.string.leancloud_luckymoney);
        // 群红包类型
        String redPacketType = data.getStringExtra(RPConstant.EXTRA_RED_PACKET_TYPE);
        // 专属红包接收者ID
        String revId = data.getStringExtra(RPConstant.EXTRA_RED_PACKET_RECEIVER_ID);
        LCIMRedPacketMessage redPacketMessage = new LCIMRedPacketMessage();
        redPacketMessage.setGreeting(greetings);
        redPacketMessage.setReadPacketId(redPacketId);
        redPacketMessage.setSponsorName(sponsorName);
        redPacketMessage.setRedPacketType(redPacketType);
        redPacketMessage.setReceiverId(revId);
        sendMessage(redPacketMessage);
      }
    }

4.2 ChatItemRedPacketHolder中打开红包消息和回执消息处理

  • 接受红包消息打开红包
打开红包需要调用RPOpenPacketUtil.getInstance().openRedPacket()方法，需要传的参数为用户名(selfName)，头像(selfAvatar)，是发送者还是接收者(moneyMsgDirect)，是单聊还是群聊(chatType)；是专属红包需要再多加3个字段，接收者的用户名(specialNickname)和头像(specialAvatarUrl)，以及发送者的id(toUserId)。
实例如下：

   /**
  * Method name:openRedPacket
  * Describe: 打开红包
  * Remarks：
  */
  private void openRedPacket(final Context context, final LCIMRedPacketMessage message) {
    final ProgressDialog progressDialog = new ProgressDialog(context);
    progressDialog.setCanceledOnTouchOutside(false);

    final String selfName = LeanchatUser.getCurrentUser().getUsername();
    String selfAvatar = LeanchatUser.getCurrentUser().getAvatarUrl();
    final String selfId = LeanchatUser.getCurrentUserId();
    String moneyMsgDirect; /*判断发送还是接收*/
    if (message.getFrom() != null && message.getFrom().equals(selfId)) {
      moneyMsgDirect = RedPacketUtils.MESSAGE_DIRECT_SEND;
    } else {
      moneyMsgDirect = RedPacketUtils.MESSAGE_DIRECT_RECEIVE;
    }
    int chatType;
    if (!TextUtils.isEmpty(message.getRedPacketType())) {
      chatType = RPConstant.CHATTYPE_GROUP;
    } else {
      chatType = RPConstant.CHATTYPE_SINGLE;
    }

    final RedPacketInfo redPacketInfo = RedPacketUtils.initRedPacketInfo_received(
      selfName, selfAvatar, moneyMsgDirect, chatType, message.getReadPacketId());
    if (null != rpUserBean) {
      /**
       * 打开专属红包需要多传一下的参数
       */
      redPacketInfo.specialNickname = rpUserBean.userNickname;
      redPacketInfo.specialAvatarUrl = rpUserBean.userAvatar;
      redPacketInfo.toUserId=selfId;
    }
    RPOpenPacketUtil.getInstance().openRedPacket(redPacketInfo,
      RedPacketUtils.getInstance().getTokenData(),
      (FragmentActivity) context,
      new RPOpenPacketUtil.RPOpenPacketCallBack() {
        @Override
        public void onSuccess(String senderId, String senderNickname) {
        
          RedPacketUtils.getInstance().sendRedPacketAckMsg(senderId, senderNickname,         selfId, selfName, message);           
        }

        @Override
        public void showLoading() {
          progressDialog.show();
        }

        @Override
        public void hideLoading() {
          progressDialog.dismiss();
        }

        @Override
        public void onError(String code, String message) { /*错误处理*/
          Toast.makeText(context, message, Toast.LENGTH_SHORT).show();
        }
      });
  }
  • 接受红包消息之后会话列表回执消息的处理 LCIMRedPcketAckMessage
  @Override
  public String getShorthand() {
    String userId=LeanchatUser.getCurrentUserId();
    if (userId.equals(senderId)&&userId.equals(recipientId)){
      return "你领取了自己的红包";
    }else if (userId.equals(senderId)&&!userId.equals(recipientId)){
      return recipientName+"领取了你的红包";
    }else if (!userId.equals(senderId)&&userId.equals(recipientId)){
      return "你领取了"+senderName+"的红包";
    }else if (!userId.equals(senderId)&&!userId.equals(recipientId)){
      if (senderId.equals(recipientId)){
        return recipientName+"领取了自己的红包";
      }else {
        return recipientName+"领取了"+senderName+"的红包";
      }
    }
    return null;
  }
  • 接受红包消息之后会话详情回执消息的处理ChatItemRedPacketAckHolder
   /**
   * @param senderName    红包发送者名字
   * @param recipientName 红包接收者名字
   * @param isSelf        是不是自己领取了自己的红包
   * @param isSend        消息是不是自己发送的
   * @param isSingle      是单聊还是群聊
   */
    private void initRedPacketAckChatItem(String senderName, String   
          recipientName, boolean isSelf, boolean isSend, boolean     
          isSingle) {
      if (isSend) {
        if (!isSingle) {
          if (isSelf) {
            contentView.setText(R.string.money_msg_take_money);
          } else {           
             contentView.setText(String.format(getContext().           
             getResources().
             getString(R.string.money_msg_take_someone_money),     
             senderName));
          }
        } else {
             contentView.setText(String.format(getContext().
             getResources().
             getString(R.string.money_msg_take_someone_money),  
             senderName));
        }
      } else {
        if (isSelf) {
             contentView.setText(String.format(getContext().
             getResources().
             getString(R.string.money_msg_someone_take_money),     
             recipientName));
        } else {
             contentView.setText(String.format(getContext().
             getResources().
             getString(R.string.money_msg_someone_take_money_same),    
             recipientName, senderName));
        }
      }
    }

4.3 ChatAdapter中处理红包消息

   /**
   * 判断是什么消息类型
   */

  @Override
  public int getItemViewType(int position) {
    AVIMMessage message = messageList.get(position);
    if (null != message && message instanceof AVIMTypedMessage) {
      AVIMTypedMessage typedMessage = (AVIMTypedMessage) message;
      boolean isMe = fromMe(typedMessage);
      if (typedMessage.getMessageType() == LCIMRedPacketMessage.RED_PACKET_MESSAGE_TYPE) {
        return isMe ? ITEM_RIGHT_TEXT_RED_PACKET : ITEM_LEFT_TEXT_RED_PACKET;
      } else if (typedMessage.getMessageType() ==       LCIMRedPacketAckMessage.RED_PACKET_ACK_MESSAGE_TYPE) {
       return      RedPacketUtils.getInstance().receiveRedPacketAckMsg((LCIMRedPacketAckMessage) typedMessage,ITEM_TEXT_RED_PACKET_NOTIFY,ITEM_TEXT_RED_PACKET_NOTIFY_MEMBER);
      }
    }
    return super.getItemViewType(position);
  }