Menggunakan Spring HATEOAS untuk pemprosesan API RESTful dalam pembangunan API Java

Dengan perkembangan berterusan Internet, permintaan orang ramai untuk API RESTful juga semakin meningkat. Sebagai rangka kerja yang biasa digunakan dalam pembangunan Java moden, Spring menyediakan koleksi alatan untuk membantu menangani API RESTful: Spring HATEOAS.

Apakah Spring HATEOAS?

HATEOAS (Hypermedia as the Engine of Application State) ialah gaya reka bentuk untuk RESTful API Idea terasnya ialah menggunakan hipermedia untuk mempromosikan perubahan dalam keadaan aplikasi. Spring HATEOAS ialah pelaksanaan rasmi Spring HATEOAS Ia menyediakan satu set API yang ringkas dan mudah digunakan untuk memudahkan kami berurusan dengan API RESTful.

Bagaimana cara menggunakan Spring HATEOAS?

Di bawah ini kami akan memperkenalkan cara menggunakan Spring HATEOAS untuk memproses API RESTful.

1. Tambah pergantungan Spring HATEOAS

Mula-mula anda perlu menambah pergantungan Spring HATEOAS pada projek:

<dependency>
    <groupId>org.springframework.hateoas</groupId>
    <artifactId>spring-hateoas</artifactId>
    <version>${spring-hateoas.version}</version>
</dependency>

2. Tulis kelas entiti

Seterusnya, kita perlu menulis kelas entiti. Untuk menggunakan Spring HATEOAS, kita perlu menjadikan entiti kita mewarisi kelas RepresentationModel.

public class User extends RepresentationModel<User> {
    private String name;
    private int age;
    //getter and setter
}

3. Menulis Pengawal

Seterusnya, kita perlu menulis pengawal untuk API RESTful. Di sini kami mengambil antara muka getUser sebagai contoh:

@RestController
@RequestMapping("/users")
public class UserController {

    @GetMapping("/{userId}")
    public EntityModel<User> getUser(@PathVariable("userId") String userId){
        User user = new User();
        user.setName("Alex");
        user.setAge(18);

        /*
            使用 EntityModel 包裹实体类，添加超链接
         */
        EntityModel<User> model = EntityModel.of(user);
        model.add(linkTo(methodOn(UserController.class).getUser(userId)).withSelfRel());

        return model;
    }
}

Dalam kod di atas, kami menggunakan EntityModel untuk membalut kelas entiti yang dikembalikan kepada klien, dan menggunakan kaedah linkTo dan methodOn untuk menambah hiperpautan.

4. Uji antara muka

Akhir sekali, kami menggunakan Posmen atau alatan lain untuk menguji antara muka:

GET http://localhost:8080/users/1

Hasil yang dikembalikan adalah seperti berikut:

{
    "name": "Alex",
    "age": 18,
    "_links": {
        "self": {
            "href": "http://localhost:8080/users/1"
        }
    }
}

Dalam contoh ini, kami mengembalikan entiti Pengguna dan menambah hiperpautan bernama diri.

Ringkasan

Dengan Spring HATEOAS, kami boleh mengendalikan API RESTful dengan lebih mudah, menjadikannya lebih mudah dibaca dan diselenggara. Walaupun lebih banyak pembelajaran dan aplikasi diperlukan dalam pembangunan sebenar, menguasai aplikasi asas Spring HATEOAS adalah perlu.

Atas ialah kandungan terperinci Menggunakan Spring HATEOAS untuk pemprosesan API RESTful dalam pembangunan API Java. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!