Menggunakan JAX-RS untuk pemprosesan perkhidmatan Web dalam pembangunan API Java

Pembangunan API Java ialah kaedah pengaturcaraan yang digunakan secara meluas, dan terdapat banyak faktor di sebalik kejayaannya, salah satunya ialah pemprosesan perkhidmatan web. Pemprosesan perkhidmatan web boleh menggunakan API Java untuk Perkhidmatan Web RESTful (JAX-RS), rangka kerja Java untuk melaksanakan perkhidmatan Web RESTful. Dalam artikel ini, kami akan meneroka konsep asas, seni bina dan penggunaan JAX-RS.

Apakah itu Perkhidmatan Web RESTful

Sebelum mula memperkenalkan JAX-RS, kita perlu memahami konsep asas Perkhidmatan Web RESTful. REST ialah singkatan daripada Pemindahan Negeri Perwakilan, yang bermaksud pemindahan keadaan lapisan pembentangan. Perkhidmatan Web RESTful ialah perkhidmatan berdasarkan protokol HTTP Ia menggunakan Uniform Resource Identifier (URI) untuk mewakili sumber dan menggunakan kaedah HTTP (GET, POST, PUT, DELETE) untuk beroperasi pada sumber. Perkhidmatan web RESTful ialah perkhidmatan ringan yang boleh berinteraksi dengan mudah dengan aplikasi web lain kerana ia menggunakan protokol HTTP.

JAX-RS Architecture

Rangka kerja JAX-RS dilaksanakan di atas Java Servlet API, yang membolehkan anda mentakrifkan perkhidmatan web RESTful menggunakan kelas dan anotasi Java. Teras rangka kerja ialah pelayan HTTP yang menerima permintaan HTTP daripada klien dan menukarnya kepada objek Java. Dalam JAX-RS, sumber adalah teras perkhidmatan web RESTful, dan sumber ialah koleksi kaedah. Kaedah ini mengendalikan permintaan HTTP.

Rangka kerja JAX-RS terdiri daripada dua bahagian utama: JAX-RS API dan pelaksanaan JAX-RS. API JAX-RS ialah antara muka Java yang mentakrifkan spesifikasi JAX-RS, dan pelaksanaan JAX-RS ialah sebarang rangka kerja yang melaksanakan spesifikasi JAX-RS. Pada masa ini terdapat banyak pelaksanaan JAX-RS, termasuk Jersey, CXF, RESTeasy, dll.

Anotasi JAX-RS

JAX-RS terutamanya mentakrifkan perkhidmatan web RESTful melalui anotasi. Anotasi ialah teknik yang digunakan untuk mengekstrak metadata daripada kod Java. Berikut ialah anotasi yang paling biasa digunakan untuk JAX-RS:

• @Path: Menentukan laluan sumber. Sebagai contoh, @Path("/books") menunjukkan bahawa laluan sumber ialah /books.
• @GET, @POST, @PUT, @DELETE: Tentukan kaedah HTTP.
• @Produces, @Consumes: Tentukan jenis media permintaan dan respons.
• @QueryParam, @PathParam, @FormParam: Tentukan parameter pertanyaan, parameter laluan dan parameter borang.

Contoh JAX-RS

Di bawah ini kami akan menggunakan Jersi untuk melaksanakan perkhidmatan web RESTful yang ringkas. Perkhidmatan ini akan mengendalikan dua permintaan, satu untuk mendapatkan semua buku dan satu lagi untuk mendapatkan satu buku berdasarkan ID bukunya. Kami akan menggunakan @Path, @GET, @Menghasilkan anotasi untuk melaksanakan perkhidmatan ini.

Pertama, kita perlu mencipta kelas Buku, yang mempunyai dua atribut: id dan tajuk. Kemudian, kita perlu mencipta kelas BookResource, yang ditandakan dengan anotasi @Path("/books") dan mengandungi dua kaedah: getAllBooks() dan getBookById(). Dalam kaedah getAllBooks(), kami menggunakan anotasi @GET dan @Produces untuk menentukan kaedah HTTP dan jenis media respons. Dalam kaedah getBookById(), kami menggunakan anotasi @GET, @Path dan @Produces untuk menentukan kaedah HTTP, laluan permintaan dan jenis media respons.

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

Akhir sekali, kita perlu mencipta kelas permulaan untuk menjalankan perkhidmatan ini pada port 8080 localhost. Kami menggunakan URI /api untuk menentukan laluan ke perkhidmatan ini. Contohnya, permintaan untuk mendapatkan semua buku ialah http://localhost:8080/api/books, dan permintaan untuk mendapatkan ID buku 1 ialah 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();
    }
}

Ringkasan

JAX-RS menyediakan cara mudah untuk mencipta perkhidmatan web yang RESTful dan penyepaduan dengan aplikasi Java adalah sangat mudah. API JAX-RS menyediakan satu set anotasi dan kelas untuk mentakrifkan perkhidmatan web RESTful, dan pelaksanaan JAX-RS menterjemahkan spesifikasi ini ke dalam kod Java sebenar. Menggunakan JAX-RS menjadikannya lebih mudah untuk mencipta dan menggunakan perkhidmatan web RESTful, dengan itu meningkatkan ketersediaan dan kebolehskalaan aplikasi.

Atas ialah kandungan terperinci Menggunakan JAX-RS untuk pemprosesan perkhidmatan Web dalam pembangunan API Java. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!