C# ActiveX开发及安装部署

　　最近项目中，因为需要在WEB页面上操作串口，包括串口查询、打开、发送指令、接收数据、关闭串口等功能。如下所示：

　　考虑使用ActiveX来实现。因为以前没有这方面的经验，开发过程中也是遇到各种问题。废话不多说，下面进入正题：

　　1：打开VS2008，新建项目，以下是具体代码：

using System;
using System.Collections.Generic;
using System.Windows.Forms;
using System.IO.Ports;
using System.IO;
using System.Reflection;
using System.Runtime.InteropServices;
using mshtml;
using System.Text;
using Microsoft.Win32;
using System.Threading;

namespace WebSerial
{
    [ProgId("WebSerial")]//控件名称
    [ClassInterface(ClassInterfaceType.AutoDual), ComSourceInterfaces(typeof(ControlEvents))]
    [Guid("6C6A0DE4-193A-48f5-BA91-3C180558785B")]//控件的GUID，用于COM注册和HTML中Object对象classid引用
    [ComVisible(true)]
    public partial class SerialPortControl : UserControl,IObjectSafety
    {
        ExSerialPort serialPort;
        List<byte> buffer = new List<byte>(4096);

        /// <summary>
        /// 是否准备关闭串口
        /// </summary>
        private static bool m_IsTryToClosePort = false;
        /// <summary>
        /// 是否正在接收数据
        /// </summary>
        private static bool m_IsReceiving = false;
        public SerialPortControl()
        {

        }

        /// <summary>
        /// 获取本地串口列表，以逗号隔开
        /// </summary>
        /// <returns></returns>
        public string getComPorts()
        {
            string ports = "";
            foreach (string s in ExSerialPort.GetPortNames())
            {
                ports += "," + s;
            }
            return ports.Length > 0 ? ports.Substring(1) : "";
        }

        /// <summary>
        /// 以指定串口号和波特率连接串口
        /// </summary>
        /// <param name="com">端口号</param>
        /// <param name="baudRate">波特率</param>
        /// <returns></returns>
        [ComVisible(true)]
        public string connect(string com, int baudRate)
        {
            close();
            serialPort = null;
            serialPort = new ExSerialPort(com);
            serialPort.BaudRate = baudRate;
            serialPort.Parity = Parity.None;
            serialPort.DataBits = 8;
            serialPort.Encoding = Encoding.ASCII;
            serialPort.ReceivedBytesThreshold = 5;
            serialPort.ReadBufferSize = 102400;

            try
            {
                serialPort.Open();
                if (serialPort.IsOpen)
                {
                    m_IsTryToClosePort = false;
                    this.clear();
                    serialPort.DataReceived += new SerialDataReceivedEventHandler(serialPort_DataReceived);
                    return "true";
                }
            }
            catch { }

            return "false";
        }

        /// <summary>
        /// 清理串口数据并关闭串口
        /// </summary>
        [ComVisible(true)]
        public void close()
        {
            m_IsTryToClosePort = true;
            while (m_IsReceiving)
            {
                Application.DoEvents();
            }

            if (serialPort != null)
            {
                serialPort.Dispose();
            }
        }

        /// <summary>
        /// 清理串口数据
        /// </summary>
        [ComVisible(true)]
        public void clear()
        {
            if (serialPort != null && serialPort.IsOpen)
            {
                serialPort.Clear();
            }
        }

        /// <summary>
        /// 发送字符串
        /// </summary>
        /// <param name="s"></param>
        [ComVisible(true)]
        public void writeString(string hexString)
        {
            if (serialPort != null && serialPort.IsOpen)
            {
                byte[] bytes = strToToHexByte(hexString);
                serialPort.Write(bytes, 0, bytes.Length);
            }
        }

        /// <summary>
        /// 字符串转16进制字节数组
        /// </summary>
        /// <param name="hexString"></param>
        /// <returns></returns>
        private static byte[] strToToHexByte(string hexString)
        {
            hexString = hexString.Replace(" ", "");
            if ((hexString.Length % 2) != 0)
                hexString += " ";
            byte[] returnBytes = new byte[hexString.Length / 2];
            for (int i = 0; i < returnBytes.Length; i++)
                returnBytes[i] = Convert.ToByte(hexString.Substring(i * 2, 2), 16);
            return returnBytes;
        }

