优秀API的设计原则与实例实现RESTful(6)

简介: 优秀API的设计原则与实例实现RESTful(6)

HTTP/2Protobuf的组合gRPC


gRPC源于被称为StubbyGoogle内部项目,Google内部大量使用Stubby进行服务间通信。作为gRPC的前身,Stubby大量依赖Google的其他基础服务,所以不太方便开放出来给社区使用。随着HTTP/2的逐步成熟,2015Google开源了gRPC框架。截至201712gRPC已经发布了1.7.3版本,并且CNCF(云原生计算基金会)收录。gRPCETCD/Kubernetes上得到了大量使用。


gRPC是基于HTTP/2设计的,因此也继承了HTTP/2相应的诸多特性,这些特性使得其在移动设备上表现得更好,更节省空间、更省电。gRPC目前提供的CJavaGo语言版本分别是grpcgrpc-javagrpc-go,其中C版本支持CC++Node.jsPythonRubyObjective-CPHPC#


说了这么多,gRPC到底能够给我们提供哪些优势呢?


· gRPC默认使用Protobuf进行序列化和反序列化,而Protobuf是已经被证明的高效的序列化方式,因此,gRPC的序列化性能是可以得到保障的。


· gRPC默认采用HTTP/2进行传输。HTTP/2支持流(streaming),在批量发送数据的场景下使用流可以显著提升性能——服务端和客户端在接收数据的时候,可以不必等所有的消息全收到后才开始响应,而是在接收到第一条消息的时候就可以及时响应。例如,客户端向服务端发送了一千条update消息,服务端不必等到所有消息接收完毕才开始处理,而是一边接收一边处理。这显然比以前的类HTTP 1.1的方式提供的响应更快、性能更优。gRPC的流可以分为三类:客户端流式发送、服务器流式返回,以及客户端/服务器同时流式处理,也就是单向流和双向流。在我写这本书的时候,Dubbo 3.0正在酝酿中,其中一个显著的变化是新版本将以streaming为内核,而不再是2.0时代的RPC,目的是去掉一切阻塞。


· 基于HTTP/2协议很容易实现负载均衡及流控的方案,可以利用Header做很多事情。

同时,gRPC也不是完美的。相比于非IDL描述的RPC(例如HessionKyro)方式,定义proto文件是一个比较麻烦的事情,而且需要额外安装客户端、插件等。另外HTTP/2相比于基于TCP的通信协议,性能上也有显著的差距。


下面通过一个简单的例子来理解一下gRPC的使用方式。假设我们要开发电商中的产品服务,通过id获取产品的信息,主要步骤及实现代码如下。


1)定义proto文件。


syntax = "proto3";//声明支持的版本是proto3
option java_multiple_files = true;//以外部类模式生成
option java_package = "com.cloudnative.grpc";//声明包名,可选
option java_outer_classname="ProductProtos";//声明类名,可选
message ProductRequest{
    int32 id = 1;
}
message ProductResponse {
    int32 id = 1;
    string name  = 2;
    string price = 3;
}
service ProductService{
    rpc GetProduct(ProductRequest) returns(ProductResponse);
}


2)生成相关类。可以采用Protobuf中介绍的方法,在命令行执行protoc生成相关代码。如果使用Maven,则可以通过Maven插件实现。


<build>
    <extensions>
        <extension>
            <groupId>kr.motd.maven</groupId>
            <artifactId>os-maven-plugin</artifactId>
            <version>1.5.0.Final</version>
        </extension>
    </extensions>
    <plugins>
        <plugin>
            <groupId>org.xolstice.maven.plugins</groupId>
            <artifactId>protobuf-maven-plugin</artifactId>
            <version>0.5.0</version>
            <configuration>
        <protocArtifact>com.google.protobuf:3.5.1:exe:${os.detected.classifier} </protocArtifact>
                <pluginId>grpc-java</pluginId>
               <pluginArtifact>io.grpc:protoc-gen-grpc-java:1.8.0:exe:${os.detected. classifier}</pluginArtifact>
                <protocExecutable>/usr/local/bin/protoc</protocExecutable>
            </configuration>
            <executions>
                <execution>
                    <goals>
                        <goal>compile</goal>
                        <goal>compile-custom</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>


