Як налаштувати додаток JAX-RS, використовуючи лише анотації (без web.xml)?

Question 1

Чи можна налаштувати програму JAX-RS, використовуючи лише анотації? (за допомогою Servlet 3.0 та JAX-RS Jersey 1.1.0)

Я намагався і мені не пощастило. Використання деяких web.xmlвидається необхідним.

Конфігурація A (працює, але має конфігурацію 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>
   ...

Java

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

Конфігурація B (не працює, виключення)

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

Останнє, схоже, наполягає на тому, що Додаток буде підкласом Servlet (виняток не залишає здогадок)

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

Питання

Чому визначення web.xml працювало, а анотація ні? Яка різниця?
Чи є спосіб зробити так, щоб він працював, наприклад, мати додаток JAX-RS без web.xml?

Question 2

** БУДЬ ЛАСКА, ЧИ ВИ ВИКОРИСТОВУЄТЕ TOMCAT АБО JETTY! **

Прийнятий відповідь робить роботу, але тільки якщо веб - додаток розгорнуто на сервер додатків , як Glassfish або Wildfly, і , можливо , сервлет з ЕЕ розширеннями як TomEE. Це не працює у стандартних контейнерах сервлетів, таких як Tomcat, який, я впевнений, більшість людей, які шукають тут рішення, хочуть використовувати.

Якщо ви використовуєте стандартну інсталяцію Tomcat (або інший контейнер сервлета), вам потрібно включити реалізацію REST, оскільки Tomcat не постачається з нею. Якщо ви використовуєте Maven, додайте це до dependenciesрозділу:

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

Потім просто додайте клас конфігурації програми до свого проекту. Якщо у вас немає особливих потреб конфігурації, крім встановлення контекстного шляху для інших служб, клас може бути порожнім. Після додавання цього класу не потрібно нічого налаштовувати web.xml(або взагалі його мати):

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 {}

Після цього оголошення ваших веб-служб відбувається прямо за допомогою стандартних анотацій JAX-RS у ваших класах 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);
  }
}

Це має бути все, що вам потрібно. Якщо ваша інсталяція Tomcat працює локально на порту 8080, і ви розгортаєте файл WAR у контексті myContext, збираєтеся ...

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

... повинен дати очікуваний результат (5).

Question 3

Здається, все, що мені потрібно було зробити, це (Servlet 3.0 і вище)

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

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

І ніякої конфігурації web.xml, мабуть, не було потрібно (спробував на Tomcat 7)

Question 4

У розділі 2 специфікації JAX-RS: Java ™ API для специфікації веб-служб RESTful описується процес публікації програми JAX-RS у середовищі сервлету (розділ 2.3.2 Сервлет у специфікації).

Зверніть увагу, що середовище Servlet 3 рекомендовано лише (розділ 2.3.2 Servlet, стор. 6):

РЕКОМЕНДОВАНО, що реалізації підтримують механізм підключення фреймворка Servlet 3, щоб забезпечити перенесення між контейнерами та скористатися засобами сканування класів, що постачаються в контейнери.

Коротше кажучи, якщо ви хочете використовувати підхід no-web.xml, це можливо за допомогою спеціальної реалізації javax.ws.rs.core.Application, яка реєструє RESTful сервісні ресурси з анотацією javax.ws.rs.ApplicationPath .

@ApplicationPath("/rest")

Хоча ви запитували конкретно про Джерсі, вам також може сподобатися прочитати статтю Впровадження RESTful сервісів з JAX-RS та WebSphere 8.5 Liberty Profile, в якій я описав процес публікації no-web.xml для WebSphere Liberty Profile (з Apache Wink як реалізацію JAX-RS).

Question 5

Вам потрібно встановити правильні залежності в 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>

Детальніше тут: Початковий приклад для jax-rs

Question 6

Згадані раніше залежності для мене не працювали. З посібника користувача Джерсі:

Джерсі пропонує два модулі сервлету. Перший модуль - це основний модуль сервлету Джерсі, який забезпечує основну підтримку інтеграції сервлетів і необхідний у будь-якому контейнері сервлету 2.5 або новішої версії:

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

Для підтримки додаткових режимів розгортання Servlet 3.x та асинхронної моделі програмування ресурсів JAX-RS потрібен додатковий модуль Джерсі:

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

Модуль jersey-container-servlet-сервер залежить від модуля jersey-container-servlet-core, тому, коли він використовується, не потрібно чітко оголошувати залежність jersey-container-servlet-core.

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

Question 7

Як зазначив @ Eran-Medan, JBoss EAP 7.1 (примітка без веб-програми, тому без сервлету, я робив це в проекті EJB 3.2), мені довелося додати атрибут "value" як такий, оскільки я отримував виняток необхідний атрибут value.

Це спрацювало для мене

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

            private Set singletons = new HashSet();

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

            ...
    }

Трасування стека

    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