        ///  <summary>  
        /// 字节数组转字符串16进制  
        ///  </summary>  
        ///  <param name="InBytes"> 二进制字节 </param>  
        ///  <returns>类似"01 02 0F" </returns>  
        public static string ByteToString(byte[] InBytes)
        {
            string StringOut = "";
            foreach (byte InByte in InBytes)
            {
                //StringOut += String.Format("{0:X2}", InByte) + " ";  
                StringOut += " " + InByte.ToString("X").PadLeft(2, '0');
            }

            return StringOut.Trim();
        }

        /// <summary>
        /// 接收数据
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e"></param>
        void serialPort_DataReceived(object sender, SerialDataReceivedEventArgs e)
        {
            if (m_IsTryToClosePort)
            {
                return;
            }

            m_IsReceiving = true;

            try
            {
                int n = serialPort.BytesToRead;
                if (n > 0)
                {
                    byte[] buf = new byte[n];
                    serialPort.Read(buf, 0, n);
                    string dataString = ByteToString(buf);
                    Receive(dataString);
                }

                ////1.缓存数据
                //buffer.AddRange(buf);
                ////2.完整性判断
                //while (buffer.Count >= 5) //至少包含帧头（2字节）、长度（1字节）、校验位（1字节）；根据设计不同而不同
                //{
                //    //2.1 查找数据头
                //    if (buffer[0] == 0xff && buffer[1] == 0x55) //传输数据有帧头，用于判断
                //    {
                //        int len = buffer[2];
                //        if (buffer.Count < len + 4) //数据区尚未接收完整
                //        {
                //            break;
                //        }
                //        //得到完整的数据，复制到ReceiveBytes中进行校验
                //        byte[] ReceiveBytes = new byte[len + 4];
                //        buffer.CopyTo(0, ReceiveBytes, 0, len + 4);

                //        byte checkByte = ReceiveBytes[len + 3];//获取校验字节
                //        byte realCheckByte = 0x00;
                //        realCheckByte -= buffer[2];
                //        for (int packIndex = 0; packIndex < len; packIndex++)//将后面的数据加起来
                //        {
                //            realCheckByte -= ReceiveBytes[packIndex + 3];
                //        }

                //        if (checkByte == realCheckByte)//验证，看数据是否合格
                //        {
                //            string dataString = ByteToString(ReceiveBytes);                            
                //            Receive(dataString);
                //        }
                //        buffer.RemoveRange(0, len + 4);
                //    }
                //    else //帧头不正确时，清除
                //    {
                //        buffer.RemoveAt(0);
                //    }

                //}
            }
            finally
            {
                m_IsReceiving = false;
            }
        }

        public event ControlEventHandler OnReceive;
        [ComVisible(true)]
        private void Receive(string dataString)
        {
            if (OnReceive != null)
            {
                OnReceive(dataString); //Calling event that will be catched in JS
            }
        }

        ///    <summary>
        ///    Register the class as a    control    and    set    it's CodeBase entry
        ///    </summary>
        ///    <param name="key">The registry key of the control</param>
        [ComRegisterFunction()]
        public static void RegisterClass(string key)
        {
            // Strip off HKEY_CLASSES_ROOT from the passed key as I don't need it
            StringBuilder sb = new StringBuilder(key);

            sb.Replace(@"HKEY_CLASSES_ROOT", "");
            // Open the CLSID{guid} key for write access
            RegistryKey k = Registry.ClassesRoot.OpenSubKey(sb.ToString(), true);

            // And create    the    'Control' key -    this allows    it to show up in
            // the ActiveX control container
            RegistryKey ctrl = k.CreateSubKey("Control");
            ctrl.Close();

            // Next create the CodeBase entry    - needed if    not    string named and GACced.
            RegistryKey inprocServer32 = k.OpenSubKey("InprocServer32", true);
            inprocServer32.SetValue("CodeBase", Assembly.GetExecutingAssembly().CodeBase);
            inprocServer32.Close();
            // Finally close the main    key
            k.Close();
            MessageBox.Show("Registered");
        }

        ///    <summary>
        ///    Called to unregister the control
        ///    </summary>
        ///    <param name="key">Tke registry key</param>
        [ComUnregisterFunction()]
        public static void UnregisterClass(string key)
        {
            StringBuilder sb = new StringBuilder(key);
            sb.Replace(@"HKEY_CLASSES_ROOT", "");

            // Open    HKCRCLSID{guid} for write    access
            RegistryKey k = Registry.ClassesRoot.OpenSubKey(sb.ToString(), true);

            // Delete the 'Control'    key, but don't throw an    exception if it    does not exist
            k.DeleteSubKey("Control", false);

            // Next    open up    InprocServer32
            //RegistryKey    inprocServer32 = 
            k.OpenSubKey("InprocServer32", true);

            // And delete the CodeBase key,    again not throwing if missing
            k.DeleteSubKey("CodeBase", false);

            // Finally close the main key
            k.Close();
            MessageBox.Show("UnRegistered");
        }

