This question already has answers here:
How do you dynamically compile and load external java classes? [duplicate]
(2 answers)
Closed 5 years ago.
I'm using the JavaCompiler from the javax.tools package (JDK 1.7) to compile some stuff on the fly, like this:
compiler.run(null, null, "-cp", paths, "path/to/my/file.java");
It works but I would like to do it all in memory (e.g. pass a string with the code, not the source file, and get the byte code back not a .class file). I found that extending the InputStream and OutputStream parameters is no use since it's probably just the same as in the console. Do you know a way to make the run method work like this? Or do you know a confirmed way to do this with the getTask() method? (extending the FileManager looks easy but isn't that easy :)
I've run the above code in Mac OS Java 7. None of them works. So i wrote one
https://github.com/trung/InMemoryJavaCompiler
StringBuilder source = new StringBuilder()
.append("package org.mdkt;\n")
.append("public class HelloClass {\n")
.append(" public String hello() { return \"hello\"; }")
.append("}");
Class<?> helloClass = InMemoryJavaCompiler.compile("org.mdkt.HelloClass", source.toString());
I think this here might be of help it basically shows how to compile Java source from memory (the string is located in the class).
It uses the PrinterWriter and StringWriter to write the source to a String/in memory and then uses the JavaCompiler class (since JDK 6) to compile and run the program:
import javax.tools.Diagnostic;
import javax.tools.DiagnosticCollector;
import javax.tools.JavaCompiler;
import javax.tools.JavaCompiler.CompilationTask;
import javax.tools.JavaFileObject;
import javax.tools.SimpleJavaFileObject;
import javax.tools.ToolProvider;
import java.io.File;
import java.io.IOException;
import java.io.PrintWriter;
import java.io.StringWriter;
import java.lang.reflect.InvocationTargetException;
import java.net.URI;
import java.net.URL;
import java.net.URLClassLoader;
import java.util.Arrays;
public class CompileSourceInMemory {
public static void main(String args[]) throws IOException {
JavaCompiler compiler = ToolProvider.getSystemJavaCompiler();
DiagnosticCollector<JavaFileObject> diagnostics = new DiagnosticCollector<JavaFileObject>();
StringWriter writer = new StringWriter();
PrintWriter out = new PrintWriter(writer);
out.println("public class HelloWorld {");
out.println(" public static void main(String args[]) {");
out.println(" System.out.println(\"This is in another java file\");");
out.println(" }");
out.println("}");
out.close();
JavaFileObject file = new JavaSourceFromString("HelloWorld", writer.toString());
Iterable<? extends JavaFileObject> compilationUnits = Arrays.asList(file);
CompilationTask task = compiler.getTask(null, null, diagnostics, null, null, compilationUnits);
boolean success = task.call();
for (Diagnostic diagnostic : diagnostics.getDiagnostics()) {
System.out.println(diagnostic.getCode());
System.out.println(diagnostic.getKind());
System.out.println(diagnostic.getPosition());
System.out.println(diagnostic.getStartPosition());
System.out.println(diagnostic.getEndPosition());
System.out.println(diagnostic.getSource());
System.out.println(diagnostic.getMessage(null));
}
System.out.println("Success: " + success);
if (success) {
try {
URLClassLoader classLoader = URLClassLoader.newInstance(new URL[] { new File("").toURI().toURL() });
Class.forName("HelloWorld", true, classLoader).getDeclaredMethod("main", new Class[] { String[].class }).invoke(null, new Object[] { null });
} catch (ClassNotFoundException e) {
System.err.println("Class not found: " + e);
} catch (NoSuchMethodException e) {
System.err.println("No such method: " + e);
} catch (IllegalAccessException e) {
System.err.println("Illegal access: " + e);
} catch (InvocationTargetException e) {
System.err.println("Invocation target: " + e);
}
}
}
}
class JavaSourceFromString extends SimpleJavaFileObject {
final String code;
JavaSourceFromString(String name, String code) {
super(URI.create("string:///" + name.replace('.','/') + Kind.SOURCE.extension),Kind.SOURCE);
this.code = code;
}
#Override
public CharSequence getCharContent(boolean ignoreEncodingErrors) {
return code;
}
}
If you have a look at the reference link you will find a few more other examples too
Reference:
Compiling from Memory
This is a class that compiles entirely in memory.
I've taken (almost) the entirety of this from http://javapracs.blogspot.de/2011/06/dynamic-in-memory-compilation-using.html by Rekha Kumari (June 2011). Though this version is more than 100 lines shorter and has considerably more features (but no docs:P).
It can compile multiple classes at once, which is the only way to compile classes that depend on each other. If you wonder about the class "CompilerFeedback": I was working on a tiny Java IDE for coding-games where I needed that. I'm including it here because I assume that you want to do something with this compiler, and the predigestion might help with that. (I realize that some of the code in the CompilerFeedback class is complete crap. It was recycled from a years old attempt.
There's also a utility method, not needed for compilation, that derives the full class name from a class' source code (incl. package name, if it's provided). Very useful for calling the compiler, which does need this information.
DEMO CLASS:
import java.util.ArrayList;
import java.util.List;
public class Demo {
public static void main(final String[] args) {
final InMemoryCompiler.IMCSourceCode cls1source;
final InMemoryCompiler.IMCSourceCode cls2source;
final StringBuilder sb = new StringBuilder();
sb.append("package toast;\n");
sb.append("public class DynaClass {\n");
sb.append(" public static void main(final String[] args) {");
sb.append(" System.out.println(\"Based massively on the work of Rekha Kumari, http://javapracs.blogspot.de/2011/06/dynamic-in-memory-compilation-using.html\");\n");
sb.append(" System.out.println(\"This is the main method speaking.\");\n");
sb.append(" System.out.println(\"Args: \" + java.util.Arrays.toString(args));\n");
sb.append(" final Test test = new Test();\n");
sb.append(" }\n");
sb.append(" public String toString() {\n");
sb.append(" return \"Hello, I am \" + ");
sb.append("this.getClass().getSimpleName();\n");
sb.append(" }\n");
sb.append("}\n");
cls1source = new InMemoryCompiler.IMCSourceCode("toast.DynaClass", sb.toString());
sb.setLength(0);
sb.append("package toast;\n");
sb.append("public class Test {\n");
sb.append(" public Test() {\n");
sb.append(" System.out.println(\"class Test constructor reporting in.\");\n");
sb.append(" System.out.println(new DynaClass());\n");
sb.append(" }\n");
sb.append("}\n");
cls2source = new InMemoryCompiler.IMCSourceCode("toast.Test", sb.toString());
final List<InMemoryCompiler.IMCSourceCode> classSources = new ArrayList<>();
classSources.add(cls1source);
classSources.add(cls2source);
final InMemoryCompiler uCompiler = new InMemoryCompiler(classSources);
final CompilerFeedback compilerFeedback = uCompiler.compile();
System.out.println("\n\nCOMPILER FEEDBACK: " + compilerFeedback);
if (compilerFeedback != null && compilerFeedback.success) {
try {
System.out.println("\nTOSTRING DEMO:");
uCompiler.runToString(cls1source.fullClassName);
} catch (Exception e) {
e.printStackTrace();
}
try {
System.out.println("\nMAIN DEMO:");
uCompiler.runMain(cls1source.fullClassName, new String[] { "test1", "test2" });
} catch (Exception e) {
e.printStackTrace();
}
}
System.exit(0);
}
}
COMPILER CLASS:
import javax.tools.*;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.net.URI;
import java.security.SecureClassLoader;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
* MASSIVELY based on http://javapracs.blogspot.de/2011/06/dynamic-in-memory-compilation-using.html by Rekha Kumari
* (June 2011)
*/
final public class InMemoryCompiler {
final public static class IMCSourceCode {
final public String fullClassName;
final public String sourceCode;
/**
* #param fullClassName Full name of the class that will be compiled. If the class should be in some package,
* fullName should contain it too, for example: "testpackage.DynaClass"
* #param sourceCode the source code
*/
public IMCSourceCode(final String fullClassName, final String sourceCode) {
this.fullClassName = fullClassName;
this.sourceCode = sourceCode;
}
}
final public boolean valid;
final private List<IMCSourceCode> classSourceCodes;
final private JavaFileManager fileManager;
public InMemoryCompiler(final List<IMCSourceCode> classSourceCodes) {
this.classSourceCodes = classSourceCodes;
final JavaCompiler compiler = ToolProvider.getSystemJavaCompiler();
if (compiler == null) {
fileManager = null;
valid = false;
System.err.println("ToolProvider.getSystemJavaCompiler() returned null! This program needs to be run on a system with an installed JDK.");
return;
}
valid = true;
fileManager = new ForwardingJavaFileManager<JavaFileManager>(compiler.getStandardFileManager(null, null, null)) {
final private Map<String, ByteArrayOutputStream> byteStreams = new HashMap<>();
#Override
public ClassLoader getClassLoader(final Location location) {
return new SecureClassLoader() {
#Override
protected Class<?> findClass(final String className) throws ClassNotFoundException {
final ByteArrayOutputStream bos = byteStreams.get(className);
if (bos == null) {
return null;
}
final byte[] b = bos.toByteArray();
return super.defineClass(className, b, 0, b.length);
}
};
}
#Override
public JavaFileObject getJavaFileForOutput(final Location location, final String className, final JavaFileObject.Kind kind, final FileObject sibling) throws IOException {
return new SimpleJavaFileObject(URI.create("string:///" + className.replace('.', '/') + kind.extension), kind) {
#Override
public OutputStream openOutputStream() throws IOException {
ByteArrayOutputStream bos = byteStreams.get(className);
if (bos == null) {
bos = new ByteArrayOutputStream();
byteStreams.put(className, bos);
}
return bos;
}
};
}
};
}
public CompilerFeedback compile() {
if (!valid) {
return null;
}
final List<JavaFileObject> files = new ArrayList<>();
for (IMCSourceCode classSourceCode : classSourceCodes) {
URI uri = null;
try {
uri = URI.create("string:///" + classSourceCode.fullClassName.replace('.', '/') + JavaFileObject.Kind.SOURCE.extension);
} catch (Exception e) {
// e.printStackTrace();
}
if (uri != null) {
final SimpleJavaFileObject sjfo = new SimpleJavaFileObject(uri, JavaFileObject.Kind.SOURCE) {
#Override
public CharSequence getCharContent(final boolean ignoreEncodingErrors) {
return classSourceCode.sourceCode;
}
};
files.add(sjfo);
}
}
final DiagnosticCollector<JavaFileObject> diagnostics = new DiagnosticCollector<>();
final JavaCompiler compiler = ToolProvider.getSystemJavaCompiler();
if (files.size() > 0) {
final JavaCompiler.CompilationTask task = compiler.getTask(null, fileManager, diagnostics, null, null, files);
return new CompilerFeedback(task.call(), diagnostics);
} else {
return null;
}
}
public void runToString(final String className) throws InstantiationException, IllegalAccessException, ClassNotFoundException {
if (!valid) {
return;
}
final Class<?> theClass = getCompiledClass(className);
final Object instance = theClass.newInstance();
System.out.println(instance);
}
public void runMain(final String className, final String[] args) throws IllegalAccessException, ClassNotFoundException, NoSuchMethodException, InvocationTargetException {
if (!valid) {
return;
}
final Class<?> theClass = getCompiledClass(className);
final Method mainMethod = theClass.getDeclaredMethod("main", String[].class);
mainMethod.invoke(null, new Object[] { args });
}
public Class<?> getCompiledClass(final String className) throws ClassNotFoundException {
if (!valid) {
throw new IllegalStateException("InMemoryCompiler instance not usable because ToolProvider.getSystemJavaCompiler() returned null: No JDK installed.");
}
final ClassLoader classLoader = fileManager.getClassLoader(null);
final Class<?> ret = classLoader.loadClass(className);
if (ret == null) {
throw new ClassNotFoundException("Class returned by ClassLoader was null!");
}
return ret;
}
}
COMPILERFEEDBACK CLASS:
import javax.tools.Diagnostic;
import javax.tools.DiagnosticCollector;
import javax.tools.JavaFileObject;
import javax.tools.SimpleJavaFileObject;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.Locale;
final public class CompilerFeedback {
final public boolean success;
final public List<CompilerMessage> messages = new ArrayList<>();
public CompilerFeedback(final Boolean success, final DiagnosticCollector<JavaFileObject> diagnostics) {
this.success = success != null && success;
for (Diagnostic<? extends JavaFileObject> diagnostic : diagnostics.getDiagnostics()) {
messages.add(new CompilerMessage(diagnostic));
}
}
public String toString() {
final StringBuilder sb = new StringBuilder();
sb.append("SUCCESS: ").append(success).append('\n');
final int iTop = messages.size();
for (int i = 0; i < iTop; i++) {
sb.append("\n[MESSAGE ").append(i + 1).append(" OF ").append(iTop).append("]\n\n");
// sb.append(messages.get(i).toString()).append("\n");
// sb.append(messages.get(i).toStringForList()).append("\n");
sb.append(messages.get(i).toStringForDebugging()).append("\n");
}
return sb.toString();
}
final public static class CompilerMessage {
final public Diagnostic<? extends JavaFileObject> compilerInfo;
final public String typeOfProblem;
final public String typeOfProblem_forDebugging;
final public String multiLineMessage;
final public int lineNumber;
final public int columnNumber;
final public int textHighlightPos_lineStart;
final public int textHighlightPos_problemStart;
final public int textHighlightPos_problemEnd;
final public String sourceCode;
final public String codeOfConcern;
final public String codeOfConcernLong;
CompilerMessage(final Diagnostic<? extends JavaFileObject> diagnostic) {
final JavaFileObject sourceFileObject = diagnostic.getSource();
String sourceCodePreliminary = null;
if (sourceFileObject instanceof SimpleJavaFileObject) {
final SimpleJavaFileObject simpleSourceFileObject = (SimpleJavaFileObject) sourceFileObject;
try {
final CharSequence charSequence = simpleSourceFileObject.getCharContent(false);
sourceCodePreliminary = charSequence.toString();
} catch (IOException e) {
e.printStackTrace();
}
}
if (sourceCodePreliminary == null) {
sourceCode = "[SOURCE CODE UNAVAILABLE]";
} else {
sourceCode = sourceCodePreliminary;
}
compilerInfo = diagnostic;
typeOfProblem = diagnostic.getKind().name();
typeOfProblem_forDebugging = "toString() = " + diagnostic.getKind().toString() + "; name() = " + typeOfProblem;
lineNumber = (int) compilerInfo.getLineNumber();
columnNumber = (int) compilerInfo.getColumnNumber();
final int sourceLen = sourceCode.length();
textHighlightPos_lineStart = (int) Math.min(Math.max(0, diagnostic.getStartPosition()), sourceLen);
textHighlightPos_problemStart = (int) Math.min(Math.max(0, diagnostic.getPosition()), sourceLen);
textHighlightPos_problemEnd = (int) Math.min(Math.max(0, diagnostic.getEndPosition()), sourceLen);
final StringBuilder reformattedMessage = new StringBuilder();
final String message = diagnostic.getMessage(Locale.US);
final int messageCutOffPosition = message.indexOf("location:");
final String[] messageParts;
if (messageCutOffPosition >= 0) {
messageParts = message.substring(0, messageCutOffPosition).split("\n");
} else {
messageParts = message.split("\n");
}
for (String s : messageParts) {
String s2 = s.trim();
if (s2.length() > 0) {
boolean lengthChanged;
do {
final int lBeforeReplace = s2.length();
s2 = s2.replace(" ", " ");
lengthChanged = (s2.length() != lBeforeReplace);
} while (lengthChanged);
reformattedMessage.append(s2).append("\n");
}
}
codeOfConcern = sourceCode.substring(textHighlightPos_problemStart, textHighlightPos_problemEnd);
codeOfConcernLong = sourceCode.substring(textHighlightPos_lineStart, textHighlightPos_problemEnd);
if (!codeOfConcern.isEmpty()) {
reformattedMessage.append("Code of concern: \"").append(codeOfConcern).append('\"');
}
multiLineMessage = reformattedMessage.toString();
}
public String toStringForList() {
if (compilerInfo == null) {
return "No compiler!";
} else {
return compilerInfo.getCode();
}
}
public String toStringForDebugging() {
final StringBuilder ret = new StringBuilder();
ret.append("Type of problem: ").append(typeOfProblem_forDebugging).append("\n\n");
ret.append("Message:\n").append(multiLineMessage).append("\n\n");
ret.append(compilerInfo.getCode()).append("\n\n");
ret.append("line number: ").append(lineNumber).append("\n");
ret.append("column number: ").append(columnNumber).append("\n");
ret.append("textHighlightPos_lineStart: ").append(textHighlightPos_lineStart).append("\n");
ret.append("textHighlightPos_problemStart: ").append(textHighlightPos_problemStart).append("\n");
ret.append("textHighlightPos_problemEnd: ").append(textHighlightPos_problemEnd).append("\n");
return ret.toString();
}
#Override
public String toString() {
// return compilerInfo.getMessage(Locale.US);
return typeOfProblem + ": " + multiLineMessage + "\n";
}
}
}
UTILITY METHOD (Not needed for the three classes further up.):
final public static String PREFIX_CLASSNAME = "class ";
final public static String PREFIX_PACKAGENAME = "package ";
final public static String CHARSET_JAVAKEYWORDENDERS = " \n[](){}<>;,\"\\/*+-=%!&?#:";
/**
* #return e.g. "com.dreamspacepresident.TestClass" if the source's first root level "class" (I'm talking about {}
* hierarchy.) is named "TestClass", and if the "package" name is "com.dreamspacepresident". Null is returned if
* sourceCode is null or does not provide a class name. (Mind that the parsing is done in a quite crappy way.)
*/
public static String deriveFullClassNameFromSource(final String sourceCode) {
if (sourceCode == null) {
return null;
}
final int firstBr = sourceCode.indexOf('{');
if (firstBr >= 0) {
// DETERMINE CLASS NAME
final int firstClass = sourceCode.indexOf(PREFIX_CLASSNAME);
if (firstClass < firstBr) {
String className = sourceCode.substring(firstClass + PREFIX_CLASSNAME.length(), firstBr).trim();
final int classNameEnd = indexOfAnyOfThese(className, CHARSET_JAVAKEYWORDENDERS);
if (classNameEnd >= 0) {
className = className.substring(0, classNameEnd);
}
if (!className.isEmpty()) {
// DETERMINE PACKAGE NAME
String packageName = null;
final int firstPackage = sourceCode.indexOf(PREFIX_PACKAGENAME);
if (firstPackage >= 0 && firstPackage < firstBr && firstPackage < firstClass) {
packageName = sourceCode.substring(firstPackage + PREFIX_PACKAGENAME.length(), firstBr).trim();
final int packageNameEnd = indexOfAnyOfThese(packageName, CHARSET_JAVAKEYWORDENDERS);
if (packageNameEnd >= 0) {
packageName = packageName.substring(0, packageNameEnd);
}
}
return (packageName != null && !packageName.isEmpty() ? packageName + "." : "") + className;
}
}
}
return null;
}
/**
* Looks for the first occurrence of ANY of the given characters, which is easier than using a bunch of
* String.indexOf() calls.
*
* #return -1 if not found, otherwise the String index of the first hit
*/
public static int indexOfAnyOfThese(final String text, final String characters) {
if (text != null && !text.isEmpty() && characters != null && !characters.isEmpty()) {
final int lenT = text.length();
final int lenC = characters.length();
for (int i = 0; i < lenT; i++) {
final char c = text.charAt(i);
for (int ii = 0; ii < lenC; ii++) {
if (c == characters.charAt(ii)) {
return i;
}
}
}
}
return -1;
}
I wrote a library to do this a few years ago. It takes a String which can contain nested classes, compiles them and optionally loads them into the current class loader (so you don't need an additional class loader) If the JVM is running in debug mode it will write the generated code to a file so you can step through your generated code.
http://vanillajava.blogspot.co.uk/2010_11_01_archive.html
To paraphrase the example from erolagnab you can do
StringBuilder sourceCode = new StringBuilder();
sourceCode.append("package org.mdkt;\n")
.append("public class HelloClass {\n")
.append(" public String hello() { return \"hello\"; }")
.append("}");
Class<?> helloClass = CACHED_COMPILER.compile("org.mdkt.HelloClass",
sourceCode.toString());
Update, the source is available here https://github.com/OpenHFT/Java-Runtime-Compiler
And you can obtain the latest build via maven http://search.maven.org/#browse%7C842970587
A longer example.
// this writes the file to disk only when debugging is enabled.
CachedCompiler cc = CompilerUtils.DEBUGGING ?
new CachedCompiler(new File(parent, "src/test/java"), new File(parent, "target/compiled")) :
CompilerUtils.CACHED_COMPILER;
String text = "generated test " + new Date();
Class fooBarTeeClass = cc.loadFromJava("eg.FooBarTee", "package eg;\n" +
'\n' +
"import eg.components.BarImpl;\n" +
"import eg.components.TeeImpl;\n" +
"import eg.components.Foo;\n" +
'\n' +
"public class FooBarTee{\n" +
" public final String name;\n" +
" public final TeeImpl tee;\n" +
" public final BarImpl bar;\n" +
" public final BarImpl copy;\n" +
" public final Foo foo;\n" +
'\n' +
" public FooBarTee(String name) {\n" +
" // when viewing this file, ensure it is synchronised with the copy on disk.\n" +
" System.out.println(\"" + text + "\");\n" +
" this.name = name;\n" +
'\n' +
" tee = new TeeImpl(\"test\");\n" +
'\n' +
" bar = new BarImpl(tee, 55);\n" +
'\n' +
" copy = new BarImpl(tee, 555);\n" +
'\n' +
" // you should see the current date here after synchronisation.\n" +
" foo = new Foo(bar, copy, \"" + text + "\", 5);\n" +
" }\n" +
'\n' +
" public void start() {\n" +
" }\n" +
'\n' +
" public void stop() {\n" +
" }\n" +
'\n' +
" public void close() {\n" +
" stop();\n" +
'\n' +
" }\n" +
"}\n");
// add a debug break point here and step into this method.
FooBarTee fooBarTee = new FooBarTee("test foo bar tee");
Foo foo = fooBarTee.foo;
assertNotNull(foo);
assertEquals(text, foo.s);
I wanted:
in-memory compilation of a java file (useful for Java as a scripting language)
No additional dependencies (easy to setup)
Implementation in as low number of files as possible (easy to incorporate in a project)
You can try it first here: http://ideone.com/cu1GhE#view_edit_box
The following code is based on Rekha Kumari code:
Main.java
package com.mycompany.java;
//import org.slf4j.Logger;
//import org.slf4j.LoggerFactory;
import java.io.PrintWriter;
import java.io.StringWriter;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
public class Main {
//private static final Logger logger = LoggerFactory.getLogger(Main.class);
public static void main(String[] args) {
try {
StringWriter writer = new StringWriter();
PrintWriter out = new PrintWriter(writer);
out.println("package com.mycompany.script;");
out.println("");
out.println("public class HelloWorld {");
out.println(" public static void main(String args[]) {");
out.println(" System.out.println(\"This is in another java file\");");
out.println(" }");
out.println("}");
out.close();
String fullName = "com.mycompany.script.HelloWorld";
String src = writer.toString();
DynamicCompiler uCompiler = new DynamicCompiler(fullName, src);
uCompiler.compile();
uCompiler.run();
} catch (Exception e) {
//logger.error("Exception:", e);
System.out.print("Exception");
}
}
}
DynamicCompiler.java
package com.mycompany.java;
//import org.slf4j.Logger;
//import org.slf4j.LoggerFactory;
import javax.tools.*;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.lang.reflect.InvocationTargetException;
import java.net.URI;
import java.security.SecureClassLoader;
import java.util.ArrayList;
import java.util.List;
// Based on: http://javapracs.blogspot.cz/2011/06/dynamic-in-memory-compilation-using.html
public class DynamicCompiler {
//private static final Logger logger = LoggerFactory.getLogger(DynamicCompiler.class);
private JavaFileManager fileManager;
private String fullName;
private String sourceCode;
public DynamicCompiler(String fullName, String srcCode) {
this.fullName = fullName;
this.sourceCode = srcCode;
this.fileManager = initFileManager();
}
public JavaFileManager initFileManager() {
if (fileManager != null)
return fileManager;
else {
JavaCompiler compiler = ToolProvider.getSystemJavaCompiler();
fileManager = new
ClassFileManager(compiler
.getStandardFileManager(null, null, null));
return fileManager;
}
}
public void compile() {
JavaCompiler compiler = ToolProvider.getSystemJavaCompiler();
List<JavaFileObject> files = new ArrayList<>();
files.add(new CharSequenceJavaFileObject(fullName, sourceCode));
compiler.getTask(
null,
fileManager,
null,
null,
null,
files
).call();
}
public void run() throws InstantiationException, IllegalAccessException, ClassNotFoundException {
try {
fileManager
.getClassLoader(null)
.loadClass(fullName)
.getDeclaredMethod("main", new Class[]{String[].class})
.invoke(null, new Object[]{null});
} catch (InvocationTargetException e) {
System.out.print("InvocationTargetException");
//logger.error("InvocationTargetException:", e);
} catch (NoSuchMethodException e) {
System.out.print("NoSuchMethodException ");
//logger.error("NoSuchMethodException:", e);
}
}
public class CharSequenceJavaFileObject extends SimpleJavaFileObject {
/**
* CharSequence representing the source code to be compiled
*/
private CharSequence content;
public CharSequenceJavaFileObject(String className, CharSequence content) {
super(URI.create("string:///" + className.replace('.', '/') + Kind.SOURCE.extension), Kind.SOURCE);
this.content = content;
}
public CharSequence getCharContent(boolean ignoreEncodingErrors) {
return content;
}
}
public class ClassFileManager extends ForwardingJavaFileManager {
private JavaClassObject javaClassObject;
public ClassFileManager(StandardJavaFileManager standardManager) {
super(standardManager);
}
#Override
public ClassLoader getClassLoader(Location location) {
return new SecureClassLoader() {
#Override
protected Class<?> findClass(String name) throws ClassNotFoundException {
byte[] b = javaClassObject.getBytes();
return super.defineClass(name, javaClassObject.getBytes(), 0, b.length);
}
};
}
public JavaFileObject getJavaFileForOutput(Location location, String className, JavaFileObject.Kind kind, FileObject sibling) throws IOException {
this.javaClassObject = new JavaClassObject(className, kind);
return this.javaClassObject;
}
}
public class JavaClassObject extends SimpleJavaFileObject {
protected final ByteArrayOutputStream bos =
new ByteArrayOutputStream();
public JavaClassObject(String name, Kind kind) {
super(URI.create("string:///" + name.replace('.', '/')
+ kind.extension), kind);
}
public byte[] getBytes() {
return bos.toByteArray();
}
#Override
public OutputStream openOutputStream() throws IOException {
return bos;
}
}
}
I'd like to introduce my solution which runs well in production.
Here are the three source code files.
MemoryJavaCompiler.java
package me.soulmachine.compiler;
import java.io.IOException;
import java.io.PrintWriter;
import java.io.Writer;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import javax.tools.*;
/**
* Simple interface to Java compiler using JSR 199 Compiler API.
*/
public class MemoryJavaCompiler {
private javax.tools.JavaCompiler tool;
private StandardJavaFileManager stdManager;
public MemoryJavaCompiler() {
tool = ToolProvider.getSystemJavaCompiler();
if (tool == null) {
throw new RuntimeException("Could not get Java compiler. Please, ensure that JDK is used instead of JRE.");
}
stdManager = tool.getStandardFileManager(null, null, null);
}
/**
* Compile a single static method.
*/
public Method compileStaticMethod(final String methodName, final String className,
final String source)
throws ClassNotFoundException {
final Map<String, byte[]> classBytes = compile(className + ".java", source);
final MemoryClassLoader classLoader = new MemoryClassLoader(classBytes);
final Class clazz = classLoader.loadClass(className);
final Method[] methods = clazz.getDeclaredMethods();
for (final Method method : methods) {
if (method.getName().equals(methodName)) {
if (!method.isAccessible()) method.setAccessible(true);
return method;
}
}
throw new NoSuchMethodError(methodName);
}
public Map<String, byte[]> compile(String fileName, String source) {
return compile(fileName, source, new PrintWriter(System.err), null, null);
}
/**
* compile given String source and return bytecodes as a Map.
*
* #param fileName source fileName to be used for error messages etc.
* #param source Java source as String
* #param err error writer where diagnostic messages are written
* #param sourcePath location of additional .java source files
* #param classPath location of additional .class files
*/
private Map<String, byte[]> compile(String fileName, String source,
Writer err, String sourcePath, String classPath) {
// to collect errors, warnings etc.
DiagnosticCollector<JavaFileObject> diagnostics =
new DiagnosticCollector<JavaFileObject>();
// create a new memory JavaFileManager
MemoryJavaFileManager fileManager = new MemoryJavaFileManager(stdManager);
// prepare the compilation unit
List<JavaFileObject> compUnits = new ArrayList<JavaFileObject>(1);
compUnits.add(fileManager.makeStringSource(fileName, source));
return compile(compUnits, fileManager, err, sourcePath, classPath);
}
private Map<String, byte[]> compile(final List<JavaFileObject> compUnits,
final MemoryJavaFileManager fileManager,
Writer err, String sourcePath, String classPath) {
// to collect errors, warnings etc.
DiagnosticCollector<JavaFileObject> diagnostics =
new DiagnosticCollector<JavaFileObject>();
// javac options
List<String> options = new ArrayList<String>();
options.add("-Xlint:all");
// options.add("-g:none");
options.add("-deprecation");
if (sourcePath != null) {
options.add("-sourcepath");
options.add(sourcePath);
}
if (classPath != null) {
options.add("-classpath");
options.add(classPath);
}
// create a compilation task
javax.tools.JavaCompiler.CompilationTask task =
tool.getTask(err, fileManager, diagnostics,
options, null, compUnits);
if (task.call() == false) {
PrintWriter perr = new PrintWriter(err);
for (Diagnostic diagnostic : diagnostics.getDiagnostics()) {
perr.println(diagnostic);
}
perr.flush();
return null;
}
Map<String, byte[]> classBytes = fileManager.getClassBytes();
try {
fileManager.close();
} catch (IOException exp) {
}
return classBytes;
}
}
MemoryJavaFileManager.java
package me.soulmachine.compiler;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FilterOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.net.URI;
import java.nio.CharBuffer;
import java.util.HashMap;
import java.util.Map;
import javax.tools.FileObject;
import javax.tools.ForwardingJavaFileManager;
import javax.tools.JavaFileManager;
import javax.tools.JavaFileObject;
import javax.tools.JavaFileObject.Kind;
import javax.tools.SimpleJavaFileObject;
/**
* JavaFileManager that keeps compiled .class bytes in memory.
*/
#SuppressWarnings("unchecked")
final class MemoryJavaFileManager extends ForwardingJavaFileManager {
/** Java source file extension. */
private final static String EXT = ".java";
private Map<String, byte[]> classBytes;
public MemoryJavaFileManager(JavaFileManager fileManager) {
super(fileManager);
classBytes = new HashMap<>();
}
public Map<String, byte[]> getClassBytes() {
return classBytes;
}
public void close() throws IOException {
classBytes = null;
}
public void flush() throws IOException {
}
/**
* A file object used to represent Java source coming from a string.
*/
private static class StringInputBuffer extends SimpleJavaFileObject {
final String code;
StringInputBuffer(String fileName, String code) {
super(toURI(fileName), Kind.SOURCE);
this.code = code;
}
public CharBuffer getCharContent(boolean ignoreEncodingErrors) {
return CharBuffer.wrap(code);
}
}
/**
* A file object that stores Java bytecode into the classBytes map.
*/
private class ClassOutputBuffer extends SimpleJavaFileObject {
private String name;
ClassOutputBuffer(String name) {
super(toURI(name), Kind.CLASS);
this.name = name;
}
public OutputStream openOutputStream() {
return new FilterOutputStream(new ByteArrayOutputStream()) {
public void close() throws IOException {
out.close();
ByteArrayOutputStream bos = (ByteArrayOutputStream)out;
classBytes.put(name, bos.toByteArray());
}
};
}
}
public JavaFileObject getJavaFileForOutput(JavaFileManager.Location location,
String className,
Kind kind,
FileObject sibling) throws IOException {
if (kind == Kind.CLASS) {
return new ClassOutputBuffer(className);
} else {
return super.getJavaFileForOutput(location, className, kind, sibling);
}
}
static JavaFileObject makeStringSource(String fileName, String code) {
return new StringInputBuffer(fileName, code);
}
static URI toURI(String name) {
File file = new File(name);
if (file.exists()) {
return file.toURI();
} else {
try {
final StringBuilder newUri = new StringBuilder();
newUri.append("mfm:///");
newUri.append(name.replace('.', '/'));
if(name.endsWith(EXT)) newUri.replace(newUri.length() - EXT.length(), newUri.length(), EXT);
return URI.create(newUri.toString());
} catch (Exception exp) {
return URI.create("mfm:///com/sun/script/java/java_source");
}
}
}
}
MemoryClassLoader.java
package me.soulmachine.compiler;
import java.io.File;
import java.net.MalformedURLException;
import java.net.URL;
import java.net.URLClassLoader;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.StringTokenizer;
/**
* ClassLoader that loads .class bytes from memory.
*/
final class MemoryClassLoader extends URLClassLoader {
private Map<String, byte[]> classBytes;
public MemoryClassLoader(Map<String, byte[]> classBytes,
String classPath, ClassLoader parent) {
super(toURLs(classPath), parent);
this.classBytes = classBytes;
}
public MemoryClassLoader(Map<String, byte[]> classBytes, String classPath) {
this(classBytes, classPath, ClassLoader.getSystemClassLoader());
}
public MemoryClassLoader(Map<String, byte[]> classBytes) {
this(classBytes, null, ClassLoader.getSystemClassLoader());
}
public Class load(String className) throws ClassNotFoundException {
return loadClass(className);
}
public Iterable<Class> loadAll() throws ClassNotFoundException {
List<Class> classes = new ArrayList<Class>(classBytes.size());
for (String name : classBytes.keySet()) {
classes.add(loadClass(name));
}
return classes;
}
protected Class findClass(String className) throws ClassNotFoundException {
byte[] buf = classBytes.get(className);
if (buf != null) {
// clear the bytes in map -- we don't need it anymore
classBytes.put(className, null);
return defineClass(className, buf, 0, buf.length);
} else {
return super.findClass(className);
}
}
private static URL[] toURLs(String classPath) {
if (classPath == null) {
return new URL[0];
}
List<URL> list = new ArrayList<URL>();
StringTokenizer st = new StringTokenizer(classPath, File.pathSeparator);
while (st.hasMoreTokens()) {
String token = st.nextToken();
File file = new File(token);
if (file.exists()) {
try {
list.add(file.toURI().toURL());
} catch (MalformedURLException mue) {}
} else {
try {
list.add(new URL(token));
} catch (MalformedURLException mue) {}
}
}
URL[] res = new URL[list.size()];
list.toArray(res);
return res;
}
}
Explanations:
In order to represent a Java source file in memory instead of disk, I defined a StringInputBuffer class in the MemoryJavaFileManager.java.
To save the compiled .class files in memory, I implemented a class MemoryJavaFileManager. The main idea is to override the function getJavaFileForOutput() to store bytecodes into a map.
To load the bytecodes in memory, I have to implement a customized classloader MemoryClassLoader, which reads bytecodes in the map and turn them into classes.
Here is a unite test.
package me.soulmachine.compiler;
import org.junit.Test;
import java.io.IOException;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.util.ArrayList;
import static org.junit.Assert.assertEquals;
public class MemoryJavaCompilerTest {
private final static MemoryJavaCompiler compiler = new MemoryJavaCompiler();
#Test public void compileStaticMethodTest()
throws ClassNotFoundException, InvocationTargetException, IllegalAccessException {
final String source = "public final class Solution {\n"
+ "public static String greeting(String name) {\n"
+ "\treturn \"Hello \" + name;\n" + "}\n}\n";
final Method greeting = compiler.compileStaticMethod("greeting", "Solution", source);
final Object result = greeting.invoke(null, "soulmachine");
assertEquals("Hello soulmachine", result.toString());
}
}
Reference
JavaCompiler.java from Cloudera Morphlines
How to create an object from a string in Java (how to eval a string)?
InMemoryJavaCompiler
Java-Runtime-Compiler
[动态的Java - 无废话JavaCompilerAPI中文指南]
Compile and Run Java Source Code in Memory.
String fileToCompile = ;
JavaCompile compiler = ToolProvider.getSystemJavaCompiler();
if(
compiler.run(null, null, null, "PACKAGE_NAME" + java.io.File.separator +"CLASS_NAME.java") == 0
)
System.out.println("Compilation is successful");
else
System.out.println("Compilation Failed");
I'm first time here so...
The task is in compilation dynamic class(created from string) and subsequent creating instantiation.
The problem is in importation my custom package/classes, placed in different folders, to dynamic class. For example: after import controller.*; an error occurs:
/CompiledClass.java:4: error: package controller does not exist
but standard packages(libraries) have been imported well without any issues and compilation ended the same way.
I've tried to solve via getTask method of JavaCompiler Api by sending optionList with path but without success.
So how to correct import custom package?
Here is my code:
package view;
import controller.*;
import java.io.*;
import java.lang.reflect.Constructor;
import java.lang.reflect.Method;
import java.net.URI;
import java.security.SecureClassLoader;
import java.util.*;
import javax.tools.*;
import javax.tools.JavaCompiler.*;
import javax.tools.JavaFileObject.Kind;
public class CompileJavaManager {
public static void compileJavaFileObject(StringBuilder inputString, Writer jspOut) throws Exception {
String className = "CompiledClass";
String classMethod = "methodOf" + className;
Class compiledClass = null;
//Class<?> c = Class.forName(className);
StringBuilder javaFileContents =
new StringBuilder("" +
//"package compiled;" +
'\n' +
"import java.io.*;\n" +
"import java.util.*;\n" +
"import controller.*;\n" +
'\n' +
"public class " + className +"{\n" +
" private Writer out = null;\n" +
'\n' +
" public " + className +"(Writer out){\n" +
" this.out = out;\n" +
//" this.container = container;" +
" }" +
" public void " + classMethod + "() throws java.io.IOException{\n" +
//inputString +
" }\n" +
"}\n");
JavaCompiler compiler = ToolProvider.getSystemJavaCompiler();
DiagnosticCollector diagnosticsCollector = new DiagnosticCollector();
StandardJavaFileManager standardJavaFileManager = compiler.getStandardFileManager(diagnosticsCollector, null, null);
SpecialClassLoader classLoader = new SpecialClassLoader();
SpecialJavaFileManager fileManager = new SpecialJavaFileManager(standardJavaFileManager, classLoader);
List<String> optionList = new ArrayList<String>();
optionList.addAll(Arrays.asList("-classpath", System.getProperty("java.class.path")));
JavaObjectFromString javaObjectFromString = new JavaObjectFromString(className, javaFileContents.toString());
Iterable fileObjects = Arrays.asList(javaObjectFromString);
Iterable classes = null;
Writer out = new PrintWriter(jspOut);
CompilationTask task = compiler.getTask(out, fileManager, diagnosticsCollector, optionList, classes, fileObjects);
Boolean result = task.call();
List<Diagnostic> diagnostics = diagnosticsCollector.getDiagnostics();
if (result) {
compiledClass = classLoader.findClass(className);
Constructor<?> constructor = compiledClass.getConstructor(Writer.class);
Object instance = constructor.newInstance(jspOut);
//call the method, pass a null params
Method instanceMethod = compiledClass.getDeclaredMethod(classMethod, null);
instanceMethod.invoke(instance, null);
//System.out.println(instance);
} else {
// Compilation fails
for (Diagnostic d : diagnostics) {
System.out.println(d);
}
}
}
private static class JavaObjectFromString extends SimpleJavaFileObject {
private String sourceCode = null;
public JavaObjectFromString(String className, String sourceCode) throws Exception {
super(URI.create("file:///" + className + Kind.SOURCE.extension), Kind.SOURCE);
this.sourceCode = sourceCode;
}
#Override
public CharSequence getCharContent(boolean ignoreEncodingErrors) throws IOException {
return sourceCode;
}
#Override
public OutputStream openOutputStream() {
throw new IllegalStateException();
}
#Override
public InputStream openInputStream() {
return new ByteArrayInputStream(sourceCode.getBytes());
}
}
private static class JavaObjectFromByteCode extends SimpleJavaFileObject {
private ByteArrayOutputStream baos;
public JavaObjectFromByteCode(String name) {
super(URI.create("byte:///" + name + Kind.CLASS.extension), Kind.CLASS);
}
#Override
public CharSequence getCharContent(boolean ignoreEncodingErrors) {
throw new IllegalStateException();
}
#Override
public OutputStream openOutputStream() {
baos = new ByteArrayOutputStream();
return baos;
}
#Override
public InputStream openInputStream() {
throw new IllegalStateException();
}
public byte[] getBytes() {
return baos.toByteArray();
}
}
private static class SpecialClassLoader extends ClassLoader {
private Map<String,JavaObjectFromByteCode> m = new HashMap<String, JavaObjectFromByteCode>();
protected Class<?> findClass(String name) throws ClassNotFoundException {
JavaObjectFromByteCode jobc = m.get(name);
if (jobc==null){
jobc = m.get(name.replace(".","/"));
if (jobc==null){
return super.findClass(name);
}
}
return defineClass(name, jobc.getBytes(), 0, jobc.getBytes().length);
}
public void addClass(String name, JavaObjectFromByteCode jobc) {
m.put(name, jobc);
}
}
private static class SpecialJavaFileManager extends ForwardingJavaFileManager {
private SpecialClassLoader scl;
public SpecialJavaFileManager(StandardJavaFileManager sjfm, SpecialClassLoader scl) {
super(sjfm);
this.scl = scl;
}
public JavaFileObject getJavaFileForOutput(Location location, String name, JavaFileObject.Kind kind, FileObject sibling) throws IOException {
JavaObjectFromByteCode jobc = new JavaObjectFromByteCode(name);
scl.addClass(name, jobc);
return jobc;
}
public ClassLoader getClassLoader(Location location) {
return scl;
}
}
}
Thanks in advance!
The problem has been solved:
I have added path to my jar controller.jar in addition to System.getProperty("java.class.path").
Here is the code:
optionList.addAll(Arrays.asList("-classpath", System.getProperty("java.class.path") + ";path/to/your/controller.jar"));
I'm making a classloader which can take a jar, and based on that, it can take a package name, and is allowed to load only classes that are in that package. When I try to load a class from there I get the error :
Exception in thread "main" java.lang.NullPointerException
at com.classloader.CustomClassLoader.getClassBytes(CustomClassLoader.java:64)
at com.classloader.CustomClassLoader.getClass(CustomClassLoader.java:48)
at com.classloader.CustomClassLoader.loadClass(CustomClassLoader.java:89)
at com.classloader.TestJar.main(TestJar.java:46)
Even though the package name and entry name are correct. Any ideas where the problem is and how to fix it ? The code is below and I believe it's pretty self explanatory.
CustomLoader
package com.classloader;
import java.io.ByteArrayOutputStream;
import java.io.DataInputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.zip.ZipEntry;
import java.util.zip.ZipException;
import java.util.zip.ZipFile;
public class CustomClassLoader extends ClassLoader implements LoaderConstraints {
private Map<String, Class> loaded = new HashMap<String, Class>();
private Map<String, String> available = new LinkedHashMap<String, String>();
private Set<String> allowed = new LinkedHashSet<String>();
public Set<String> getPermited() {
return allowed;
}
public Map<String, String> getAvailable() {
return available;
}
public Map<String, Class> getLoaded() {
return loaded;
}
public CustomClassLoader() {
super(CustomClassLoader.class.getClassLoader());
}
private Class<?> getClass(String className, String pack) throws ClassNotFoundException {
Class<?> c = null;
String classPath = className.replace('.', File.separatorChar) + ".class";
byte[] b = null;
try {
b = getClassBytes(classPath, pack);
c = defineClass(className, b, 0, b.length);
resolveClass(c);
return c;
} catch (IOException e) {
e.printStackTrace();
}
return c;
}
private byte[] getClassBytes(String classPath, String pack) throws IOException {
ZipFile zip = new ZipFile(pack);
// System.out.println(classPath); classPath is right , as well as pack
ZipEntry entry = zip.getEntry(classPath);//This return null, for some reason ???
InputStream in = zip.getInputStream(zip.getEntry(classPath));
long size = entry.getSize();
byte buff[] = new byte[(int)size];
in.read(buff);
in.close();
return buff;
}
#Override
public Class<?> loadClass(String className) throws ClassNotFoundException {
Class<?> found = null;
if(loaded.get(className) != null){
return loaded.get(className);
}
if(available.get(className ) != null){
if(allowed.contains(className ) == true){
found = getClass(className, available.get(className));
if(found != null)
loaded.put(className, found);
}
}
else{
found = super.loadClass(className);
if(found != null)
loaded.put(className, found);
}
return found;
}
public void files(ZipFile zip, Map<String,String> list) throws ZipException, IOException{
Enumeration<? extends ZipEntry> entries = zip.entries();
while(entries.hasMoreElements()) {
ZipEntry entry = entries.nextElement();
if (!entry.isDirectory() && entry.getName().endsWith(".class")) {
String className = entry.getName().replace('/', '.');
list.put(className.substring(0, className.length() - ".class".length())
,zip.getName());
}
}
}
public void addJar (File jarFile) {
try {
files(new ZipFile(jarFile), available);
} catch (ZipException e) {
e.printStackTrace();
} catch (IOException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
public void deleteJar(File jarFile) {
Map<String,String> removes = new HashMap<String, String>();
try {
files(new ZipFile(jarFile), removes );
} catch (ZipException e) {
// TODO Auto-generated catch block
e.printStackTrace();
} catch (IOException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
available.keySet().removeAll(removes.keySet());
}
public void allowPackage(final String p) {
for(String s : available.keySet()){
if(s.startsWith(p))
allowed.add(new String(s));
}
}
public void denyPackage(final String p) {
Set<String> newPermited = new HashSet<String>();
for(String s : allowed){
if(!s.startsWith(p))
newPermited.add(new String(s));
}
allowed = newPermited;
}
}
Test
public static void main(String[] args) throws ZipException, IOException, ClassNotFoundException, InstantiationException, IllegalAccessException {
CustomClassLoader ccl = new CustomClassLoader();
ccl.addJar(new File("derby.jar"));
ccl.allowPackage("org.apache.derby.jdbc");
//System.out.println(ccl.getAvailable().get("org.apache.derby.jdbc.EmbeddedDriver")); --> returns "derby.jar"
Class<?> clazz = ccl.loadClass("org.apache.derby.jdbc.EmbeddedDriver");//Gives exception , line 46
System.out.println(clazz.getClass());
Object instance = clazz.newInstance();
System.out.println(instance.getClass());
}
The derby.jar is located in the project folder. Any help is welcomed :)
Try to replace File.separatorChar with '/'
For some reason, attempting to cast a class, X, to a another class, Y, in a third class Z throws a ClassCastException. This seems wrong to me, seeing as the class X extends the other class Y. Is there any specific reason why class X could not be cast to Y even though X extends it?
See the following code for reference:
Y:
public abstract class Y {
/**
* Called when the extension is enabled.
*/
public void onEnable() {
}
}
X:
public class X extends Y {
#Override
public void onEnable() {
// Extension specific code.
}
}
Z: (This code is the code where the ClassCastException originates.)
public class Z {
private boolean loadExtension(ExtensionDescription description) {
try {
URLClassLoader loader = new ExtensionClassLoader(new URL[]{description.getFile().toURI().toURL()});
Y y = (Y) loader.loadClass(description.getMain()).newInstance();
} catch (Throwable t) {}
}
}
If loader.loadClass(description.getMain()).newInstance(); is known to create a new instance of X, then why would casting to Y cause a ClassCastException?
Just to illustrate further, here is an example:
Create a Custom ClassLoader, e.g. below (copied from here)
package com.dd;
import java.io.BufferedInputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
public class CustomClassLoader extends ClassLoader {
/**
* The HashMap where the classes will be cached
*/
private Map<String, Class<?>> classes = new HashMap<String, Class<?>>();
#Override
public String toString() {
return CustomClassLoader.class.getName();
}
#Override
protected Class<?> findClass(String name) throws ClassNotFoundException {
if (classes.containsKey(name)) {
return classes.get(name);
}
byte[] classData;
try {
classData = loadClassData(name);
} catch (IOException e) {
throw new ClassNotFoundException("Class [" + name
+ "] could not be found", e);
}
Class<?> c = defineClass(name, classData, 0, classData.length);
resolveClass(c);
classes.put(name, c);
return c;
}
/**
* Load the class file into byte array
*
* #param name
* The name of the class e.g. com.codeslices.test.TestClass}
* #return The class file as byte array
* #throws IOException
*/
private byte[] loadClassData(String name) throws IOException {
BufferedInputStream in = new BufferedInputStream(
ClassLoader.getSystemResourceAsStream(name.replace(".", "/")
+ ".class"));
ByteArrayOutputStream out = new ByteArrayOutputStream();
int i;
while ((i = in.read()) != -1) {
out.write(i);
}
in.close();
byte[] classData = out.toByteArray();
out.close();
return classData;
}
}
And here's class Z
package com.dd;
import java.lang.reflect.InvocationTargetException;
public class Z {
public static void main(String[] args) throws ClassNotFoundException,
InstantiationException, IllegalAccessException,
NoSuchMethodException, SecurityException, IllegalArgumentException,
InvocationTargetException {
CustomClassLoader loader = new CustomClassLoader();
Class<?> c1 = loader.findClass("com.dd.X");
System.out.println("Classloader:: "+ X.class.getClassLoader());
System.out.println("Classloader:: "+ loader.findClass("com.dd.X").getClassLoader());
X x = (X)c1.newInstance();
}
}
And here's the output:
Classloader:: sun.misc.Launcher$AppClassLoader#781fb069
Classloader:: com.dd.CustomClassLoader
Exception in thread "main" java.lang.ClassCastException: com.dd.X cannot be cast to com.dd.X
at com.dd.Z.main(Z.java:18)
I'm currently creating a plugin system (My first attempt), looking at other peoples code I'm trying to piece together my own classloader and get the plugins loaded from a directory (These will be class files)
My problem is that whenever I attempt to load the class with my classloader, any imports in the plugin referencing the program are not found by the classloader. (ie: MyClass extends Plugin, com.mgmc.plugins noclassdeffound) Different namespace?
Some sample code:
Classloader:
/*
* To change this template, choose Tools | Templates
* and open the template in the editor.
*/
package com.mcgm.game.provider;
import com.mcgm.utils.Misc;
import com.mcgm.utils.Paths;
import java.awt.AWTPermission;
import java.io.*;
import java.net.MalformedURLException;
import java.net.SocketPermission;
import java.net.URL;
import java.security.CodeSigner;
import java.security.CodeSource;
import java.security.Permissions;
import java.security.ProtectionDomain;
import java.util.PropertyPermission;
import java.util.logging.Level;
import java.util.logging.Logger;
/**
*
* #author Tom
*/
public class GameClassLoader extends ClassLoader {
private final ProtectionDomain domain;
private final URL base;
public GameClassLoader(final URL url) {
base = url;
final CodeSource codeSource = new CodeSource(base, (CodeSigner[]) null);
domain = new ProtectionDomain(codeSource, getPermissions());
}
public void loadGames() {
for (File f : Paths.compiledFolder.listFiles()) {
try {
Class c = loadClass(f.getPath());
Misc.outPrint(c.getName());
} catch (ClassNotFoundException ex) {
Logger.getLogger(GameClassLoader.class.getName()).log(Level.SEVERE, null, ex);
}
}
}
private Permissions getPermissions() {
final Permissions ps = new Permissions();
ps.add(new AWTPermission("accessEventQueue"));
ps.add(new PropertyPermission("user.home", "read"));
ps.add(new PropertyPermission("java.vendor", "read"));
ps.add(new PropertyPermission("java.version", "read"));
ps.add(new PropertyPermission("os.name", "read"));
ps.add(new PropertyPermission("os.arch", "read"));
ps.add(new PropertyPermission("os.version", "read"));
ps.add(new SocketPermission("*", "resolve"));
ps.add(new FilePermission(Paths.compiledFolder.getPath(), "read,write,delete"));
ps.setReadOnly();
return ps;
}
#Override
#SuppressWarnings("rawtypes")
public Class<?> loadClass(final String name, final boolean resolve) throws ClassNotFoundException {
Class clazz = findLoadedClass(name);
if (clazz == null) {
try {
byte[] bytes = loadClassData(name);
clazz = defineClass(name, bytes, 0, bytes.length, domain);
if (resolve) {
resolveClass(clazz);
}
} catch (final Exception e) {
clazz = super.loadClass(name, resolve);
}
}
return clazz;
}
public byte[] loadClassData(final String name) {
try {
final InputStream in = getResourceAsStream(name.replace('.', '/') + ".class");
final byte[] buffer = new byte[4096];
final ByteArrayOutputStream out = new ByteArrayOutputStream();
int n;
while ((n = in.read(buffer, 0, 4096)) != -1) {
out.write(buffer, 0, n);
}
return out.toByteArray();
} catch (IOException ex) {
Logger.getLogger(GameClassLoader.class.getName()).log(Level.SEVERE, null, ex);
}
return null;
}
#Override
public URL getResource(final String name) {
try {
return new URL(base, name);
} catch (final MalformedURLException e) {
return null;
}
}
#Override
public InputStream getResourceAsStream(final String name) {
try {
return new URL(base, name).openStream();
} catch (final IOException e) {
return null;
}
}
}
The Plugin I am loading: (The annotation isn't found either)
import com.mcgm.GameInfo;
import com.mcgm.game.Minigame;
#GameInfo(name = "RandomGame",
description = "A really long and boring game.",
authors = {"Tom", "Is", "The", "Greatest"},
version = 0.1,
maxPlayers = 100,
teamBased = false,
teamAmount = -1,
PvP = false)
public class game extends Minigame {
}
How I'm calling the class to be loaded:
GameClassLoader classLoader = new GameClassLoader(Paths.compiledFolder.toURI().toURL());
classLoader.loadClass("game", true);
I figure this is trivial for those that know what they're doing!
FINALLY! After a day and a half of searching, Vulcan pointed me in the right direction:
I changed the GameClassLoader to:
public GameClassLoader(final URL url, ClassLoader parent) {
super(parent);
and finally added the base url to the getResourceAsStream()
final InputStream in = getResourceAsStream(base.getFile() + "/" + name.replace('.', '/') + ".class");
Thanks so much for your help guys!
Try to add leading slash into resource path:
final InputStream in = getResourceAsStream("/" + name.replace('.', '/') + ".class");
This is the thing I have to try every time I am calling getResourceAsStream(). I just have tried this for you again. The path here is relative to package of class that is used to call getResourceAsStream(), so leading slash is needed to say "start from root."