12 - Spring Boot GraphQL

03/03/2025 - 3 phút

#spring-boot #spring-boot-features #spring-boot-graphql

Trong bài viết này, chúng ta sẽ tìm hiểu về Spring Boot GraphQL, cách xây dựng API linh hoạt hơn REST!

1. Giới Thiệu

Trong khi REST API là phương pháp phổ biến để xây dựng API, GraphQL đang trở thành một lựa chọn mạnh mẽ giúp cải thiện hiệu suất và tính linh hoạt trong việc truy vấn dữ liệu.

Spring Boot GraphQL giúp bạn:

Truy vấn dữ liệu linh hoạt, chỉ lấy đúng thông tin cần thiết.
Giảm số lượng request API, hạn chế over-fetching và under-fetching.
Tối ưu performance cho frontend, đặc biệt trong ứng dụng mobile.

Trong bài viết này, chúng ta sẽ tìm hiểu về Spring Boot GraphQL, cách cài đặt, cấu hình schema, truy vấn và tối ưu hiệu suất GraphQL API.

2. Cài Đặt Spring Boot GraphQL

2.1. Thêm Dependencies

Spring Boot hỗ trợ GraphQL thông qua thư viện Spring GraphQL. Thêm vào pom.xml:

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

<dependency>
    <groupId>com.graphql-java-kickstart</groupId>
    <artifactId>graphql-spring-boot-starter</artifactId>
    <version>11.1.0</version>
</dependency>

2.2. Cấu Hình GraphQL Trong `application.properties`

spring.graphql.path=/graphql

spring.graphql.path: Định nghĩa endpoint GraphQL mặc định (/graphql).

Sau khi cấu hình, Spring Boot sẽ tự động kích hoạt GraphQL API.

3. Tạo Schema Cho GraphQL

GraphQL sử dụng schema để định nghĩa cấu trúc dữ liệu. Trong Spring Boot, bạn có thể tạo schema trong thư mục src/main/resources/graphql/.

3.1. Tạo `schema.graphqls`

type Query {
    getBook(id: ID!): Book
    getAllBooks: [Book]
}

type Mutation {
    addBook(title: String!, author: String!): Book
}

type Book {
    id: ID!
    title: String!
    author: String!
}

Query: Định nghĩa các truy vấn để lấy dữ liệu.
Mutation: Định nghĩa API để thêm dữ liệu.
Book: Định nghĩa model dữ liệu sách.

4. Tạo Service Cho GraphQL API

4.1. Tạo `Book.java`

import java.util.UUID;

public class Book {
    private String id;
    private String title;
    private String author;
    
    public Book(String title, String author) {
        this.id = UUID.randomUUID().toString();
        this.title = title;
        this.author = author;
    }
    
    public String getId() { return id; }
    public String getTitle() { return title; }
    public String getAuthor() { return author; }
}

4.2. Tạo `BookService.java`

import org.springframework.stereotype.Service;
import java.util.*;

@Service
public class BookService {
    private final List<Book> books = new ArrayList<>();
    
    public BookService() {
        books.add(new Book("Spring Boot GraphQL", "John Doe"));
        books.add(new Book("GraphQL for Beginners", "Jane Doe"));
    }
    
    public List<Book> getAllBooks() {
        return books;
    }
    
    public Book getBook(String id) {
        return books.stream().filter(book -> book.getId().equals(id)).findFirst().orElse(null);
    }
    
    public Book addBook(String title, String author) {
        Book newBook = new Book(title, author);
        books.add(newBook);
        return newBook;
    }
}

4.3. Tạo GraphQL Controller

import org.springframework.graphql.data.method.annotation.*;
import org.springframework.stereotype.Controller;
import java.util.List;

@Controller
public class BookController {
    private final BookService bookService;
    
    public BookController(BookService bookService) {
        this.bookService = bookService;
    }
    
    @QueryMapping
    public List<Book> getAllBooks() {
        return bookService.getAllBooks();
    }
    
    @QueryMapping
    public Book getBook(@Argument String id) {
        return bookService.getBook(id);
    }
    
    @MutationMapping
    public Book addBook(@Argument String title, @Argument String author) {
        return bookService.addBook(title, author);
    }
}

@QueryMapping: Định nghĩa các query cho GraphQL API.
@MutationMapping: Định nghĩa các mutation (thêm/sửa/xóa dữ liệu).
@Argument: Truyền tham số từ request vào hàm.

5. Kiểm Tra GraphQL API

Sau khi chạy ứng dụng (mvn spring-boot:run), bạn có thể sử dụng GraphQL Playground hoặc Postman để thử nghiệm API.

5.1. Query Lấy Danh Sách Sách

Request:

query {
  getAllBooks {
    id
    title
    author
  }
}

Response:

{
  "data": {
    "getAllBooks": [
      { "id": "1", "title": "Spring Boot GraphQL", "author": "John Doe" },
      { "id": "2", "title": "GraphQL for Beginners", "author": "Jane Doe" }
    ]
  }
}

5.2. Query Lấy Chi Tiết Một Cuốn Sách

query {
  getBook(id: "1") {
    title
    author
  }
}

5.3. Mutation Thêm Sách Mới

mutation {
  addBook(title: "GraphQL Advanced", author: "Alice Smith") {
    id
    title
    author
  }
}

6. Kết Luận

Spring Boot GraphQL giúp xây dựng API linh hoạt hơn REST, tối ưu hiệu suất và giảm số lượng request.

Tóm tắt:

GraphQL API giúp lấy đúng dữ liệu cần thiết, tránh over-fetching.
Hỗ trợ query và mutation mạnh mẽ, dễ dàng mở rộng.
Spring Boot GraphQL đơn giản, dễ tích hợp với hệ thống hiện có.

👉 Trong bài viết tiếp theo, chúng ta sẽ tìm hiểu về Spring Boot gRPC, giúp xây dựng API hiệu suất cao hơn REST!