Jak skonfigurować aplikację JAX-RS za pomocą samych adnotacji (bez web.xml)?

Czy można skonfigurować aplikację JAX-RS tylko przy użyciu adnotacji? (przy użyciu Servlet 3.0 i JAX-RS Jersey 1.1.0)

Próbowałem i nie miałem szczęścia. Korzystanie z niektórych web.xmlwydaje się wymagane.

Konfiguracja A (działa, ale ma konfigurację web.xml)

web.xml

   ...
   <servlet>
      <servlet-name>org.foo.rest.MyApplication</servlet-name>
   </servlet>
   <servlet-mapping>
       <servlet-name>org.foo.rest.MyApplication</servlet-name>
       <url-pattern>/*</url-pattern>
   </servlet-mapping>
   ...

Jawa

@ApplicationPath("/")
public class MyApplication extends Application {
    ...
}

Konfiguracja B (nie działa, zgłoszony wyjątek)

@ApplicationPath("/")
@WebServlet("/*") // <-- 
public class MyApplication extends Application {
    ...
}

Ten ostatni wydaje się nalegać, że aplikacja będzie podklasą serwletu (wyjątek nie pozostawia domysłów)

java.lang.ClassCastException: org.foo.rest.MyApplication cannot be cast to javax.servlet.Servlet

pytania

1. Dlaczego definicja web.xml zadziałała, a adnotacja nie? Co za różnica?

2. Czy jest sposób, aby to zadziałało, np. Mieć aplikację JAX-RS bez pliku web.xml?

** PRZECZYTAJ, JEŚLI UŻYWASZ TOMCAT LUB JETTY! **

Odpowiedź Zaakceptowany ma pracy, ale tylko wtedy, gdy jest wdrożony webapp do serwera aplikacji, takich jak GlassFish lub JBoss Application Server i ewentualnie serwletów pojemników z rozszerzeniami EE jak TomEE. To nie działa na standardowych kontenerach serwletów jak Tomcat, którego jestem pewien, że większość ludzi szuka rozwiązania tutaj chcesz użyć.

Jeśli używasz standardowej instalacji Tomcat (lub innego kontenera serwletów), musisz dołączyć implementację REST, ponieważ Tomcat jej nie zawiera. Jeśli używasz Mavena, dodaj to do dependenciessekcji:

<dependencies>
  <dependency>
    <groupId>org.glassfish.jersey.bundles</groupId>
    <artifactId>jaxrs-ri</artifactId>
    <version>2.13</version>
  </dependency>
  ...
</dependencies>

Następnie po prostu dodaj klasę konfiguracji aplikacji do swojego projektu. Jeśli nie masz żadnych specjalnych potrzeb konfiguracyjnych poza ustawieniem ścieżki kontekstu dla pozostałych usług, klasa może być pusta. Po dodaniu tej klasy nie musisz niczego konfigurować web.xml(lub w ogóle ją mieć):

package com.domain.mypackage;
import javax.ws.rs.ApplicationPath;
import javax.ws.rs.core.Application;

@ApplicationPath("rest") // set the path to REST web services
public class ApplicationConfig extends Application {}

Następnie deklarowanie usług internetowych jest proste przy użyciu standardowych adnotacji JAX-RS w klasach Java:

package com.domain.mypackage;
import javax.ws.rs.Consumes;
import javax.ws.rs.Produces;
import javax.ws.rs.GET;
import javax.ws.rs.MatrixParam;
import javax.ws.rs.Path;

// It's good practice to include a version number in the path so you can have
// multiple versions deployed at once. That way consumers don't need to upgrade
// right away if things are working for them.
@Path("calc/1.0")
public class CalculatorV1_0 {
  @GET
  @Consumes("text/plain")
  @Produces("text/plain")
  @Path("addTwoNumbers")
  public String add(@MatrixParam("firstNumber") int n1, @MatrixParam("secondNumber") int n2) {
    return String.valueOf(n1 + n2);
  }
}

To powinno wystarczyć. Jeśli twoja instalacja Tomcat działa lokalnie na porcie 8080 i wdrażasz plik WAR w kontekście myContext, przechodzisz do ...

http://localhost:8080/myContext/rest/calc/1.0/addTwoNumbers;firstNumber=2;secondNumber=3

... powinien przynieść oczekiwany rezultat (5).

Wygląda na to, że wszystko, co musiałem zrobić, to to (Servlet 3.0 i nowsze)

import javax.ws.rs.ApplicationPath;
import javax.ws.rs.core.Application;

@ApplicationPath("/*")
public class MyApplication extends Application {
    ...
}

I najwyraźniej nie była potrzebna żadna konfiguracja web.xml (próbowano na Tomcat 7)

Rozdział 2 specyfikacji JAX-RS: Java ™ API for RESTful Web Services opisuje proces publikacji aplikacji JAX-RS w środowisku Servlet (sekcja 2.3.2 Servlet w specyfikacji).

Należy pamiętać, że środowisko Servlet 3 jest zalecane tylko (sekcja 2.3.2 Servlet, strona 6):

ZALECA SIĘ implementacje obsługujące mechanizm podłączania struktury Servlet 3, aby umożliwić przenoszenie między kontenerami i korzystać z dostarczanych przez kontener funkcji skanowania klas.

Krótko mówiąc, jeśli chcesz zastosować podejście bez web.xml, jest to możliwe dzięki niestandardowej implementacji aplikacji javax.ws.rs.core.Application, która rejestruje zasoby usługi RESTful z adnotacją javax.ws.rs.ApplicationPath .

@ApplicationPath("/rest")

Chociaż pytałeś konkretnie o Jersey, możesz również przeczytać artykuł Implementing RESTful services with JAX-RS i WebSphere 8.5 Liberty Profile, w którym opisałem proces publikacji no-web.xml dla WebSphere Liberty Profile (z Apache Wink jako implementacją JAX-RS).

Musisz ustawić odpowiednie zależności w pom.xml

<dependency>
        <groupId>javax.servlet</groupId>
        <artifactId>javax.servlet-api</artifactId>
        <version>3.0.1</version>
        <scope>provided</scope>
    </dependency>
    <dependency>
        <groupId>org.glassfish.jersey.containers</groupId>
        <artifactId>jersey-container-servlet</artifactId>
    </dependency>

Więcej szczegółów tutaj: Przykład startowy dla jax-rs

Wspomniane wcześniej zależności nie działają u mnie. Z podręcznika użytkownika Jersey:

Jersey zapewnia dwa moduły serwletów. Pierwszym modułem jest podstawowy moduł serwletów Jersey, który zapewnia podstawową obsługę integracji serwletów i jest wymagany w każdym kontenerze Servlet 2.5 lub nowszym:

<dependency>
 <groupId>org.glassfish.jersey.containers</groupId>
 <artifactId>jersey-container-servlet-core</artifactId>
</dependency>

Aby zapewnić obsługę dodatkowych trybów wdrażania Servlet 3.x i asynchronicznego modelu programowania zasobów JAX-RS, wymagany jest dodatkowy moduł Jersey:

<dependency>
 <groupId>org.glassfish.jersey.containers</groupId>
 <artifactId>jersey-container-servlet</artifactId>
</dependency>

Moduł jersey-container-servlet zależy od modułu jersey-container-servlet-core, dlatego gdy jest używany, nie jest konieczne jawne deklarowanie zależności jersey-container-servlet-core.

https://jersey.github.io/documentation/latest/deployment.html#deployment.servlet.3

Jak zauważył @ Eran-Medan, JBoss EAP 7.1 (uwaga bez aplikacji internetowej, więc bez serwletu, robiłem to w projekcie EJB 3.2) musiałem dodać atrybut „value” jako taki, ponieważ otrzymałem wyjątek, że atrybut wartości był wymagany.

To zadziałało dla mnie

    @ApplicationPath(value="/*")
        public class MyApplication extends Application {

            private Set singletons = new HashSet();

            public MyApplication() {
                singletons.add(new MyService());
            }

            ...
    }

Ślad stosu

    Caused by: java.lang.annotation.IncompleteAnnotationException: javax.ws.rs.ApplicationPath missing element value
        at sun.reflect.annotation.AnnotationInvocationHandler.invoke(AnnotationInvocationHandler.java:80)
        at com.sun.proxy.$Proxy141.value(Unknown Source)
        ... 21 more