Làm cách nào để thiết lập Ứng dụng JAX-RS chỉ sử dụng chú thích (không có web.xml)?

Question 1

Có thể thiết lập ứng dụng JAX-RS chỉ bằng chú thích không? (sử dụng Servlet 3.0 và JAX-RS Jersey 1.1.0)

Tôi đã thử và không có may mắn. Sử dụng một số web.xmlcó vẻ cần thiết.

Cấu hình A (hoạt động, nhưng có cấu hình 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 {
    ...
}

Cấu hình B (không hoạt động, ngoại lệ được ném)

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

Sau này dường như nhấn mạnh rằng Ứng dụng sẽ là một lớp con của Servlet (ngoại lệ không để lại phỏng đoán)

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

Câu hỏi

Tại sao định nghĩa web.xml hoạt động nhưng chú thích thì không? Có gì khác biệt?
Có cách nào để nó hoạt động, ví dụ: có Ứng dụng JAX-RS không có web.xml không?

Question 2

** VUI LÒNG ĐỌC NẾU BẠN SỬ DỤNG TOMCAT HOẶC JETTY! **

Câu trả lời được chấp nhận sẽ hoạt động, nhưng chỉ khi ứng dụng web được triển khai tới máy chủ ứng dụng như Glassfish hoặc Wildfly và có thể là vùng chứa servlet có phần mở rộng EE như TomEE. Nó không hoạt động trên các thùng chứa servlet tiêu chuẩn như Tomcat, mà tôi chắc rằng hầu hết mọi người đang tìm kiếm giải pháp ở đây đều muốn sử dụng.

Nếu bạn đang sử dụng bản cài đặt Tomcat tiêu chuẩn (hoặc một số vùng chứa servlet khác), bạn cần bao gồm triển khai REST vì Tomcat không đi kèm với một bản cài đặt. Nếu bạn đang sử dụng Maven, hãy thêm phần này vào dependenciesphần:

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

Sau đó, chỉ cần thêm một lớp cấu hình ứng dụng vào dự án của bạn. Nếu bạn không có bất kỳ nhu cầu cấu hình đặc biệt nào ngoài việc thiết lập đường dẫn ngữ cảnh cho các dịch vụ còn lại, thì lớp có thể trống. Khi lớp này được thêm vào, bạn không cần phải định cấu hình bất kỳ thứ gì trong web.xml(hoặc có một cái gì cả):

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

Sau đó, việc khai báo các dịch vụ web của bạn sẽ được thực hiện ngay bằng cách sử dụng các chú thích JAX-RS tiêu chuẩn trong các lớp Java của bạn:

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);
  }
}

Đây là tất cả những gì bạn cần. Nếu cài đặt Tomcat của bạn đang chạy cục bộ trên cổng 8080 và bạn triển khai tệp WAR của mình vào ngữ cảnh myContext, đi tới ...

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

... nên tạo ra kết quả mong đợi (5).

Question 3

Có vẻ như tất cả những gì tôi cần làm là điều này (Servlet 3.0 trở lên)

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

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

Và dường như không cần cấu hình web.xml (đã thử trên Tomcat 7)

Question 4

Chương 2 của đặc tả JAX-RS: Java ™ API cho RESTful Web Services mô tả quy trình xuất bản của ứng dụng JAX-RS trong môi trường Servlet (phần 2.3.2 Servlet trong đặc tả).

Xin lưu ý rằng môi trường Servlet 3 chỉ được khuyến nghị (phần 2.3.2 Servlet, trang 6):

KHUYẾN CÁO rằng việc triển khai hỗ trợ cơ chế cắm thêm của khung Servlet 3 để cho phép khả năng di chuyển giữa các vùng chứa và tận dụng các phương tiện quét lớp do vùng chứa cung cấp.

Tóm lại, nếu bạn muốn sử dụng phương pháp tiếp cận no-web.xml, bạn có thể triển khai tùy chỉnh javax.ws.rs.core.Application đăng ký tài nguyên dịch vụ RESTful với chú thích javax.ws.rs.ApplicationPath .

@ApplicationPath("/rest")

Mặc dù bạn đã hỏi cụ thể về Jersey, bạn cũng có thể muốn đọc bài viết Triển khai các dịch vụ RESTful với JAX-RS và WebSphere 8.5 Liberty Profile, trong đó tôi đã mô tả quy trình xuất bản no-web.xml cho WebSphere Liberty Profile (với Apache Wink là việc triển khai JAX-RS).

Question 5

Bạn cần thiết lập các phụ thuộc phù hợp trong 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>

Thêm chi tiết tại đây: Ví dụ người mới bắt đầu cho jax-rs

Question 6

Các phụ thuộc được đề cập trước đó không hoạt động đối với tôi. Từ Hướng dẫn sử dụng Jersey:

Jersey cung cấp hai mô-đun Servlet. Mô-đun đầu tiên là mô-đun Servlet lõi Jersey cung cấp hỗ trợ tích hợp Servlet cốt lõi và được yêu cầu trong bất kỳ vùng chứa Servlet 2.5 hoặc cao hơn nào:

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

Để hỗ trợ các chế độ triển khai Servlet 3.x bổ sung và mô hình lập trình tài nguyên JAX-RS không đồng bộ, cần có thêm mô-đun Jersey:

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

Mô-đun jersey-container-servlet phụ thuộc vào mô-đun lõi jersey-container-servlet-core, do đó khi nó được sử dụng, không cần khai báo rõ ràng sự phụ thuộc jersey-container-servlet-core.

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

Question 7

Như @ Eran-Medan đã chỉ ra, JBoss EAP 7.1 (lưu ý rằng không có Ứng dụng web nên không có servlet, tôi đang thực hiện nó trong một dự án EJB 3.2), tôi phải thêm thuộc tính "value" chẳng hạn như tôi đã nhận được một ngoại lệ thuộc tính giá trị là bắt buộc.

Điều này đã làm việc cho tôi

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

            private Set singletons = new HashSet();

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

            ...
    }

Dấu vết ngăn xếp

    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