如何通过 Maven 正确安装和配置 JSF 库？

Posted 2023-02-19

技术标签:

【中文标题】如何通过 Maven 正确安装和配置 JSF 库？【英文标题】：How to properly install and configure JSF libraries via Maven? 【发布时间】：2021-05-04 17:52:29 【问题描述】：

我正在尝试将基于 JSF 的应用程序部署到 Tomcat 6。我的构建系统的设置方式是，WAR 本身没有任何库，因为该服务器总共为 43 个应用程序提供服务。相反，这些库被复制到共享库文件夹中并在应用程序之间共享。部署时出现此错误

SEVERE: Error deploying configuration descriptor SSOAdmin.xml
java.lang.ClassFormatError: Absent Code attribute in method that is not native or abstract in class file javax/faces/webapp/FacesServlet
    at java.lang.ClassLoader.defineClass1(Native Method)
    at java.lang.ClassLoader.defineClassCond(ClassLoader.java:631)
    at java.lang.ClassLoader.defineClass(ClassLoader.java:615)
    at java.security.SecureClassLoader.defineClass(SecureClassLoader.java:141)
    at java.net.URLClassLoader.defineClass(URLClassLoader.java:283)
    at java.net.URLClassLoader.access$000(URLClassLoader.java:58)
    at java.net.URLClassLoader$1.run(URLClassLoader.java:197)
    at java.security.AccessController.doPrivileged(Native Method)
    at java.net.URLClassLoader.findClass(URLClassLoader.java:190)
    at java.lang.ClassLoader.loadClass(ClassLoader.java:306)
    at java.lang.ClassLoader.loadClass(ClassLoader.java:247)
    at org.apache.catalina.loader.WebappClassLoader.loadClass(WebappClassLoader.java:1667)
    at org.apache.catalina.loader.WebappClassLoader.loadClass(WebappClassLoader.java:1526)
    at org.apache.catalina.startup.WebAnnotationSet.loadApplicationServletAnnotations(WebAnnotationSet.java:108)
    at org.apache.catalina.startup.WebAnnotationSet.loadApplicationAnnotations(WebAnnotationSet.java:58)
    at org.apache.catalina.startup.ContextConfig.applicationAnnotationsConfig(ContextConfig.java:297)
    at org.apache.catalina.startup.ContextConfig.start(ContextConfig.java:1078)
    at org.apache.catalina.startup.ContextConfig.lifecycleEvent(ContextConfig.java:261)
    at org.apache.catalina.util.LifecycleSupport.fireLifecycleEvent(LifecycleSupport.java:142)
    at org.apache.catalina.core.StandardContext.start(StandardContext.java:4611)
    at org.apache.catalina.core.ContainerBase.addChildInternal(ContainerBase.java:799)
    at org.apache.catalina.core.ContainerBase.addChild(ContainerBase.java:779)
    at org.apache.catalina.core.StandardHost.addChild(StandardHost.java:601)
    at org.apache.catalina.startup.HostConfig.deployDescriptor(HostConfig.java:675)
    at org.apache.catalina.startup.HostConfig.deployDescriptors(HostConfig.java:601)
    at org.apache.catalina.startup.HostConfig.deployApps(HostConfig.java:502)
    at org.apache.catalina.startup.HostConfig.start(HostConfig.java:1315)
    at org.apache.catalina.startup.HostConfig.lifecycleEvent(HostConfig.java:324)
    at org.apache.catalina.util.LifecycleSupport.fireLifecycleEvent(LifecycleSupport.java:142)
    at org.apache.catalina.core.ContainerBase.start(ContainerBase.java:1061)
    at org.apache.catalina.core.StandardHost.start(StandardHost.java:840)
    at org.apache.catalina.core.ContainerBase.start(ContainerBase.java:1053)
    at org.apache.catalina.core.StandardEngine.start(StandardEngine.java:463)
    at org.apache.catalina.core.StandardService.start(StandardService.java:525)
    at org.apache.catalina.core.StandardServer.start(StandardServer.java:754)
    at org.apache.catalina.startup.Catalina.start(Catalina.java:595)
    at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
    at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
    at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
    at java.lang.reflect.Method.invoke(Method.java:597)
    at org.apache.catalina.startup.Bootstrap.start(Bootstrap.java:289)
    at org.apache.catalina.startup.Bootstrap.main(Bootstrap.java:414)