        #region IObjectSafety 成员
        public void GetInterfacceSafyOptions(int riid, out int pdwSupportedOptions, out int pdwEnabledOptions)
        {
            pdwSupportedOptions = 1;
            pdwEnabledOptions = 2;
        }
        public void SetInterfaceSafetyOptions(int riid, int dwOptionsSetMask, int dwEnabledOptions)
        {
            throw new NotImplementedException();
        }
        #endregion

        #region IObjectSafety 成员

        private const string _IID_IDispatch = "{00020400-0000-0000-C000-000000000046}";
        private const string _IID_IDispatchEx = "{a6ef9860-c720-11d0-9337-00a0c90dcaa9}";
        private const string _IID_IPersistStorage = "{0000010A-0000-0000-C000-000000000046}";
        private const string _IID_IPersistStream = "{00000109-0000-0000-C000-000000000046}";
        private const string _IID_IPersistPropertyBag = "{37D84F60-42CB-11CE-8135-00AA004BB851}";

        private const int INTERFACESAFE_FOR_UNTRUSTED_CALLER = 0x00000001;
        private const int INTERFACESAFE_FOR_UNTRUSTED_DATA = 0x00000002;
        private const int S_OK = 0;
        private const int E_FAIL = unchecked((int)0x80004005);
        private const int E_NOINTERFACE = unchecked((int)0x80004002);

        private bool _fSafeForScripting = true;
        private bool _fSafeForInitializing = true;


        public int GetInterfaceSafetyOptions(ref Guid riid, ref int pdwSupportedOptions, ref int pdwEnabledOptions)
        {
            int Rslt = E_FAIL;

            string strGUID = riid.ToString("B");
            pdwSupportedOptions = INTERFACESAFE_FOR_UNTRUSTED_CALLER | INTERFACESAFE_FOR_UNTRUSTED_DATA;
            switch (strGUID)
            {
                case _IID_IDispatch:
                case _IID_IDispatchEx:
                    Rslt = S_OK;
                    pdwEnabledOptions = 0;
                    if (_fSafeForScripting == true)
                        pdwEnabledOptions = INTERFACESAFE_FOR_UNTRUSTED_CALLER;
                    break;
                case _IID_IPersistStorage:
                case _IID_IPersistStream:
                case _IID_IPersistPropertyBag:
                    Rslt = S_OK;
                    pdwEnabledOptions = 0;
                    if (_fSafeForInitializing == true)
                        pdwEnabledOptions = INTERFACESAFE_FOR_UNTRUSTED_DATA;
                    break;
                default:
                    Rslt = E_NOINTERFACE;
                    break;
            }

            return Rslt;
        }

        public int SetInterfaceSafetyOptions(ref Guid riid, int dwOptionSetMask, int dwEnabledOptions)
        {
            int Rslt = E_FAIL;

            string strGUID = riid.ToString("B");
            switch (strGUID)
            {
                case _IID_IDispatch:
                case _IID_IDispatchEx:
                    if (((dwEnabledOptions & dwOptionSetMask) == INTERFACESAFE_FOR_UNTRUSTED_CALLER) &&
                         (_fSafeForScripting == true))
                        Rslt = S_OK;
                    break;
                case _IID_IPersistStorage:
                case _IID_IPersistStream:
                case _IID_IPersistPropertyBag:
                    if (((dwEnabledOptions & dwOptionSetMask) == INTERFACESAFE_FOR_UNTRUSTED_DATA) &&
                         (_fSafeForInitializing == true))
                        Rslt = S_OK;
                    break;
                default:
                    Rslt = E_NOINTERFACE;
                    break;
            }

            return Rslt;
        }

        #endregion
    }

    /// <summary>
    /// Event handler for events that will be visible from JavaScript
    /// </summary>
    public delegate void ControlEventHandler(string dataString);

    /// <summary>
    /// This interface shows events to javascript
    /// </summary>
    [Guid("68BD4E0D-D7BC-4cf6-BEB7-CAB950161E79")]
    [InterfaceType(ComInterfaceType.InterfaceIsIDispatch)]
    public interface ControlEvents
    {
        //Add a DispIdAttribute to any members in the source interface to specify the COM DispId.
        [DispId(0x60020001)]
        void OnReceive(string dataString); //This method will be visible from JS
    }

