根上下文上的 JAX-RS 应用程序 - 如何完成?

2022-09-01 03:15:43

我希望我的 JAX-RX 应用程序从根上下文开始,这样我的 URL 将是

http://example.com/restfullPath

而不是

http://example.com/rest/restfullPath

我从此处切换了应用程序的注释

@ApplicationPath("/rest/*")

到这个

@ApplicationPath("/*")

但是,它似乎接管了诸如/index之类的文件.html

有没有办法在根应用程序上下文中运行 JAX-RS,但仍提供静态页面?

似乎之前在JBOSS论坛上问过这个问题,但解决方案并不实际


答案 1

这与其说是一个错误,不如说是Servlet规范的限制。如何处理 JAX-RS 的细节是特定于实现的,我不能代表所有实现,但我猜典型的方法是简单地将其用作 servlet URL 模式。以泽西岛的 ServletContainerInitializer 实现为例,您会发现 addServletWithApplication() 方法负责创建 servlet 并映射来处理请求,您可以看到它确实使用 Jersey ServletContainer 映射路径中的路径。@ApplicationPath@ApplicationPath

不幸的是,自古以来,Servlet 规范只允许少数几种将 servlet 映射到 URL 路径的方法。Servlet 3.0 的当前选项,在规范的第 12.2 节中给出 - 可悲的是只能以 PDF 格式提供,因此不能按部分链接 - 是:

  • /.../*其中,初始值为零个或多个路径元素/...
  • *.<ext>哪里是一些匹配的扩展<ext>
  • 空字符串,仅映射到空路径/上下文根目录
  • /,单个斜杠,表示上下文中的“默认”servlet,它处理与其他任何内容都不匹配的任何内容
  • 任何其他字符串,这些字符串被视为要匹配的文本值

规范的同一部分还对匹配规则的应用顺序有特定的规则,但简短的版本是这样的:要使资源类在上下文根目录下应答请求,您必须使用或作为路径。如果使用 ,则将替换容器的默认 servlet,该 servlet 通常负责处理静态资源。如果你使用 ,那么你就让它变得太贪婪了,并说它应该一直匹配所有内容,并且默认的servlet永远不会被调用。//*//*

因此,如果我们接受我们处于由 servlet URL 模式的局限性决定的框中,那么我们的选择就相当有限。以下是我能想到的:

1) 使用 ,并按名称或扩展名显式映射静态资源到容器的默认 servlet(在 Tomcat 和 Jetty 中名为“default”,不确定其他资源)。在网络.xml中,它看起来像@ApplicationPath("/")

<!-- All html files at any path -->
<servlet-mapping>   
    <servlet-name>default</servlet-name>
    <url-pattern>*.html</url-pattern>
</servlet-mapping>
<!-- Specifically index.html at the root -->
<servlet-mapping>   
    <servlet-name>default</servlet-name>
    <url-pattern>/index.html</url-pattern>
</servlet-mapping>

或者使用 ServletContextInitializer,例如

public class MyInitializer implements ServletContainerInitializer {
    public void onStartup(Set<Class<?>> c, ServletContext ctx) {
        ctx.getServletRegistration("default").addMapping("*.html");
        ctx.getServletRegistration("default").addMapping("/index.html");
    }
}

由于匹配规则的编写方式,扩展模式胜过默认的 servlet,因此您只需要为每个静态文件扩展名添加映射,只要这些扩展与 API 中可能发生的任何“扩展”之间没有重叠即可。这非常接近您链接的论坛帖子中提到的不良选项,我只是为了完整性并添加ServletContextInitializer部分而提及它。

2) 将 API 保持映射到 ,并使用筛选器来标识对 API 的请求并将其转发到该路径。这样,您就可以打破 Servlet URL 模式框,并可以按照所需的任何方式匹配 URL。例如,假设所有 REST 调用都指向以 “/foo” 开头或正好是 “/bar” 的路径,并且所有其他请求都应转到静态资源,则如下所示:/rest/*

import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
import java.util.regex.Pattern;

@WebFilter(urlPatterns = "/*")
public class PathingFilter implements Filter {
    Pattern[] restPatterns = new Pattern[] {
            Pattern.compile("/foo.*"),
            Pattern.compile("/bar"),
    };

    @Override
    public void doFilter(ServletRequest request, ServletResponse response,
            FilterChain chain) throws IOException, ServletException {
        if (request instanceof HttpServletRequest) {
            String path = ((HttpServletRequest) request).getServletPath();
            for (Pattern pattern : restPatterns) {
                if (pattern.matcher(path).matches()) {
                    String newPath = "/rest/" + path;
                    request.getRequestDispatcher(newPath)
                        .forward(request, response);
                    return;
                }
            }
        }
        chain.doFilter(request, response);
    }

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {}

    @Override
    public void destroy() {}
}

通过上述操作,您基本上可以按如下方式翻译请求:

http://example.org/foo          -> http://example.org/rest/foo
http://example.org/foox         -> http://example.org/rest/foox
http://example.org/foo/anything -> http://example.org/rest/foo/anything
http://example.org/bar          -> http://example.org/rest/bar
http://example.org/bart         -> http://example.org/bart
http://example.org/index.html   -> http://example.org/index.html

3)意识到前面的选项基本上是URL重写,并使用现有的实现,例如Apache的mod_rewriteTuckey重写过滤器ocpsoft Rewrite


答案 2

我发现了另一个涉及内部泽西岛类的解决方案,我认为它可能还不是JAX-RS规范的一部分(基于:http://www.lucubratory.eu/simple-jerseyrest-and-jsp-based-web-application/)

网.xml

<web-app version="3.0" xmlns="http://java.sun.com/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd">
  <display-name>jersey-rest-jsp-frame-1</display-name>

  <filter>
    <filter-name>jersey</filter-name>
    <filter-class>
      com.sun.jersey.spi.container.servlet.ServletContainer
    </filter-class>
    <init-param>
      <param-name>
        com.sun.jersey.config.property.JSPTemplatesBasePath
      </param-name>
      <param-value>/WEB-INF/jsp</param-value>
    </init-param>
    <init-param>
      <param-name>
        com.sun.jersey.config.property.WebPageContentRegex
      </param-name>
      <param-value>
        (/(image|js|css)/?.*)|(/.*\.jsp)|(/WEB-INF/.*\.jsp)|
        (/WEB-INF/.*\.jspf)|(/.*\.html)|(/favicon\.ico)|
        (/robots\.txt)
      </param-value>
    </init-param>
  </filter>
  <filter-mapping>
    <filter-name>jersey</filter-name>
    <url-pattern>/*</url-pattern>
  </filter-mapping>
</web-app>

WEB-INF/JSP/index.jsp

<%@ page contentType="text/html; charset=UTF-8" language="java" %>

<html>
<body>
<h2>Hello ${it.foo}!</h2>
</body>
</html>

索引模型.java

package example;

import com.sun.jersey.api.view.Viewable;

import javax.servlet.http.HttpServletRequest;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.core.Context;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import java.net.URI;
import java.util.HashMap;

@Path("/")
@Produces(MediaType.TEXT_HTML)
public class IndexModel {

    @GET
    public Response root() {
      return Response.seeOther(URI.create("/index")).build();
    }

    @GET
    @Path("index")
    public Viewable index(@Context HttpServletRequest request) {
      HashMap<String, String> model = new HashMap<String, String>();
      model.put("foo","World");
      return new Viewable("/index.jsp", model);
    }
}

这似乎有效,但我想知道它是否是/将成为JAX-RS规范/实现的一部分。


推荐