现在在我的研究中，我发现这应该通过下载 JSF 源代码并自己编译来解决。就我而言，这是一个可怕的解决方案。这将给我的团队带来巨大的问题，我们必须应对各种配置。是否有其他解决方法？

这是我的pom.xml：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.nms.sso</groupId>
  <artifactId>SSOAdmin</artifactId>
  <version>09142011-BETA</version>
  <packaging>war</packaging>
  <dependencies>
    <dependency>
      <groupId>asm</groupId>
      <artifactId>asm</artifactId>
      <scope>$myExeScope</scope>
    </dependency>
    <dependency>
      <groupId>cglib</groupId>
      <artifactId>cglib</artifactId>
      <scope>$myExeScope</scope>
    </dependency>
    <!-- <dependency> -->
    <!-- <groupId>com.sun.faces</groupId> -->
    <!-- <artifactId>jsf-api</artifactId> -->
    <!-- <scope>$myExeScope</scope> -->
    <!-- </dependency> -->
    <!-- <dependency> -->
    <!-- <groupId>com.sun.faces</groupId> -->
    <!-- <artifactId>jsf-impl</artifactId> -->
    <!-- <scope>$myExeScope</scope> -->
    <!-- </dependency> -->
    <dependency>
      <groupId>commons-codec</groupId>
      <artifactId>commons-codec</artifactId>
      <scope>$myExeScope</scope>
    </dependency>
    <dependency>
      <groupId>javax</groupId>
      <artifactId>javaee-api</artifactId>
      <version>6.0</version>
      <scope>provided</scope>
    </dependency>
    <dependency>
      <groupId>javax.faces</groupId>
      <artifactId>javax.faces-api</artifactId>
      <scope>$myExeScope</scope>
    </dependency>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <scope>$myExeScope</scope>
    </dependency>
    <dependency>
      <groupId>net.sf.jt400</groupId>
      <artifactId>jt400</artifactId>
      <scope>$myExeScope</scope>
    </dependency>
    <dependency>
      <groupId>nmsc</groupId>
      <artifactId>nmsc_api</artifactId>
      <version>09142011-BETA</version>
    </dependency>
    <dependency>
      <groupId>org.hibernate</groupId>
      <artifactId>hibernate-core</artifactId>
      <scope>$myExeScope</scope>
    </dependency>
    <dependency>
      <groupId>org.icefaces</groupId>
      <artifactId>icefaces</artifactId>
      <scope>$myExeScope</scope>
    </dependency>
    <dependency>
      <groupId>org.icefaces</groupId>
      <artifactId>icefaces-ace</artifactId>
      <scope>$myExeScope</scope>
    </dependency>
    <dependency>
      <groupId>org.icefaces</groupId>
      <artifactId>icefaces-compat</artifactId>
      <scope>$myExeScope</scope>
    </dependency>
    <dependency>
      <groupId>org.javassist</groupId>
      <artifactId>javassist</artifactId>
      <scope>$myExeScope</scope>
    </dependency>
    <dependency>
      <groupId>org.jibx</groupId>
      <artifactId>jibx-extras</artifactId>
      <scope>$myExeScope</scope>
    </dependency>
    <dependency>
      <groupId>org.jibx</groupId>
      <artifactId>jibx-run</artifactId>
      <scope>$myExeScope</scope>
    </dependency>
    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-log4j12</artifactId>
      <scope>$myExeScope</scope>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-context</artifactId>
      <scope>$myExeScope</scope>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-orm</artifactId>
      <scope>$myExeScope</scope>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-tx</artifactId>
      <scope>$myExeScope</scope>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-web</artifactId>
      <scope>$myExeScope</scope>
    </dependency>
    <dependency>
      <groupId>postgresql</groupId>
      <artifactId>postgresql</artifactId>
      <scope>$myExeScope</scope>
    </dependency>
  </dependencies>
  <parent>
    <groupId>nmsc</groupId>
    <artifactId>nmsc_lib</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <relativePath>../libs</relativePath>
  </parent>
  <build>
    <finalName>SSOAdmin</finalName>
  </build>
  <name>SSOAdmin Maven Webapp</name>
</project>

这里必须有一个解决方案。我简直不敢相信用于 JSF 的 Maven 可分发仅适用于编译而不适用于部署。

【问题讨论】：

