是否可以在 jar 中公开 JAX RS 类而不在 web.xml / Application 子类中声明它们？答案

【问题标题】：Is it possible to expose JAX RS classes inside jars without declaring them in web.xml / Application subclass?是否可以在 jar 中公开 JAX RS 类而不在 web.xml / Application 子类中声明它们？
【发布时间】：2019-10-24 13:52:12
【问题描述】：

我们正在尝试创建一个 .ear 项目，其中包含一个公开一些 rest api 的 Web 应用程序。该项目包括代表一些业务逻辑的“微型罐子”（由@Path注释），每个罐子都包含一些休息类（由@Path注释）。该应用程序符合 Java EE 7 并部署在 WAS 9 实例上，结构化的 .ear 如下：

project.ear
|
|- META-INF
|    |- application.xml
|
|-lib
|    |- service1.jar                (with rest classes)
|    |              |- META-INF
|    |                      |- beans.xml
|    |              
|    |              
|    |
|    |- service2.jar  (with rest classes, same structure as service1.jar)
|    |   
|    |- core.jar      (with Application subclass, same structure as service1.jar)
|    
|    
|- app.war
|    |- classes (empty)
|    |- web.xml
|    |- beans.xml

.war 包中的 web.xml 包含对自定义应用程序子类的引用：

<servlet>
  <description>JAX-RS Tools Generated - Do not modify</description>
  <servlet-name>JAX-RS Servlet</servlet-name>
  <servlet-class>com.ibm.websphere.jaxrs.server.IBMRestServlet</servlet-class>
  <init-param>
    <param-name>javax.ws.rs.Application</param-name>
    <param-value>com.example.MyApplicationSubclass</param-value>
  </init-param>
  <load-on-startup>1</load-on-startup>
</servlet>


<servlet-mapping>
  <servlet-name>JAX-RS Servlet</servlet-name>
  <url-pattern>/resources/*</url-pattern>
</servlet-mapping>

每个 bean.xml 看起来都是这样的：

<?xml version="1.0" encoding="UTF-8"?>
 <beans xmlns="http://xmlns.jcp.org/xml/ns/javaee"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee 
     http://xmlns.jcp.org/xml/ns/javaee/beans_1_1.xsd"
     bean-discovery-mode="all">
 </beans>

MyApplicationSubclass 为空，它确实有任何被覆盖的方法，并使用基本的@ApplicationPath 注释进行注释。

在 WebLogic 和 JBOSS 等其他 AS 上，不需要显式声明 servlet，一切都会自动发现，但在 WAS 上，我们发现了以下主要问题：

自动发现功能已完全关闭，@ApplicationPath 和 @Path 类都不会自动发现。
MyApplicationSubclass 必须包含在 .war 的 web.xml 中
即使在 web.xml 中声明了 MyApplicationSubclass，也不会自动发现其余端点
即使通过反射，也无法从MyApplicationSubclass 找到休息点类

有什么建议吗？为什么这个结构在其他 AS 上没问题？这些问题是否与 Apache CXF 有关？

注意：我们还尝试使用父级上次加载策略启动应用程序，但问题仍然存在。

【问题讨论】：

您是将 JAX-RS 引擎与应用程序捆绑在一起，还是使用 WAS 中提供的引擎？

标签： jakarta-ee jax-rs websphere websphere-liberty ear

【解决方案1】：

问题很可能是应用程序类未打包在 WAR 文件中。根据 JAX-RS 规范的第 2.3.2 节（我使用的是 JAX-RS 2.1 规范，但我相信相同的规则适用于 2.0）：

JAX-RS 应用程序被打包为 .war 文件中的 Web 应用程序。应用类打包在WEB-INF/classes或WEB-INF/lib中，所需库打包在WEB-INF/lib中。

听起来，与您试验的其他一些应用程序服务器相比，WebSphere 更直接地采用了这条线。

因此，最简单、最可靠的解决方法是将 JAX-RS 应用程序类打包到 WAR 的 WEB-INF/classes 或 JAR 的 WEB-INF/lib 目录中，而不是 EAR 的 lib 目录中。

另一个选项（我自己没有测试过）可能是在你的 WAR 清单文件中添加一个 Class-Path: 属性，以显式引用包含 JAX-RS 应用程序的 JAR - iiuc，这应该将这些 JAR 放在相同的类路径中作为 web 模块的其余部分，允许加载它。

第三个选项（我也没有测试过）可能是将应用程序类放入共享库，然后将该共享库与 Web 模块相关联。

希望这会有所帮助！

【讨论】：