Проектирование по схеме и сопоставление типов
Определяйте схему GraphQL и сопоставляйте типы, запросы и мутации с методами контроллеров Java.
«Проектирование по схеме и сопоставление типов» — бесплатный урок Spring Boot 4 Complete Guide на CoddyKit. Это урок 1 из 4. Ты можешь прочитать весь урок бесплатно ниже — а потом практиковать его прямо в браузере с встроенным редактором кода и ИИ-репетитором 24/7. Это часть пути обучения Spring Boot 4 Complete Guide, и твой прогресс синхронизируется между веб-версией и приложением CoddyKit. Курс Spring Boot 4 Complete Guide содержит 4 уроков всего.
Части этого урока еще не переведены и отображаются на английском.
Schema-First in Spring for GraphQL
Spring for GraphQL is schema-first: you describe your API in a .graphql Schema Definition Language (SDL) file, and your Java code maps onto it.
- The schema is the single source of truth for the API contract.
- Clients ask for exactly the fields they need.
- Your controllers provide the data behind each field.
By convention, Spring Boot auto-discovers .graphqls / .graphql files under src/main/resources/graphql/.
Defining Object Types in SDL
A GraphQL object type describes the shape of an entity. Each field has a name and a type.
ID,String,Int,Float,Booleanare the built-in scalars.- A trailing
!marks a field as non-null. [Type]denotes a list.
Place this in src/main/resources/graphql/schema.graphqls.
type Book {
id: ID!
title: String!
pageCount: Int
author: Author!
}
type Author {
id: ID!
name: String!
books: [Book!]!
}The Query Root Type
Every read operation lives under the special Query root type. Each field of Query is an entry point a client can call.
- Fields can take arguments, e.g.
bookById(id: ID!). - The return type can be a single object, a list, or a scalar.
A nullable return (no !) is appropriate when the entity may not exist.
type Query {
bookById(id: ID!): Book
allBooks: [Book!]!
searchBooks(titleContains: String!): [Book!]!
}Mapping a Query to a Controller
Spring for GraphQL maps schema fields to Java methods using annotated controllers. A class annotated with @Controller exposes handler methods with @QueryMapping.
- The method name must match the schema field, or you set
@QueryMapping("fieldName"). - Arguments are bound with
@Argument.
This is framework code (it needs the Spring runtime), so it is not standalone-runnable.
@Controller
public class BookController {
private final BookRepository books;
public BookController(BookRepository books) {
this.books = books;
}
@QueryMapping
public Book bookById(@Argument String id) {
return books.findById(id).orElse(null);
}
@QueryMapping
public List<Book> allBooks() {
return books.findAll();
}
}Type Mapping: SDL to Java
Spring maps GraphQL types to Java types by field name, not by inheritance. Your POJO (record or class) just needs matching accessors.
- SDL
String→ JavaString - SDL
Int→ Javaint/Integer - SDL
ID→ usuallyString(orLongcoerced) - SDL
[Book!]!→List<Book>
A Java record is the cleanest representation of a GraphQL object type.
public record Book(
String id,
String title,
Integer pageCount,
String authorId
) {}
public record Author(
String id,
String name
) {}Argument Binding Details
The @Argument annotation binds a named schema argument to a method parameter.
- By default the parameter name must match the argument name (requires
-parameterscompilation, on by default in Spring Boot). - Override explicitly with
@Argument("titleContains"). - Complex input types bind to a Java record or class automatically.
Spring coerces the incoming GraphQL value to your parameter's Java type.
@QueryMapping
public List<Book> searchBooks(@Argument("titleContains") String fragment) {
return books.findAll().stream()
.filter(b -> b.title().toLowerCase().contains(fragment.toLowerCase()))
.toList();
}Resolving Nested Fields with @SchemaMapping
When a field needs extra work beyond a simple getter (e.g. Book.author must be looked up), use @SchemaMapping. The source object is passed as a parameter.
- The method's class/type is inferred from the parameter type, or set via
@SchemaMapping(typeName = "Book"). - This solves the N+1 concern by letting you batch later with
@BatchMapping.
Here, each Book resolves its author field on demand.
@SchemaMapping
public Author author(Book book) {
return authorRepository.findById(book.authorId())
.orElseThrow(() -> new IllegalStateException("Author missing"));
}Defining Mutations in SDL
Write operations live under the Mutation root type. They typically accept an input object and return the created or updated entity.
- Use a dedicated
inputtype for arguments — input types cannot have fields that reference object types. - Returning the mutated entity lets clients re-fetch fresh state in one round trip.
input AddBookInput {
title: String!
pageCount: Int
authorId: ID!
}
type Mutation {
addBook(input: AddBookInput!): Book!
deleteBook(id: ID!): Boolean!
}Mapping a Mutation to a Controller
Mutations map with @MutationMapping. A GraphQL input type binds cleanly to a Java record via @Argument.
- The record field names must match the SDL input field names.
- Return the entity to satisfy the non-null
Book!result.
Still framework code — needs Spring's GraphQL runtime, so not standalone-runnable.
public record AddBookInput(String title, Integer pageCount, String authorId) {}
@MutationMapping
public Book addBook(@Argument AddBookInput input) {
Book created = new Book(
UUID.randomUUID().toString(),
input.title(),
input.pageCount(),
input.authorId()
);
return books.save(created);
}Pure Type Mapping in Plain Java
The data-shaping logic behind a resolver is plain Java — you can reason about it without any server. Below, a search filter (the body of searchBooks) runs as a complete standalone program.
- This mirrors exactly what your
@QueryMappingmethod does internally. - No Spring, no schema engine — just type mapping and filtering.
import java.util.List;
public class Main {
record Book(String id, String title, Integer pageCount) {}
static List<Book> searchBooks(List<Book> all, String fragment) {
return all.stream()
.filter(b -> b.title().toLowerCase().contains(fragment.toLowerCase()))
.toList();
}
public static void main(String[] args) {
List<Book> catalog = List.of(
new Book("1", "Spring in Action", 600),
new Book("2", "GraphQL Basics", 220),
new Book("3", "Effective Java", 412)
);
searchBooks(catalog, "graphql").forEach(b -> System.out.println(b.title()));
}
}Where Schema and Code Meet
At startup Spring validates that every schema field is satisfiable. If a field has no getter and no @SchemaMapping, you may get an unresolved-field error at query time.
- Properties on your record resolve automatically by name.
- Computed / fetched fields need an explicit mapping method.
- Use the GraphiQL UI (enable
spring.graphql.graphiql.enabled=true) to explore the live schema.
Keeping SDL and Java field names aligned is the core discipline of schema-first design.
Quick Check
You have a schema field Book.author: Author!, but a Book record only stores authorId and no author property. What is the correct schema-first way to resolve it?
Recap
You mapped a GraphQL schema to Spring controllers, schema-first:
- SDL files under
src/main/resources/graphql/define object,input,Query, andMutationtypes. @QueryMappinghandles reads,@MutationMappinghandles writes, both binding args with@Argument.@SchemaMapping(and@BatchMapping) resolve nested/computed fields from a source object.- Types map by field name: records are the cleanest representation, and SDL scalars map to their natural Java types.
Keep SDL and Java names aligned, and the schema stays the single source of truth.
Изучай Java с ИИ-репетитором — бесплатно
Пиши и запускай код прямо в браузере, получай мгновенную помощь от ИИ-репетитора 24/7 и продолжи учиться на сайте или в приложении.
- Курсы
- 21
- Уроки
- 84
Часто задаваемые вопросы
Урок «Проектирование по схеме и сопоставление типов» бесплатный?
Да — полный текст урока «Проектирование по схеме и сопоставление типов» бесплатно доступен здесь в веб-версии. Чтобы практиковать его интерактивно (встроенный редактор кода и ИИ-репетитор 24/7) и разблокировать остальной курс Spring Boot 4 Complete Guide, подпишись на CoddyKit PRO. Курс Spring Boot 4 Complete Guide содержит 4 уроков всего.
Чему я научусь в уроке «Проектирование по схеме и сопоставление типов»?
Определяйте схему GraphQL и сопоставляйте типы, запросы и мутации с методами контроллеров Java. Ты практикуешь Spring Boot 4 Complete Guide с помощью реального кода, который запускаешь прямо в браузере, и ИИ-репетитор 24/7 отвечает на твои вопросы во время урока.
Нужен ли мне опыт, чтобы начать Spring Boot 4 Complete Guide?
Предыдущий опыт не требуется. Spring Boot 4 Complete Guide на CoddyKit структурирован для всех уровней — от новичков до продвинутых, поэтому ты можешь начать отсюда или с самого начала и учиться в своем темпе. Это урок 1 из 4.
Сколько времени занимает урок «Проектирование по схеме и сопоставление типов»?
Большинство уроков CoddyKit занимают около 5–10 минут. Каждый из них компактный и интерактивный, поэтому ты постоянно делаешь прогресс и продолжаешь с того же места в веб-версии и приложении.
Можно ли писать и запускать код в этом уроке Spring Boot 4 Complete Guide?
Да. Каждый урок Spring Boot 4 Complete Guide включает встроенный редактор кода, поэтому ты пишешь и запускаешь реальный код прямо в браузере и получаешь моментальную обратную связь от AI — локальная установка не требуется.
Все уроки этого курса
- Проектирование по схеме и сопоставление типов
- Получатели данных и связывание аргументов
- Устранение N+1 с помощью пакетных загрузчиков
- Подписки, ошибки и безопасность схемы