【参考方案1】：

当您遇到“奇怪”异常时，提示类/方法/文件/组件/标签不存在或不同，而它们似乎明确包含在 Web 应用程序中，如下所示，

java.lang.ClassFormatError：类文件 javax/faces/webapp/FacesServlet 中非本机或抽象方法中的缺失代码属性

java.util.MissingResourceException：找不到 javax.faces.LogStrings 包

com.sun.faces.vendor.WebContainerInjectionProvider 无法转换为 com.sun.faces.spi.InjectionProvider

com.sun.faces.config.ConfigurationException：配置失败

命名空间 http://xmlns.jcp.org/jsf/html 中名为 inputFile 的标签定义了一个空处理程序类。

javax.faces.CurrentThreadToServletContext.getFallbackFactory 的 java.lang.NullPointerException

javax.faces.application.ViewHandlerWrapper.getWebsocketURL 处的 java.lang.AbstractMethodError

com.sun.faces.config.InitFacesContext.cleanupInitMaps 处的 java.lang.NullPointerException

或者当您面临“奇怪”的运行时行为，例如 HTTP 会话中断（jsessionid 出现在所有地方的链接 URL 中）和/或 JSF 视图范围（它表现为请求范围）和/或损坏的 CSS/JS/图像资源，那么 webapp 的运行时类路径很可能被重复的不同版本的 JAR 文件污染。

在您使用FacesServlet 上的ClassFormatError 的具体情况下，这意味着第一次发现包含上述类的JAR 文件实际上是一个“蓝图”API JAR 文件，旨在供实现供应商使用（例如为 Mojarra 和 MyFaces 工作的开发人员）。它包含只有类和方法签名的类文件，没有任何代码体和资源文件。这正是“缺少代码属性”的含义。它纯粹用于 javadocs 和编译。

始终将服务器提供的库标记为 `provided`

所有在 Maven 中标记为“Java Specifications”并在工件 ID 中具有 -api 后缀的依赖项都是那些蓝图 API。您绝对不应该将它们放在运行时类路径中。如果你真的需要在你的 pom 中使用它，你应该总是标记它们<scope>provided</scope>。一个众所周知的例子是Java EE (Web) API：

<dependency>
    <groupId>javax</groupId>
    <artifactId>javaee-web-api</artifactId>
    <version><!-- 7.0 or 8.0 or newer --></version>
    <scope>provided</scope>
</dependency>

如果provided 范围不存在，那么这个JAR 将最终出现在webapp 的/WEB-INF/lib 中，从而导致您现在面临的所有问题。此 JAR 还包含 FacesServlet 的蓝图类。

在您的具体情况下，您有一个不必要的 JSF API 依赖项：

<dependency>
    <groupId>javax.faces</groupId>
    <artifactId>javax.faces-api</artifactId>
</dependency>

这会引起麻烦，因为它包含FacesServlet 的蓝图类。删除它并依赖如上所示的provided Java EE (Web) API 应该可以解决它。

Tomcat 作为准系统 JSP/Servlet 容器已经提供了 JSP、Servlet 和 EL（从 8 开始还有 WebSocket）。因此，您应该至少将jsp-api、servlet-api 和el-api 标记为provided。 Tomcat 仅不提供开箱即用的 JSF（和 JSTL）。所以你需要通过 webapp 安装它。

WildFly、TomEE、GlassFish、Payara、WebSphere 等成熟的 Java EE 服务器已经提供了完整的 Java EE API，包括 JSF。所以你绝对不需要通过 webapp 安装 JSF。如果服务器已经提供了不同的实现和/或开箱即用的版本，它只会导致冲突。您需要的唯一依赖项是javaee-web-api，完全如上所示。

在 Tomcat 9 或更早版本上安装 JSF

有两个 JSF 实现：Mojarra and MyFaces。您应该选择安装其中一个，因此不要同时安装。

在 Tomcat 9 或更早版本上安装 Mojarra 2.3：

<dependency>
    <groupId>org.glassfish</groupId>
    <artifactId>jakarta.faces</artifactId>
    <version><!-- Check https://eclipse-ee4j.github.io/mojarra --></version>
</dependency>

您还可以查看org.glassfish:jakarta.faces repository 以获取当前最新的 2.3.x 发行版本（当前为 2.3.16）。另请参阅 Mojarra installation instructions 了解其他必要的依赖项（CDI、BV、JSONP）。

