基于第三方开源库的OPC服务器开发指南（3）——OPC客户端

本篇将讲解如何编写一个OPC客户端程序测试我们在前文《基于第三方开源库的OPC服务器开发指南（2）——LightOPC的编译及部署》一篇建立的服务器。本指南的目的是熟悉OPC服务器的开发流程，所以客户端部分我就不做过多描述，只是简单讲解几个关键技术细节及其实现函数，完整工程源码请从如下地址获取：

https://github.com/Neo-T/OPCDASrvBasedOnLightOPC

OPC客户端的编写流程与涉及的技术细节跟本指南第一篇博文给出的DCOM客户端本质上没有什么不同，同样是模拟登录远程机器、获取操作接口然后调用就可以了。相较于普通的DCOM客户端，OPC客户端还需要枚举并读取远程机器上已经注册的OPC服务器的CLSID，我们需要根据这个CLSID来指定要使用远程机器上哪一个OPC服务器提供的远程操作接口。首先是如何枚举远程机器上所有已注册OPC服务器以及如何读取指定服务器的CLSID，有两种方法实现这个操作：

1、访问远程机器上的注册表，直接读取指定OPC服务器的CLSID；

2、使用OPC组织提供的OPCEnum服务，枚举所有已注册OPC服务并读取指定服务器的CLSID；

第一种方法不需要下载OPC组织提供的——目前看个人开发者已经无法通过OPC基金会网站免费获得的——“opc core components”支持包，只需要目标机器开通“RemoteRegistry”服务，同时我们拥有访问注册表的权限即可。可以说这种方式是最对我胃口的，不受别人限制。该方法的实现函数如下：

 //* 获取指定名称的OPC服务器的CLSID
 static INT __GetRemoteOPCSrvCLSIDByRegistry(CHAR *pszIPAddr, CHAR *pszUserName, CHAR *pszPassword, CHAR *pszOPCSrvProgID, CHAR *pszOPCSrvCLSID)
 {
     INT nRtnVal = 0;

     //* 登录远程计算机
     HANDLE hToken;
     if (!LogonUser(pszUserName, pszIPAddr, pszPassword, LOGON32_LOGON_NEW_CREDENTIALS, LOGON32_PROVIDER_DEFAULT, &hToken))
     {
         printf("无法连接IP地址为%s的计算机，错误码：%d", pszIPAddr, GetLastError());
         return -1;
     }

     //* 模拟当前登录的用户
     ImpersonateLoggedOnUser(hToken);
     {
         do {
             CHAR szKey[MAX_PATH + 1];
             DWORD dwLen = MAX_PATH;
             DWORD dwIdx = 0;
             CHAR szCLSID[100];
             LONG lSize;
             HKEY hKey = HKEY_CLASSES_ROOT;
             DWORD dwRtnVal = RegConnectRegistry(pszIPAddr, HKEY_CLASSES_ROOT, &hKey);
             if (dwRtnVal != ERROR_SUCCESS)
             {
                 printf("无法连接IP地址为%s的计算机，错误码：%d", pszIPAddr, dwRtnVal);
                 nRtnVal = -2;
                 break;
             }

             printf("成功连接IP地址为%s的计算机，开始枚举该计算机系统上的注册表...\r\n", pszIPAddr);

             //* 读取指定键值
             if (RegEnumKey(hKey, dwIdx, szKey, dwLen) == ERROR_SUCCESS)
             {
                 HKEY hSubKey;

                 //* 打开指定名称的OPC服务器所在的键，在这里就是"OPC.LightOPC-exe"
                 sprintf(szKey, pszOPCSrvProgID);

                 //* 打开指定键值并取值
                 if (RegOpenKey(hKey, szKey, &hSubKey) == ERROR_SUCCESS)
                 {
                     memset(szCLSID, 0, sizeof(szCLSID));
                     lSize = sizeof(szCLSID) - 1;
                     if (RegQueryValue(hSubKey, "CLSID", szCLSID, &lSize) == ERROR_SUCCESS)
                     {
                         if (RegQueryValue(hSubKey, "OPC", NULL, NULL) == ERROR_SUCCESS)
                         {
                             sprintf(pszOPCSrvCLSID, "%s", szCLSID);
                             printf("『%s』服务已找到：%s\r\n", pszOPCSrvProgID, pszOPCSrvCLSID);
                         }
                         else
                         {
                             printf("查询OPC键失败，错误码：%d\r\n", GetLastError());
                             nRtnVal = -6;
                         }
                     }
                     else
                     {
                         printf("查询CLSID键失败，错误码：%d\r\n", GetLastError());
                         nRtnVal = -5;
                     }

                     RegCloseKey(hSubKey);
                 }
                 else
                 {
                     printf("RegOpenKey()函数执行失败，错误码：%d\r\n", GetLastError());
                     nRtnVal = -4;
                 }
             }
             else
             {
                 printf("RegEnumKey()函数执行失败，错误码：%d\r\n", GetLastError());
                 nRtnVal = -3;
             }

         } while (FALSE);
     }
     RevertToSelf();    //* 结束模拟

     return nRtnVal;
 }

