Java API 開發中使用 GraphQL 進行請求處理-java教程-PHP中文網

Java API 開發中使用 GraphQL 進行請求處理

PHPz

發布： 2023-06-18 12:14:24

原創

2122 人瀏覽過

隨著Web應用程式的不斷發展與普及，前端與後端介面的互動方式也不斷更新與最佳化。隨著Restful API的成熟與廣泛應用，GraphQL作為新興的Web API開發框架，也開始受到越來越多的關注與應用。

本文將介紹在Java API開發中使用GraphQL進行請求處理的具體實作方法，包括GraphQL的基本概念、GraphQL的優點、在Java中如何使用GraphQL和GraphQL的使用建議。

一、GraphQL的基本概念

GraphQL（Graph Query Language）是Facebook開發的新型API查詢語言，它允許客戶端明確指定需要從後端API取得的數據。 GraphQL的基本特性如下：

宣告式API設計風格：GraphQL允許客戶端定義所需取得的資料集，後端只需要提供對應資料即可。
強型別系統：GraphQL使用型別系統對資料進行驗證與定義。
與多種程式語言相容：GraphQL支援多種程式語言，包括Java、JavaScript、Python、Ruby等。
即時性：GraphQL支援即時查詢和訂閱功能。
自我描述能力：GraphQL具有自我描述的能力，透過查詢操作傳回的資料也能給出資料的類型和結構。

二、GraphQL的優點

減少網路傳輸量：GraphQL只傳回客戶端請求的數據，減少了因為資料冗餘而導致的網路傳輸量和伺服器資源消耗。
靈活性：GraphQL的靈活性非常高，客戶端可以定義自己需要的資料結構，而後端並不需要改變返回資料的結構。
避免多次要求：GraphQL透過查詢複合欄位的方式，避免了一次請求只回傳一種資料的情況，從而減少了多次請求帶來的效能消耗。
易於使用：GraphQL的查詢和操作語言易於使用和學習，使得資料取得變得更加方便和快速。

三、在Java中使用GraphQL

Java開發者可以透過使用GraphQL-Java函式庫來完成GraphQL的應用。 GraphQL-Java是由GraphQL社群開源的Java實現，它提供了完整的GraphQL協定實作和解析器。以下是Java中使用GraphQL的具體步驟：

<dependency>
    <groupId>com.graphql-java</groupId>
    <artifactId>graphql-java</artifactId>
    <version>15.0</version>
</dependency>

登入後複製

public class HelloWorldSchema {
    public static GraphQLSchema buildSchema() {
        //定义GraphQL的查询和类型
        return GraphQLSchema.newSchema()
                .query(GraphQLObjectType.newObject()
                        .name("HelloQuery")
                        .field(field -> field
                                .type(GraphQLString)
                                .name("hello")
                                .dataFetcher(new StaticDataFetcher("world")))
                        .build())
                .build();
    }
}

登入後複製

public class GraphQLConfig {
    @Bean
    public GraphQLServlet graphQLServlet() {
        return new SimpleGraphQLServlet.Builder(
                HelloWorldSchema.buildSchema())
                .build();
    }
}

登入後複製

public class BookDataFetcher implements DataFetcher<Book> {
    private final BookRepository repository;

    public BookDataFetcher(BookRepository repository) {
        this.repository = repository;
    }

    @Override
    public Book get(DataFetchingEnvironment environment) throws Exception {
        String id = environment.getArgument("id");
        return repository.findById(id);
    }
}

登入後複製

@RestController
public class GraphQLController {
    private final GraphQL graphql;

    public GraphQLController(GraphQL graphql) {
        this.graphql = graphql;
    }

    @PostMapping(value = "/graphql")
    public ResponseEntity<String> handlePost(@RequestBody String request) {
        ExecutionResult executionResult = graphql.execute(request);
        return ResponseEntity.ok(executionResult.getData().toString());
    }
}

登入後複製

四、GraphQL的使用建議