草庐IT

java - 使用 SWIG 将 Java Map<String, String> 传递给 C++ 方法

coder 2024-02-02 原文

我有一个用 C++ 定义的方法:

std::map<std::string, std::string> validate(
                                   std::map<std::string, std::string> key, 
                                   std::map<std::string, std::string> value
                                   );

我想在 Java 中使用这个方法。所以,我必须使用 Swig 编写一个包装器,我将能够通过它来传递 Java Map作为 STL map到 C++ 方法。

请让我知道我应该如何为 swig 定义 .i 文件以完成这项工作。

最佳答案

为此,您需要使用 java.util.Map 告诉 SWIG 将 %typemap(jstype) 用于输入参数。您还需要提供一些代码以将 Java 映射类型转换为 C++ std::map 类型,SWIG 将在适当的点注入(inject)该类型。我已经整理了一个小(编译,但未经测试)的例子来说明这一点:

%module test

%include <std_map.i>
%include <std_string.i>

%typemap(jstype) std::map<std::string, std::string> "java.util.Map<String,String>"
%typemap(javain,pre="    MapType temp$javainput = $javaclassname.convertMap($javainput);",pgcppname="temp$javainput") std::map<std::string, std::string> "$javaclassname.getCPtr(temp$javainput)"
%typemap(javacode) std::map<std::string, std::string> %{
  static $javaclassname convertMap(java.util.Map<String,String> in) {
    $javaclassname out = new $javaclassname();
    for (java.util.Map.Entry<String, String> entry : in.entrySet()) {
      out.set(entry.getKey(), entry.getValue());      
    }
    return out;
  }    
%}

%template(MapType) std::map<std::string, std::string>;

void foo(std::map<std::string, std::string>);
pgcppname 部分确保我们传入的 std::map 不会过早地被垃圾收集。有关其工作原理的更多详细信息,请参阅 SWIG 文档中的 this example

支持从 std::map 从 C++ 返回到 Java 需要做更多的工作,但这是可能的。 java.util.Map 是一个接口(interface),所以我们需要调整 std::map 的默认包装来满足该接口(interface)。在实践中,使用 java.util.AbstractMap 并从中继承更容易,尽管我最终覆盖了其中的大部分功能。整个解决方案类似于 my answer for std::vector

在我的最终版本中有相当多的移动部分。我将在这里完整地展示它,并附上注释:
%module test
%{
#include <cassert>
#include <iostream>
%}

%include <std_map.i>

// 1.
%rename (size_impl) std::map<std::string,std::string>::size;
%rename (isEmpty) std::map<std::string,std::string>::empty;
%include <std_string.i>

%typemap(jstype) std::map<std::string, std::string> "java.util.Map<String,String>"
%typemap(javain,pre="    MapType temp$javainput = $javaclassname.convertMap($javainput);",pgcppname="temp$javainput") std::map<std::string, std::string> "$javaclassname.getCPtr(temp$javainput)"
%typemap(javacode) std::map<std::string, std::string> %{
  static $javaclassname convertMap(Map<String,String> in) {
    // 2.
    if (in instanceof $javaclassname) {
      return ($javaclassname)in;
    }

    $javaclassname out = new $javaclassname();
    for (Map.Entry<String, String> entry : in.entrySet()) {
      out.set(entry.getKey(), entry.getValue());
    }
    return out;
  }

  // 3.
  public Set<Map.Entry<String,String>> entrySet() {
    HashSet<Map.Entry<String,String>> ret = new HashSet<Map.Entry<String,String>>(size());
    String array[] = new String[size()];
    all_keys(array);
    for (String key: array) {
      ret.add(new MapTypeEntry(key,this));
    }
    return ret;
  }

  public Collection<String> values() {
    String array[] = new String[size()];
    all_values(array);
    return new ArrayList<String>(Arrays.asList(array));
  }

  public Set<String> keySet() {
    String array[] = new String[size()];
    all_keys(array);
    return new HashSet<String>(Arrays.asList(array));
  }

  // 4.
  public String remove(Object key) {
    final String ret = get(key);
    remove((String)key);
    return ret;
  }

  public String put(String key, String value) {
    final String ret = has_key(key) ? get(key) : null;
    set(key, value);
    return ret;
  }

  // 5.
  public int size() {
    return (int)size_impl();
  }
%}