    public class ExSerialPort : SerialPort
    {
        public ExSerialPort(string name)
            : base(name)
        {
        }

        public void Clear()
        {
            try
            {
                if (this.IsOpen)
                {
                    this.DiscardInBuffer();
                    this.DiscardOutBuffer();
                }
            }
            catch { }
        }

        protected override void Dispose(bool disposing)
        {
            Clear();

            var stream = (Stream)typeof(SerialPort).GetField("internalSerialStream", BindingFlags.Instance | BindingFlags.NonPublic).GetValue(this);

            if (stream != null)
            {
                stream.Dispose();
            }

            base.Dispose(disposing);
        }
    }
}

　　2：新建安装项目，将上面项目DLL打包生成Msi安装文件。这里不多说，网上大把文章教你怎么做。

　　3：新建Web项目，具体代码如下：

<html> 
<head> 
<title>JavaScript串口测试</title>
<meta http-equiv="Content-Type" content="text/html; charset=GB2312" />
<script   language="javascript"   type="text/javascript"> 
<!-- 
    function getComPorts()
    {
        var ports = webSerial.getComPorts();
        var arr = ports.split(',');
        var ctl = document.getElementById("ComName"); 
        if(ctl) 
        { 
            ctl.options.length = 0;
            for(var i=0;i<arr.length;i++)
            {
                ctl.options[i] = new Option(arr[i],arr[i]); 
            }
        } 
   }
    
    function connectComPort()
    {
        var com = document.getElementById("ComName").value.toString();
        var baudRate = document.getElementById("BaudRate").value;
        var result = webSerial.connect(com,baudRate);
        alert(result);
    }
    
    function clearComPort()
    {
        webSerial.clear();
        alert("清理串口成功!");
    }
    
    function closeComPort()
    {
        webSerial.close();
        alert("关闭串口成功!");
    }
    
    function writeString()
    {
        var hexString = document.getElementById("txtSend").value.toString(); 
        webSerial.writeString(hexString);
        alert("发送指令成功!");
    } 
    
    function clearSend()
    {
        document.getElementById("txtSend").innerText="";
    }
    
    function clearReceive()
    {
        document.getElementById("txtReceive").innerText="";
    }
    
    function startTime()
    {
        var today=new Date()
        var h=today.getHours()
        var m=today.getMinutes()
        var s=today.getSeconds()
        // add a zero in front of numbers<10
        m=checkTime(m)
        s=checkTime(s)
        document.getElementById('lblTime').innerHTML=h+":"+m+":"+s
        t=setTimeout('startTime()',500)
    }

    function checkTime(i)
    {
        if (i<10) 
          {i="0" + i}
          return i
    }

--> 
</script>   

</head> 
<body onload="startTime()" onunload="closeComPort()">
<form name="form1">     
<fieldset style="225px;height:180px;text-align:center;">
   <legend>串口</legend>
   <div style="float:left;250px">   
       <br/>   
       <span>串口号:</span>
       <select name="ComName" id="ComName" style="100px" >  
       </select>
       <br/>   
       <span>波特率:</span>
   <select name="BaudRate" id="BaudRate" style="100px" >
   <option value="9600" selected="selected">9600</option>
   <option value="57600"  >57600</option>
   <option value="115200" >115200</option>   
   <option value="1382400" >1382400</option>  
   <option value="3000000" >3000000</option>  
   </select>   
   <br/>
       <br/>
       <input   type="button" id="btnGetPort" style="80px;height:30px;font-size:13px"   name="btnGetPort"   value="获取串口"   onclick="getComPorts()"/>       
       <input   type="button" id="btnOpenPort" style="80px;height:30px;font-size:13px"   name="btnOpenPort"   value="打开串口"   onclick="connectComPort()"/>     
       <input   type="button" id="btnClearPort" style="80px;height:30px;font-size:13px"   name="btnClearPort"   value="清理串口"   onclick="clearComPort()"/>         
       <input   type="button" id="btnClosePort" style="80px;height:30px;font-size:13px"   name="btnClosePort"   value="关闭串口"   onclick="closeComPort()"/>       
    </div> 
