服务器程序的Xamarin-Java.Interop体验(二)

原本以为会比较容易跑起来demo,但其实还是我太单纯了。

那么今天来介绍一下单纯的在C#中调用Java代码段的一些解读。这样,意味着我们在本文中会直接调用Java的类,而不会在C#中进行继承、重写等。

此时需要考虑用到两个工具:class-parse和generator。

class-parse通过读取jar包字节码,推导出每个类的public、protected方法、字段,并以XML的格式输出。此工具基本上没有太大问题,可以直接使用;当然了,你不会在C#里用java的Stream API吧,所以可以考虑改一下源码来手动去掉stream api。

generator通过读取上述工具生成的XML和部分引用程序集来生成对应的.cs文件。这个工具似乎官方的进度还不够快,有很多老旧的类名称、方法都没有修改(例如JNIEnv、RegisterAttribute、JniHandleOwnership等)需要魔改后才能正式用起来。https://github.com/yang-er/java-interop 这里提供了我自己魔改的结果,不保证运行正确性、与最终发布时的设计的一致性啊~

上述程序运行完了以后,你会获得一个一串.cs文件,然后编译之后就可以在你的C#程序里运行了。注意由于截止目前还没有支持coreclr,请使用TargetFramework = net472编译,并在linux/macos上用mono运行。另外直接根据rt.jar编译出来的文件需要进行一些修改(例如让Java.Lang.Object继承于Java.Interop.JavaObject,让Java.Lang.Throwable继承于Java.Interop.JavaException)

互操作基本方法

generator将对应类的字段、函数,生成对应的JNI调用代码,C#运行时调用这个函数就会通过JNI访问Java的对应功能。

  • 每个函数都会翻译出来四个部分:
    • 一个cb_XXXX的Delegate,用于缓存互操作的时候Java的callback,在继承和重写中需要使用。
    • 一个GetXXXXHandler,用于获取或创建上述callback的委托。
    • 一个n_XXXXX_函数,是提供上述回调类似于C++的方式访问(函数签名都是IntPtr、int等基础值类型),在C#中获取对应对象并进行调用。
    • 一个对应的函数,会将传参列表转换成jvalue*数组,然后通过JniPeerMember缓存的方法信息进行调用。
  • 普通的字段会被生成成为具有getter和setter的属性

  • 具有getXXX(),setXXX(value)的一对函数也会被翻译成属性

  • Listener、Observer之类的东西则会被翻译成事件、EventArgs等

  • 抽象类、接口会生成对应的Invoker,如果C#中没有注册返回对象实际对应类型,则会使用这些Invoker来提供一个假的C#实现,否则哪来的类来调用Java方法呢(雾)

一些细节和讨论

设计是否正确?

是否有必要将get和set对翻译成属性?我个人的观点是:只翻译成对应的函数,然后提供一个属性来访问对应函数。显然这些get和set也可能被virtual override,而重写属性的话代码就会长得比较丑了。

另外对有些类型的返回处理是否有必要?例如java.lang.String和System.String之间是否有必要每次调用都转换?数组直接返回JavaArray不也挺好?有必要将java.util.Collection,java.util.Set等翻译成System.Collections.ICollection吗?虽然生成的代码更C#了,但是实际上似乎会比较影响GC和性能吧?我个人持怀疑态度。

IJavaPeerable

目前与Xamarin.Android一个很大的变化是,他们决定废弃JNIEnv这个不伦不类的类,改为使用JniEnvironment这个进行良好的整理的类。所以类的生成内容都有变化。原来的JniEnv中提供了直接对IntPtr操作的类,现在由JniObjectReference提供对应的方法来复制,整理的更加“干净”。

在Xamarin团队决定将互操作支持带到桌面上的时候,他们一开始使用了SafeHandle来代替原来的IntPtr,但是发现性能下降明显,所以后期他们全部改成了JniObjectReference。目前的generator大部分还都返回IntPtr+JniHandleOwnership,你需要改成ref JniObjectReference+JniObjectReferenceOptions。

除此之外,与初代实现的不同一点是,

类型系统相容性

显然Java中,Throwable是继承于Object的,但是如果想在C#中强类型处理Java异常,Throwable就不能再继承于Object了,除非之后CLR规范修改(雾)

另外目前的Generator生成出来的并没有泛型,全部都是平铺直叙的类。如果想支持C#那样的泛型,需要后期他们继续增加支持,目前你需要自己写一些胶水代码(继承、重写、cast)来“支持”。

另外Java还支持重写某函数以后返回比父类更具体的子类类型,这一点C#是不支持的,所以你可能需要修改生成的胶水代码才能编译。

性能

这套框架走JNI,所以其实性能其实不会太差?但是需要注意的是,这套框架目前翻译Java数组、CharSequence的时候,会有Java数组内容复制到C#数组,和C#数组内容复制到Java数组里,这两个过程,你需要非常小心,尽量在胶水中少使用数组,多使用ArrayList等。

完成进度

我怎么总觉得按他们的速度,这个功能会跳票啊?(大雾)

服务器程序的Xamarin-Java.Interop体验(一)

这几天需要写一个用到Java模块的程序,但是Java是不可能写的,这辈子都不可能写的,只能搞搞interop了。

目前市面上已有的基本上是IKVM.NET和JNBridgePro,后者没太了解技术细节,前者看起来是只有单向的互操作(JVM是跑在CLR上的,或者将Java字节码翻译到MSIL)。

想起来之前好像说.NET 5.0要支持Java互操作,但是翻了翻dotnet/runtime库,丝毫看不出来仓库内在搞支持。后来就想了想,换了xamarin/java.interop库研究看看。

按照之前Xamarin.Android的做法的话,互操作应该是双向的。C#这边可以继承Java的类,然后Java那边也会生成访问对应C#代码的代码。

