《高性能Polaris网关》客户端SDK-第01节：网关客户端SDK注解与协议的设计与定义

作者：冰河
星球：http://m6z.cn/6aeFbs (opens new window)
博客：https://binghe.gitcode.host (opens new window)
文章汇总：https://binghe.gitcode.host/md/all/all.html (opens new window)
源码获取地址：https://t.zsxq.com/0dhvFs5oR (opens new window)

沉淀，成长，突破，帮助他人，成就自我。

• 本节难度：★★★☆☆
• 本节重点：对网关客户端SDK的注解与协议进行设计与定义，深入理解其他服务对接高性能Polaris网关SDK的设计与实现。重点掌握整体调用链路的设计思路和设计方法，并能够将其灵活应用到自身实际项目中。

设计并实现网关的核心主体功能后，就需要思考其他服务如何快速高效的对接网关，让网关能够正确将请求路由到对应的服务。在网关的核心设计中，如果其他服务要想对接网关，可以通过网关的SDK将自身服务注册到注册中心，网关从注册中心发现注册的服务后，可以将请求路由到对应的服务。同时，网关的SDK会提供对应的注解，其他服务在自己的类和接口上添加对应的注解后，网关就可以正确识别这些信息，将请求正确路由到接口的同时，也能够执行一定的策略。

一、背景

截止到目前，我们已经完成了网关核心主体功能的设计和开发，包含：通用模型的设计与实现、通用过滤器的设计与实现、通用处理器的设计与实现、核心容器的设计与实现、启动流程的设计与实现、注册中心的设计与实现、负载均衡的设计与实现、增强型负载均衡的设计与实现、配置中心的设计与实现和网关热插拔插件的设计与实现等。

设计并实现网关的核心主体功能后，我们就需要考虑如何让其他服务方便、快速的对接网关，为此，高性能Poalris网关会专门设计对应的客户端SDK来让其他服务方便、快速的对接网关。

二、本节重点

对网关客户端SDK的注解与协议进行设计与定义，深入理解其他服务对接高性能Polaris网关SDK的设计与实现。重点掌握整体调用链路的设计思路和设计方法，并能够将其灵活应用到自身实际项目中。

三、核心类设计

网关客户端SDK注解与协议的类图如图1-1所示。

可以看到，在网关客户端SDK注解与协议的设计中，主要提供了@PolarisService注解、@PolarisInvoker注解、PolarisProtocol枚举和PolarisClientProperties类。其中，@PolarisService注解会依赖PolarisProtocol枚举，实现HTTP、RPC、WEBSOCKET不同协议的路由。

注意：本节只给大家展示网关SDK的核心逻辑，其他代码的实现细节，大家可以自行到本节对应的源码分支进行查看，这里不再赘述。

四、编码实现

本节，就对网关客户端SDK注解与协议进行编码实现，其他代码的实现细节，大家可以自行到本节对应的源码分支进行查看，这里不再赘述

（1）实现@PolarisService注解

@PolarisService注解是标注到类上的注解，主要用来标识当前类接入网关时的一些特定信息。

源码详见：polaris-client-api工程下的io.binghe.polaris.client.api.annotation.PolarisService。

查看完整文章

加入冰河技术 (opens new window)知识星球，解锁完整技术文章、小册、视频与完整代码