在 Tomcat 9 或更早版本上安装 MyFaces 2.3：

<dependency>
    <groupId>org.apache.myfaces.core</groupId>
    <artifactId>myfaces-impl</artifactId>
    <version><!-- Check http://myfaces.apache.org --></version>
</dependency>

您还可以查看org.apache.myfaces.core:myfaces-impl repository 获取当前最新的 2.3.x 发行版本（当前为 2.3.9）。

请注意，作为 Servlet 2.5 容器的 Tomcat 6 支持最大 JSF 2.1。

顺便说一句，不要忘记安装 JSTL API。这在 Tomcat 中也没有。

<dependency>
    <groupId>jakarta.servlet.jsp.jstl</groupId>
    <artifactId>jakarta.servlet.jsp.jstl-api</artifactId>
    <version><!-- Check https://mvnrepository.com/artifact/jakarta.servlet.jsp.jstl/jakarta.servlet.jsp.jstl-api --></version>
</dependency>

还要注意，自 JSF 2.3 起，CDI 已成为必需的依赖项。这在普通的 Java EE 服务器中可用，但在 Tomcat 等 servlet 容器上不可用。在这种情况下，请前往How to install and use CDI on Tomcat?

在 Tomcat 10 或更新版本上安装 JSF

您需要的最低 JSF 版本为 3.0 而不是 2.3，因为自 3.0 起，javax.* 包已重命名为 jakarta.*。

在 Tomcat 10 或更高版本上安装 Mojarra 3.0：

<dependency>
    <groupId>org.glassfish</groupId>
    <artifactId>jakarta.faces</artifactId>
    <version><!-- Check https://eclipse-ee4j.github.io/mojarra --></version>
</dependency>

您还可以查看org.glassfish:jakarta.faces repository 以获取当前最新的 3.0.x 发布版本（当前为 3.0.1）。另请参阅 Mojarra installation instructions 了解其他必要的依赖项（CDI、BV、JSONP）。

在 Tomcat 10 或更高版本上安装 MyFaces 3.0：

<dependency>
    <groupId>org.apache.myfaces.core</groupId>
    <artifactId>myfaces-impl</artifactId>
    <version><!-- Check http://myfaces.apache.org --></version>
</dependency>

您还可以查看org.apache.myfaces.core:myfaces-impl repository 以获取当前最新的 3.0.x 发布版本（当前为 3.0.1）。

顺便说一句，不要忘记安装 JSTL API。这在 Tomcat 中也没有。

<dependency>
    <groupId>jakarta.servlet.jsp.jstl</groupId>
    <artifactId>jakarta.servlet.jsp.jstl-api</artifactId>
    <version><!-- Check https://mvnrepository.com/artifact/jakarta.servlet.jsp.jstl/jakarta.servlet.jsp.jstl-api 2.x --></version>
</dependency>

另见：

What exactly is Java EE? java.lang.NoClassDefFoundError: javax/servlet/jsp/jstl/core/Config How to install and use CDI on Tomcat? JSF returns blank/unparsed page with plain/raw XHTML/XML/EL source instead of rendered HTML output

【讨论】：

是的，这东西一团糟。现在我一直专注于让一切运行起来。完成后，我将清理依赖项。所有版本号都在一个父 pom 文件中，我将在 jsf 上将依赖项更改为 2.0 版，看看会发生什么。当我将 jsf 降级到 2.0 时，一切都开始工作了。谢谢 com.sun.faces:jsf-api 和 com.sun.faces:jsf-impl 怎么样？我应该使用它们吗？

以上是关于如何通过 Maven 正确安装和配置 JSF 库？的主要内容，如果未能解决你的问题，请参考以下文章

Maven私有库和本地库的安装与配置 Sonatype Nexus + Maven

安装 Richfaces 后，“Palette”不显示 Richfaces 或 Ajax4Jsf 库

如何在MAVEN中配置Spring的依赖包

Maven 范围如何通过 ivy 映射到 ivy 配置

Centos7 Maven配置安装

maven

如何通过 Maven 正确安装和配置 JSF 库？

始终将服务器提供的库标记为 provided

在 Tomcat 9 或更早版本上安装 JSF

在 Tomcat 10 或更新版本上安装 JSF

另见：

始终将服务器提供的库标记为 `provided`