REST vs. GraphQL vs. gRPC – 选择哪种API?
REST vs. GraphQL vs. gRPC – 选择哪种API?
多年来,REST一直是设计Web API的事实行业标准架构风格。然而,GraphQL和gRPC最近出现,以解决REST的一些限制。每种API方法都带来了巨大的好处和一些权衡。
在本教程中,我们将首先查看每种API设计方法。然后,我们将使用Spring Boot的三种不同方法构建一个简单服务。接下来,我们将通过查看在决定使用其中一种之前应考虑的几个标准来比较它们。
最后,由于没有一种方法适合所有情况,们将看到如何在不同的应用层混合使用不同的方法。
表现层状态转移(REST)是全球最常用的API架构风格。它由Roy Fielding在2000年定义。
2.1. 架构风格
REST不是一个框架或库,而是一种基于URL结构和HTTP协议的接口描述的架构风格。它描述了一个无状态、可缓存、基于约定的客户端-服务器交互架构。它使用URL来定位适当的资源,并使用HTTP方法来表达要执行的操作:
- GET用于获取现有资源或多个资源
- POST用于创建新资源
- PUT用于更新资源或如果不存在则创建它
- DELETE用于删除资源
- PATCH用于部分更新现有资源
REST可以在多种编程语言中实现,并支持JSON和XML等多种数据格式。
2.2. 示例服务
我们可以通过使用@RestController注解定义一个控制器类来在Spring中构建REST服务。接下来,我们通过@GetMapping注解定义一个与HTTP方法相对应的函数,例如GET。最后,在注解参数中,我们提供一个资源路径,该方法应该在该路径上触发:
@GetMapping("/rest/books")
public List````<Book>```` books() {
return booksService.getBooks();
}
MockMvc为Spring中的REST服务提供了集成测试支持。它封装了所有Web应用程序bean,并使它们可用于测试:
this.mockMvc.perform(get("/rest/books"))
.andDo(print())
.andExpect(status().isOk())
.andExpect(content().json(expectedJson));
由于它们基于HTTP,REST服务可以在浏览器中或使用Postman或CURL等工具进行测试:
$ curl http://localhost:8082/rest/books
2.3. 优点和缺点
REST的最大优势是它是技术界最成熟的API架构风格。由于其普及,许多开发人员已经熟悉REST并发现它很容易使用。然而,由于其灵活性,REST可能在开发人员之间有不同的解释。
由于每个资源通常位于一个独特的URL后面,因此很容易监控和限制API。REST还通过利用HTTP使缓存变得简单。通过缓存HTTP响应,我们的客户端和服务器不需要不断地相互交互。
REST容易出现不足和过度获取数据的情况。例如,要获取嵌套实体,我们可能需要发出多个请求。另一方面,在REST API中,通常不可能只获取特定实体数据的一部分。客户端总是接收到请求端点配置返回的所有数据。
3. GraphQL
GraphQL是由Facebook开发的开源API查询语言。
3.1. 架构风格
GraphQL提供了一种用于开发API的查询语言,以及一个框架来满足这些查询。它不依赖于HTTP方法来操作数据,主要只使用POST。相比之下,GraphQL使用查询、变异和订阅:
- 查询用于从服务器请求数据
- 变异用于修改服务器上的数据
- 订阅用于在数据更改时获取实时更新
GraphQL是由客户端驱动的,因为它使客户端能够确切定义他们需要的特定用例的数据。然后,请求的数据在一次往返中从服务器检索。
3.2. 示例服务
在GraphQL中,数据是通过定义对象、它们的字段和类型的模式来表示的。因此,我们将首先为我们的示例服务定义一个GraphQL模式:
type Author {
firstName: String!
lastName: String!
}
type Book {
title: String!
year: Int!
author: Author!
}
type Query {
books: [Book]
}
我们可以像REST服务一样使用@RestController类注解在Spring中构建GraphQL服务。接下来,我们使用@QueryMapping注解标记我们的函数,将其标记为GraphQL数据获取组件:
@QueryMapping
public List````<Book>```` books() {
return booksService.getBooks();
}
HttpGraphQlTester为Spring中的GraphQL服务提供了集成测试支持。它封装了所有Web应用程序bean,并使它们可用于测试:
this.graphQlTester.document(document)
.execute()
.path("books")
.matchesJson(expectedJson);
GraphQL服务可以使用Postman或CURL等工具进行测试。然而,它们需要在POST正文中指定查询:
$ curl -X POST -H "Content-Type: application/json" -d "{\"query\":\"query{books{title}}\"}" http://localhost:8082/graphql
3.3. 优点和缺点
GraphQL对客户端高度灵活,因为它允许获取和仅传递请求的数据。由于没有不必要的数据在网络上传输,GraphQL可以带来更好的性能。
与REST的模糊性相比,GraphQL使用更严格的规范。此外,GraphQL为调试目的提供了详细的错误描述,并在API更改时自动生成文档。
由于每个查询都可以不同,GraphQL打破了中间代理缓存,使得缓存实现更加困难。此外,由于GraphQL查询可能执行大量复杂的服务器端操作,查询通常限制在复杂性上,以避免过载服务器。
4. gRPC
RPC代表远程过程调用,gRPC是由Google创建的高性能、开源的RPC框架。
4.1. 架构风格
gRPC框架基于远程过程调用的客户端-服务器模型。客户端应用程序可以直接调用服务器应用程序上的方法,就像它是一个本地对象一样。它是一种基于合同的严格方法,客户端和服务器都需要访问相同的模式定义。
在gRPC中,一种称为协议缓冲区语言的DSL定义了请求和响应类型。然后,协议缓冲区编译器生成服务器和客户端代码工件。我们可以扩展生成的服务器代码,添加自定义业务逻辑并提供响应数据。
该框架支持几种类型的客户端-服务器交互:
- 传统的请求-响应交互
- 服务器流,其中一个客户端请求可能产生多个响应
- 客户端流,多个客户端请求产生单个响应
客户端和服务器通过使用紧凑的二进制格式的HTTP/2进行通信,这使得gRPC消息的编码和解码非常高效。
4.2. 示例服务
类似于GraphQL,我们首先通过定义一个模式来定义服务、请求和响应,包括它们的字段和类型:
message BooksRequest {}
message AuthorProto {
string firstName = 1;
string lastName = 2;
}
message BookProto {
string title = 1;
AuthorProto author = 2;
int32 year = 3;
}
message BooksResponse {
repeated BookProto book = 1;
}
service BooksService {
rpc books(BooksRequest) returns (BooksResponse);
}
然后,我们需要将我们的协议缓冲区文件传递给协议缓冲区编译器,以生成所需的代码。我们可以选择使用预编译的二进制文件手动执行此操作,或者使用protobuf-maven-plugin将其作为构建过程的一部分:
`<plugin>`
`<groupId>`org.xolstice.maven.plugins`</groupId>`
`<artifactId>`protobuf-maven-plugin`</artifactId>`
`<version>`${protobuf-plugin.version}`</version>`
`<configuration>`
`<protocArtifact>`com.google.protobuf:protoc:${protobuf.version}:exe:${os.detected.classifier}`</protocArtifact>`
`<pluginId>`grpc-java`</pluginId>`
`<pluginArtifact>`io.grpc:protoc-gen-grpc-java:${grpc.version}:exe:${os.detected.classifier}`</pluginArtifact>`
`</configuration>`
`<executions>`
`<execution>`
`<goals>`
``<goal>``compile``</goal>``
``<goal>``compile-custom``</goal>``
`</goals>`
`</execution>`
`</executions>`
`</plugin>`
现在,我们可以扩展生成的BooksServiceImplBase类,使用@GrpcService注解标记它,并覆盖books方法:
@Override
public void books(BooksRequest request, StreamObserver`<BooksResponse>` responseObserver) {
List````<Book>```` books = booksService.getBooks();
BooksResponse.Builder responseBuilder = BooksResponse.newBuilder();
books.forEach(book -> responseBuilder.addBook(GrpcBooksMapper.mapBookToProto(book)));
responseObserver.onNext(responseBuilder.build());
responseObserver.onCompleted();
}
Spring中的gRPC服务集成测试是可能的,但还没有像REST和GraphQL那样成熟:
BooksRequest request = BooksRequest.newBuilder().build();
BooksResponse response = booksServiceGrpc.books(request);
List````<Book>```` books = response.getBookList().stream()
.map(GrpcBooksMapper::mapProtoToBook)
.collect(Collectors.toList());
JSONAssert.assertEquals(objectMapper.writeValueAsString(books), expectedJson, true);
要使此集成测试工作,我们需要使用以下注解标记我们的测试类:
- @SpringBootTest配置客户端连接所谓的gRPC "in process" 测试服务器
- @SpringJUnitConfig准备和提供应用程序bean
- @DirtiesContext确保每次测试后服务器都能正确关闭
Postman最近增加了对gRPC服务的测试支持。类似于CURL,一个名为grpcurl的命令行工具使我们能够与gRPC服务器交互:
$ grpcurl --plaintext localhost:9090 com.baeldung.chooseapi.BooksService/books
这个工具使用JSON编码,使协议缓冲区编码对人类更友好,以便于测试。
4.3. 优点和缺点
gRPC的最大优势是性能,这得益于其紧凑的数据格式、快速的消息编码和解码,以及使用HTTP/2。此外,它的代码生成功能支持多种编程语言,并帮助我们节省了编写样板代码的时间。
通过要求使用HTTP 2和TLS/SSL,gRPC提供了更好的安全默认值和内置的流支持。语言中立的接口合同定义使不同编程语言编写的服务之间能够进行通信。
然而,目前gRPC在开发人员社区中的受欢迎程度远不如REST。它的数据格式对人类来说是不可读的,因此需要额外的工具来分析负载和执行调试。此外,HTTP/2仅在现代浏览器的最新版本中通过TLS支持。
5. 选择哪种API
现在我们已经熟悉了所有三种API设计方法,让我们看看在决定使用其中一种之前应该考虑的几个标准。
5.1. 数据格式
REST在请求和响应数据格式方面是最灵活的方法。我们可以实现REST服务以支持一个或多个数据格式,如JSON和XML。
另一方面,GraphQL定义了自己的查询语言,请数据时需要使用。GraphQL服务以JSON格式响应。尽管可以将响应转换为另一种格式,但这不常见,可能会影响性能。
gRPC框架使用协议缓冲区,这是一种自定义的二进制格式。它对人类来说是不可读的,但也是使gRPC如此高性能的主要原因之一。尽管在几种编程语言中得到支持,但该格式无法定制。
5.2. 数据获取
GraphQL是获取服务器数据最有效的API方法。由于它允许客户端选择要获取的数据,因此通常不会在网络上发送额外的数据。
REST和gRPC都不支持如此高级的客户端查询。因此,除非在服务器上开发和部署了新的端点或过滤器,否则服务器可能会返回额外的数据。
5.3. 浏览器支持
REST和GraphQL API在所有现代浏览器中都得到支持。通常,JavaScript客户端代码用于通过HTTP请求从浏览器发送到服务器API。
gRPC API的浏览器支持不是开箱即用的。然而,gRPC的Web扩展是可用的。它基于HTTP 1.1,但并不提供所有gRPC功能。类似于Java客户端,Web上的gRPC需要浏览器客户端代码从协议缓冲区模式生成gRPC客户端。
5.4. 代码生成
GraphQL需要向像Spring这样的核心框架添加额外的库。这些库增加了处理GraphQL模式、基于注解的编程和服务器处理GraphQL请求的支持。从GraphQL模式生成代码是可能的,但不是必需的。任何与GraphQL模式中定义的类型匹配的自定义POJO都可以使用。
gRPC框架还需要向核心框架添加额外的库,以及强制的代码生成步骤。协议缓冲区编译器生成我们可以扩展的服务器和客户端样板代码。如果我们使用自定义POJO,则需要将它们映射到自动生成的协议缓冲区类型。
REST是一种架构风格,可以使用任何编程语言和各种HTTP库实现。它不使用预定义的模式,也不需要任何代码生成。也就是说,使用Swagger或OpenAPI允许我们定义模式并生成代码(如果需要)。
5.5. 响应时间
由于其优化的二进制格式,gRPC的响应时间比REST和GraphQL显著更快。此外,所有三种方法都可以使用负载均衡来平均分配客户端请求到多个服务器。
然而,gRPC默认使用HTTP 2.0,这使gRPC的延迟低于REST和GraphQL API。使用HTTP 2.0,几个客户端可以同时发送多个请求,而无需建立新的TCP连接。大多数性能测试报告称,gRPC的速度大约比REST快5到10倍。
5.6. 缓存
使用REST进行请求和响应的缓存是简单且成熟的,因为它允许在HTTP级别缓存数据。每个GET请求都暴露了应用程序资源,这些资源可以很容易地被浏览器、代理服务器或CDN缓存。
由于GraphQL默认使用POST方法,每个查询都可以不同,这使得缓存实现更加困难。特别是当客户端和服务器地理位置相距甚远时。解决这个问题的一种可能的变通方法是通过GET进行查询,并使用在服务器上预先计算并存储的持久查询。一些GraphQL中间件服务也提供缓存。
目前,gRPC默认不支持缓存请求和响应。然而,可以实施自定义中间件层来缓存响应。
5.7. 预期用途
REST适合于可以轻松描述为一组资源的领域,而不是操作。使用HTTP方法可以对这些资源执行标准的CRUD操作。通过依赖HTTP语义,它对调用者来说是直观的,这使得它适合于公共接口。REST的良好缓存支持使其适合于具有稳定使用模式和地理分布用户的API。
GraphQL适合于多个客户端需要不同数据集的公共API。因此,GraphQL客户端可以通过标准化的查询语言指定他们想要的确切数据。它也是聚合来自多个来源的数据,然后将其提供给多个客户端的API的良好选择。
gRPC框架适合于开发内部API,其中微服务之间频繁交互。它通常用于从低级代理(如不同的IoT设备)收集数据。然而,其有限的浏览器支持使其难以在面向客户的Web应用程序中使用。
6. 混合搭配
三种API架构风格各有优势。然而,没有一种方法适合所有情况,我们选择哪种方法将取决于我们的用例。
我们不必每次都做出单一选择。我们还可以在我们的解决方案架构中混合搭配不同的风格:

在上面的示例架构图中,我们展示了不同的API风格可能如何应用于不同的应用层。
7. 结论
在本文中,我们探讨了设计Web API的三种流行的架构风格:REST、GraphQL和gRPC。我们查看了每种不同风格的用例,并描述了它们的好处和权衡。
我们探讨了如何使用Spring Boot的所有三种不同方法构建一个简单服务。我们还通过查看在决定方法之前应考虑的几个标准来比较它们。最后,由于没有一种方法适合所有情况,我们看到了如何在不同的应用层中混合搭配不同的方法。
如往常一样,完整的源代码可在GitHub上获得。
OK