UniApp 应用接入¶

|--datakit-uniapp-native-plugin
    |-- Hbuilder_Example                // GCUniPlugin 插件的示例工程
        |-- nativeplugins          // 示例工程的本地插件文件夹
            |-- GCUniPlugin           // ⭐️ GCUniPlugin 原生插件包 ⭐️
                |-- android              // 存放 android 插件所需要的依赖库及资源文件
                |-- ios                  // 存放 ios 插件所需要的依赖库及资源文件
                |-- package.json         // 插件配置文件
    |-- UniPlugin-Android           // 插件开发 Android 主工程 
    |-- UniPlugin-iOS                     // 插件开发 iOS 主工程 

    - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    ....
      //  注册 GCUniPlugin module
    [WXSDKEngine registerModule:@"GCUniPlugin-MobileAgent" withClass:NSClassFromString(@"FTMobileUniModule")];
    [WXSDKEngine registerModule:@"GCUniPlugin-RUM" withClass:NSClassFromString(@"FTRUMModule")];
    [WXSDKEngine registerModule:@"GCUniPlugin-Logger" withClass:NSClassFromString(@"FTLogModule")];
    [WXSDKEngine registerModule:@"GCUniPlugin-Tracer" withClass:NSClassFromString(@"FTTracerModule")];  
      return YES;
    }

  dependencies {
      implementation files('libs/ft-native-[version].aar')
      implementation files('libs/ft-sdk-[version].aar')
      implementation files('libs/gc-uniplugin-[last-version].aar')
      implementation 'com.google.code.gson:gson:2.8.5'
  }   

  public class App extends Application {
      @Override
      public void onCreate() {
          super.onCreate();
          try {
            //  注册 GCUniPlugin module
              WXSDKEngine.registerModule("GCUniPlugin-Logger", FTLogModule.class);
              WXSDKEngine.registerModule("GCUniPlugin-RUM", FTRUMModule.class);
              WXSDKEngine.registerModule("GCUniPlugin-Tracer", FTTracerModule.class);
              WXSDKEngine.registerModule("GCUniPlugin-MobileAgent", FTSDKUniModule.class);
          } catch (Exception e) {
              e.printStackTrace();
          }
          ......
      }
  }

// 在 App.vue 配置
<script>
    var guanceModule = uni.requireNativePlugin("GCUniPlugin-MobileAgent");
    export default {
        onLaunch: function() {
            console.log('App Launch')
            guanceModule.sdkConfig({
                'datakitUrl': 'your datakitUrl',
                'debug': true,
                'env': 'common',
                'globalContext': {
                    'custom_key': 'custom value'
                }
            })
        },
        onShow: function() {
            console.log('App Show')
        },
        onHide: function() {
            console.log('App Hide')
        }
    }
</script>
<style>
</style>

var rum = uni.requireNativePlugin("GCUniPlugin-RUM");
rum.setConfig({
        'androidAppId':'YOUR_ANDROID_APP_ID',
                'iOSAppId':'YOUR_IOS_APP_ID',
                'errorMonitorType':'all', // or 'errorMonitorType':['battery','memory']
                'deviceMonitorType':['cpu','memory']// or  'deviceMonitorType':'all'
            })

var logger = uni.requireNativePlugin("GCUniPlugin-Logger");
logger.setConfig({
  'enableLinkRumData':true,
  'enableCustomLog':true,
  'discardStrategy':'discardOldest'
})

var tracer = uni.requireNativePlugin("GCUniPlugin-Tracer");
tracer.setConfig({
                'traceType': 'ddTrace'
            })

var rum = uni.requireNativePlugin("GCUniPlugin-RUM");

rum.startAction({
                    'actionName': 'action name',
                    'actionType': 'action type'
                })

rum.addAction({
                    'actionName': 'action name',
                    'actionType': 'action type'
                })

// 自动采集，可参考 SDK 包内 GCUniPlugin 插件的示例工程
// step 1. 在 SDK 包内找到 GCWatchRouter.js、GCPageMixin.js 文件，添加到您的工程
// step 2. 在 App.vue 添加 Router 监控，如下：
<script>
    import WatchRouter from '@/GCWatchRouter.js'
    export default {
    mixins:[WatchRouter],
    }
