First, choose Spring for GraphQL for its official support, annotation driver, zero configuration startup, compatibility and ease of testing; 1. Add spring-boot-starter-graphql dependency and optionally add Web and GraphiQL support; 2. Define Query and Book types in schema.graphqls; 3. Create Book classes and use Lombok to simplify the code; 4. Use @Controller and @QueryMapping to implement bookById and allBooks queries; 5. After starting the application, test queries through http://localhost:8080/graphiql; 6. Extensible support for Mutation, automatic field mapping and paging filtering; 7. Configure custom paths and debugging options in application.properties to complete Java The Spring for GraphQL API is built and supports subsequent advanced features.
If you are developing backend services in Java and Spring and considering introducing GraphQL, Spring for GraphQL is the most natural and most integrated option at present. It is a GraphQL support module officially launched by Spring. It is part of Spring Ecosystem and is seamlessly integrated with Spring Boot, greatly simplifying the process of building GraphQL APIs in Java projects.

The following are several key aspects to quickly get started with Java Spring for GraphQL to build APIs.
? 1. Add Spring for GraphQL dependencies
When using Spring Boot project, just add in pom.xml
:

<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-graphql</artifactId> </dependency>
If you also need to provide a GraphQL interface over HTTP (usually required), Spring Boot will automatically introduce Web MVC or WebFlux (depending on whether you are responsively programming).
Optional: Add GraphiQL IDE support (for debugging):

<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>org.springframework.graphql</groupId> <artifactId>spring-graphql-ui-graphiql</artifactId> </dependency>
After starting, visit http://localhost:8080/graphiql
(or /graphql
send a request) to test it.
? 2. Define Schema (.graphqls file)
Spring for GraphQL uses the standard GraphQL Schema Definition Language (SDL) to define types.
Create schema.graphqls
in src/main/resources/graphql
directory:
type Query { bookById(id: ID!): Book allBooks: [Book!]! } type Book { id: ID! title: String! author: String! pages: Int }
This schema defines two queries:
-
bookById(id)
: Query a book based on ID -
allBooks
: Get all books
? 3. Create a data model (Java class)
Create the corresponding Java class to map Book
types:
public class Book { private String id; private String title; private String author; private Integer pages; // Constructor, getter, setter omitted}
It is recommended to use Lombok to simplify the code:
@Data @AllArgsConstructor @NoArgsConstructor public class Book { private String id; private String title; private String author; private Integer pages; }
? 4. Implement data acquisition (write Data Fetcher/Controller)
Spring for GraphQL recommends using @Controller
@QueryMapping
annotation, which is more in line with Spring style than traditional DataFetcher.
@Controller public class BookController { private List<Book> books = Arrays.asList( new Book("1", "Spring in Action", "Craig Walls", 450), new Book("2", "Effective Java", "Joshua Bloch", 416) ); @QueryMapping public Book bookById(@Argument String id) { return books.stream() .filter(book -> book.getId().equals(id)) .findFirst() .orElse(null); } @QueryMapping public List<Book> allBooks() { return books; } }
-
@QueryMapping
corresponds to theQuery
field in the schema -
@Argument
is used to bind GraphQL parameters to Java method parameters
? 5. Start and test
After running the Spring Boot application, you can:
Test with GraphiQL (recommended)
Visit: http://localhost:8080/graphiql
(Use UI module to be enabled)
Execute the query:
{ bookById(id: "1") { title author } }
return:
{ "data": { "bookById": { "title": "Spring in Action", "author": "Craig Walls" } } }
? 6. Advanced function support
?? Support Mutation (modify operations)
@MutationMapping public Book createBook(@Argument String title, @Argument String author) { Book book = new Book(UUID.randomUUID().toString(), title, author, 300); books.add(book); return book; }
Added in Schema:
type Mutation { createBook(title: String!, author: String!): Book! }
?? Entity Mapping (automatically mapped fields)
Spring for GraphQL supports automatic mapping of Java Bean fields to GraphQL types as long as the name is the same. You can also use @SchemaMapping
to fine control.
?? Supports pagination and parameter filtering
@QueryMapping public List<Book> allBooks(@Argument Integer limit) { if (limit != null) { return books.stream().limit(limit).collect(Collectors.toList()); } return books; }
? 7. Configuration options (optional)
In application.properties
you can configure:
# Customize GraphQL endpoint spring.graphql.path=/api/graphql # Enable GraphiQL (Development Environment) spring.graphql.graphhiql.enabled=true # Enable schema printing (for debugging) spring.graphql.schema.printer.enabled=true
Summary: Why choose Spring for GraphQL?
Advantages | illustrate |
---|---|
Official support | Maintenance by Spring Team, deep integration with Spring Boot |
Annotation driver | Use @Controller and @QueryMapping to have a unified style |
Zero configuration startup | Automatically configure GraphQL HTTP endpoints after adding dependencies |
Support Reactive | Compatible with WebFlux, supports Mono<book></book> return type |
Easy to test | Can be tested WebTestClient or GraphQLTester
|
Basically that's it. Spring for GraphQL allows you to write GraphQL in the most "Spring" way in the Java world, saying goodbye to complex configurations and boilerplate code. Suitable for smooth evolution from simple projects to medium and large systems.
The above is the detailed content of GraphQL APIs with Java and Spring for GraphQL. For more information, please follow other related articles on the PHP Chinese website!

Hot AI Tools

Undress AI Tool
Undress images for free

Undresser.AI Undress
AI-powered app for creating realistic nude photos

AI Clothes Remover
Online AI tool for removing clothes from photos.

Clothoff.io
AI clothes remover

Video Face Swap
Swap faces in any video effortlessly with our completely free AI face swap tool!

Hot Article

Hot Tools

Notepad++7.3.1
Easy-to-use and free code editor

SublimeText3 Chinese version
Chinese version, very easy to use

Zend Studio 13.0.1
Powerful PHP integrated development environment

Dreamweaver CS6
Visual web development tools

SublimeText3 Mac version
God-level code editing software (SublimeText3)

Java supports asynchronous programming including the use of CompletableFuture, responsive streams (such as ProjectReactor), and virtual threads in Java19. 1.CompletableFuture improves code readability and maintenance through chain calls, and supports task orchestration and exception handling; 2. ProjectReactor provides Mono and Flux types to implement responsive programming, with backpressure mechanism and rich operators; 3. Virtual threads reduce concurrency costs, are suitable for I/O-intensive tasks, and are lighter and easier to expand than traditional platform threads. Each method has applicable scenarios, and appropriate tools should be selected according to your needs and mixed models should be avoided to maintain simplicity

In Java, enums are suitable for representing fixed constant sets. Best practices include: 1. Use enum to represent fixed state or options to improve type safety and readability; 2. Add properties and methods to enums to enhance flexibility, such as defining fields, constructors, helper methods, etc.; 3. Use EnumMap and EnumSet to improve performance and type safety because they are more efficient based on arrays; 4. Avoid abuse of enums, such as dynamic values, frequent changes or complex logic scenarios, which should be replaced by other methods. Correct use of enum can improve code quality and reduce errors, but you need to pay attention to its applicable boundaries.

JavaNIO is a new IOAPI introduced by Java 1.4. 1) is aimed at buffers and channels, 2) contains Buffer, Channel and Selector core components, 3) supports non-blocking mode, and 4) handles concurrent connections more efficiently than traditional IO. Its advantages are reflected in: 1) Non-blocking IO reduces thread overhead, 2) Buffer improves data transmission efficiency, 3) Selector realizes multiplexing, and 4) Memory mapping speeds up file reading and writing. Note when using: 1) The flip/clear operation of the Buffer is easy to be confused, 2) Incomplete data needs to be processed manually without blocking, 3) Selector registration must be canceled in time, 4) NIO is not suitable for all scenarios.

