具有动态类加载的java CDI扩展
目标是从远程位置加载一堆jar文件作为插件,并在CDI上下文中初始化它们 然后servlet可以触发如下事件:具有动态类加载的java CDI扩展,java,servlets,jakarta-ee,dependency-injection,cdi,Java,Servlets,Jakarta Ee,Dependency Injection,Cdi,目标是从远程位置加载一堆jar文件作为插件,并在CDI上下文中初始化它们 然后servlet可以触发如下事件: testEvent.fire(new EventTest("some message")); 插件将能够观察到的。示例插件如下所示: public class Plugin{ public void respond (@Observes EventTest e){ //does something with the even object } } 下
testEvent.fire(new EventTest("some message"));
插件将能够观察到的。示例插件如下所示:
public class Plugin{
public void respond (@Observes EventTest e){
//does something with the even object
}
}
下面是假定加载插件的代码。从这个类中获取并重写的内容与servlet类位于同一个包中。它有必要的META-INF/services目录和javax.enterprise.inject.spi.Extension文件,该文件只有一行——扩展类的完全限定名:main.initplugins.initplugins
package main.initplugins;
import java.sql.SQLException;
import java.sql.Connection;
import java.sql.Statement;
import java.util.jar.JarInputStream;
import java.util.jar.JarEntry;
import java.lang.ClassLoader;
import java.lang.reflect.Method;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.enterprise.event.Observes;
import javax.enterprise.inject.spi.BeforeBeanDiscovery;
import javax.enterprise.inject.spi.BeanManager;
public class InitPlugins implements javax.enterprise.inject.spi.Extension{
Logger log = Logger.getLogger("");
private java.util.Set<Class<?>> classes;
public void beforeBeanDiscovery(@Observes BeforeBeanDiscovery bbd, BeanManager bm){
log.log(Level.INFO, "LOAD PLUGINS HERE");
loadFromFiles();
try{
for (Class<?> cl: classes){
final javax.enterprise.inject.spi.AnnotatedType<?> at = bm.createAnnotatedType(cl);
bbd.addAnnotatedType(at);
log.log(Level.INFO, "ADD ANNOTATED TYPE FOR: " + cl.getName());
}
log.log(Level.INFO, "ANNOTATED TYPE CREATION COMPLETE");
} catch (Exception ex){
log.log(Level.INFO, "FAIL TO CREATE ANNOTATED TYPE: " + ex.getMessage());
}
}
public void loadFromFiles() {
classes = new java.util.LinkedHashSet<Class<?>>();
try{
//connect to a remote location. In this case it will be a database that holds the bytes of the .jar files
Connection dbConnection = java.sql.DriverManager.getConnection("jdbc:mysql://localhost/testdb?user=user&password=passwd");
Statement statement = dbConnection.createStatement();
java.sql.ResultSet plugins = statement.executeQuery("select * from plugins"); //the plugins table contain 2 columns: 1) fileName as primary key, 2) longblob that hold raw byte of the jar file
while (plugins.next()){
JarInputStream js = new JarInputStream(new java.io.ByteArrayInputStream(plugins.getBytes(2))); //load them as jar files, 2 is the index for the raw byte column that holds the jar file
JarEntry je;
while((je = js.getNextJarEntry()) != null){
//open each jar file, scan through file contents and find the .class files, then extract those bytes and pass them in the ClassLoader's defineClass method
if(!je.isDirectory() && je.getName().endsWith(".class")){
String className = je.getName().substring(0, je.getName().length() - 6).replace("/", ".");
log.log(Level.INFO, "class name is: " + className);
java.io.ByteArrayOutputStream classBytes = new java.io.ByteArrayOutputStream();
byte[] bytes;
try{
byte[] buffer = new byte[2048];
int read = 0;
while(js.available() > 0){
read = js.read(buffer, 0, buffer.length);
if(read > 0){
classBytes.write(buffer, 0, read);
}
}
bytes = classBytes.toByteArray();
//code below taken from: https://jaxenter.com/tips-for-writing-pluggable-java-ee-applications-105281.html
java.security.ProtectionDomain protDomain = getClass().getProtectionDomain();
ClassLoader cl = Thread.currentThread().getContextClassLoader();
Method tempDefineClassMethod = null;
for (Method tempMethod : ClassLoader.class.getDeclaredMethods()){
if(tempMethod.getName().equals("defineClass") && tempMethod.getParameterCount() == 5){
tempDefineClassMethod = tempMethod;
break;
}
}
final Method defineClassMethod = tempDefineClassMethod;
try{
java.security.AccessController.doPrivileged(new java.security.PrivilegedExceptionAction(){
@Override
public java.lang.Object run() throws Exception{
if (!defineClassMethod.isAccessible()){
defineClassMethod.setAccessible(true);
}
return null;
}
});
log.log(Level.INFO, "Attempting load class: " + className + " with lenght of: " + bytes.length);
defineClassMethod.invoke(cl, className, bytes, 0, bytes.length, protDomain);
classes.add(cl.loadClass(className));
log.log(Level.INFO, "Loaded class: " + je.getName());
} catch (Exception ex){
log.log(Level.INFO, "Error loading class: " + ex.getMessage());
ex.printStackTrace();
}
} catch (Exception ex){
log.log(Level.INFO, "Error loading bytes: " + ex.getMessage());
}
}
}
}
} catch (SQLException ex){
log.log(Level.SEVERE, "Fail to get db connection or create statement in plugin ejb: ".concat(ex.getMessage()));
} catch (Exception ex){
log.log(Level.SEVERE, "Fail to get db connection or create statement in plugin ejb: ".concat(ex.getMessage()));
}
}
}
package main.initplugins;
导入java.sql.SQLException;
导入java.sql.Connection;
导入java.sql.Statement;
导入java.util.jar.JarInputStream;
导入java.util.jar.JarEntry;
导入java.lang.ClassLoader;
导入java.lang.reflect.Method;
导入java.util.logging.Level;
导入java.util.logging.Logger;
导入javax.enterprise.event.asp;
导入javax.enterprise.inject.spi.BeforeBeanDiscovery;
导入javax.enterprise.inject.spi.BeanManager;
公共类InitPlugins实现javax.enterprise.inject.spi.Extension{
Logger log=Logger.getLogger(“”);
private java.util.Set at=bm.createAnnotatedType(cl);
bbd.addAnnotatedType(at);
log.log(Level.INFO,“为“+cl.getName()”添加注释类型);
}
log.log(Level.INFO,“注释类型创建完成”);
}捕获(例外情况除外){
log.log(Level.INFO,“无法创建带注释的类型:”+ex.getMessage());
}
}
公共void loadFromFiles(){
classes=newjava.util.LinkedHashSet从CDI的角度来看,您的方法应该可以正常工作
这里的问题是类加载,特别是在考虑任何非平面部署(纯SE以外的任何部署)时
您选择使用TCCL,例如:
ClassLoader cl = Thread.currentThread().getContextClassLoader();
在某些应用程序服务器/servlet中,它可能会为您提供与加载扩展本身的类加载程序不同的类加载程序(InitPlugin
)
相反,您应该使用加载扩展的同一个CL来处理CDIBeans
ClassLoader cl = InitPlugins.class.getClassLoader()
注意:请注意,您正在航行未定义的水域。此行为/修复可能无法移植。从CDI的角度来看,您的方法应该可以正常工作
这里的问题是类加载,特别是在考虑任何非平面部署(纯SE以外的任何部署)时
您选择使用TCCL,例如:
ClassLoader cl = Thread.currentThread().getContextClassLoader();
在某些应用程序服务器/servlet中,它可能会为您提供与加载扩展本身的类加载程序不同的类加载程序(InitPlugin
)
相反,您应该使用加载扩展的同一个CL来处理CDIBeans
ClassLoader cl = InitPlugins.class.getClassLoader()
注意:请注意,您正在航行未定义的水域。此行为/修复可能不可移植。您是否看到表明类已加载的日志消息?另外,您如何部署应用程序?什么容器(包括版本)是的,所有日志消息都会显示,包括@Observable方法中的日志消息:为“+…和”添加注释类型创建完成“。使用wildfly 10.1,只是想知道,您的bean.xml
看起来像什么?当您向插件添加作用域时,如@ApplicationScoped
,这种情况会发生吗?My beans.xml位于servlet包中,该servlet包包含servlet和InitPlugins类。它是标准的beans.xml,具有bean发现模式=“all”attribute.Added@javax.enterprise.context.ApplicationScoped to plugin,但它仍然不会拾取从servlet触发的事件。还尝试了另一个服务器-glassfish,但更糟糕的是-它甚至不会执行带有扩展名的InitPlugins类。要添加到我之前的评论中,您可以尝试改用“标准”类加载器例如,使用加载扩展的同一个CL(您通过InitPlugins.class.getClassLoader()
)获取的CL)。您是否看到表明类已加载的日志消息?另外,您如何部署应用程序?什么容器(包括版本)是的,显示所有日志消息,包括@Observable方法中的日志消息:为“+…和”添加注释类型创建完成“。使用wildfly 10.1,只是想知道,您的bean.xml
看起来像什么?当您向插件添加作用域时,如@ApplicationScoped
,这种情况会发生吗?My beans.xml位于servlet包中,该servlet包包含servlet和InitPlugins类。它是标准的beans.xml,具有bean发现模式=“all”attribute.Added@javax.enterprise.context.ApplicationScoped to plugin,但它仍然不会拾取从servlet触发的事件。还尝试了另一个服务器-glassfish,但更糟糕的是-它甚至不会执行带有扩展名的InitPlugins类。要添加到我之前的评论中,您可以尝试改用“标准”类加载器例如,使用加载扩展的同一个CL(通过InitPlugins.class.getClassLoader()
获得的CL)。