这个函数对注册表的操作没什么可说的，使用的是标准API，重点是如何获取远程注册表的访问权限。在这里我们依然使用了模拟用户登录技术，利用远程机器为我们分配的某个具有注册表访问权限的用户，通过调用LogonUser()函数获取该用户成功登录后的访问令牌，通过这个令牌获取对注册表的访问权限，这才是这个函数的得以正常执行的关键。我们可以在main()函数中输入如下代码测试一下这个函数：

 int main(int argc, CHAR* argv[])
 {
     CHAR szCLSID[100];

     __GetRemoteOPCSrvCLSIDByRegistry(argv[1], argv[2], argv[3], argv[4], szCLSID);

     return 0;
 }

打开控制台输入测试指令，顺利的话我们会如愿得到LightOPC样例服务器的CLSID：

控制台输入的参数依次为：远程机器的IP地址、登录账户、密码以及样例服务器的ProgID。

需要注意的一点是，如果你的程序不能正常访问远程机器，请按顺序确定以下内容无误：

1、确保lanmanserver，也就是名称为“Server”的服务已经启动，如果你的远程机器是“Server 2008 R2”，且在服务管理器中没找到“Server”服务，请在我提供的源码工程“opc_core_components”目录下找到“lanmanServer.reg”文件，直接导入你的原机器即可解决“Server”服务不存在的问题；
2、确保Workstation服务启动；
3、确保RemoteRegistry服务启动；
4、确保Remote Procedure Call (RPC)服务启动；
5、确保TCP/IP NetBIOS Helper服务启动；
6、确保网卡属性中Microsoft网络的文件和打印机共享服务已勾选；

