如何在SWIG中高效封装C++轻量Timestamp类为C#值类型？

背景 #

我有一个C++轻量时间戳类型，本质是int64_t的包装类，属于trivially copyable类型，使用时和直接操作int64_t几乎无额外开销，处理大量实例也很高效：

/// Represents UTC timestamp
class Timestamp {
    int64_t nanos_;

    public:
    Timestamp(int64_t nanos)
        : nanos_(nanos) {}

    int64_t nanos() const noexcept { return nanos_; }

    /// Convert timestamp to string with form YYYY-MM-DD HH:MM:SS (UTC time)
    std::string toString() const;

    /// Convert timestamp to string with form YYYY-MM-DD HH:MM:SS (UTC time)
    /// Use the specified timezone, eg 'America/New_York'
    std::string toString(std::string const& tz) const;

    // Other functions...
};

但用SWIG生成的C#包装却是臃肿的引用类型，每个实例都持有指向堆分配C++对象的指针，每次调用都有多层间接调用：

///  Represents UTC timestamp
public class Timestamp : global::System.IDisposable {
  private global::System.Runtime.InteropServices.HandleRef swigCPtr;
  protected bool swigCMemOwn;

  internal Timestamp(global::System.IntPtr cPtr, bool cMemoryOwn) {
    swigCMemOwn = cMemoryOwn;
    swigCPtr = new global::System.Runtime.InteropServices.HandleRef(this, cPtr);
  }

  internal static global::System.Runtime.InteropServices.HandleRef getCPtr(Timestamp obj) {
    return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
  }

  internal static global::System.Runtime.InteropServices.HandleRef swigRelease(Timestamp obj) {
    if (obj != null) {
      if (!obj.swigCMemOwn)
        throw new global::System.ApplicationException("Cannot release ownership as memory is not owned");
      global::System.Runtime.InteropServices.HandleRef ptr = obj.swigCPtr;
      obj.swigCMemOwn = false;
      obj.Dispose();
      return ptr;
    } else {
      return new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero);
    }
  }

  // ...
}

请问是否有办法让SWIG生成同样高效的C#实现，比如基于int64的值类型包装？

解决方案 #

1. 用%value指令标记值类型 #

SWIG提供了%value指令，可直接将C++的轻量类标记为值类型，避免生成引用类型的包装。在SWIG接口文件中添加：

%module YourModuleName

// 标记Timestamp为值类型，告知SWIG按值传递/处理
%value(Timestamp);

%{
#include "Timestamp.h"
%}

// 引入C++类定义
%include "Timestamp.h"

这样SWIG会生成C#的struct（值类型），直接持有对应的long值，消除堆分配和指针间接调用的开销。

2. 自定义typemap实现精细控制（可选） #

如果需要更灵活地控制C#端的结构和方法，可以用SWIG的%typemap直接定义C#值类型，并处理C++与C#的转换逻辑：

%module YourModuleName

%{
#include "Timestamp.h"
%}

// 将C#端的Timestamp定义为struct（值类型）
%typemap(csclassmodifiers) Timestamp "public struct"

// 自定义C#结构体的内部实现
%typemap(csbody) Timestamp %{
    private long nanos;

    public Timestamp(long nanos) {
        this.nanos = nanos;
    }

    public long Nanos {
        get { return nanos; }
    }

    // 映射C++的toString方法
    public string ToString() {
        return YourModuleNamePINVOKE.Timestamp_toString(this.nanos);
    }

    public string ToString(string tz) {
        return YourModuleNamePINVOKE.Timestamp_toString__SWIG_1(this.nanos, tz);
    }
%}

// 处理C++返回值到C#结构体的转换
%typemap(out) Timestamp %{
    $result = Timestamp($1.nanos());
%}

// 处理C#结构体到C++参数的转换
%typemap(in) Timestamp %{
    $1 = Timestamp($input.Nanos);
%}

%include "Timestamp.h"

3. 验证与注意事项 #

• 确保C++的Timestamp是trivially copyable：无虚函数、无自定义析构/构造函数，保证值传递的安全性。
• 生成的C#struct会直接持有long类型的时间戳值，调用方法时直接传递值，和C++端效率一致。
• 对于std::vector<Timestamp>这类容器，SWIG会自动适配值类型，生成高效的C#容器包装，避免指针开销。

内容的提问来源于stack exchange，提问作者Alecto