// 6.
%typemap(javaimports) std::map<std::string, std::string> "import java.util.*;";
// 7.
%typemap(javabase) std::map<std::string, std::string> "AbstractMap<String, String>";

// 8.
%{
template <typename K, typename V>
struct map_entry {
  const K key;
  map_entry(const K& key, std::map<K,V> *owner) : key(key), m(owner) {
  }
  std::map<K,V> * const m;
};
%}

// 9.
template <typename K, typename V>
struct map_entry {
  const K key;
  %extend {
    V getValue() const {
      return (*$self->m)[$self->key];
    }

    V setValue(const V& n) const {
      const V old = (*$self->m)[$self->key];
      (*$self->m)[$self->key] = n;
      return old;
    }
  }
  map_entry(const K& key, std::map<K,V> *owner);
};

// 10.
%typemap(javainterfaces) map_entry<std::string, std::string> "java.util.Map.Entry<String,String>";
// 11.
%typemap(in,numinputs=0) JNIEnv * %{
  $1 = jenv;
%}

// 12.
%extend std::map<std::string, std::string> {
  void all_values(jobjectArray values, JNIEnv *jenv) const {
    assert((jsize)$self->size() == jenv->GetArrayLength(values));
    jsize pos = 0;
    for (std::map<std::string, std::string>::const_iterator it = $self->begin();
         it != $self->end();
         ++it) {
       jenv->SetObjectArrayElement(values, pos++, jenv->NewStringUTF(it->second.c_str()));
    }
  }

  void all_keys(jobjectArray keys, JNIEnv *jenv) const {
    assert((jsize)$self->size() == jenv->GetArrayLength(keys));
    jsize pos = 0;
    for (std::map<std::string, std::string>::const_iterator it = $self->begin();
         it != $self->end();
         ++it) {
       jenv->SetObjectArrayElement(keys, pos++, jenv->NewStringUTF(it->first.c_str()));
    }
  }
}

%template(MapType) std::map<std::string, std::string>;
%template(MapTypeEntry) map_entry<std::string, std::string>;

