Java Plugin-System mit jar-Dateien

:shinner:

Der uebliche Weg, um alle Klassen, die ein bestimmtes Interface implementieren, aus dem Jar File zu laden ist dieses Service Provider Pattern. Das hab ich auch heuer in "Technologien für verteilte Systeme" gelernt.

Uebrigens:
Ein wenig bloed ist, das diese Service Klasse in dem sun.* namespace liegt und nicht in java.* oder org.*. D.h. eigentlich sollte man von sun.* packages die Finger lassen, weil die nicht Teil der JDK Spec sind.. Ich habe da aber auch Diskussionen zu gefunden, und die Klasse wird wohl demnachst in einen oeffentlichen Namespace wandern.

hihi, das hat mich jetzt aber interessiert.
hab mal schnell was zusammen gehackt:

public class App {
	public static void main(String[] args) throws Exception {
		File pluginDir = new File("plugins");

		System.out.println("loading plugins from: " + pluginDir.getAbsolutePath());
		File[] jars = pluginDir.listFiles(new FileFilter() {
			public boolean accept(File pathname) {
				return pathname.getName().endsWith(".jar");
			}
		});
		for (File f : jars) {
			System.out.println("processing jar: " + f.getName());
			final JarFile jar = new JarFile(f);

			for (Enumeration<JarEntry> entries = jar.entries(); entries.hasMoreElements(); ) {
				JarEntry entry = entries.nextElement();
				String name = entry.getName();
				if(name.endsWith(".class") == false) {
					continue;
				}
				String className = name.replaceAll("/", ".");
				className = className.substring(0, className.length() - ".class".length());

				URLClassLoader loader = URLClassLoader.newInstance(new URL[] { f.toURL() });
				ISub sub = (ISub) loader.loadClass(className).newInstance();
				System.out.println("Sub says ----> " + sub.getMsg());
			}
		}
	}
}

Zitat von a9bejo

Der uebliche Weg, um alle Klassen, die ein bestimmtes Interface implementieren, aus dem Jar File zu laden ist dieses Service Provider Pattern. Das hab ich auch heuer in "Technologien für verteilte Systeme" gelernt.

hm.... service provider? warum nicht eine einfache variante davon nachprogrammieren?! eine "service.properties" datei in das plugin jar file reinhaun mit inhalt:

pkg.plugininterfaces.ISub = pkg.plugin1.Sub1

dann geht auch das:

public class App {
	public static void main(String[] args) throws Exception {
		File pluginDir = new File("plugins");

		System.out.println("loading plugins from: " + pluginDir.getAbsolutePath());
		File[] jars = pluginDir.listFiles(new FileFilter() {
			public boolean accept(File pathname) {
				return pathname.getName().endsWith(".jar");
			}
		});
		for (File f : jars) {
			System.out.println("processing jar: " + f.getName());

			URLClassLoader loader = URLClassLoader.newInstance(new URL[] { f.toURL() });
			ResourceBundle props = ResourceBundle.getBundle("service", Locale.getDefault(), loader);
			final String isubClassName = props.getString("pkg.plugininterfaces.ISub");

			ISub sub = (ISub) loader.loadClass(isubClassName).newInstance();
			System.out.println("Sub says ----> " + sub.getMsg());
		}
	}
}

Zitat von phudy

hm.... service provider? warum nicht eine einfache variante davon nachprogrammieren?!

Was hast du denn davon, wenn du etwas nachprogrammierst, das es bereits gibt? Die 0815 Loesung ist (halbwegs) dokumentiert, sie hat tool support (z.b. ant kann damit umgehen) und sie funktioniert.

Zitat von a9bejo

Was hast du denn davon, wenn du etwas nachprogrammierst, das es bereits gibt?

es macht spaß

(mal vom lerneffekt abgesehen)

[edit] oder man kann sich auch OSGi "antun"...

OK, das ist natuerlich ein guter Grund. Ich habe

Zitat

hm.... service provider? warum nicht eine einfache variante davon nachprogrammieren?!

als einen Loesungsvorschlag fuer Stephes Problem gelesen, als bessere Variante gegenueber der fertigen Implementierung. Vielleicht wegen des entsetzten "?!" .

Zitat von a9bejo

Vielleicht wegen des entsetzten "?!" .

was ist an dem "?!" so entsetzend?!
fuer mich ist das nur eine frage, die leicht etwas von einer aufforderung hat (in dem fall halt an mich selbst).

Stephe: evtl kannst nachher ueber deine erfahrungen kurz berichten? wuerd mich naemlich auch interessen...

das funktioniert nur, wenn das plugin-jar bereits beim start der vm als teil des classpath angegeben wird.
diese art der einbindung von plugins ist aber nicht wirklich schön und funktioniert zu laufzeit überhaupt nicht. dafür braucht man einen URLClassLoader, wie oben schon beschrieben.

hallo,

zur realen anwendbarkeit fehlen jetzt eigentlich nur noch live-updatebarkeit
und eine sinnvolle test-methodik

mfg, lb

theoretisch könntest du alle deine plugins auch ein gemeinsames interface implementieren lassen, dann könntest du die klasse aufs interface casten und könntest die methoden direkt aufrufen...
würd ich jedenfalls so machen, weil ich reflection vermeide wo es nur geht.

Wenn man ein existierendes Plugin Framework verwenden will und nicht unbedingt OSGI, dann kann ich nur http://jpf.sf.net/ empfehlen.

also, ich hab mich jetzt einige zeit intensivst mit JPF auseinandergesetzt (vorm schlafen gehn denk ich immer nur ), und muss sagen dass es aeusserst einfach und bequem einzusetzen ist im vergleich zu anderen frameworks a la osgi. es ist sogar ein selbstgestecktes ziel von den JPF leuten nicht zuuu komplex zu sein.
von daher: JPF :thumb:

interessant koennten auch noch folgende blogeintraege sein ueber "sich-selber-ein-plugin-framework-schreiben":
java-dynamic-loading-of-class-and-jar-file
develop-a-java-plugin-framework
develop-a-java-plugin-framework-search-for-plugin-dynamically

bzw noch besser: du verwendest neue moeglichkeiten von java 6 mit hilfe des service providers:
http://java.sun.com/developer/tech…ase/extensible/

---- edit ----
wenn man java6 zur verfuegung hat, geht das mit dem ServiceLoader echt ur geschmeidig:

1) jar bauen, welches eine datei /META-INF/services/com.example.ISomeServiceInterface mit inhalt com.example.plugin.SomeServiceImpl hat (natuerlich auch noch diese impl klasse korrekt erstellen)
2) die hauptanwendung hat dann dieses jar im classpath und folgende zwei zeilen reichen dann aus um die angemeldeten service provider zu nutzen:

ServiceLoader<ISomeServiceInterface> loader = ServiceLoader.load(ISomeServiceInterface.class);
for (ISomeServiceInterface service : loader) { /* do something with service */ }