</script>
// step 3. 在应用显示的第一个 page 页面添加 pageMixin 如下
<script>
    import GCPageMixin from '../../GCPageMixin.js';
    export default {
        data() {
            return {}
        },
        mixins:[GCPageMixin],
    }
</script>

// 手动采集 View 的生命周期
// step 1（可选）
rum.onCreateView({
                    'viewName': 'Current Page Name',
                    'loadTime': 100000000,
                })
// step 2
rum.startView('Current Page Name')
// step 3  
rum.stopView()         

/// 使用 uniapp 错误监听函数 发生脚本错误或 API 调用报错时触发
<script>
  var rum = uni.requireNativePlugin("GCUniPlugin-MobileAgent");
  var appState = 'startup';
    // 只能在App.vue里监听
    export default {
        onLaunch: function() {
            console.log('App Launch')
        },
        onShow: function() {
      appState = 'run'
            console.log('App Show')
        },
        onHide: function() {
            console.log('App Hide')
        },
    onError:function(err){   
            if (err instanceof Error){
                console.log('Error name:', err.name);
                console.log('Error message:', err.message);
                console.log('Error stack:',err.stack);
                rum.addError({
                    'message': err.message,
                    'stack': err.stack,
          'state': appState,
                })
            }else if(err instanceof String){
                console.log('Error:', err);
                rum.addError({
                    'message': err,
                    'stack': err,
          'state': appState,
                })
            }
    }
</script>

// 手动添加
rum.addError({
                    'message': 'Error message',
                    'stack': 'Error stack',
                })

// GCRequest.js
var rum = uni.requireNativePlugin("GCUniPlugin-RUM");
var tracer = uni.requireNativePlugin("GCUniPlugin-Tracer");
// 获取平台信息
const platform = uni.getSystemInfoSync().platform;
export default {
    getUUID() {
        return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function(c) {
            var r = Math.random() * 16 | 0,
                v = c == 'x' ? r : (r & 0x3 | 0x8);
            return v.toString(16);
        });
    },
    isEmpty(value) {
        return value === null || value === undefined;
    },
    /// 通过 filterPlatform 参数进行平台过滤，当开启 `enableNativeUserResource` 时，
    //  由于 uniapp 的网络请求在 iOS 端是使用系统 API 实现的，iOS 所有 resource 数据能够一并采集，
    /// 此时请屏蔽 iOS 端 uniapp 中手动采集，以防止数据重复采集。
    /// 例:["ios"], iOS 端设置不进行 trace 追踪与 RUM 采集。
    request(options){ 
        let key = this.getUUID();
        var filter;
        if(this.isEmpty(options.filterPlatform)){
            filter = false
        }else{
            filter = options.filterPlatform.includes(platform);
        }
        var traceHeader = {}
        if(filter == false){
          // trace 关联 RUM
          var traceHeader = tracer.getTraceHeader({
            'key': key,
            'url': options.url,
          })
        }
        traceHeader = Object.assign({},traceHeader, options.header)
        rum.startResource({
            'key':key,
        });
        var responseHeader;
        var responseBody;
        var resourceStatus;
        return uni.request({
            url: options.url,
            method: options.method,
            header: traceHeader,
            data:options.data,
            timeout:options.timeout,
            success: (res) => {
                if(filter){
                  responseHeader = res.header;
                  responseBody = res.data;
                  resourceStatus = res.statusCode;
                }
                if(this.isEmpty(options.success)){
                    options.success(res);
                }
            },
            fail:(err) => {
                if(!filter){
                  responseBody = err.errMsg;
                }
                if(this.isEmpty(options.fail)){
                    options.fail(err);
                }
            },
            complete() {
                if(!filter){
                  rum.stopResource({
                    'key':key,
                  })
                  rum.addResource({
                    'key': key,
                    'content': {
                        'url': options.url,
                        'httpMethod': options.method,
                        'requestHeader': traceHeader,
                        'responseHeader': responseHeader,
                        'responseBody': responseBody,
                        'resourceStatus': resourceStatus,
                    }
                  })
                }
                if(this.isEmpty(options.complete)){
                    options.complete();
                }
            }
        });
    }
} 