使用第二种方法利用OPCEnum服务获取CLSID的实现函数如下：

 static INT __GetRemoteOPCSrvCLSIDByOPCEnum(CHAR *pszIPAddr, CHAR *pszUserName, CHAR *pszPassword, CHAR *pszOPCSrvProgID, CHAR *pszOPCSrvCLSID)
 {
     HRESULT hr;
     INT nRtnVal = 0;

     hr = CoInitializeEx(NULL, COINIT_MULTITHREADED);
     if (!SUCCEEDED(hr))
     {
         printf("CoInitializeEx()初始化失败：0x%08X\r\n", hr);
         return -1;
     }

     do {
         COSERVERINFO stCoServerInfo;
         COAUTHINFO stCoAuthInfo;
         COAUTHIDENTITY stCoAuthID;
         INT nSize = strlen(pszIPAddr) * sizeof(WCHAR);
         memset(&stCoServerInfo, 0, sizeof(stCoServerInfo));
         stCoServerInfo.pwszName = (WCHAR *)CoTaskMemAlloc(nSize * sizeof(WCHAR));
         if (!stCoServerInfo.pwszName)
         {
             printf("CoTaskMemAlloc()函数执行失败!\r\n");
             nRtnVal = -2;
             break;
         }

         ZeroMemory(&stCoAuthID, sizeof(COAUTHIDENTITY));
         stCoAuthID.User = reinterpret_cast<USHORT *>(pszUserName);
         stCoAuthID.UserLength = strlen(pszUserName);
         stCoAuthID.Domain = reinterpret_cast<USHORT *>("");
         stCoAuthID.DomainLength = 0;
         stCoAuthID.Password = reinterpret_cast<USHORT *>(pszPassword);
         stCoAuthID.PasswordLength = strlen(pszPassword);
         stCoAuthID.Flags = SEC_WINNT_AUTH_IDENTITY_ANSI;

         ZeroMemory(&stCoAuthInfo, sizeof(COAUTHINFO));
         stCoAuthInfo.dwAuthnSvc = RPC_C_AUTHN_WINNT;
         stCoAuthInfo.dwAuthzSvc = RPC_C_AUTHZ_NONE;
         stCoAuthInfo.pwszServerPrincName = NULL;
         stCoAuthInfo.dwAuthnLevel = RPC_C_AUTHN_LEVEL_CONNECT;
         stCoAuthInfo.dwImpersonationLevel = RPC_C_IMP_LEVEL_IMPERSONATE;    //* 必须是模拟登陆
         stCoAuthInfo.pAuthIdentityData = &stCoAuthID;
         stCoAuthInfo.dwCapabilities = EOAC_NONE;

         mbstowcs(stCoServerInfo.pwszName, pszIPAddr, nSize);
         stCoServerInfo.pAuthInfo = &stCoAuthInfo;
         stCoServerInfo.dwReserved1 = 0;
         stCoServerInfo.dwReserved2 = 0;

         MULTI_QI stMultiQI;
         ZeroMemory(&stMultiQI, sizeof(stMultiQI));
         stMultiQI.pIID = &IID_IOPCServerList;    //* 参见opccomn_i.c
         stMultiQI.pItf = NULL;

         //* 初始化安全结构，模拟登录远程机器
         hr = CoInitializeSecurity(NULL, -1, NULL, NULL, RPC_C_AUTHN_LEVEL_CONNECT, RPC_C_IMP_LEVEL_IMPERSONATE, NULL, EOAC_NONE, NULL);
         if (!(SUCCEEDED(hr) || RPC_E_TOO_LATE == hr))
         {
             printf("CoInitializeSecurity()函数执行失败，错误码：0x%08X\r\n", hr);
             nRtnVal = -3;
             break;
         }

         hr = CoCreateInstanceEx(CLSID_OpcServerList,
                                 NULL,
                                 CLSCTX_REMOTE_SERVER,    //* 显式的指定要连接远程机器
                                 &stCoServerInfo,
                                 sizeof(stMultiQI) / sizeof(MULTI_QI),
                                 &stMultiQI);

         //* 无论成功与否，先释放刚才申请的内存
         CoTaskMemFree(stCoServerInfo.pwszName);

         //* 如果CoCreateInstanceEx()执行失败
         if (FAILED(hr))
         {
             printf("CoCreateInstanceEx()函数执行失败，错误码：0x%08X %s %s\r\n", hr, pszIPAddr, pszUserName);
             nRtnVal = -4;
             break;
         }

         //* 如果没有获取到DCOM组件的查询接
         if (FAILED(stMultiQI.hr))
         {
             printf("获取组件的查询接口失败，错误码：0x%08X\r\n", stMultiQI.hr);
             nRtnVal = -5;
             break;
         }

         //* 读取所有已注册的OPC服务器
         CComPtr<IOPCServerList> pobjOPCSrvList = (IOPCServerList *)stMultiQI.pItf;
         IEnumGUID *pobjEnumGUID = NULL;
         CLSID stCLSID;
         DWORD dwCeltFetchedNum;
         LPOLESTR wszProgID, wszUserType;
         CLSID stCatID = CATID_OPCDAServer20;
         hr = pobjOPCSrvList->EnumClassesOfCategories(1, &stCatID, 1, &stCatID, &pobjEnumGUID);
         if (FAILED(hr))
         {
             printf("EnumClassesOfCategories()函数执行失败，错误码：0x%08X\r\n", hr);
             nRtnVal = -6;
             break;
         }

         //* 开始枚举服务器并获取指定ProgID的CLSID
         while (SUCCEEDED(pobjEnumGUID->Next(1, &stCLSID, &dwCeltFetchedNum)))
         {
             if (!dwCeltFetchedNum)
                 break;
             hr = pobjOPCSrvList->GetClassDetails(stCLSID, &wszProgID, &wszUserType);
             if (FAILED(hr))
             {
                 printf("GetClassDetails()函数执行失败，错误码：0x%08X\r\n", hr);
                 nRtnVal = -7;
                 break;
             }

             CHAR szProgID[100];
             CString cstrProgID = wszProgID;
             sprintf(szProgID, "%s", cstrProgID);

             if(!strcmp(pszOPCSrvProgID, szProgID))
             {
                 BSTR wszCLSID;
                 StringFromCLSID(stCLSID, &wszCLSID);
                 CString cstrCLSID = wszCLSID;

                 sprintf(pszOPCSrvCLSID, "%s", cstrCLSID);
                 printf("『%s』服务已找到：%s\r\n", pszOPCSrvProgID, pszOPCSrvCLSID);

                 //* 释放占用的内存
                 CoTaskMemFree(wszProgID);
                 CoTaskMemFree(wszUserType);

                 break;
             }

             //* 释放占用的内存
             CoTaskMemFree(wszProgID);
             CoTaskMemFree(wszUserType);
         }
     } while (FALSE);

     CoUninitialize();

     return nRtnVal;
 }

