GraphQL 是一个用于 API 的查询语言，是一个使用基于类型系统来执行查询的服务端运行时（类型系统由你的数据定义）。GraphQL 并没有和任何特定数据库或者存储引擎绑定，而是依靠你现有的代码和数据支撑。
可见 GraphQL 的作用类似传统的 Web API 接口（比如 RESTful API），都是提供了一种数据访问的形式，但是在一些场景下有着更好的使用体验，比如：
如果使用 RESTful API 客户端只能固定接收接口设计时返回字段的数据；而 GraphQL 中，客户端可以按需指定要接收哪些字段的数据。所以，面对一些复杂的数据查询可能需要多个 RESTful API 接口，如果使用 GraphQL 只需要一个查询接口就可以实现，因为客户端可以按需接收数据，更加的灵活方便。当然 GraphQL 不只查询，一些修改相关的功能也是没问题的。
准备工作
首先添加 GraphQL 相关的依赖，这里使用 GraphiQL 作为前端图形化工具来访问 graphql 接口：
com.graphql-java-kickstart
graphql-spring-boot-starter
11.1.0
com.graphql-java-kickstart
graphiql-spring-boot-starter
11.1.0
然后就是graphql、graphiql的相关配置了：
server:
port: 8848
graphql:
servlet:
enabled: true
mapping: /graphql
exception-handlers-enabled: true
context-setting: PER_REQUEST_WITH_INSTRUMENTATION
tools:
schema-location-pattern: /graphql/schema.graphqls
graphiql:
mapping: /graphiql
endpoint:
graphql: /graphql
enabled: true
basePath: /
pageTitle: GraphiQL
props:
resources:
query: /graphql/schema.graphqls
variables:
editorTheme: "solarized light"
编写 graphqls 文件
上边application.yml配置文件里引用了一个schema.graphqls文件，里边定义了 graphql 查询、变更相关的接口，以及返回的对象类型、输入的对象类型等。
type Query {
user(name: String!, age: Int!): User
users(input: UserInput): [User]
}
type Mutation {
addUser(input: UserInput!): Result
}
type User {
id: String!
name: String!
age: Int
}
type Result {
code: Int!
msg: String!
}
input UserInput {
name: String!
age: Int
}
-
Query：查询类型，里边定义了查询操作相关的接口 -
Mutation：变更类型，里边定义了变更操作相关的接口 -
User、Result是普通的自定义对象类型，这里用作接口返回值 -
UserInput是一个可以作为接口参数的输入对象类型，User、Result却不可以 -
String、Int则是基础类型，基础类型可以直接作为接口参数 -
name: String!表示字段值不为空 -
[User]表示数组
这里先简单的了解下 GraphQL 的用法，更多的内容可参考官方文档 https://graphql.cn/learn/
对象类型类
在schema.graphqls 中定义了User、Result 、UserInput三个对象类型，还需要给它们定义对应的 Java 类：
// Result .java
@Data
@AllArgsConstructor
public class Result {
private Integer code;
private String msg;
}
// User .java
@Data
@AllArgsConstructor
public class User {
private Long id;
private String name;
private Integer age;
}
// UserInput.java
@Data
public class UserInput {
private String name;
private Integer age;
}
这里用lombok来简化代码！
解析器
前边已经定义好了查询、变更操作的接口，还需要定义对应的解析器来实现对应的接口方法。
实现查询相关的接口需要用到GraphQLQueryResolver：
@Component
public class QueryResolver implements GraphQLQueryResolver {
public User user(String name, Integer age) {
return new User(1L, name, age);
}
public List users(UserInput input) {
List users = new ArrayList<>();
users.add(new User(1L, "aaa", 10));
users.add(new User(2L, "bbb", 11));
return users;
}
}
实现变更相关的接口需要用到GraphQLMutationResolver：
@Slf4j
@Component
public class MutationResolver implements GraphQLMutationResolver {
public Result addUser(UserInput input) {
log.info(input.toString());
return new Result(200, "success");
}
}
这里简单起见直接在内存中创建了一些数据，实际中可以结合各种数据数据存储层技术。
测试
启动项目后，用浏览器访问 http://localhost:8848/graphiql 就可以使用 GraphiQL 来进行测试了：