.NET运行时核心开发指南：CLR代码编写规范详解-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00240/article/details/148375780

.NET运行时核心开发指南：CLR代码编写规范详解

runtime .NET is a cross-platform runtime for cloud, mobile, desktop, and IoT apps. 项目地址: https://gitcode.com/gh_mirrors/runtime6/runtime

前言

在开发.NET运行时核心组件时，遵循正确的编码规范至关重要。本文将深入解析CLR开发中的关键注意事项，帮助开发者避免常见问题，编写出高效、安全的底层代码。

垃圾收集安全编程

GC问题的本质

GC问题是CLR开发中最危险的错误类型之一，它会导致对象引用失效，引发数据损坏或程序崩溃。这类错误通常难以复现，调试成本极高。

典型GC问题示例

{
    MethodTable* pMT = g_pObjectClass->GetMethodTable();
    OBJECTREF a = AllocateObject(pMT);  // 分配第一个对象
    OBJECTREF b = AllocateObject(pMT); // 可能触发GC
    
    // 注意！如果第二次分配触发GC，a可能指向无效内存
    DoSomething(a, b); 
}

正确保护对象引用

使用GCPROTECT_BEGIN/END宏保护对象引用：

#include "frames.h"
{
    MethodTable* pMT = g_pObjectClass->GetMethodTable();
    OBJECTREF a = AllocateObject(pMT);
    
    GCPROTECT_BEGIN(a);  // 开始保护
    OBJECTREF b = AllocateObject(pMT);
    DoSomething(a, b);
    GCPROTECT_END();     // 结束保护
}

保护机制要点

每个GCPROTECT_BEGIN必须有对应的GCPROTECT_END
禁止在保护块内使用非局部跳转(如goto、return)
可以抛出托管异常(通过COMPlusThrow)
不要重复保护同一变量

长期对象保护

对于需要长期保护的对象引用，应使用OBJECTHANDLE：

{
    OBJECTHANDLE ah = CreateHandle(AllocateObject(pMT));
    // 可以通过ObjectFromHandle(ah)获取最新引用
    DestroyHandle(ah); // 不再需要时释放
}

资源管理与异常安全

Holder模式的重要性

Holder是CLR中管理资源的智能指针模式，确保资源在作用域结束时被正确释放。

典型Holder使用示例

{
    // 使用NewHolder自动管理内存
    NewHolder<MyClass> pObj = new MyClass();
    pObj->DoWork();
    // 退出作用域时自动调用delete
}

常用Holder类型

NewHolder: 管理new分配的内存
NewArrayHolder: 管理new[]分配的数组
ComHolder: 管理COM接口引用计数
CrstHolder: 管理临界区锁

内存不足(OOM)处理

OOM处理原则

明确标注可能抛出OOM异常的函数
使用INJECT_FAULT宏处理潜在OOM
避免在OOM状态下执行危险操作

OOM处理示例

void MyFunction()
{
    CONTRACTL {
        THROWS;
        GC_TRIGGERS;
    } CONTRACTL_END;
    
    INJECT_FAULT(ThrowOutOfMemory());
    // 可能分配内存的操作
}

字符串与内存操作

安全字符串处理

使用SString类代替原生字符串操作
避免直接使用strcpy等不安全函数
跨平台开发时注意字符编码问题

安全内存计算

使用safemath.h中的工具进行安全的内存大小计算：

size_t cbTotal;
if (!ClrSafeInt<size_t>::addition(cb1, cb2, cbTotal)) {
    ThrowOutOfMemory();
}

线程同步机制

临界区使用规范

使用Crst类型代替原生同步机制
明确指定锁的层级
使用CrstHolder自动管理锁状态

临界区示例

{
    CrstHolder holder(&m_crst);  // 自动加锁
    // 受保护的代码区域
    // 退出作用域时自动解锁
}

锁层级原则

定义清晰的锁层次结构
避免循环等待
使用CRST_UNORDERED标记特殊锁

类型系统与平台兼容性

跨平台开发注意事项

避免直接使用wchar_t
使用平台无关的类型定义(如INT_PTR)
64位兼容性检查

类型大小规范

| 类型 | 32位大小 | 64位大小 | |------------|---------|---------| | SIZE_T | 4字节 | 8字节 | | INT_PTR | 4字节 | 8字节 | | LPVOID | 4字节 | 8字节 |

函数契约与调试支持

函数契约规范

每个函数都应声明CONTRACT，明确其行为：

void MyFunction()
{
    CONTRACTL {
        THROWS;               // 可能抛出异常
        GC_TRIGGERS;          // 可能触发GC
        MODE_COOPERATIVE;     // 必须在协作模式下调用
    } CONTRACTL_END;
    
    // 函数实现
}