这个函数处理流程与DCOM客户端基本相同，不多说了，重点是如何使用这个函数？首先我们必须下载“opc core components”支持包，64位的机器下载x64版本，32位的机器下载x86版本，可问题是在哪里下载呢？前面我不止一次说过，OPC基金会关闭了普通用户的下载通道，我们在基金会网站是找不到下载地址的。像CSDN、pudn之类的同样铜臭味十足的GoPi网站提供下载，可是要积分啊，我记得CSDN上有个64位版本支持包的下载链接竟然丧心病狂的要44积分，太WuChi了。还是要感谢github，感谢无私奉献的大神们，请去这个地址下载两个版本的支持包，顺便给该资源的主人点个星：

https://github.com/jmbeach/chocolatey-OpcClassicCoreComponents/tree/master/tools

下载下来后，远程机器和本地都要安装，远程机器安装完就不用管它了。本地安装完毕后，需要在安装路径下找到OPCEnum.h和OpcEnum_i.c两个文件将其添加到客户端工程中，同时把OPCEnum.h文件#include进来，否则会编译失败。然后修改main()函数：

 int main(int argc, CHAR* argv[])
 {
     CHAR szCLSID[100];

     __GetRemoteOPCSrvCLSIDByOPCEnum(argv[1], argv[2], argv[3], argv[4], szCLSID);
     //__GetRemoteOPCSrvCLSIDByRegistry(argv[1], argv[2], argv[3], argv[4], szCLSID);

     return 0;
 }

控制台输入指令测试该函数，结果如下：

抛开与OPC业务有关的逻辑不说，以上两个函数针对远程OPC服务器的访问提供了一种更安全的访问方法，而不像相当一部分公开资料所描述的那样把服务器权限降低到任何人都可以访问的令人发指的地步。