import gc from './GCRequest.js';
gc.request({
                url: requestUrl,
                method: method,
                header: header,
                filterPlatform:["ios"],
                timeout:30000,
                success(res)  {
                    console.log('success:' + JSON.stringify(res))
                },
                fail(err) {
                    console.log('fail:' + JSON.stringify(err))
                },
                complete() {
                    console.log('complete:' + JSON.stringify(err))
                }
            });

var logger = uni.requireNativePlugin("GCUniPlugin-Logger");
logger.logging({
                    'content':`Log content`,
                    'status':status
                })

//示例使用 uni.request 进行网络请求
var tracer = uni.requireNativePlugin("GCUniPlugin-Tracer");
let key = Utils.getUUID();//可参考 example utils.js
var header = tracer.getTraceHeader({
                    'key': key,
                    'url': requestUrl,
                })
uni.request({
          url: requestUrl,
          header: header,
          success() {
            console.log('success');
          },
          complete() {
            console.log('complete');
          }
        });

var guanceModule = uni.requireNativePlugin("GCUniPlugin-MobileAgent");

guanceModule.bindRUMUserData({
                'userId':'Test userId',
                'userName':'Test name',
                'userEmail':'test@123.com',
                'extra':{
                    'age':'20'
                }
            })

guanceModule.unbindRUMUserData()

var guanceModule = uni.requireNativePlugin("GCUniPlugin-MobileAgent");
guanceModule.shutDown()

var guanceModule = uni.requireNativePlugin("GCUniPlugin-MobileAgent");
guanceModule.clearAllData()

var guanceModule = uni.requireNativePlugin("GCUniPlugin-MobileAgent");
guanceModule.flushSyncData()

var guanceModule = uni.requireNativePlugin("GCUniPlugin-MobileAgent");
ftMobileSDK.appendGlobalContext({
                  'ft_global_key':'ft_global_value'
              })
ftMobileSDK.appendRUMGlobalContext({
                  'ft_global_rum_key':'ft_global_rum_value'
              })
ftMobileSDK.appendLogGlobalContext({
                  'ft_global_log_key':'ft_global_log_value'
             })               

|--iOSSDK   
    |-- HBuilder-Hello              // uni-app 离线打包工程
    |-- HBuilder-uniPluginDemo      // uni-app 插件开发主工程 （本文档需要使用的工程）
    |-- SDK                         // 依赖库及依赖资源文件

|-- UniPlugin-iOS
    |-- HBuilder-uniPluginDemo      // uni-app 插件开发主工程 （本文档需要使用的工程）
    |-- SDK                         // 依赖库及依赖资源文件

$(inherited) -ObjC -framework "FTMobileSDK" -framework "Guance_UniPlugin_App"

$(inherited)
"${PODS_CONFIGURATION_BUILD_DIR}/FTMobileSDK"
"${PODS_CONFIGURATION_BUILD_DIR}/Guance-UniPlugin-App"
$(DEVELOPER_FRAMEWORKS_DIR)
$(PROJECT_DIR)/../SDK/libs
$(PROJECT_DIR)

|-- UniPlugin-Android
    |-- app
        |--build.gradle
        // ---> 配置 ft-plugin
        // apply:'ft-plugin'

    |-- uniplugin_module
        |-- src
            |-- main
                |-- java
                    |-- com.ft.sdk.uniapp
        |-- build.gradle 
        //---> 配置依赖 dependencies
        //implementation 'com.cloudcare.ft.mobile.sdk.tracker.agent:ft-sdk:xxxx'
        //implementation 'com.google.code.gson:gson:xxxx'
        //implementation 'com.cloudcare.ft.mobile.sdk.tracker.agent:ft-native:xxxx'

    |-- build.gradle
        //---> 配置 repo
        //  maven {
        //          url 'https://mvnrepo.jiagouyun.com/repository/maven-releases'
        //  }
        //
        //--> 配置 buildScrpit
        //  classpath 'com.cloudcare.ft.mobile.sdk.tracker.plugin:ft-plugin:xxxx'