</fieldset>
<br /><br />
<fieldset style="800px;height:150px;text-align:center;">
   <legend>发送区域</legend>
   <div align="left">V6-握手指令： FF 55 01 01 FE</div>
   <div align="left">V6-50HZ采集：FF 55 05 03 20 4E 00 00 8A</div>
   <div align="left">V6-停止指令： FF 55 01 10 EF</div>
   <div style="float:left;">
       <textarea id="txtSend"  name="txtSend" style="800px;height:80px"></textarea> 
       <br/>
       <input   type="button" id="btnSend" style="100px;height:30px"   name="btnSend"   value="发送"   onclick="writeString()"/>   
       <input  type="button" id="btnClearSend" style="100px;height:30px"   name="btnClearSend"   value="清空"   onclick="clearSend()"/>
   </div> 
</fieldset>
<br /><br />
<fieldset style="800px;height:500px;text-align:center;">
   <legend>接收区域</legend>   
   <div style="float:left;">
   <textarea id="txtReceive"  readonly="readonly" name="txtReceive" style="800px;height:430px"></textarea>  
   <br/>
   <input  type="button" id="btnClearReceive" style="100px;height:30px"   name="btnClearReceive"   value="清空"   onclick="clearReceive()"/>
   </div>
</fieldset>   
<span id="lblTime"></span>
</form> 

<p>

<object classid="clsid:6C6A0DE4-193A-48f5-BA91-3C180558785B" codebase="../WebSerialSetup.msi" width="442" height="87" id="webSerial" name="webSerial">
        </object>
</p>

 <!-- Attaching to an ActiveX event-->
<script language="javascript" type="text/javascript">
    function webSerial::OnReceive(dataString)
    {
        document.getElementById("txtReceive").value += dataString+"
";;   
    }
</script>
</body> 
</html>  

      在使用JS调用ActiveX的时候碰上问题一：方法可以成功调用，而事件却调用失败。网上文章大都是说JS如何调ActiveX,而ActiveX这边的方法或者事件需要满足什么条件才能被JS成功调用却少有涉及。正当我山穷水尽疑无路的时候，事情有了转折，无意中看到一篇老外写的文章。链接地址是：http://www.codeproject.com/Articles/24089/Create-ActiveX-in-NET-Step-by-Step。才知道事件需要实现一个接口才能被JS识别。所以这部分代码后面被加上去了：

　　

/// <summary>
    /// Event handler for events that will be visible from JavaScript
    /// </summary>
    public delegate void ControlEventHandler(string dataString);

    /// <summary>
    /// This interface shows events to javascript
    /// </summary>
    [Guid("68BD4E0D-D7BC-4cf6-BEB7-CAB950161E79")]
    [InterfaceType(ComInterfaceType.InterfaceIsIDispatch)]
    public interface ControlEvents
    {
        //Add a DispIdAttribute to any members in the source interface to specify the COM DispId.
        [DispId(0x60020001)]
        void OnReceive(string dataString); //This method will be visible from JS
    }

　　控件类名前面也加上这个

　　

[ClassInterface(ClassInterfaceType.AutoDual), ComSourceInterfaces(typeof(ControlEvents))]

　　事件定义如下：

　　

public event ControlEventHandler OnReceive;
        [ComVisible(true)]
        private void Receive(string dataString)
        {
            if (OnReceive != null)
            {
                OnReceive(dataString); //Calling event that will be catched in JS
            }
        }

　　本地打开网页，执行全部功能，操作正常，大功告成！！！

　　随后我把网页在本地发布并使用局域网中其他电脑（操作系统WIN7）IE访问该网页。那么问题来了：

　　1：机器弹出对话框拒绝安装当前ActiveX。经过对IE internet选项设置，放开对无签名ActiveX访问限制后。有的机器能弹出安装对话框，有的机器仍然坚决禁止。而且就算是弹出安装对话框，在确认安装后，对话框消失，插件也没装上。。。

　　好吧，这个问题也是没搞明白啥原因。后面时间紧迫，只好给客户一个下载链接，自己去点击下载。

　　2：下载安装包并安装完毕后，在客户机器上操作网页功能。前面几个按钮功能都OK，但是在填入指令点击发送，网页出现崩溃重新刷新的情况，而且换了几台机器都是这样。后面想起在生成安装包的时候，有弹出一个对话框，提示Visual Studio registry capture utility 已停止工作。百度一番后，找到解决方法：在Microsoft Visual Studio 9.0/Common7/Tools/Deployment 路径下面的regcap.exe文件，点击右键在属性页面中，选择兼容性页面，选中“以兼容模式运行”框就好了。兼容win7 就行。

相应设置后，重新生成安装文件。。。在客户机上安装后，一切正常！！！

　　最后附上完整项目代码：http://pan.baidu.com/s/1hq8MzJ2