如何对 jar 中的资源使用 JSF 版本控制答案

【问题标题】：How to use JSF versioning for resources in jar如何对 jar 中的资源使用 JSF 版本控制
【发布时间】：2013-08-11 04:34:21
【问题描述】：

PF 3.5.10、Mojarra 2.1.21、omnifaces 1.5

我有一个 JSF 库（仅包含 css 文件）。该库位于 .jar 文件中。 css 将包含在 xhtml 中 <h:outputStylesheet library="mylib" name="css/mycss.css">.

在 html 中呈现为：localhost:8080/cms/javax.faces.resource/css/mycss.css.jsf?ln=mylib

primefaces 的 CSS 文件被渲染为： localhost:8080/cms/javax.faces.resource/primefaces.js.jsf?ln=primefaces&v=3.5.10

请注意最后的库版本（&3.5.10）。我怎么能做同样的事情？我应该在 Manifest.mf 中编写版本吗？或者如何在 jar 文件中使用 jsf-versioning？

【问题讨论】：

How to specify resource library version in JSF2? 的可能重复项
不，我认为这不是重复的，因为问题是关于 jar 文件的。在罐子里这是不同的。请参阅 BalusC 答案：link

标签： jsf-2 jar resources versioning

【解决方案1】：

很遗憾，这是不可能的。 JAR 中的资源不支持库版本控制。

你基本上有两个选择：

用简单而丑陋的方式来做，包括服务器的启动时间作为查询字符串。鉴于您使用的是 OmniFaces，您可以使用其内置的 #{startup} 托管 bean 来引用应用程序范围内的 java.util.Date 实例：
```
<h:outputStylesheet ... name="some.css?#{startup.time}" />
<h:outputScript ... name="some.js?#{startup.time}" />
```
或者您可能已经将版本作为某个应用程序变量。
```
<h:outputStylesheet ... name="some.css?v=#{app.version}" />
<h:outputScript ... name="some.js?v=#{app.version}" />
```
更新：尽管如此，这不适用于<h:outputStylesheet>。另见：https://github.com/javaserverfaces/mojarra/issues/3945 或 https://github.com/javaee/javaserverfaces-spec/issues/1395

它适用于<h:outputScript>，但它有一个非常相似的错误报告，很快就实现了https://github.com/javaserverfaces/mojarra/issues/1216

Do the same as PrimeFaces，创建自定义ResourceHandler。

public class MyVersionResourceHandler extends ResourceHandlerWrapper {

    private ResourceHandler wrapped;

    public MyVersionResourceHandler(ResourceHandler wrapped) {
        this.wrapped = wrapped;
    }

    @Override
    public Resource createResource(String resourceName) {
        return createResource(resourceName, null, null);
    }

    @Override
    public Resource createResource(String resourceName, String libraryName) {
        return createResource(resourceName, libraryName, null);
    }

    @Override
    public Resource createResource(String resourceName, String libraryName, String contentType) {
        final Resource resource = super.createResource(resourceName, libraryName, contentType);

        if (resource == null) {
            return null;
        }

        return new ResourceWrapper() {

            @Override
            public String getRequestPath() {
                return super.getRequestPath() + "&v=1.0";
            }

            @Override // Necessary because this is missing in ResourceWrapper (will be fixed in JSF 2.2).
            public String getResourceName() {
                return resource.getResourceName();
            }

            @Override // Necessary because this is missing in ResourceWrapper (will be fixed in JSF 2.2).
            public String getLibraryName() {
                return resource.getLibraryName();
            }

            @Override // Necessary because this is missing in ResourceWrapper (will be fixed in JSF 2.2).
            public String getContentType() {
                return resource.getContentType();
            }

            @Override
            public Resource getWrapped() {
                return resource;
            }
        };
    }

    @Override
    public ResourceHandler getWrapped() {
        return wrapped;
    }

}

或者，如果您碰巧已经在使用 OmniFaces，则可以更简单地完成：

public class YourVersionResourceHandler extends DefaultResourceHandler {

    public YourVersionResourceHandler(ResourceHandler wrapped) {
        super(wrapped);
    }

    @Override
    public Resource decorateResource(Resource resource) {
        if (resource == null || !"mylib".equals(resource.getLibraryName())) {
            return resource;
        }

        return new RemappedResource(resource, resource.getRequestPath() + "&v=1.0");
    }

}

无论哪种方式，要使其运行，请将其注册为 JAR 的 /META-INF/faces-config.xml 中的 <resource-handler>。

<application>
    <resource-handler>com.example.MyVersionResourceHandler</resource-handler>
