c#实战踩坑指南2：写个函数调用都能翻车

╰+攻爆jí腚メ 2023-10-03 11:12 20阅读 0赞

在c\#中有一种叫做成员函数的概念，即类（或结构体）中的（成员或静态）的方法。这是基础中不能更基础的内容了。怎么这里也会有坑吗？对的，不仅有，而且还是文档里没有描述过的坑。

某天，我拿到了一台大华摄像头（卡口型，其实跟枪机的SDK是通用的）。顺便一提，大华是监控领域的2位大佬之一，另一位是海康。

根据摄像头SDK及示例代码，有如下c\#函数可供调用以获取摄像头画面（其实这个与bug症状的成因无关，仅仅只是介绍上下文，不看也可）：

NETClient.RealLoadPicture(loginId, ChannelNum, (uint)EM_EVENT_IVS_TYPE.TRAFFIC_MANUALSNAP, true, currentSnap.CallBack_KaKou, loginId, IntPtr.Zero);

其中currentSnap 参数是 以下SnapInfo 类的实例，该类大体类似于下面的代码，其中的参数与本文描述的内容无关，从略：

public class SnapInfo
        {
            internal int CallBack_KaKou(......)
            {
                ......
            }
        }

总之就是一段很简单的类含有一个成员函数就行了。

故障的效果很有趣，开始几分钟，一切正常，代码工作如预期，能够得到了摄像头画面。但是几分钟后，程序就挂了。不是线程挂了，而是整个进程直接死掉——哪怕在所有部位都加上try...catch...段进行包裹都无法避免进程死掉。

这就特别蹊跷了！根据经验，这事明显GC在作怪啊！，于是果断加上GC防杀。

GC.KeepAlive(currentSnap) // currentSnap是SnapInfo类的一个实例

然并卵！症状依旧。于是回头看了一眼大华提供的官方示例。有一个细节引起了我的注意。

在官方示例中，它们使用的是（一个委托类型的）成员属性，而不是成员函数（面向对象中称为成员方法），哪怕他们的值是相同的。

注意，好玩的地方正在于此。大家都知道，方法和属性是类（或结构体）的两种不同成员，前者用于动词，后者用于形容词。比如鸭子类，属性可以是颜色、重量，方法可以是游泳、飞行。这里官方示例为什么需要对一个获取图象画面使用属性，而不是使用方法呢？

原因确实在于GC，垃圾回收器。

我的成员方法，也就是函数，在某个不适当的时候，被GC销毁掉了——注意此时类的实例还是活着的，类的成员函数被杀死了。

为了避免被GC杀死，不得不违反一下面向对象（OOD）的原则，把函数改造为属性。代码如下（无关代码已缩略）：

public class SnapInfo
        {
            public SnapInfo() { this.Prop = new fAnalyzerDataCallBack(this.CallBack_KaKou); }
    
            public fAnalyzerDataCallBack Prop { get; private set; }
    
            internal int CallBack_KaKou(......)
            {
                ......
            }
        }

其中构造函数时，将成员属性赋值，其值为成员函数构成的一个回调实例。同时也适当修改SDK函数传参处的值，使其语法合规。

然后，这个GC乱杀函数的故障就被成功回避了。

这个故障的要点在于，c\#程序不是独立工作的，而是将自己的函数指针送交给了某个非托管的程序。

在我的故障中，是一个硬件设备，但是实际上对任何其他类型的非托管程序，效果都是一样的。因为GC并不知道你的函数是否仍然有用，于是发生了误杀。当修改为成员属性的时候，由于属性和实例具有明确的不可分割性，GC就算想杀掉该函数，也会看在类实例的面子上保留这个值的——当然，建议对类实例加上防杀，更为严谨，这么做即使没有代码上的意义，也会为Code Review的人提供一个便于理解的辅助效果。

再次强调，作为【**回调函数】**，给【**非托管】**程序传参，是造成此问题的原因因为GC并不知道函数参数的引用对象是否应该被回收。并不仅限于对硬件设备传参（本例中的大华摄像头）。