部署附加的 Servlet 25.02

在 ChatGPT 中打开

webforJ 会通过 WebforjServlet 路由所有请求，该 servlet 默认映射到 /* 在 web.xml 中。此 servlet 管理组件生命周期、路由和驱动您的 webforJ 应用程序的 UI 更新。

在某些情况下，您可能需要在 webforJ 应用旁边部署附加的 servlets：

• 集成提供自己 servlets 的第三方库
• 实现 REST API 或 webhooks
• 使用自定义处理处理文件上传
• 支持基于 servlet 的遗留代码

webforJ 提供了两种方法来部署您的自定义 servlets：

AI skill available

The webforj-adding-servlets skill can add REST endpoints, webhooks, and custom servlets. After installing the webforJ AI plugin, ask your assistant:

• "Add a REST endpoint at /api/orders."
• "Wire up a webhook handler for Stripe."
• "Mount Swagger UI at /api/docs."

方法 1：重新映射 WebforjServlet

此方法将 WebforjServlet 从 /* 重新映射到特定路径，如 /ui/*，释放出自定义 servlets 的 URL 命名空间。虽然这需要修改 web.xml，但它允许自定义 servlets 直接访问其 URL 模式，而没有任何代理开销。

<web-app>
  <!-- WebforjServlet 重新映射以处理仅 /ui/* -->
  <servlet>
    <servlet-name>WebforjServlet</servlet-name>
    <servlet-class>com.webforj.servlet.WebforjServlet</servlet-class>
    <load-on-startup>1</load-on-startup>
  </servlet>
  <servlet-mapping>
    <servlet-name>WebforjServlet</servlet-name>
    <url-pattern>/ui/*</url-pattern>
  </servlet-mapping>
  
  <!-- 自定义 servlet 具有自己的 URL 模式 -->
  <servlet>
    <servlet-name>HelloWorldServlet</servlet-name>
    <servlet-class>com.example.HelloWorldServlet</servlet-class>
  </servlet>
  <servlet-mapping>
    <servlet-name>HelloWorldServlet</servlet-name>
    <url-pattern>/hello-world</url-pattern>
  </servlet-mapping>
</web-app>

通过此配置：

• webforJ 组件可在 /ui/ 下访问
• 自定义 servlet 处理对 /hello-world 的请求
• 无需代理机制 - 直接的 servlet 容器路由

Spring Boot 配置

在使用 Spring Boot 的 webforJ 时，没有 web.xml 文件。相反，在 application.properties 中配置 servlet 映射：

webforj.servlet-mapping=/ui/*

此属性将 WebforjServlet 从默认的 /* 重新映射到 /ui/*，释放出自定义 servlets 的 URL 命名空间。不要在值周围包含引号 - 它们将被解释为 URL 模式的一部分。

方法 2：WebforjServlet 代理配置

此方法将 WebforjServlet 保持在 /* 并在 webforj.conf 中配置自定义 servlets。WebforjServlet 拦截所有请求并将匹配的模式代理到您的自定义 servlets。

标准 web.xml 配置

<servlet>
  <servlet-name>WebforjServlet</servlet-name>
  <servlet-class>com.webforj.servlet.WebforjServlet</servlet-class>
  <load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
  <servlet-name>WebforjServlet</servlet-name>
  <url-pattern>/*</url-pattern>
</servlet-mapping>

<!-- 自定义 servlet 具有自己的 URL 模式 -->
<servlet>
  <servlet-name>HelloWorldServlet</servlet-name>
  <servlet-class>com.example.HelloWorldServlet</servlet-class>
</servlet>
<servlet-mapping>
  <servlet-name>HelloWorldServlet</servlet-name>
  <url-pattern>/hello-world</url-pattern>
</servlet-mapping>
</web-app>

webforJ.conf 配置

servlets: [
  {
    class: "com.example.HelloWorldServlet",
    name: "hello-world",
    config: {
      foo: "bar",
      baz: "bang"
    }
  }
]

通过此配置：

• WebforjServlet 处理所有请求
• 对 /hello-world 的请求被代理到 HelloWorldServlet
• 可选的 config 键提供名称/值对作为 servlet 的初始化参数