SWIG 结构成员被 Java 的垃圾收集器过早释放

Question

我有一个 C++ 库，Java 通过基于 SWIG 的接口调用它。在 Java 方面，我使用默认的 struct 接口和 carrays.i 的 %array_class 构建了一个包含指向其他结构数组的指针的结构。

由于 Java 的垃圾收集器不知道顶级结构的成员，因此有时会释放数组，此时其终结器将删除其后备内存。我需要一种解决方法，最好不要在 Java 中复制该结构，因为它相当大。

一个最小的示例如下所示（尽管它可能不会触发错误，因为它没有做太多事情）：

C++/SWIG：

%module example

%include "carrays.i"
%array_class(object, objectArray);

struct object {
    unsigned int id;
    char *name;
};

struct data {
    size_t nobjects;
    object *objects;
};

void use_data(data*);

Java：

public class Example {
    private static data writeData() {
        data d = new data();
        objectArray os = new objectArray(3);
        for (int i = 0; i < 3; i++) {
            object o = new object();
            o.setId(i);
            o.setName("obj" + i);
            os.setitem(i, o);
        }
        d.setNobjects(3);
        d.setObjects(os.cast());

        return d;
    }

    public static void main(String[] args) {
        data d = writeData();
        example.use_data(d);
    }
}

Answer 1

对此有几种可能的解决方案。最简单的方法是包装一个可以创建对象而无需 Java“拥有”内存的函数。这可能看起来像：

%inline %{
object *new_object() {
  // SWIG will assume that it doesn't own this
  return new object;
}
%}

---

您实际上可以在创建后修改 swigCMemOwn boolean 。类型映射应该能够将其注入到适当的位置（当将 object 传递给 setitem 时）。例如，您可以编写：

%typemap(javacode) object %{
  object transfer() {
    swigCMemOwn = false;
    return this;
  }
%}

这需要在第一次看到 object 类之前，并允许您编写类似以下内容：

os.setitem(i, o.transfer());

而不是 os.setitem(i, o); 。

---

此主题的一个变体是使用 javain 类型映射来替换 Java 代理中的默认 setitem 实现，以便它调用 上的函数（您提供） >object 更改所有权，例如：

%javamethodmodifiers objectArray::setitem "protected";
%rename  objectArray::setitem setitemImpl;

%typemap(javacode) objectArray %{
  public void setitem(int i, object o) {
    o.disown();
    setitemImpl(i, o);
  }
%}

在 %include "carrays.i" 之前以及通过 %typemap(javacode) 相应的 disown() ）对象。 （swigCMemOwn 受保护，因此 objectArray 无法直接修改它）。

---

还有其他可能的方法，其中也涉及设置所有权。我所展示的那些是我认为最简单的。

或者，另一种常见的解决方法是 保留对 Java 代理对象的引用，通过将其分配给成员变量。在这种情况下，因为您可能有很多对象，但它们本身必须是容器。