linecode/androidjscore

AndroidJSCore allows Android developers to use JavaScript natively in their apps.

AndroidJSCore

AndroidJSCore allows Android developers to use JavaScript natively in their apps.

AndroidJSCore is an Android Java JNI wrapper around Webkit's JavaScriptCore C library. It is inspired by the Objective-C JavaScriptCore Framework included natively in iOS 7 and above. Being able to natively use JavaScript in an app without requiring the use of JavaScript injection on a bloated, slow, security-constrained WebView is very useful for many types of apps, such as games or platforms that support plugins. However, its use is artificially limited because the framework is only supported on iOS. Most developers want to use technologies that will scale across both major mobile operating systems. AndroidJSCore was designed to support that requirement.

Design Goals

• Enable full JavaScript support on Android with a Java-only interface (no need to write C/C++ code)
• Maintain feature-level compatibility with the Objective-C JavaScriptCore framework

NOTICE

AndroidJSCore is currently unsupported. Instead, I am moving all of this functionality and more to its permanent home, LiquidCore. Please migrate to this version going forward.

Version

3.0.1 - Get it through JitPack

Note there are some significant changes between 3.0 and the 2.x series. In particular, handling of functions and constructors is simpler (and more correct).

Working With AndroidJSCore

Please see the Javadocs for complete documentation of the API. Also take a look at the example app source code. It contains more detailed examples that cover the basics, sharing data and functions between Java and JavaScript, wrapping JS classes in Java which are accessible from both environments, and asynchronous, multi-threaded callbacks between environments.

To get started, you need to create a JavaScript JSContext. The execution of JS code occurs within this context, and separate contexts are isolated virtual machines which do not interact with each other.

JSContext context = new JSContext();

This context is itself a JavaScript object. And as such, you can get and set its properties. Since this is the global JavaScript object, these properties will be in the top-level context for all subsequent code in the environment.

context.property("a", 5);
JSValue aValue = context.property("a");
double a = aValue.toNumber();
DecimalFormat df = new DecimalFormat(".#");
System.out.println(df.format(a)); // 5.0

You can also run JavaScript code in the context:

context.evaluateScript("a = 10");
JSValue newAValue = context.property("a");
System.out.println(df.format(newAValue.toNumber())); // 10.0
String script =
  "function factorial(x) { var f = 1; for(; x > 1; x--) f *= x; return f; }\n" +
  "var fact_a = factorial(a);\n";
context.evaluateScript(script);
JSValue fact_a = context.property("fact_a");
System.out.println(df.format(fact_a.toNumber())); // 3628800.0

AndroidJSCore is much more powerful than that. You can also write functions in Java, but expose them to JavaScript:

JSFunction factorial = new JSFunction(context,"factorial") {
    public Integer factorial(Integer x) {
        int factorial = 1;
        for (; x > 1; x--) {
        	   factorial *= x;
        }
        return factorial;
    }
};

This creates a JavaScript function that will call the Java method factorial when called from JavaScript. It can then be passed to the JavaScript VM:

context.property("factorial", factorial);
context.evaluateScript("var f = factorial(10);")
JSValue f = context.property("f");
System.out.println(df.format(f.toNumber())); // 3628800.0

If you are used to working with JavaScriptCore in iOS, see the file OwenMatthewsExample.java in the example app to see side-by-side how to use AndroidJSCore in Java the same way you would use JavaScriptCore in Objective-C.

The Javadocs and included example app have detailed descriptions of how to do just about everything.

Use AndroidJSCore in your project

Step 1. Add the JitPack repository to your build file

Add it in your root build.gradle at the end of repositories:

allprojects {
	repositories {
		...
		maven { url "https://jitpack.io" }
	}
}

Step 2. Add the dependency

dependencies {
        compile 'com.github.ericwlange:AndroidJSCore:3.0.1'
}

You should be all set!

Building the AndroidJSCoreExample app

If you want to see AndroidJSCore in action, you can run the example app:

git clone https://github.com/ericwlange/AndroidJSCore.git ~/AndroidJSCore

Now you can open ~/AndroidJSCore/examples/AndroidJSCoreExample in Android Studio and run it.

Building AndroidJSCore-3.0 library

If you are interested in building the library directly and possibly contributing, you must do the following:

