Click here to Skip to main content
15,861,172 members
Articles / Desktop Programming / Win32

How to Call Java Functions from C Using JNI

Rate me:
Please Sign up or sign in to vote.
4.47/5 (35 votes)
12 Jan 2008CPOL3 min read 427.8K   8K   46   84
This article covers calling Java functions from C using JNI. It also covers passing/returning simple parameters, arrays, and structure arrays in Java functions.

Introduction

This article describes the methodology to use Java code in C/C++. I have not only discussed simple parameter passing and returning, but complex data structures such as structures and structure arrays to Java functions as well.

Background

A few days ago, my manager asked me to write code in C/C++ that will use Java classes in other projects. It took me a lot of time to grab some information on how to call simple functions as well as pass/return complex data types. I found many articles describing C/C++ function calls in Java using JNI, but very few discussing calling Java functions in C/C++ using JNI. At that time, I decided to write an article so that other people could get help from it.

Using the code

The CTest.cpp file contains the code that calls different functions from Java classes. Java classes that are used in this project are given here under:

  • HelloWorld.java
  • ControlDetail.java
  • WorkOrder.java
  • ReturnData.java

HelloWorld.java contains the functions that will be called from CTest.cpp. The other three Java classes are simply used in place of structures in Java. As there is no structure concept in Java, we can use classes for that purpose. That is what the other three .java files contain.

HelloWorld.java contains the following functions that will be called from C/C++ code:

Java
public static void main(String args[])
{
}

public static void TestCall(String szArg)
{
} 

public static int DisplayStruct(ControlDetail ctrlDetail)
{
} 

public static void DisplayStructArray(WorkOrder ArrWO[])
{
} 

public static Object ReturnObjFunc()
{
}

To call these functions from C/C++, first you need to load the JVM using the following function:

Java
JNIEnv* create_vm(JavaVM ** jvm) {
    
    JNIEnv *env;
    JavaVMInitArgs vm_args;

    JavaVMOption options; 
    //Path to the java source code     
    options.optionString = "-Djava.class.path=D:\\Java Src\\TestStruct"; 
    vm_args.version = JNI_VERSION_1_6; //JDK version. This indicates version 1.6
    vm_args.nOptions = 1;
    vm_args.options = &options;
    vm_args.ignoreUnrecognized = 0;
    
    int ret = JNI_CreateJavaVM(jvm, (void**)&env, &vm_args);
    if(ret < 0)
        printf("\nUnable to Launch JVM\n");       
    return env;
}

Kindly note that to use this code, you will have to modify the options.optionString variable. You will have to set the path of the Java code: where the Java classes are placed. Currently, it being set to D:\Java Src\TestStruct. You can modify it to you situation. You will also need to modify the JDK version information in the above code, as shown below:

vm_args.version = JNI_VERSION_1_6; //JDK version. This indicates version 1.6

Modify it if you have another JDK version installed.

To call a specific Java function from C, you need to do the following:

  1. Obtain the class reference using the FindClass(,,) method.
  2. Obtain the method IDs of the functions of the class that you want to call using the GetStaticMethodID and GetMethodID function calls.
  3. Call the functions using CallStaticVoidMethod, CallStaticIntMethod, and CallStaticObjectMethod.

One important thing to be noted here is specifying the function signatures while obtaining the method IDs.

To obtain the correct method signature, you can use the following Java command:

javap -s -p HelloWorld

It will display you the signature of each function in the HelloWorld class. These signatures can be used to obtain the method IDs. The result of the above command can be seen below:

D:\Java Src\TestStruct>javap -s -p HelloWorld
Compiled from "HelloWorld.java"
public class HelloWorld extends java.lang.Object{
public HelloWorld();
  Signature: ()V
public static void main(java.lang.String[]);
  Signature: ([Ljava/lang/String;)V
public static void TestCall(java.lang.String);
  Signature: (Ljava/lang/String;)V
public static int DisplayStruct(ControlNEDetail);
  Signature: (LControlNEDetail;)I
public static void DisplayStructArray(WorkOrder[]);
  Signature: ([LWorkOrder;)V
public static java.lang.Object ReturnObjFunc();
  Signature: ()Ljava/lang/Object;
}

Kindly note that while specifying the method name in the GetMethodID function, if the method is a constructor, then its method name will be <init>.

Prerequisites

Before traveling down a difficult path, it is important to understand the basic concepts and to have various frameworks and tools installed on your computer.

  1. You will need the Sun Java Developer Kit (JDK). I recommend Java 1.6.0.
  2. Any C/C++ compiler installed.

How to run

To use this code, follow the instructions below:

  • Compile the *.java files using the javac command.
  • Compile the CTest.cpp file using any C++ compiler; I used MSVC++ 6.

Converting this code to pure C from C++

The attached code is written in C++. To convert this code into pure C, you will have to modify the following in the CTest.cpp file:

Use:

C++
(*env)->FunctionName(env,args,..);

instead of:

C++
env->FunctionName(args,..);

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)


Written By
Software Developer (Senior)
United Kingdom United Kingdom
Ahmad Qarshi is an IT Consultant and have good expertise in different development technologies. He loves to code in .NET, JavaFX, Delphi, XSLT/Schematron. Above all very keen to learn new stuff Smile | :)