OPC客户端的主业务逻辑可以参见源码的main()函数，以此按图索骥理解整个处理流程：

 int main(int argc, CHAR* argv[])
 {
     CHAR szCLSID[100];

     if (argc != 5)
     {
         printf("Usage:%s opcserver_ip username password OpcProgID\r\n", argv[0]);
         return -1;
     }

     //* 设定该程序捕获控制台CTRL+C输入，以使程序能够正常退出
     SetConsoleCtrlHandler((PHANDLER_ROUTINE)ConsoleHandler, TRUE);

     //__GetRemoteOPCSrvCLSIDByOPCEnum(argv[1], argv[2], argv[3], argv[4], szCLSID);
     if (__GetRemoteOPCSrvCLSIDByRegistry(argv[1], argv[2], argv[3], argv[4], szCLSID))
     {
         printf("__GetRemoteOPCSrvCLSIDByRegistry()函数执行失败，进程退出！\r\n");
         return -2;
     }

     //* 连接成功则进行后续操作
     if (!__ConnOPCServer(argv[1], argv[2], argv[3], szCLSID))
     {
         do {
             if (__AddDefaultGroup())
             {
                 printf("__AddDefaultGroup()函数执行失败，进程退出！\r\n");
                 break;
             }

             //* 手动添加要操作的变量
             //* =======================================================
             ST_OPC_ITEM staItem[2];
             sprintf(staItem[0].szItemName, "lulu");
             staItem[0].vtDataType = VT_I2;
             if (__AddItemToLocalMgmtIf(staItem[0].szItemName, staItem[0].vtDataType, &staItem[0].ohItemSrv))    //* exe_samp工程之sample.cpp文件第573行“lulu”变量为VT_I2类型
             {
                 printf("__AddItemToLocalMgmtIf()函数添加变量[lulu]执行失败，进程退出！\r\n");
                 break;
             }

             sprintf(staItem[1].szItemName, "zuzu");
             staItem[1].vtDataType = VT_R8;
             if (__AddItemToLocalMgmtIf(staItem[1].szItemName, staItem[1].vtDataType, &staItem[1].ohItemSrv))    //* exe_samp工程之sample.cpp文件第564行“zuzu”变量为VT_R8类型
             {
                 printf("__AddItemToLocalMgmtIf()函数添加变量[zuzu]执行失败，进程退出！\r\n");
                 break;
             }
             //* =======================================================

             //* 隐藏控制台光标
             ShowConsoleCursor(FALSE);

             //* 读取控制台当前光标位置，以便循环读取时固定输出位置，而不是整屏滚动输出
             SHORT x, y;
             GetConsoleCursorPosition(&x, &y);

             time_t tPrevWriteTime = time(NULL);
             ULONG ulWriteVal = 2009;

             blIsRunning = TRUE;
             while (blIsRunning)
             {
                 //* 每次读取均设定在控制台同一输出位置
                 SetConsoleCursorPosition(x, y);

                 if (__ReadItem(staItem, sizeof(staItem) / sizeof(ST_OPC_ITEM)))
                     break;

                 Sleep(100);

                 if (time(NULL) - tPrevWriteTime > 1)
                 {
                     if (__WriteItem(&staItem[0], ulWriteVal++))
                         break;

                     tPrevWriteTime = time(NULL);
                 }
             }

             //* 恢复控制台光标
             ShowConsoleCursor(TRUE);

         } while (FALSE);

         //* 断开连接
         __DisconnectOPCServer();
     }
     else
     {
         printf("__ConnOPCServer()函数执行失败，进程退出！\r\n");
         return -3;
     }

     return 0;
 }
 

整个流程很简单：获取CLSID，利用这个CLSID连接服务器，连接成功后调用__AddDefaultGroup()函数添加一个缺省组，添加成功则就获得了对OPC服务器指定变量进行管理、读、写等操作的具体操作接口，接着通过__AddItemToLocalMgmtIf()函数把我们要操作的样例服务器提供的两个变量添加到OPC的本地变量管理接口，然后就可以进入主循环进行读取操作了。主循环以100毫秒间隔读取“zuzu”变量的值，以1秒间隔写“lulu”变量的值。其实OPC样例服务器提供了多个变量，具体列表参见“sample.cpp”文件的第278-282行：

 …… ……

 /* Our data tags: */
 /* zero is resierved for an invalid RealTag */
 #define TI_zuzu      (1)
 #define TI_lulu      (2)
 #define TI_bandwidth (3)
 #define TI_array     (4)
 #define TI_enum      (5)
 #define TI_quiet     (6)
 #define TI_quality   (7)
 #define TI_string    (8)
 #define TI_MAX       (8)

 static loTagId ti[TI_MAX + 1];          /* their IDs */
 static const char *tn[TI_MAX + 1] =     /* their names */
 { "--not--used--", "zuzu", "lulu", "bandwidth", "array", "enum-localizable",
     "quiet", "quality", "string" };
 static loTagValue tv[TI_MAX + 1];       /* their values */

 …… ……

