利用输入类型实现变更
通过定义可复用的输入类型，简化变更参数，使 API 调用更清晰、更有条理。
利用输入类型实现变更 是 CoddyKit 上的免费 GraphQL APIs with Spring Boot 课时。 这是第 3 节课，共 4 节。 你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。 这是 GraphQL APIs with Spring Boot 学习路径的一部分，你的进度在网页和 CoddyKit 应用中同步。 GraphQL APIs with Spring Boot 课程共包含 4 节课。
本课时的部分内容尚未翻译，以英文显示。
Long Mutation Arguments?
When building GraphQL mutations, you often need to pass several pieces of data to create or update an entity. Think about creating a new user or a product.
Passing each field as a separate argument can make your mutation signatures quite long and hard to manage, leading to less readable and maintainable code.
Meet GraphQL Input Types
Input types are special object types in GraphQL used specifically as arguments for mutations (or sometimes queries). They allow you to group related fields into a single, structured object.
This makes your mutation definitions cleaner and more organized, similar to how a DTO (Data Transfer Object) works in traditional REST APIs.
Input Type Syntax (SDL)
Defining an input type in your GraphQL Schema Definition Language (SDL) is straightforward. You use the input keyword instead of type.
Input types can only contain scalar types, enums, or other input types as their fields. They cannot contain output object types, interfaces, or union types.
input CreateProductInput {
name: String!
description: String
price: Float!
category: String
}The Problem: Many Arguments
Consider a mutation to create a new product. Without an input type, you might define it like this:
Notice how the argument list can become long and repetitive, especially if you have many fields. This can be cumbersome to write and read.
type Mutation {
createProduct(
name: String!,
description: String,
price: Float!,
category: String
): Product
}The Solution: Clean Mutations
By using our CreateProductInput, the mutation signature becomes much cleaner and easier to read. All related input fields are now encapsulated within a single argument.
This improves clarity and reduces clutter in your schema.
type Mutation {
createProduct(input: CreateProductInput!): Product
}
input CreateProductInput {
name: String!
description: String
price: Float!
category: String
}Spring Boot DTO for Input
In your Spring Boot application, you'll represent your GraphQL input types as simple Java classes. These act as Data Transfer Objects (DTOs) that Spring's GraphQL integration can automatically map for you.
Ensure the field names in your Java class match your SDL input type for seamless mapping.
package com.coddykit.graphql;
public class CreateProductInput {
private String name;
private String description;
private float price;
private String category;
// Getters and Setters (omitted for brevity)
public String getName() { return name; }
public void setName(String name) { this.name = name; }
// ... other getters/setters
}Using Input in Resolver
Now, let's see how your GraphQL resolver method in Spring Boot will use this CreateProductInput DTO. Instead of multiple @Argument annotations, you'll have just one for your input object.
This makes the resolver method signature much cleaner and easier to manage, especially with many input fields.
package com.coddykit.graphql;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.graphql.data.method.annotation.Argument;
import org.springframework.graphql.data.method.annotation.MutationMapping;
import org.springframework.stereotype.Controller;
// Dummy Product class for example return type
class Product {
String id; String name; public Product(String id, String name) { this.id = id; this.name = name; }
public String getId() { return id; } public String getName() { return name; }
}
// Input DTO from previous scene
class CreateProductInput {
private String name; private String description; private float price; private String category;
public String getName() { return name; } public void setName(String name) { this.name = name; }
public String getDescription() { return description; } public void setDescription(String description) { this.description = description; }
public float getPrice() { return price; } public void setPrice(float price) { this.price = price; }
public String getCategory() { return category; } public void setCategory(String category) { this.category = category; }
}
@SpringBootApplication
@Controller
public class Main {
public static void main(String[] args) {
// This would start a Spring Boot web server
// SpringApplication.run(Main.class, args);
System.out.println("Application context started (conceptually).");
}
private static long productIdCounter = 1;
@MutationMapping
public Product createProduct(@Argument CreateProductInput input) {
System.out.println("Creating product: " + input.getName());
// In a real application, you'd save this to a database
String newId = "prod-" + productIdCounter++;
return new Product(newId, input.getName());
}
}Why Use Input Types?
Input types offer several significant advantages for your GraphQL API design:
- Readability: Mutation signatures become much shorter and clearer.
- Reusability: The same input type can often be used for both creation and update mutations, reducing schema duplication.
- Validation: It's easier to apply validation logic to a single, consolidated input object.
- Extensibility: Adding new optional fields to an input type doesn't break existing clients, as they can simply ignore the new fields.
Complex Data with Nested Inputs
Input types can also contain other input types, allowing you to model complex, hierarchical data for your mutations. This is very powerful for structured data submission.
For example, when creating an order, you might need to include customer details and a list of items, each with its own properties, all within a single input object.
input AddressInput {
street: String!
city: String!
zipCode: String
}
input CustomerInput {
name: String!
email: String!
shippingAddress: AddressInput
}
input CreateOrderInput {
customer: CustomerInput!
items: [OrderItemInput!]!
}
input OrderItemInput {
productId: ID!
quantity: Int!
}Input Types Check
You've learned about GraphQL Input Types and their benefits. Let's test your understanding!
Recap: Input Types Mastered!
Great job! In this lesson, you mastered GraphQL Input Types. You learned how they streamline mutation arguments, making your API cleaner and more maintainable.
- We saw how to define input types in SDL using the
inputkeyword. - Implemented them in Spring Boot resolvers by using DTOs.
- And explored their key benefits like improved readability, reusability, and easier validation.
These are essential for building robust and user-friendly GraphQL APIs! Keep practicing!
常见问题解答
「利用输入类型实现变更」课时是免费的吗？
是的 — 「利用输入类型实现变更」的完整文本可在网页上免费阅读。要进行交互式练习（内置代码编辑器和全天候 AI 导师）并解锁 GraphQL APIs with Spring Boot 课程的其余内容，请升级到 CoddyKit PRO。 GraphQL APIs with Spring Boot 课程共包含 4 节课。
「利用输入类型实现变更」这节课中我会学到什么？
通过定义可复用的输入类型，简化变更参数，使 API 调用更清晰、更有条理。 你通过在浏览器中直接运行的动手代码来练习 GraphQL APIs with Spring Boot，全天候 AI 导师会在你学习这节课的过程中回答你的问题。
学习 GraphQL APIs with Spring Boot 需要有经验吗？
无需任何先前经验。CoddyKit 上的 GraphQL APIs with Spring Boot 课程适合初学者到高级学习者，你可以从这里开始或从头开始，按照自己的节奏学习。 这是第 3 节课，共 4 节。
「利用输入类型实现变更」课时需要多长时间？
大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动，所以你能稳步进步，并在网页和应用中从离开的地方继续。
我能在这节 GraphQL APIs with Spring Boot 课中编写并运行代码吗？
能。每节 GraphQL APIs with Spring Boot 课都包含内置代码编辑器，你可以在浏览器中直接编写并运行真实代码，并获得即时 AI 反馈 — 无需本地设置。
此课程中的所有课时
- 建模嵌套对象与关系
- 实现接口与联合类型
- 利用输入类型实现变更
- 枚举与自定义标量类型