</application>

【讨论】：

谢谢！很有帮助的答案。您在 1 #{startup} 中的想法很好。因此客户端 css 将始终更新，您不能忘记更改版本。另一个问题：是否可以将此 ResourceHandler 放在 jar 文件中并从那里使用它？所以每个罐子都是独立的。
是的，把class放到JAR里，注册到JAR的/META-INF/faces-config.xml。对于您错过的情况，答案底部也提到了这一点。
像往常一样出色的答案。但是我发现 com.sun.faces.application.resource.ResourceImpl 将对带有版本信息的库使用 v 参数。因此，我通过更改参数名称对这个很好的示例进行了轻微更改。我正在使用优秀的github.com/ktoso/maven-git-commit-id-plugin 生成一个以gch 作为参数名称的git commit hash。
@raupach：这是一个技术限制。现在你在多年后回来，如果你碰巧已经在使用 OmniFaces，看看这里如何用更少的代码做到这一点：github.com/omnifaces/omnifaces/blob/master/src/main/java/org/…
@marcel：嗯，不是错误，但监督和规范失败了。见java.net/jira/browse/JAVASERVERFACES-3941 和java.net/jira/browse/JAVASERVERFACES_SPEC_PUBLIC-1395

【解决方案2】：

您还可以使用您的项目版本并将其作为版本号附加到您的资源文件中。这可以使用maven-war-plugin 来完成。 maven-war-plugin 将在构建期间查看您的页面并替换定义的属性。

以下示例向您展示如何配置 maven-war-plugin 以过滤您的 webapp 资源以注入自定义属性 asset.version：

pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" ...>
  ...

  <properties>
    <asset.version>${project.version}</asset.version>    
  </properties>

  ...

  <build>
    <plugins>
      ...

      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-war-plugin</artifactId>
        <version>2.3</version>
        <configuration>

          <nonFilteredFileExtensions>
            <nonFilteredFileExtension>gif</nonFilteredFileExtension>
            <nonFilteredFileExtension>ico</nonFilteredFileExtension>
            <nonFilteredFileExtension>jpg</nonFilteredFileExtension>
            <nonFilteredFileExtension>png</nonFilteredFileExtension>
            <nonFilteredFileExtension>pdf</nonFilteredFileExtension>
          </nonFilteredFileExtensions>

          <failOnMissingWebXml>false</failOnMissingWebXml>

          <webResources> 
            <webResource>
              <directory>${basedir}/src/main/webapp</directory> 
              <filtering>true</filtering> 
            </webResource>
          </webResources> 

        </configuration>
      </plugin>

      ...
    </plugins>
  </build>

</project>

然后可以在您的 JSF 文件中使用 asset.version 属性。

这是一个使用 JSF 2.2 测试的示例：

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html ...
      xmlns:jsf="http://xmlns.jcp.org/jsf">

...
<script jsf:name="js/libs/pure/pure-min.css?v=${project.version}" />

结果（在我的例子中）如下：

<script type="text/javascript" src="/context-path/javax.faces.resource/js/libs/pure/pure-min.css.xhtml?v=1.0.15-SNAPSHOT"></script>

【讨论】：

好点！谢谢你。使用 Maven 的解决方案很有趣。很遗憾，我们没有这样做。

【解决方案3】：

@Balusc 回应说“好吧，不是错误，而是监督和规范失败”。似乎部署在库中的 css 资源无法使用 mojarra 2.2.14 进行版本控制。这样对吗？我尝试使用自定义 ResourceHandler 实现您的解决方案，但 getWrapped().createResource(resourceName, libraryName) 返回的资源始终返回 null。似乎 createResource() 尝试使用路径 /META-INF/resources/ 查找库的资源（如 css/layout.css），但它缺少版本。

为了解决这个问题，我重写了自定义 ResourceHandler 上的 createResource 方法，该方法扩展了 Omnifaces DefaultResourceHandler 以将版本前缀添加到资源名称

@Override
public Resource createResource(String resourceName, String libraryName) {
    if (libraryName != null && libraryName.equals(LIBRARY_NAME)) {
        if (!resourceName.startsWith(version)) {
            resourceName = version + "/"+resourceName;
        }
    }
    return super.createResource(resourceName, libraryName);
}

通过这种解决方法，生成的链接看起来像

<link type="text/css" rel="stylesheet" href="/javax.faces.resource/1_0_3/css/layout.css?ln=common&amp;v=1_0_3"/>

用于输出样式表声明

<h:outputStylesheet library="common" name="css/layout.css" />

我不确定这是最好的解决方法。

【讨论】：