这些变量的数据类型参见driver_init()函数：

 int driver_init(int lflags)
 {
     …… ……

   /* We needn't to VariantClear() for simple datatypes like numbers */
   V_R8(&var) = 214.1; /* initial value. Will be used to check types conersions */
   V_VT(&var) = VT_R8; //* 变量“zuzu”的数据类型
   ecode = loAddRealTag_a(my_service,    /* actual service context */
                          &ti[TI_zuzu],  /* returned TagId */
                          (loRealTag)TI_zuzu, /* != 0 driver's key */
                          tn[TI_zuzu],   /* tag name */
                          0,     /* loTF_ Flags */
                          OPC_READABLE | OPC_WRITEABLE, &var, 12., 1200.);
   UL_TRACE((LOGID, "%!e loAddRealTag_a(zuzu) = %u ", ecode, ti[TI_zuzu]));

   V_I2(&var) = 1000;
   V_VT(&var) = VT_I2; //* 变量“lulu”的数据类型
   ecode = loAddRealTag(my_service,      /* actual service context */
                        &ti[TI_lulu],    /* returned TagId */
                        (loRealTag) TI_lulu,     /* != 0 driver's key */
                        tn[TI_lulu],     /* tag name */
                        0,       /* loTF_ Flags */
                        OPC_READABLE | OPC_WRITEABLE, &var, 0, 0);
   UL_TRACE((LOGID, "%!e loAddRealTag(lulu) = %u ", ecode, ti[TI_lulu]));

     …… ……
 }

进行客户端测试之前我们还需要对“sample.cpp”文件的代码做些调整，否则无法测试写操作。共有两个地方需要调整，其一，“simulate()”函数找到如下几句：

 void simulate(unsigned pause)
 {
     …… ……

 double zuzu =
       (V_R8(&tv[TI_zuzu].tvValue) += ./.); /* main simulation */
       V_VT(&tv[TI_zuzu].tvValue) = VT_R8;
       tv[TI_zuzu].tvState.tsTime = ft;

       V_I2(&tv[TI_lulu].tvValue) = (short)zuzu;
       V_VT(&tv[TI_lulu].tvValue) = VT_I2;
       tv[TI_lulu].tvState.tsTime = ft;

       V_I2(&tv[TI_enum].tvValue) = (short)((ft.dwLowDateTime >> ) % );
       V_VT(&tv[TI_enum].tvValue) = VT_I2;
       tv[TI_enum].tvState.tsTime = ft;

     …… ……
 }

红色语句全部注释掉，不让OPC服务器更新“lulu”变量。然后是“WriteTags()”函数，增加如下几句：

 int WriteTags(const loCaller *ca,
               unsigned count, loTagPair taglist[],
               VARIANT values[], HRESULT error[], HRESULT *master, LCID lcid)
 {
     …… ……

       case TI_lulu:
         hr = VariantChangeType(&tv[TI_lulu].tvValue, &values[ii], 0, VT_I2);
         if (S_OK == hr)
         {
             lo_statperiod(V_I2(&tv[TI_lulu].tvValue)); /* VERY OPTIONAL, really */

             FILETIME ft;
             GetSystemTimeAsFileTime(&ft); /* awoke */
             tv[TI_lulu].tvState.tsTime = ft;
         }

     …… ……
 }

红色部分为要增加的语句，这几条语句的作用是当客户端写入新的“lulu”变量值时同步更新该变量的时间戳。重新编译修改后的样例服务器，并覆盖远程机器上的旧文件，然后我们就可以启动客户端看看效果了：

最后，需要注意的一点是，OPC服务器所在的机器必须已经登录，否则OPC客户端是无法连接的，会报0x8000401A错误。这一点与普通的DCOM不同，普通的DCOM客户端无须DCOM组件所在的服务器登录即可正常使用。

至此，OPC系统的完整开发流程梳理完毕。本指南的最后一篇——《基于第三方开源库的OPC服务器开发指南（4）——后记：与另一个开源库opc workshop库相关的问题》将推荐另一个更加简单的开源库opc workshop。