Heim > Java > javaLernprogramm > Hauptteil

Verwendung von JAX-RS für die Webdienstverarbeitung in der Java-API-Entwicklung

PHPz
Freigeben: 2023-06-18 08:40:37
Original
1316 Leute haben es durchsucht

Die Java-API-Entwicklung ist eine weit verbreitete Programmiermethode, und es gibt viele Faktoren für ihren Erfolg, darunter die Webservice-Verarbeitung. Die Verarbeitung von Webdiensten kann die Java API für RESTful Web Services (JAX-RS) verwenden, ein Java-Framework zur Implementierung von RESTful Web Services. In diesem Artikel untersuchen wir die grundlegenden Konzepte, Architektur und Verwendung von JAX-RS.

Was ist RESTful Web Service?

Bevor wir mit der Einführung von JAX-RS beginnen, müssen wir die Grundkonzepte von RESTful Web Services verstehen. REST ist die Abkürzung für Representational State Transfer, was soviel bedeutet wie Präsentationsschicht-Zustandsübertragung. Der RESTful-Webdienst ist ein Dienst, der auf dem HTTP-Protokoll basiert. Er verwendet Uniform Resource Identifier (URI) zur Darstellung von Ressourcen und verwendet HTTP-Methoden (GET, POST, PUT, DELETE), um Ressourcen zu bearbeiten. Ein RESTful-Webdienst ist ein einfacher Dienst, der problemlos mit anderen Webanwendungen interagieren kann, da er das HTTP-Protokoll verwendet.

JAX-RS-Architektur

Das JAX-RS-Framework wird basierend auf der Java Servlet API implementiert, die es Ihnen ermöglicht, RESTful-Webdienste mithilfe von Java-Klassen und Annotationen zu definieren. Der Kern des Frameworks ist ein HTTP-Server, der HTTP-Anfragen von Clients empfängt und diese in Java-Objekte umwandelt. In JAX-RS sind Ressourcen der Kern von RESTful-Webdiensten und Ressourcen sind eine Sammlung von Methoden. Diese Methoden verarbeiten HTTP-Anfragen.

Das JAX-RS-Framework besteht aus zwei Hauptteilen: der JAX-RS-API und der JAX-RS-Implementierung. Die JAX-RS-API ist eine Java-Schnittstelle, die die JAX-RS-Spezifikation definiert, und eine JAX-RS-Implementierung ist ein beliebiges Framework, das die JAX-RS-Spezifikation implementiert. Derzeit gibt es viele JAX-RS-Implementierungen, darunter Jersey, CXF, RESTeasy usw.

JAX-RS-Annotationen

JAX-RS definiert hauptsächlich RESTful-Webdienste durch Anmerkungen. Anmerkungen sind eine Technik zum Extrahieren von Metadaten aus Java-Code. Im Folgenden sind die am häufigsten verwendeten Anmerkungen für JAX-RS aufgeführt:

  • @Path: Gibt den Pfad der Ressource an. Beispielsweise gibt @Path("/books") an, dass der Pfad der Ressource /books ist.
  • @GET, @POST, @PUT, @DELETE: Geben Sie die HTTP-Methode an.
  • @Produces, @Consumes: Geben Sie den Medientyp der Anfrage und Antwort an.
  • @QueryParam, @PathParam, @FormParam: Geben Sie Abfrageparameter, Pfadparameter und Formularparameter an.

JAX-RS-Beispiel

Im Folgenden verwenden wir Jersey, um einen einfachen RESTful-Webdienst zu implementieren. Dieser Dienst verarbeitet zwei Anfragen, eine zum Abrufen aller Bücher und die andere zum Abrufen eines einzelnen Buchs basierend auf seiner Buch-ID. Wir werden die Annotationen @Path, @GET und @Produces verwenden, um diesen Dienst zu implementieren.

Zuerst müssen wir eine Buchklasse erstellen, die zwei Attribute hat: ID und Titel. Dann müssen wir eine BookResource-Klasse erstellen, die mit der Annotation @Path("/books") gekennzeichnet ist und zwei Methoden enthält: getAllBooks() und getBookById(). In der getAllBooks()-Methode verwenden wir die Annotationen @GET und @Produces, um die HTTP-Methode und den Medientyp der Antwort anzugeben. In der getBookById()-Methode verwenden wir die Annotationen @GET, @Path und @Produces, um die HTTP-Methode, den Anforderungspfad und den Antwortmedientyp anzugeben.

public class Book {
    private int id;
    private String title;
    public Book(int id, String title) {
        this.id = id;
        this.title = title;
    }
    public int getId() {
        return id;
    }
    public String getTitle() {
        return title;
    }
}

@Path("/books")
public class BookResource {
    private static List<Book> bookList = new ArrayList<>();
    static {
        bookList.add(new Book(1, "Java SE 8"));
        bookList.add(new Book(2, "Java EE 7"));
        bookList.add(new Book(3, "Spring 5"));
    }
    @GET
    @Produces(MediaType.APPLICATION_JSON)
    public List<Book> getAllBooks() {
        return bookList;
    }
    @GET
    @Path("/{id}")
    @Produces(MediaType.APPLICATION_JSON)
    public Book getBookById(@PathParam("id") int id) {
        return bookList.stream().filter(b -> b.getId() == id).findFirst().orElse(null);
    }
}
Nach dem Login kopieren

Zuletzt müssen wir eine Startup-Klasse erstellen, um diesen Dienst auf Port 8080 von localhost auszuführen. Wir verwenden den URI /api, um den Pfad zu diesem Dienst anzugeben. Eine Anfrage zum Abrufen aller Bücher lautet beispielsweise http://localhost:8080/api/books und eine Anfrage zum Abrufen der Buch-ID 1 lautet http://localhost:8080/api/books/1.

public class Application extends ResourceConfig {
    public Application() {
        packages("com.example.web");
    }
    public static void main(String[] args) throws Exception {
        URI baseUri = UriBuilder.fromUri("http://localhost/").port(8080).build();
        ResourceConfig config = new Application();
        HttpServer server = JdkHttpServerFactory.createHttpServer(baseUri, config, false);
        Runtime.getRuntime().addShutdownHook(new Thread(server::stop));
        server.start();
    }
}
Nach dem Login kopieren

Zusammenfassung

JAX-RS bietet eine bequeme Möglichkeit, RESTful-Webdienste zu erstellen, und die Integration mit Java-Anwendungen ist sehr einfach. Die JAX-RS-API stellt eine Reihe von Anmerkungen und Klassen zur Definition von RESTful-Webdiensten bereit, und die JAX-RS-Implementierung übersetzt diese Spezifikationen in tatsächlichen Java-Code. Die Verwendung von JAX-RS erleichtert die Erstellung und Bereitstellung von RESTful-Webdiensten und verbessert dadurch die Anwendungsverfügbarkeit und Skalierbarkeit.

Das obige ist der detaillierte Inhalt vonVerwendung von JAX-RS für die Webdienstverarbeitung in der Java-API-Entwicklung. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!

Verwandte Etiketten:
Quelle:php.cn
Erklärung dieser Website
Der Inhalt dieses Artikels wird freiwillig von Internetnutzern beigesteuert und das Urheberrecht liegt beim ursprünglichen Autor. Diese Website übernimmt keine entsprechende rechtliche Verantwortung. Wenn Sie Inhalte finden, bei denen der Verdacht eines Plagiats oder einer Rechtsverletzung besteht, wenden Sie sich bitte an admin@php.cn
Beliebte Tutorials
Mehr>
Neueste Downloads
Mehr>
Web-Effekte
Quellcode der Website
Website-Materialien
Frontend-Vorlage