pom.xml中配置,并且执行mvn compile命令会在target/generated-sources中生成相关类,可以将相关类移到src /main/java目录下备用。

3)服务端实现代码。一是,实现ProductService

public class GRPCServer{
    private static final Logger logger = Logger.getLogger(GRPCServer.class.getName());
    private final int port;
    private final Server server;
    public GRPCServer(int port){
        this.port=port;
        this.server = ServerBuilder.forPort(port)
                .addService(new ProductService())
                .build();
    }
    /** Start serving requests. */
    public void start() throws IOException {
        this.server.start();
        logger.info("Server started, listening on " + port);
        Runtime.getRuntime().addShutdownHook(new Thread() {
            @Override
            public void run() {
                // Use stderr here since the logger may has been reset by its JVM shutdown hook.
                logger.info("*** shutting down gRPC server since JVM is shutting down");
                GRPCServer.this.stop();
                logger.info("*** server shut down");
            }
        });
    }
    /** Stop serving requests and shutdown resources. */
    public void stop() {
        if (server != null) {
            server.shutdown();
        }
    }
    /**
     * Await termination on the main thread since the grpc library uses daemon threads.
     */
    private void blockUntilShutdown() throws InterruptedException {
        if (server != null) {
            server.awaitTermination();
        }
    }
    /**
     * Main method.  This comment makes the linter happy.
     */
    public static void main(String[] args) throws Exception {
        GRPCServer server = new GRPCServer(8888);
        server.start();
        server.blockUntilShutdown();
    }
}


4)客户端实现代码。


public class GRPCClient {
    private static final Logger logger = Logger.getLogger(GRPCServer.class.getName());
    public static void main(String[] args) {
        ManagedChannel channel = ManagedChannelBuilder.forAddress("localhost", 8888)
                .usePlaintext(true)
                .build();
        ProductServiceGrpc.ProductServiceBlockingStub blockStub=ProductServiceGrpc.newBlockingStub(channel);
        ProductResponse response=blockStub.getProduct(ProductRequest.newBuilder().setId(111).build());
        logger.info(response.getName());
     response=blockStub.getProduct(ProductRequest.newBuilder().setId(2).build());
        logger.info(response.getName());
    }
}


上面是一个简单的实现,关于流式RPC可以参考官方的例子。

 

本文节选自《持续演进的Cloud Native:云原生架构下微服务最佳实践》一书,王启军 著。电子工业出版社出版。


public class ProductService extends ProductServiceGrpc.ProductServiceImplBase{
    private static final Logger logger = Logger.getLogger(GRPCServer.class.getName());
    @Override
    public void getProduct(ProductRequest request, StreamObserver<ProductResponse> responseObserver) {
        logger.info("接收到客户端的信息:"+request.getId());
        ProductResponse responsed;
        if (111==request.getId()){
            responsed=ProductResponse.newBuilder().setId(111).setName ("dddd").build();
        }else {
            responsed=ProductResponse.newBuilder().setId(0).setName("---").build();
        }
        responseObserver.onNext(responsed);
        responseObserver.onCompleted();
    }
}


二是实现server代码。



