如何使用 Spring Boot 1.5.2 注入 Jersey 端点接口的实现？

Question

在 Spring Boot 1.5.2 上，我正在缩减一个包含 Web 服务的大型 Web 应用程序，使其仅成为 Jersey Web 服务。因为 Web 服务已经有一套完整的由 Apache Wink 实现的 JAX-RS 注释，所以我决定使用 Spring + Jersey 而不是 Spring Rest。我发现这个spring-boot-jersey-sample 应用程序可以用作参考。我正在开发的应用程序与示例之间的最大区别在于我的端点定义分为接口和实现。

我在 pom.xml 中添加了以下内容：

    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-jersey</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-tomcat</artifactId>
        <scope>provided</scope>
    </dependency>

我的新泽西配置如下所示：

package com.example.configuration;

import org.glassfish.jersey.server.ResourceConfig;
import com.example.EndpointImpl;
import org.springframework.stereotype.Component;

@Component
public class JerseyConfiguration extends ResourceConfig {
  public JerseyConfiguration() {
    registerEndpoints();
  }

  private void registerEndpoints() {
    register(EndpointImpl.class);     
  }
}

然后我有以下Application.java：

package com.example;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.builder.SpringApplicationBuilder;
import org.springframework.boot.web.support.SpringBootServletInitializer;

@SpringBootApplication
public class Application extends SpringBootServletInitializer{
  public static void main(String[] args) {
    new Application().configure(new SpringApplicationBuilder(Application.class)).run(args);
  }
}

端点被定义为接口和实现，如下所示（减去导入）：

public interface Endpoint {
  @GET
  @Produces({MediaType.APPLICATION_JSON})
  public Response getHello(@Context ServletContext sc, @Context HttpServletRequest req, @Context HttpHeaders httpHeaders) ;
}

@Path("")
@Component
public class EndpointImpl implements Endpoint {
  @Override
  public Response getHello(@Context ServletContext sc, @Context HttpServletRequest req,
      @Context HttpHeaders httpHeaders)  {
      return Response.ok("hello").build();
  }
}

当我启动我的应用程序时，我看到消息说 Tomcat 已启动，包括一个消息说 Mapping servlet: 'com.example.configuration.JerseyConfiguration' to [/*]。但是，当我使用 Web 浏览器访问 / 时，我收到 404 Not Found 错误。看起来 GET 定义并没有被采纳。

Answer 1

第 3.6 节注释继承中的 JAX-RS spec 解释了此问题。

JAX-RS 注解可用于超类或已实现接口的方法和方法参数。此类注解由相应的子类或实现类方法继承前提是该方法及其参数本身没有任何 JAX-RS 注解。

如果子类或实现方法有任何 JAX-RS 注释，则忽略超类或接口方法上的所有注释。例如：

public interface ReadOnlyAtomFeed {
  @GET @Produces("application/atom+xml")
  Feed getFeed();
}

@Path("feed")
public class ActivityLog implements ReadOnlyAtomFeed {
  public Feed getFeed() {...}
}

上面ActivityLog.getFeed从接口继承了@GET和@Produces注解。

反之：

@Path("feed")
public class ActivityLog implements ReadOnlyAtomFeed {
  @Produces("application/atom+xml")
  public Feed getFeed() {...}
}

在上面，ReadOnlyAtomFeed.getFeed 上的 @GET 注释不被 ActivityLog.getFeed 继承，它需要自己的请求方法指示符 (@GET)，因为它重新定义了 @Produces 注释。

为了与其他 Java EE 规范保持一致，建议始终重复注解，而不是依赖注解继承。

我已经强调了重要的端口。应该很清楚为什么它不适合你。在您的EndpointImpl 中，您重复了@Context 注释，因此导致“忽略超类或接口方法上的所有注释”。这包括@GET。所以最终，这会导致该端点没有被注册，因为端点需要@METHOD。

至于块引用中的最后一段，您可以选择是否遵循它。我只是为了完整性把它扔在那里。

Answer 2

你的 application.yml (.properties) 是什么样子的：

您可能需要声明两个路径映射，一个用于Spring MVC 调度程序servlet，一个用于Jersey 调度程序servlet。比如：

application.yml

...
# Spring MVC dispatcher servlet path. Needs to be different than Jersey's to enable/disable Actuator endpoints access (/info, /health, ...)
server.servlet-path: /
# Jersey dispatcher servlet
spring.jersey.application-path: /api
...

您现在应该可以访问位于 /api/..... 的 Jersey 端点了

我在 2016 年 4 月发表的一篇博文中对此进行了介绍：Microservices using Spring Boot, Jersey, Swagger and Docker

Answer 3

除非在最近的 Spring Boot/Spring MVC + Jersey 版本中有所改变，否则要让 Spring Boot 识别 Jersey 端点，您需要像这样使用扩展 Jersey 的 ResourceConfig 的附加 @Component 注册它：

@Component
public class JerseyExampleConfig extends ResourceConfig {

    public JerseyExampleConfig() {
        register(EndpointImpl.class);
    } 
}