// 13.
%inline %{
  std::map<std::string, std::string> foo(std::map<std::string, std::string> in) {
    for (std::map<std::string, std::string>::const_iterator it = in.begin();
         it != in.end(); ++it) {
      std::cout << it->first << ": " << it->second << "\n";
    }

    return std::map<std::string, std::string>(in);
  }
%}
  • std_map.i 并不是要实现任何接口(interface)/抽象类。为此,我们需要重命名一些公开的内容。
  • 因为我们让我们的类型实现 Map (通过 AbstractMap ),所以最终从 MapType -> MapType 转换是很愚蠢的,而这实际上只是一个复制操作。 convertMap 方法现在检查这种情况作为优化。
  • EntrySetAbstractMap 的主要要求。我们(稍后)定义了 MapTypeEntry 来为我们实现 Map.Entry 接口(interface)。这稍后会在 %extend 中使用更多代码来有效地将所有键作为数组进行枚举。请注意,这不是线程安全的,如果我们在此枚举进行时更改 map ,则会发生奇怪的坏事并且可能无法检测到。
  • remove 是我们为了可变而必须实现的方法之一。 removeput 都必须返回旧值,所以这里有一些额外的 Java 来实现这一点,因为 C++ 映射不这样做。
  • 由于需要 long/int 转换,甚至 size() 也不兼容。真的,我们应该检测非常大的 map 某处的精度损失,并为溢出做一些理智的事情。
  • 我厌倦了在任何地方输入 java.util.Map,所以这使得生成的 SWIG 代码具有所需的导入。
  • 这将 MapType 设置为从 AbstractMap 继承,以便我们代理并满足 Java 映射的要求,而不是做额外的复制来转换回来。
  • 将作为我们入口的类的 C++ 定义。它只有一个键和一个指向它所拥有的映射的指针。该值不存储在 Entry 对象本身中,并且总是被引用回底层映射。这种类型也是不可变的,我们永远无法更改拥有的 map 或 key 。
  • 这就是 SWIG 看到的。我们提供了一个额外的 get/setValue 函数来回调它源自的 map 。指向拥有映射的指针没有公开,因为我们不需要这样做,它实际上只是一个实现细节。
  • java.util.Map.Entry<String,String>
  • 这是一个技巧,它自动填充 jenv 中某些代码的 %extend 参数,我们需要在该代码中进行一些 JNI 调用。
  • %extend 中的这两个方法将所有的键和值分别放入一个输出数组中。传入数组时,预计该数组的大小是正确的。有一个断言来验证这一点,但实际上它应该是一个异常(exception)。这两个都是内部实现细节,无论如何都应该是私有(private)的。它们被所有需要批量访问键/值的函数使用。
  • foo 的实际实现,用于对我的代码进行完整性检查。

  • 内存管理在这里是免费的,因为它仍然归 C++ 代码所有。 (因此您仍然必须决定如何管理 C++ 容器的内存,但这并不是什么新鲜事)。由于返回给 Java 的对象只是 C++ 映射的包装器,因此容器的元素不必比它更长寿。在这里,它们也是 Strings,它们的特殊之处在于它们作为新对象返回,如果它们是使用 SWIG 的 std::shared_ptr 支持的智能指针,那么一切都会按预期工作。唯一棘手的情况是指向对象的指针映射。在这种情况下,Java 程序员有责任至少在返回任何 Java 代理时使映射及其内容保持 Activity 状态。

    最后我写了以下Java来测试它:
    import java.util.Map;
    
    public class run {
      public static void main(String[] argv) {
        System.loadLibrary("test");
    
        Map<String,String> m = new MapType();
        m.put("key1", "value1");
        System.out.println(m);
        m = test.foo(m);
        System.out.println(m);
      }
    }
    

    我编译并运行为:

    swig2.0 -Wall -java -c++ test.i
    gcc -Wall -Wextra -shared -o libtest.so -I/usr/lib/jvm/default-java/include -I/usr/lib/jvm/default-java/include/linux test_wrap.cxx
    javac run.java
    LD_LIBRARY_PATH=. java run
    {key1=value1}
    key1: value1
    {key1=value1}
    

    关于java - 使用 SWIG 将 Java Map<String, String> 传递给 C++ 方法,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/10812607/

    有关java - 使用 SWIG 将 Java Map<String, String> 传递给 C++ 方法的更多相关文章

    1. ruby - 如何使用 Nokogiri 的 xpath 和 at_xpath 方法 - 2

      我正在学习如何使用Nokogiri,根据这段代码我遇到了一些问题:require'rubygems'require'mechanize'post_agent=WWW::Mechanize.newpost_page=post_agent.get('http://www.vbulletin.org/forum/showthread.php?t=230708')puts"\nabsolutepathwithtbodygivesnil"putspost_page.parser.xpath('/html/body/div/div/div/div/div/table/tbody/tr/td/div

    2. ruby - 使用 RubyZip 生成 ZIP 文件时设置压缩级别 - 2

      我有一个Ruby程序,它使用rubyzip压缩XML文件的目录树。gem。我的问题是文件开始变得很重,我想提高压缩级别,因为压缩时间不是问题。我在rubyzipdocumentation中找不到一种为创建的ZIP文件指定压缩级别的方法。有人知道如何更改此设置吗?是否有另一个允许指定压缩级别的Ruby库? 最佳答案 这是我通过查看ruby​​zip内部创建的代码。level=Zlib::BEST_COMPRESSIONZip::ZipOutputStream.open(zip_file)do|zip|Dir.glob("**/*")d

    3. ruby - 为什么我可以在 Ruby 中使用 Object#send 访问私有(private)/ protected 方法? - 2

      类classAprivatedeffooputs:fooendpublicdefbarputs:barendprivatedefzimputs:zimendprotecteddefdibputs:dibendendA的实例a=A.new测试a.foorescueputs:faila.barrescueputs:faila.zimrescueputs:faila.dibrescueputs:faila.gazrescueputs:fail测试输出failbarfailfailfail.发送测试[:foo,:bar,:zim,:dib,:gaz].each{|m|a.send(m)resc

    4. ruby-on-rails - 使用 Ruby on Rails 进行自动化测试 - 最佳实践 - 2

      很好奇,就使用ruby​​onrails自动化单元测试而言,你们正在做什么?您是否创建了一个脚本来在cron中运行rake作业并将结果邮寄给您?git中的预提交Hook?只是手动调用?我完全理解测试,但想知道在错误发生之前捕获错误的最佳实践是什么。让我们理所当然地认为测试本身是完美无缺的,并且可以正常工作。下一步是什么以确保他们在正确的时间将可能有害的结果传达给您? 最佳答案 不确定您到底想听什么,但是有几个级别的自动代码库控制:在处理某项功能时,您可以使用类似autotest的内容获得关于哪些有效,哪些无效的即时反馈。要确保您的提

    5. ruby - 在 Ruby 中使用匿名模块 - 2

      假设我做了一个模块如下:m=Module.newdoclassCendend三个问题:除了对m的引用之外,还有什么方法可以访问C和m中的其他内容?我可以在创建匿名模块后为其命名吗(就像我输入“module...”一样)?如何在使用完匿名模块后将其删除,使其定义的常量不再存在? 最佳答案 三个答案:是的,使用ObjectSpace.此代码使c引用你的类(class)C不引用m:c=nilObjectSpace.each_object{|obj|c=objif(Class===objandobj.name=~/::C$/)}当然这取决于

    6. ruby - 使用 ruby​​ 和 savon 的 SOAP 服务 - 2

      我正在尝试使用ruby​​和Savon来使用网络服务。测试服务为http://www.webservicex.net/WS/WSDetails.aspx?WSID=9&CATID=2require'rubygems'require'savon'client=Savon::Client.new"http://www.webservicex.net/stockquote.asmx?WSDL"client.get_quotedo|soap|soap.body={:symbol=>"AAPL"}end返回SOAP异常。检查soap信封,在我看来soap请求没有正确的命名空间。任何人都可以建议我

    7. python - 如何使用 Ruby 或 Python 创建一系列高音调和低音调的蜂鸣声? - 2

      关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题?更新问题,以便editingthispost可以用事实和引用来回答它.关闭4年前。Improvethisquestion我想在固定时间创建一系列低音和高音调的哔哔声。例如:在150毫秒时发出高音调的蜂鸣声在151毫秒时发出低音调的蜂鸣声200毫秒时发出低音调的蜂鸣声250毫秒的高音调蜂鸣声有没有办法在Ruby或Python中做到这一点?我真的不在乎输出编码是什么(.wav、.mp3、.ogg等等),但我确实想创建一个输出文件。

    8. ruby-on-rails - 'compass watch' 是如何工作的/它是如何与 rails 一起使用的 - 2

      我在我的项目目录中完成了compasscreate.和compassinitrails。几个问题:我已将我的.sass文件放在public/stylesheets中。这是放置它们的正确位置吗?当我运行compasswatch时,它不会自动编译这些.sass文件。我必须手动指定文件:compasswatchpublic/stylesheets/myfile.sass等。如何让它自动运行?文件ie.css、print.css和screen.css已放在stylesheets/compiled。如何在编译后不让它们重新出现的情况下删除它们?我自己编译的.sass文件编译成compiled/t

    9. ruby - 使用 ruby​​ 将 HTML 转换为纯文本并维护结构/格式 - 2

      我想将html转换为纯文本。不过,我不想只删除标签,我想智能地保留尽可能多的格式。为插入换行符标签,检测段落并格式化它们等。输入非常简单,通常是格式良好的html(不是整个文档,只是一堆内容,通常没有anchor或图像)。我可以将几个正则表达式放在一起,让我达到80%,但我认为可能有一些现有的解决方案更智能。 最佳答案 首先,不要尝试为此使用正则表达式。很有可能你会想出一个脆弱/脆弱的解决方案,它会随着HTML的变化而崩溃,或者很难管理和维护。您可以使用Nokogiri快速解析HTML并提取文本:require'nokogiri'h

    10. ruby - 在 64 位 Snow Leopard 上使用 rvm、postgres 9.0、ruby 1.9.2-p136 安装 pg gem 时出现问题 - 2

      我想为Heroku构建一个Rails3应用程序。他们使用Postgres作为他们的数据库,所以我通过MacPorts安装了postgres9.0。现在我需要一个postgresgem并且共识是出于性能原因你想要pggem。但是我对我得到的错误感到非常困惑当我尝试在rvm下通过geminstall安装pg时。我已经非常明确地指定了所有postgres目录的位置可以找到但仍然无法完成安装:$envARCHFLAGS='-archx86_64'geminstallpg--\--with-pg-config=/opt/local/var/db/postgresql90/defaultdb/po

    随机推荐