% git clone https://github.com/ericwlange/AndroidJSCore.git
% cd AndroidJSCore/AndroidJSCore
% echo ndk.dir=$ANDROID_NDK > local.properties
% echo sdk.dir=$ANDROID_SDK >> local.properties
% ./gradlew assembleRelease

Your library now sits in AndroidJSCore-library/build/outputs/aar/AndroidJSCore-3.0.1-release.aar. To use it, simply add the following to your app's build.gradle:

repositories {
    flatDir {
        dirs '/path/to/lib'
    }
}

dependencies {
    compile(name:'AndroidJSCore-3.0.1-release', ext:'aar')
}

Note: The JavaScriptCore library is built using The Hemroid Project

The Webkit shared libraries are included in binary form in the repository at AndroidJSCore/AndroidJSCore-library/jni/lib. Under most circumstances, you will have no need to build those libraries yourself. However, if for any reason you feel the need to build the libraries directly, it must be done via hemroid.

hemroid is a package manager for Android, similar in intent to Homebrew on OSX or apt on Linux. The JavaScriptCore library is part of WebKit. hemroid manages the tweaks required to get it to build on Android. Building JavaScriptCore takes a long time, upwards of an hour or more, depending on your hardware. If the process fails for any reason it will dump the build log in /tmp/hemroid.burst. Most likely some tool or another needs to be installed that is not installed on your system. Fix the dependency and then re-run hemroid install javascriptcore.

% git clone https://github.com/ericwlange/hemroid.git
% git checkout tags/AndroidJSCore-3.0.1
% export PATH=$PATH:$PWD/hemroid
% export ANDROID_NDK=/path/to/ndk
% export ANDROID_SDK=/path/to/sdk
% hemroid install javascriptcore

Upon successful completion of the build, the JavaScriptCore libraries will be located at $PWD/hemroid/vault/hemroot/**/libjavascriptcore-4.0.so, where ** represents each of the seven different ABIs (armeabi, armeabi-v7a, arm64-v8a, x86, x86_64, mips and mips64). You will need to copy those libraries into AndroidJSCore/AndroidJSCore-library/jni/lib/**/ and then perform a clean build of AndroidJSCore. You might want to blow away all intermediates and obj directories to be 100% sure your new library doesn't get passed over due to an old cached version.

Note that hemroid requires GIT LFS. If you don't already have it installed, you will need to install it.

Frequently Asked Questions

What features of JavaScript does AndroidJSCore support?

AndroidJSCore is a port of Webkit's JavaScriptCore for Android. It is, itself, based on a Linux GTK port, called WebKitGTK+. The current version is built on WebKitGTK+ 2.10.7, which is rougly equivalent to Safari 9, in terms of support. See the comparison table to find out what JavaScript capabilities are supported. The "SF 9" column is a pretty accurate reflection. I am planning for version 3.1.0+ of AndroidJSCore to provide the same support as Safari 10.

Can I use this to download web pages and manipulate HTML?

Can I use JQuery with this?

No. AndroidJSCore is just the JavaScript runtime environment. It does not contain any Web capabilities, such as DOM parsing, HTTP support, File Reading, HTML5 extensions, etc. Those, from a WebKit standpoint, are contained in WebCore, not JavaScriptCore, which I have not ported, nor do I have any immediate plans to do so. If you need this level of browser support, then your best bet is to actually load a page using a WebView and calling [evaluateJavascript()](https://developer.android.com/reference/android/webkit/WebView.html#evaluateJavascript(java.lang.String, android.webkit.ValueCallback<java.lang.String>)) to inject JavaScript.

This library makes my APK look Yuuuuge!

Was that a question? Yes, the library is a pig and currently balloons your APK to about 40MB. I am looking at ways to reduce this. The issue is that I have to compile the JavaScriptCore library for each architecture (x86, armeabi-v7a, ...). There are 7 ABIs, and the library compresses to about 6MB per ABI. That's where the bloated size is coming from. I will try to figure out if there is a way to reduce this footprint, but in the meantime, please check out this link: https://realm.io/news/reducing-apk-size-native-libraries/. See the section on "APK Splits". You only need one ABI for any given APK, so you should theoretically be able to get the size down to around 6MB.

License

Copyright (c) 2014-2016 Eric Lange. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.