PC SDK 使用说明

当前PC SDK支持Windows XP SP3以上版本。

1. 集成SDK

1.1 SDK下载

下载 最新统计SDK 并解压缩。

1.2 导入SDK包

进入bin目录下，进入Debug（调试版本）、Release（正式版本）目录；
拷贝 libNDDataSdk.dll、libNDDataSdk.pdb 至指定目录；
拷贝对应环境下配置文件 CloudServer.ini 到 libNDDataSdk.dll 同级目录下；

备注事项：

1. 压缩包中含有x64、Win32两个文件夹，接入者依据自身需求接入不同文件夹中的libNDDataSdk.dll及相关文件;

2. CloudServer.ini必须与dll文件同级目录且不能没有此文件；

2. 基本功能集成

2.1 配置基础属性

CloudServer.ini 文件内容如下：

[Server]
IP_PRODUCE=http://cloud-atlas-collection.oth.web.sdp.101.com/v0.1/?/action/collect
Port=80
Interval=1000
ListMaxCount=20

配置文件相关说明：

IP_PRODUCE 上传的采集服务器url
Port 采集服务器的端口号
Interval 采集线程定时轮询，本地采集数据库的时间间隔
ListMaxCount 每次拼接上传的最大记录数

3. 接入SDK

3.1 创建SDK接口实例

每个进程创建一个对应的接口实例，进程退出前要调用Release接口释放该指针，详情请看Release接口说明。

方法示例：

 INDDataSdkNewNew* m_pNDDataSdk = CreateNDDataSdkNew(const char* lpszAppKey);

3.2 初始化接口

virtual bool Init(const char* lpszAppVer/*app版本*/, const char* lpszChannelId/*app渠道*/) = 0;

输入参数：

• lpszAppVer应用版本，长度大于255时会被强行截断成255，必填，格式要求UTF8格式
• lpszChannelId渠道id， 必填，格式要求UTF8格式,否则会出现乱码问题

调用示例：

if（m_pNDDataSdk） 
{
  m_pNDDataSdk->Init("1.0.8.5","101PPT");
}

9.卸载应用

virtual bool UnInstall(const char* lpszAppVer) = 0;

参数说明：

• lpszAppVer应用版本号，字符串，内容长度限制32位以下，不允许出现异常字符

调用示例：

if（m_pNDDataSdk）
{
     m_pNDDataSdk->UnInstall('v1.0');
}

10. 功能配置

10.1 环境切换

根据不同环境配置环境下的CloudServer.ini文件，打开CloudServer.ini文件后找到[Server]设置里面的[IP]为如下表格的内容：

10.2 测试过程中的日志查看

通过设置调试模式

• 调试开关，启用时，会将日志输出。我们可以在exe文件目录下找到Log目录， 进入Log目录将发现如下文件， debug.log为调试信息输入文件 data.log数采集到的记录文件， error.log：为错误输出文件（只有发生错误后才会创建）
• @param bFlag true-启用，false-关闭

方法定义：

virtual void SetDebugMode(bool bFlag) = 0;

调用示例：

if（m_pNDDataSdk）
{
  m_pNDDataSdk->SetDebugMode(true);
}

注意：生产环境请不要打开调试模式，以免生成大量日志。

依据上述要求开启调试模式后，可进入 C:\Users{用户名}\AppData\Roaming\Log 目录查看实时日志内容。

11 使用案例

11.1 动态加载dll使用方法（DEMO下载）

typedef NDDataSDK::INDDataSdkNew*  (*CreateNDDataSdkNew)(const char* lpszAppKey,  NDDataSDK::ENV_TYPE type);
typedef NDDataSDK::INDDataMAP*  (*CreateNDDataMap)();

HINSTANCE m_hModule = ::LoadLibrary(L"libNDDataSdk.dll");
if (m_hModule)
{
    CreateNDDataSdkNew funCreateNDDataSdk = (CreateNDDataSdkNew)::GetProcAddress(m_hModule, "CreateNDDataSdkNew");
    CreateNDDataMap funCreateNDDataMap = (CreateNDDataMap)::GetProcAddress(m_hModule, "CreateNDDataMap");
   if (funCreateNDDataSdk && funCreateNDDataMap)
   {
      NDDataSDK::INDDataSdkPtr pSdk = funCreateNDDataSdk("appkey", type);
      if (pSdk != NULL)
      {
        result = pSdk->Init("version", "channel");
        // 设置缓存条数发送功能，达到指定条数自动上传数据
        pSdk->SetFlushBulkSize(30);
        // 设置发送定时间隔,默认30秒
        pSdk->SetFlushInterval(30);
        // 上报登录数据
        pSdk->Login(123);
        // 设置调试模式
        pSdk->SetDebugMode(true);

**用法一：**
        pSdk->AddEvent("1");

**用法二：**
        pSdk->AddEvent("1", "2");

**用法四：**
        NDDataSDK::INDDataMAP* pMap = funCreateNDDataMap();
        if (pMap)
        {
          pMap->Add("tcp", "ip");
          pMap->Add("age", "118");
          pMap->Add("year", "2015");
          pMap->Add("year", "2016");
        }
         pSdk->AddEvent("1", pMap);
         pMap->Release();

**用法四：**
           NDDataSDK::INDDataMAP* pMap = funCreateNDDataMap();
           if (pMap)
           {
            pMap->Add("tcp", "ip");
            pMap->Add("age", "118");
            pMap->Add("year", "2015");
            pMap->Add("year", "2016");
           }
           pSdk->AddEvent("1", pMap, 3);
           pMap->Release();
           pSdk->AddException("1", 1, "123");
           pSdk->Logout();
           pSdk->UnInit();
         }
        }

        // 数据立即上传
        pNDDataSdk->Flush();
        // 用户登出操作
        pNDDataSdk->Logout();
        // 用户退出应用操作
        pNDDataSdk->UnInit();

       ::FreeLibrary(m_hModule);
  }