OSGi 中的速度：如何从类路径加载模板

Question

我正在开发一个带有速度模板引擎的 OSGi 应用程序。 它非常适合通过文件加载器加载我的模板，但现在我必须在我的 jar 中实现此模板并将其作为资源加载。

我怎样才能让它发挥作用？

我的代码：

ve = new VelocityEngine();
ve.setProperty(RuntimeConstants.RESOURCE_LOADER, "classpath");
ve.setProperty("classpath.resource.loader.class", 
    ClasspathResourceLoader.class.getName());
ve.setProperty("classpath.resource.loader.path", "/velocitytemplates");
ve.init();

ve.getTemplate("foo.vm");

这会抛出一个异常，例如

无法找到资源“index.vm”

原因：

org.apache.velocity.exception.ResourceNotFoundException：无法找到资源“index.vm”

Answer 1

遗憾的是 Velocity 对 OSGi 并不友好。因此，您无法使用内置的 ClasspathResourceLoader，并且也很难添加自定义开发的 ResourceLoader。

我建议您应该以任何普通方式将模板作为 Reader 获取，并选择以下方法之一：

• 如果需要合并模板，请使用 VelocityEngine evaulate 函数
  模板很少（性能并不那么重要）
• 使用 Velocity 的内部类手动创建模板

如果您不必经常合并模板，因此性能不是关键要求，则可以使用第一个选项。

下面是第二个选项的示例，其中创建的模板对象可以通过调用合并函数来重用（期望您已经获得了 vm 文件或资源的读取器）：

RuntimeInstance runtimeInstance = new RuntimeInstance();
runtimeInstance.init();
SimpleNode simpleNode = runtimeInstance.parse(reader, "nameOfYourTemplateResource");

Template template = new Template();
simpleNode.init(new InternalContextAdapterImpl(new VelocityContext()), runtimeInstance);
template.setData(simpleNode);

template.merge(...);
...

要在 OSGi 中获得 vm 文件的读取器，您需要应该选择一个与您的虚拟机资源位于同一包中的类，并调用 SameBundleClass.class.getResourceAsStream... 您可以使用 InputStreamReader 将流转换为写入器。

请注意，该示例遗漏了一些 try-catch-finally 块。

Answer 2

需要验证的两件事

1. 类路径问题

确保通过 MANIFEST.MF 设置 OSGi 包的类路径以包含一个点：

Bundle-ClassPath: .

点表示将包的根包含在类加载层次结构中，其中您的文件夹“velocitytemplates” “可能存在。

并且您需要将 Velocity jar 文件放在模板文件所在的同一个包中，因为否则您将遇到类加载问题，因为 Velocity 将驻留在不同的包中，因此根本看不到“velocitytemplates”类路径。

2. ClasspathResourceLoader 没有“路径”

ClasspathResourceLoader 不支持设置“路径”，因为它根据定义使用类路径，因此要么将“velocitytemplates”添加到 OSGi 包 (MANIFESt.MF) 中的类路径，要么引用速度具有完整路径的模板，即“velocitytemplates/index.vm”

Answer 3

我在基于类加载器的模板中遇到了类似的问题，我想指定不同的根。我通过子类化 ClasspathResourceLoader 来解决这个问题。

package my.package;

import java.io.InputStream;
import org.apache.commons.collections.ExtendedProperties;
import org.apache.velocity.exception.ResourceNotFoundException;
import org.apache.velocity.runtime.resource.loader.ClasspathResourceLoader;

public class PrefixedClasspathResourceLoader 
    extends ClasspathResourceLoader
{
    /** Prefix to be added to any names */
    private String prefix = "";

    @Override
    public void init(ExtendedProperties configuration) {
        prefix = configuration.getString("prefix","");
    }

    @Override
    public InputStream getResourceStream(String name)
            throws ResourceNotFoundException 
    {
        return super.getResourceStream(prefix+name);
    }
}

通过这种方式设置以下属性

resource.loader=myloader
myloader.resource.loader.class=my.package.PrefixedClasspathResourceLoader
myloader.resource.loader.prefix=/velocitytemplates/

，如果您有一个名为“index.vm”的模板，velocity 将使用类加载器来查找名为“/velocitytemplates/index.vm”的资源

Answer 4

2天后，我和一位同事找到了 Velocity Engine 默认的解决方案： file.resource.loader.class=org.apache.velocity.runtime.resource.loader.FileResourceLoader

一样

public static final class PdfResourceLoader extends ResourceLoader

@Override
public void init(ExtendedProperties configuration)
{
}

@Override
public InputStream getResourceStream(String source) throws ResourceNotFoundException
{
  return getClass().getResourceAsStream(source);
}

@Override
public boolean isSourceModified(Resource resource)
{
  return false;
}

@Override
public long getLastModified(Resource resource)
{
  return 0;
}
}

创建了自己的类资源加载器，就像设置新的上下文类 加载程序

Thread.currentThread().setContextClassLoader(PdfResourceLoader.class.getClassLoader());  
    VelocityEngine ve = new VelocityEngine();

更改了速度引擎内默认的属性

ve.setProperty("resource.loader", "pdf"); 
ve.setProperty("pdf.resource.loader.class",
PdfResourceLoader.class.getName());
ve.init(); 

示例名称路径模板

String pathTemplate = "/templates/yourTemplateName.html";      
Template t = ve.getTemplate(pathTemplate, "UTF-8"); 

它是

Answer 5

哇，这个问题很老了，没有一个答案被标记。因此，我将尝试解释该问题并提供另一种解决方案。

OSGi 类路径的问题是，每个包都有它自己的私有类加载器。该捆绑包类加载器必须在类路径和 Velocity 类上具有模板资源。如果 Velocity 类由另一个包提供，则 Velocity 的 ClasspathResourceLoader 将找不到模板资源，因为它们不在该包的类路径上。

因此，您必须

1. 确保 Velocity 的 ClasspathResourceLoader 位于与模板相同的类路径中（由 @centic 提到），或者
2. 实现并配置一个能够查找资源的自定义 ResourceLoader（由 @gary-stand-with- 提到）乌克兰）。

对于后一个选项，我会选择另一种方法，并专门使用了解资源的显式类加载器实例来配置 ClasspathResourceLoader。