Cara SpringBoot menggunakan GraphQL untuk membangunkan API Web

Kata Pengantar

API Restful tradisional mempunyai banyak masalah Pertama sekali, ia tidak dapat mengawal medan yang dikembalikan, dan bahagian hadapan tidak boleh meramalkan hasil pengembalian bahagian belakang ke alamat permintaan yang berbeza. Ini mengakibatkan berbilang permintaan. GraphQL ialah bahasa pertanyaan API yang dibina berdasarkan latar belakang ini Berbanding dengan API Restful tradisional, ia mempunyai kelebihan berikut:

• Fleksibiliti: GraphQL boleh fleksibel mengikut keperluan pelanggan. Tanya data dengan cekap dan bukannya mengembalikan data berstruktur tetap seperti RESTful API.

• Kurangkan permintaan rangkaian: GraphQL membenarkan pelanggan mengambil berbilang sumber dalam satu permintaan, yang membantu mengurangkan bilangan permintaan rangkaian dan meningkatkan prestasi.

• Penaipan yang kuat: GraphQL mempunyai sistem taip kuat yang membolehkan pelanggan mengesan ralat dalam pertanyaan pada masa penyusunan, yang membantu mengurangkan ralat masa jalan.

• Boleh Dicache: GraphQL boleh dicache, yang bermaksud pelayan boleh menyimpan hasil pertanyaan, meningkatkan prestasi dan kebolehskalaan.

• Dokumentasi: GraphQL mempunyai keupayaan untuk mendokumentasikan diri, membolehkan pembangun memahami dengan cepat struktur dan fungsi API.

Pelan pelaksanaan GraphQL dalam Spring Boot

Jika bahasa back-end ialah Java, maka GraphQL Java ialah perpustakaan asas untuk melaksanakan GraphQL. Selain itu, Spring telah menyepadukan GraphQL Jika Spring digunakan dalam projek, Spring GraphQL lebih disyorkan.

Pembangunan Spring GraphQL secara amnya dibahagikan kepada langkah berikut

Tambah kebergantungan Spring GraphQL

Tambah kebergantungan Spring GraphQL dalam projek anda. Anda boleh menambah kebergantungan melalui alat binaan seperti Maven atau Gradle. Sebagai contoh, jika anda menggunakan Maven, anda boleh menambah kebergantungan berikut

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-graphql</artifactId>
        </dependency>

Define GraphQL Schema

Define GraphQL Schema dalam aplikasi anda. Skema mentakrifkan jenis dan medan yang boleh ditanya. Anda boleh mentakrifkan skema menggunakan SDL (Schema Definition Language) atau secara pengaturcaraan.

Untuk projek Spring Boot, fail skema diletakkan dalam direktori resources/graphql/ dan nama fail diakhiri dengan graphqls Berikut ialah schema.graphqls ringkas yang saya takrifkan.

Ia menentukan dua pelaksanaan pertanyaan author(id:Int) bermaksud menanyakan Pengarang dengan id, dan allAuthors bermaksud menanyakan tatasusunan Pengarang.

skema {
pertanyaan: Pertanyaan
}

taip Pertanyaan {
pengarang(id:Int): Pengarang
semuaPengarang: [Pengarang]
}

taip Pengarang {
id:Int
firstName:String
lastName:String
e-mel:String
tarikh lahir:String
}

Melaksanakan RuntimeWiringConfigurer

RuntimeWiringConfigurer ialah teras pelaksanaan GraphQL untuk mendapatkan data Menggunakan GraphQL tidak boleh langsung mengalih keluar rangka kerja lapisan kegigihan seperti Mybatis/Jpa .

RuntimeWiringConfigurer adalah serupa dengan lapisan perkhidmatan dalam Spring, yang merupakan teras pelaksanaan data asas.

Berikut ialah contoh mudah:

@Component
public class AuthorWiring implements RuntimeWiringConfigurer {
    private final AuthorRepository authorRepository;
    public AuthorWiring(AuthorRepository authorRepository) {
        this.authorRepository = authorRepository;
    }
    @Override
    public void configure(RuntimeWiring.Builder builder) {
        builder.type("Query", typeWiring -> typeWiring
                        .dataFetcher("allAuthors", environment -> authorRepository.findAll())
                        .dataFetcher("author", environment -> authorRepository.getReferenceById(environment.getArgument("id")))
    }
}

Di sini, dua objek DataFetcher ditakrifkan di dalam kaedah konfigurasi untuk menentukan cara pengarang dan semua Pengarang bertanyakan data ia masih melalui JPA Data pertanyaan.

Define GraphQL Controller

Kami mentakrifkan GraphQLController untuk menerima parameter input permintaan web Contohnya adalah seperti berikut:

@RestController
@RequestMapping("graphql")
public class GraphQLController {
    private final GraphQL graphQL;
    @Autowired
    public GraphQLController(GraphQlSource graphQlSource) {
        graphQL = graphQlSource.graphQl();
    }
    @PostMapping("query")
    public ResponseEntity<Object> query(@RequestBody String query) {
        ExecutionResult result = graphQL.execute(query);
        return ResponseEntity.ok(result.getData());
    }
}

Objek GraphQL dalam kod adalah pintu masuk ke. laksanakan pertanyaan, tetapi GraphQL Terdapat hanya satu pembina peribadi, jadi ia tidak boleh disuntik secara langsung Anda mesti mendapatkan objek GraphQL dengan menyuntik GraphQlSource.

Perhatikan bahawa dalam GraphQL kita hanya boleh menggunakan String untuk menerima parameter dan tidak boleh menggunakan objek model Ini kerana parameter permintaan Graf bukan struktur json.

Permintaan Graf Uji

Kami mencipta fail graphql.http untuk melaksanakan permintaan http dalam idea

### Hantar permintaan POST dengan badan json
POST http://localhost:8080/graphql/query
Content-Type: application/json

{
author(id: 1) {
id
firstName
lastName
tarikh lahir
}
}

### Hantar permintaan POST dengan badan json
POST http://localhost:8080/graphql/query
Kandungan -Jenis: aplikasi /json

{
allAuthors {
id
firstName
lastName
tarikh lahir
}
}

Jalankan pertanyaan untuk pengarang(id: 1) dan anda boleh melihat bahawa keputusan dikembalikan seperti biasa. Jika kita hanya memerlukan medan FirstName dan LastName, kemudian alih keluar id dan tarikh lahir daripada parameter input permintaan tanpa mengubah sebarang kod back-end.

Atas ialah kandungan terperinci Cara SpringBoot menggunakan GraphQL untuk membangunkan API Web. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!