相关文章
|
1月前
|
JSON JavaScript 前端开发
深入浅出Node.js:从零开始构建RESTful API
在数字化时代的浪潮中,后端开发作为连接用户与数据的桥梁,扮演着至关重要的角色。本文将引导您步入Node.js的奇妙世界,通过实践操作,掌握如何使用这一强大的JavaScript运行时环境构建高效、可扩展的RESTful API。我们将一同探索Express框架的使用,学习如何设计API端点,处理数据请求,并实现身份验证机制,最终部署我们的成果到云服务器上。无论您是初学者还是有一定基础的开发者,这篇文章都将为您打开一扇通往后端开发深层知识的大门。
57 12
|
2月前
|
XML JSON 缓存
深入理解RESTful API设计原则与实践
在现代软件开发中,构建高效、可扩展的应用程序接口(API)是至关重要的。本文旨在探讨RESTful API的核心设计理念,包括其基于HTTP协议的特性,以及如何在实际应用中遵循这些原则来优化API设计。我们将通过具体示例和最佳实践,展示如何创建易于理解、维护且性能优良的RESTful服务,从而提升前后端分离架构下的开发效率和用户体验。
|
2月前
|
监控 安全 API
深入浅出:构建高效RESTful API的最佳实践
在数字化时代,API已成为连接不同软件和服务的桥梁。本文将带你深入了解如何设计和维护一个高效、可扩展且安全的RESTful API。我们将从基础概念出发,逐步深入到高级技巧,让你能够掌握创建优质API的关键要素。无论你是初学者还是有经验的开发者,这篇文章都将为你提供实用的指导和启示。让我们一起探索API设计的奥秘,打造出色的后端服务吧!
|
2月前
|
JSON 缓存 测试技术
构建高效RESTful API的后端实践指南####
本文将深入探讨如何设计并实现一个高效、可扩展且易于维护的RESTful API。不同于传统的摘要概述,本节将直接以行动指南的形式,列出构建RESTful API时必须遵循的核心原则与最佳实践,旨在为开发者提供一套直接可行的实施框架,快速提升API设计与开发能力。 ####
|
2月前
|
JSON API 开发者
深入理解RESTful API设计原则
在数字化时代,API已成为连接不同软件应用的桥梁。本文旨在探讨RESTful API设计的基本原则和最佳实践,帮助开发者构建高效、可扩展的网络服务接口。通过解析REST架构风格的核心概念,我们将了解如何设计易于理解和使用的API,同时保证其性能和安全性。
|
2月前
|
存储 缓存 API
深入理解RESTful API设计原则
在现代软件开发中,RESTful API已成为前后端分离架构下不可或缺的通信桥梁。本文旨在探讨RESTful API的核心设计原则,包括资源导向、无状态、统一接口、以及可缓存性等,并通过实例解析如何在实际应用中遵循这些原则来构建高效、可维护的API接口。我们将深入分析每个原则背后的设计理念,提供最佳实践指导,帮助开发者优化API设计,提升系统整体性能和用户体验。
42 0
|
2月前
|
安全 测试技术 API
构建高效RESTful API:后端开发的艺术与实践####
在现代软件开发的浩瀚星空中,RESTful API如同一座桥梁,连接着前端世界的绚丽多彩与后端逻辑的深邃复杂。本文旨在探讨如何精心打造一款既高效又易于维护的RESTful API,通过深入浅出的方式,剖析其设计原则、实现技巧及最佳实践,为后端开发者提供一份实用的指南。我们不深入晦涩的理论,只聚焦于那些能够即刻提升API品质与开发效率的关键点,让你的API在众多服务中脱颖而出。 ####
39 0
|
2月前
|
JSON 缓存 JavaScript
深入浅出:使用Node.js构建RESTful API
在这个数字时代,API已成为软件开发的基石之一。本文旨在引导初学者通过Node.js和Express框架快速搭建一个功能完备的RESTful API。我们将从零开始,逐步深入,不仅涉及代码编写,还包括设计原则、最佳实践及调试技巧。无论你是初探后端开发,还是希望扩展你的技术栈,这篇文章都将是你的理想指南。
|
2月前
|
JavaScript NoSQL API
深入浅出Node.js:从零开始构建RESTful API
在数字化时代的浪潮中,后端开发如同一座灯塔,指引着数据的海洋。本文将带你航行在Node.js的海域,探索如何从一张白纸到完成一个功能完备的RESTful API。我们将一起学习如何搭建开发环境、设计API结构、处理数据请求与响应,以及实现数据库交互。准备好了吗?启航吧!
|
2月前
|
JSON API 数据格式
探索后端开发:从零构建简易RESTful API
在数字时代的浪潮中,后端开发如同搭建一座桥梁,连接着用户界面与数据世界。本文将引导读者步入后端开发的殿堂,通过构建一个简易的RESTful API,揭示其背后的逻辑与魅力。我们将从基础概念出发,逐步深入到实际操作,不仅分享代码示例,更探讨如何思考和解决问题,让每一位读者都能在后端开发的道路上迈出坚实的一步。