UBT上报流程

总流程图

总流程图

流程说明：

• 如上图所示，UBT上报流程分为两种，左图为逐条上传，右图为多条合并上传。
• 两则的区别在于上报时机，逐条上传是及时上报；合并上传是本地缓存，延时上报。
• 建议PC、M站用逐条上传流程，App(包括内嵌H5)用合并上传流程。

流程解读：

• 全新的用户打开app/h5/pc页面时，向服务端提交部分客户端信息，服务端根据这些信息创建一个client，并返回clientId。

• 客户端拿到clientId需持久化到本地（PC/H5可以存cookie），后续UBT相关请求需要携带clientId。

• 以下为PC、M站的后续流程，用户行为发生时，即时上报，每次一条

  • 客户端发生需要记录的用户行为（如打开页面、点击按钮等）时，调用服务端API将用户行为发送到服务端，此时需携带clientId，如果本地存在sessionId（UBT专用，与用户登录的session不同，下文session均指UBT session），需要一同携带，如过没有sessionId可以不传。
  • 服务端收到上传用户行为的请求时，如果发现session已经存在且未过期，则更新session过期时间；如果session不存在或者已过期，则新建一个session。无论是否新建session，服务端都会将最新的sessionId和过期时间返回给客户端。
  • 客户端收到新的sessionId和过期时间后需保存或更新到本地，后续发送用户行为时携带。
  • 客户端如遇到上报失败时（如网络异常或者服务器宕机），可适当的进行重试。

• 以下为App(包括内嵌H5)的后续流程，用户行为发生时，本地暂存，延迟上报，每次批量上报

  • 本地记录用户行为前，判断本地是否有sessionId，如果没有调用接口新建session并保存sessionId。
  • 后续需要在session过期前定时刷新，保证用户打开app期间始终存在sessionId
  • 本地记录用户行为使用用户行为发生的时间和当时本地的sessionId，如果用户行为符合一定要求（如：超过100条或者超过1分钟未上报），则批量上报用户行为

• 用户上报失败，需要本地继续保留未成功上报的用户行为

事件上报流程图

事件上报流程

App端实现事件上报分为两部分，分别是事件缓存和事件上报，实现层通过两个子线程（Saver&Uploader）实现，核心代码如下：

UBTSaver.java

每秒去轮询一次，当无新消息产生的时候，会造成不必要的性能损耗。后续通过HandlerThread进行了优化。优化链接

    @Override
    public void run() {
        while (!mCloseFlag.get()) {
            UBTReqeustEventModel event = null;
            try {
                if (mVector.isEmpty()) {
                    if (!mValidVector.isEmpty()) {
                        //刷新session
                        refreshSession();
                    }
                    Thread.sleep(SLEEP_TIME);
                    continue;
                }
                event = mVector.poll();
                //处理无效session
                if (TextUtils.isEmpty(event.getSessionId())) {
                    mValidVector.add(event);
                    refreshSession();
                    continue;
                }
                //保存事件到数据库
                UBTEventDBManager.getInstance().insert(event);
                LogUtils.d(DRUBT.LOG_TAG + "保存成功一条数据");
            } catch (Exception e) {
                if (event != null) {
                    //发生异常将事件保存在重试队列中
                    mValidVector.add(event);
                }
                LogUtils.d(DRUBT.LOG_TAG + "保存事件发生异常：" + e.getMessage());
                e.printStackTrace();
            }
        }
    }

UBTUploader.java

    @Override
    public void run() {
        while (!mCloseFlag.get()) {
            try {
                Thread.sleep(SLEEP_TIME);
                List list = UBTEventDBManager.getInstance().findList(MAX_UPLOAD_SIZE);
                if (ArrayUtils.isEmptyList(list)) {
                    continue;
                }
                if (list.size() < MIN_UPLOAD_SIZE) {
                    waitUploadCount++;
                    if (SLEEP_TIME * waitUploadCount < MIN_UPLOAD_TIME) {
                        continue;
                    }
                    //休眠结束后重新拿一次数据上传
                    list = UBTEventDBManager.getInstance().findList(MAX_UPLOAD_SIZE);
                }
                uploadEvent(list);
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
    }