Java's class loading mechanism is implemented through ClassLoader, and its core workflow is divided into three stages: loading, linking and initialization. During the loading phase, ClassLoader dynamically reads the bytecode of the class and creates Class objects; links include verifying the correctness of the class, allocating memory to static variables, and parsing symbol references; initialization performs static code blocks and static variable assignments. Class loading adopts the parent delegation model, and prioritizes the parent class loader to find classes, and try Bootstrap, Extension, and ApplicationClassLoader in turn to ensure that the core class library is safe and avoids duplicate loading. Developers can customize ClassLoader, such as URLClassL

HashMap implements key-value pair storage through hash tables in Java, and its core lies in quickly positioning data locations. 1. First use the hashCode() method of the key to generate a hash value and convert it into an array index through bit operations; 2. Different objects may generate the same hash value, resulting in conflicts. At this time, the node is mounted in the form of a linked list. After JDK8, the linked list is too long (default length 8) and it will be converted to a red and black tree to improve efficiency; 3. When using a custom class as a key, the equals() and hashCode() methods must be rewritten; 4. HashMap dynamically expands capacity. When the number of elements exceeds the capacity and multiplies by the load factor (default 0.75), expand and rehash; 5. HashMap is not thread-safe, and Concu should be used in multithreaded

Java enumerations not only represent constants, but can also encapsulate behavior, carry data, and implement interfaces. 1. Enumeration is a class used to define fixed instances, such as week and state, which is safer than strings or integers; 2. It can carry data and methods, such as passing values ??through constructors and providing access methods; 3. It can use switch to handle different logics, with clear structure; 4. It can implement interfaces or abstract methods to make differentiated behaviors of different enumeration values; 5. Pay attention to avoid abuse, hard-code comparison, dependence on ordinal values, and reasonably naming and serialization.

The key to handling exceptions in Java is to catch them, handle them clearly, and not cover up problems. First, we must catch specific exception types as needed, avoid general catches, and prioritize checkedexceptions. Runtime exceptions should be judged in advance; second, we must use the log framework to record exceptions, and retry, rollback or throw based on the type; third, we must use the finally block to release resources, and recommend try-with-resources; fourth, we must reasonably define custom exceptions, inherit RuntimeException or Exception, and carry context information for easy debugging.

Singleton design pattern in Java ensures that a class has only one instance and provides a global access point through private constructors and static methods, which is suitable for controlling access to shared resources. Implementation methods include: 1. Lazy loading, that is, the instance is created only when the first request is requested, which is suitable for situations where resource consumption is high and not necessarily required; 2. Thread-safe processing, ensuring that only one instance is created in a multi-threaded environment through synchronization methods or double check locking, and reducing performance impact; 3. Hungry loading, which directly initializes the instance during class loading, is suitable for lightweight objects or scenarios that can be initialized in advance; 4. Enumeration implementation, using Java enumeration to naturally support serialization, thread safety and prevent reflective attacks, is a recommended concise and reliable method. Different implementation methods can be selected according to specific needs