然后发现……他们正在支持.NET Core 3.1,但是其JNI库引用的头文件还是mono的,而且用到了pthread和dlfcn的头文件,也就是说……现在必须在Linux/macOS和mono下运行。

那么先来build一下吧~

此处以Ubuntu 18.04为例。首先需要准备一些系统依赖。编译要很久,还是选择apt安装吧。

sudo apt install gnupg ca-certificates
sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys 3FA7E0328081BFF6A14DA29AA6A19B38D3D831EF
echo "deb https://download.mono-project.com/repo/ubuntu stable-bionic main" | sudo tee /etc/apt/sources.list.d/mono-official-stable.list
sudo apt update
sudo apt install openjdk-8-jdk mono-devel nuget dotnet-sdk-3.1
sudo ln -s /usr/include/mono-2.0/mono /usr/include/mono

编译的时候TargetFrameworks要用到netcoreapp3.1,所以得安装上。然后就是编译内容了。

先clone一下。

git clone https://github.com/xamarin/java.interop --depth=1
cd java.interop

然后先简单修改一下几个文件。

diff --git a/Directory.Build.props b/Directory.Build.props
index 521e68a..1da7d44 100644
--- a/Directory.Build.props
+++ b/Directory.Build.props
@@ -43,6 +43,8 @@
     <XamarinAndroidToolsDirectory   Condition=" '$(XamarinAndroidToolsDirectory)' == '' ">$(MSBuildThisFileDirectory)external\xamarin-android-tools</XamarinAndroidToolsDirectory>
   </PropertyGroup>
   <PropertyGroup>
+    <JavaCPath>/usr/lib/jvm/java-8-openjdk-amd64/bin/javac</JavaCPath>
+    <JarPath>/usr/lib/jvm/java-8-openjdk-amd64/bin/jar</JarPath>
     <JavacSourceVersion Condition=" '$(JavacSourceVersion)' == '' ">1.8</JavacSourceVersion>
     <JavacTargetVersion Condition=" '$(JavacTargetVersion)' == '' ">1.8</JavacTargetVersion>
     <_BootClassPath Condition=" '$(JreRtJarPath)' != '' ">-bootclasspath "$(JreRtJarPath)"</_BootClassPath>
diff --git a/samples/Hello/Program.cs b/samples/Hello/Program.cs
index 6ffacbb..9f45fac 100644
--- a/samples/Hello/Program.cs
+++ b/samples/Hello/Program.cs
@@ -10,6 +10,7 @@ namespace Hello
                public static unsafe void Main (string[] args)
                {
                        Console.WriteLine ("Hello World!");
+                       JreRuntime.Initialize("/usr/lib/jvm/java-8-openjdk-amd64/jre/lib/amd64/server/libjvm.so");
                        try {
                                var ignore = JniRuntime.CurrentRuntime;
                        } catch (InvalidOperationException e) {
diff --git a/src/Java.Interop/Java.Interop/JniRuntime.cs b/src/Java.Interop/Java.Interop/JniRuntime.cs
index 6de9021..f9fa0de 100644
--- a/src/Java.Interop/Java.Interop/JniRuntime.cs
+++ b/src/Java.Interop/Java.Interop/JniRuntime.cs
@@ -149,7 +149,8 @@ namespace Java.Interop
                                Debug.Assert (count == 0);
                                var available   = GetAvailableInvocationPointers ().FirstOrDefault ();
                                if (available == IntPtr.Zero)
-                                       throw new NotSupportedException ("No available Java runtime to attach to. Please create one.");
+                                       return null;
+                                       //throw new NotSupportedException ("No available Java runtime to attach to. Please create one.");
                                var options     = new CreationOptions () {
                                        DestroyRuntimeOnDispose = false,
                                        InvocationPointer       = available,
diff --git a/src/Java.Runtime.Environment/Java.Interop/JreRuntime.cs b/src/Java.Runtime.Environment/Java.Interop/JreRuntime.cs
index ea1489f..9ca06b0 100644
--- a/src/Java.Runtime.Environment/Java.Interop/JreRuntime.cs
+++ b/src/Java.Runtime.Environment/Java.Interop/JreRuntime.cs
@@ -72,6 +72,14 @@ namespace Java.Interop {

        public class JreRuntime : JniRuntime
        {
+               public static void Initialize(string path)
+               {
+                       int r = NativeMethods.java_interop_jvm_load (path);
+                       if (r != 0) {
+                               throw new Exception ($"Could not load JVM path `{path}` ({r})!");
+                       }
+               }
+
                static int CreateJavaVM (out IntPtr javavm, out IntPtr jnienv, ref JavaVMInitArgs args)
                {
                        return NativeMethods.java_interop_jvm_create (out javavm, out jnienv, ref args);

另外,OpenJDK11应该也是可用的,不过得注意JavacSourceVersion和JavacTargetVersion=11,由于使用的部分代码还是java8标准所以建议继续JavacSourceVersion=1.8。暂时还没实验jdk11。

文件差不多编辑完了,来编译。

make src/Java.Runtime.Environment/Java.Runtime.Environment.dll.config
make
mono bin/TestDebug/Hello.exe

此时会显示运行成功的样子。如果没成功,那就是我忘了哪个步骤没写(逃)

Hello World!
Part 2!
# JniEnvironment.EnvironmentPointer=94212541059552
vm.SafeHandle=140206052962432
java.lang.Object=0x55af91090e50/L
hashcode=1735600054
WITHIN: GetCreatedJavaVMs: 140206052962432
POST: GetCreatedJavaVMs: 140206052962432

接下来的文章将大致介绍如何在C#中直接调用Java代码,而不是JniType一顿操作。