Comments and Discussions

 
GeneralA good sample but need fix a few points Pin
atest2005010113-Apr-11 16:12
atest2005010113-Apr-11 16:12 
GeneralRe: A good sample but need fix a few points Pin
AngryCats28-Sep-11 1:25
AngryCats28-Sep-11 1:25 
GeneralRe: A good sample but need fix a few points Pin
wang Tom5-Apr-22 22:33
wang Tom5-Apr-22 22:33 
QuestionUnable to find the requested class Pin
arnott0722-Mar-11 5:23
arnott0722-Mar-11 5:23 
AnswerRe: Unable to find the requested class Pin
atest2005010113-Apr-11 16:06
atest2005010113-Apr-11 16:06 
QuestionHow to debug jni code [modified] Pin
G Mahesh Babu31-Jan-11 22:04
G Mahesh Babu31-Jan-11 22:04 
GeneralI can´t compile the cpp code Pin
rolotandil5-Oct-10 9:51
rolotandil5-Oct-10 9:51 
GeneralMy vote of 5 Pin
T.Balaji4-Aug-10 19:51
T.Balaji4-Aug-10 19:51 
GeneralMy vote of 5 Pin
cdk28-Jul-10 7:06
cdk28-Jul-10 7:06 
GeneralMy vote of 2 Pin
-midiman-19-Apr-10 5:25
-midiman-19-Apr-10 5:25 
GeneralRe: My vote of 2 Pin
ajalilqarshi26-Apr-10 23:24
ajalilqarshi26-Apr-10 23:24 
GeneralThanks Pin
megatelevizor16-Apr-10 16:48
megatelevizor16-Apr-10 16:48 
GeneralThanks! Comments on getting to run under GNU/Linux Pin
Laurence Finston12-Apr-10 5:43
Laurence Finston12-Apr-10 5:43 
GeneralRe: Thanks! Comments on getting to run under GNU/Linux Pin
ajalilqarshi12-Apr-10 10:53
ajalilqarshi12-Apr-10 10:53 
GeneralRe: Thanks! Comments on getting to run under GNU/Linux Pin
Laurence Finston12-Apr-10 21:13
Laurence Finston12-Apr-10 21:13 
GeneralRe: Thanks! Comments on getting to run under GNU/Linux Pin
Laurence Finston12-Apr-10 22:54
Laurence Finston12-Apr-10 22:54 
GeneralRe: Thanks! Comments on getting to run under GNU/Linux Pin
Laurence Finston13-Apr-10 0:20
Laurence Finston13-Apr-10 0:20 
GeneralRe: Thanks! Comments on getting to run under GNU/Linux Pin
kna261118-Aug-10 12:04
kna261118-Aug-10 12:04 
GeneralRe: Thanks! Comments on getting to run under GNU/Linux Pin
Laurence Finston18-Aug-10 21:36
Laurence Finston18-Aug-10 21:36 
GeneralRe: Thanks! Comments on getting to run under GNU/Linux Pin
Laurence Finston18-Aug-10 21:47
Laurence Finston18-Aug-10 21:47 
GeneralThanks! Pin
Alex Kolesnichenko6-Mar-10 12:05
professionalAlex Kolesnichenko6-Mar-10 12:05 
QuestionJNI load error - main class not found Pin
alien_invader1-Mar-10 11:17
alien_invader1-Mar-10 11:17 
AnswerRe: JNI load error - main class not found Pin
alien_invader26-Apr-10 9:27
alien_invader26-Apr-10 9:27 
GeneralMy application crashes while calling JNI_CreateJavaVM function Pin
Khalid Noor21-Feb-10 23:06
Khalid Noor21-Feb-10 23:06 
GeneralRe: My application crashes while calling JNI_CreateJavaVM function Pin
ajalilqarshi22-Feb-10 2:28
ajalilqarshi22-Feb-10 2:28 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.