在这篇博文中我想谈谈 API,讲一下针对微服务该如何设计 API。
准备工作:
项目源码在这里:
https://github.com/subzero112233/golang-twirp
直到前些年的时候,构建应用程序的首选方法还是做一个单层且不可分割的单元,用它来处理多个互相关联的任务。这就是单体(Monolith)模式。
这种模式在过去是最常见的,如今许多场景下它依旧有很好的效果,并且业内还有很多应用程序都在用它。
但这种方法有一些缺点:
如今,市场要求你不惜一切代价快速行动、打破常规、改变方向、扩大规模并随时待命。为了满足这些要求,软件行业开始采用一种新方法——微服务。
微服务为你带来了一个高度可维护和可测试的软件,它是松散耦合和独立部署的。小型团队可以负责一个或多个微服务,并按照自己的节奏,使用自己选择的语言和框架来开发软件。
我认为,选择单体还是微服务应该视具体情况而定。这里我不会探讨这个问题,但不管怎样每种选项都有自己的优缺点。
一家公司有一个 SaaS 产品,并向用户公开了一个 REST API。随着该产品的发展壮大,他们之前一直在使用的单体架构已经无法满足他们的目标了:
这样的原因还可以有很多。所以他们决定将单体应用拆分为 5 个微服务和一个队列。
stats api 将接收来自不同类型来源的请求,各自请求不同类型的数据。
此外,我们不想给我们的数据库带来太多压力,所以我们在 stats api 和 stats writer 之间放了一个队列,它会以 10 个项目为一组写入数据库。
其他组件会收到诸如“我想对比 Devin Booker 和 Chris Middleton”之类的请求,因此它们必须从数据库中获取数据并做一些高级计算。
这种请求是由用户发起的,必须在几秒钟或更短的时间内返回,因此我们必须让它们保持同步。
开发人员和架构师选择 RESTful API 作为服务之间的通信方式是很常见的,但我想解释为什么 REST 可能是我实在没办法才会考虑的选项之一。
当今最常见的 API 实现是 REST。REST 是 REpresentational State Transfer(表征状态转移)的首字母缩写词。
REST 依赖于一个无状态的客户端 - 服务器协议,其中客户端和服务器是完全分离的(关注点分离)。可以使用缓存来提高网络效率和性能。
REST API 有一个统一的接口,允许应用程序独立演进,而无需应用程序的服务或模型和动作与 API 层本身紧密耦合。
REST API 也是由一些限制组件行为的分层结构组成的,因此每个组件无法看到与其交互的所在层之外的内容。
由于这些原因,REST API 在过去十年中凭借可扩展性、性能和易用性的优势而广受欢迎,几乎所有人都在使用它们。
听起来就该是它了?其实不一定。
除了面向公众的 API 之外,现在的通信完全是内部的、服务到服务的,没有人参与。
当你遇到下列情况时,REST 是一个不错的选择:
但上面这些都不符合我们的情况。
REST API 的代码生成需要你使用第三方工具,并且不受原生支持。这可能会有非常多的局限,例如在 Go 中就没有用于生成完全兼容的 OAS3 客户端的库。
JSON 是迄今为止最流行的 REST API 数据格式,但它有几个限制:
考虑上面的场景,哪种请求方法最适合检索玩家的统计数据呢?
POST /stats/:name
PUT /stats/:name
应该发送哪些标头、查询参数和 / 或请求正文?应该有什么响应?我们如何传达错误?要问的问题太多,要做出的决定也太多了。
开发人员可能需要通读由什么人撰写的 API 文档,并且通常还需要阅读应用程序的代码以了解端点的实际工作方式。
于是我们又要花费很多宝贵的时间。
本质上,RPC 的用途是让一台机器上的程序能够调用网络上另一台机器上的子程序。RPC 更多是关于动作的,而 REST 的重点则在资源上。
RPC 服务可以比 REST 更简单、性能更好,但代价是灵活性和独立性。对于服务到服务的通信来说,这完全不是什么问题。
虽然 Go 中还有其他一些 RPC 框架,但除非我的确没得选,否则我会使用 Twirp,原因如下:
gRPC 应该获得荣誉提名,并且绝对有它自己的用武之地,尤其是当你需要双向流传输、长生命周期连接和客户端负载平衡时。
gRPC 的缺点是你经常会遇到各种问题,需要第三方支持,例如 grpc-gateway、grpc-web 等。
Protobuf 是谷歌编写的一种数据序列化机制,并且越来越流行了。
它是开源的,也是语言和平台中立的。
Protobuf 使用一个二进制传输格式,这意味着它不是人类可读的,但也意味着它会消耗更少的空间和带宽,消耗更少的 CPU。
与其他类型相比,Protobuf 具有以下优势:
为了对比 Twirp 和 REST,我编写了这个基础应用程序,可以通过 RPC 和 REST 发送 / 检索玩家统计数据。
REST 实现很简单,可以在这里找到,我们就跳过它直接来看 twirp。
首先,我们看看 stats.proto 文件:
syntax = "proto3";
import "google/protobuf/timestamp.proto";
option go_package = "./rpc/stats";
package stats;
service StatsService {
rpc AddStats(AddStatsRequest) returns (AddStatsResponse);
rpc GetStats(GetStatsRequest) returns (GetStatsResponse);}
message Stats {
string player_name = 1;
float minutes = 2;
int32 field_goals = 3;
int32 field_goal_attempts = 4;
int32 three_pointers_made = 5;
int32 three_pointer_attempts = 6;
int32 free_throws_made = 7;
int32 free_throw_attempts = 8;
int32 offensive_rebounds = 9;
int32 defensive_rebounds = 10;
int32 assists = 11;
int32 steals = 12;
int32 blocks = 13;
int32 turnovers = 14;
int32 personal_fouls = 15;
int32 points = 16;
string team = 17;
string opponent = 18;
google.protobuf.Timestamp game_date = 19;
}
message AddStatsRequest {
repeated Stats stats = 1;
}
message GetStatsRequest {
string player_name = 1;
}
message AddStatsResponse {
string status = 1;
}
message GetStatsResponse {
repeated Stats stats = 1;
}
该文件以一种结构化格式对我们的消息建模,在这里我们以请求 - 响应格式定义我们的 RPC 服务。例如:AddStats 函数接收 AddStatsRequest 消息,它本质上是一个 Stats 消息的数组,并返回一个 AddStatsResponse 格式的消息,这里就是一个字符串。
为此,我们需要安装这两个生成器:
go install github.com/twitchtv/twirp/protoc-gen-twirp
go install google.golang.org/protobuf/cmd/protoc-gen-go
从 proto 文件中生成.go 文件:
确保 $GOPATH 指向你的 golang 安装目录,在我的例子中是 /usr/local/go。
然后运行:
protoc --proto_path=$GOPATH/src:. --twirp_out=../ --go_out=../ rpc/stats/stats.proto
两个新文件:stats.pb.go 和 stats.twirp.go 包含一个客户端和服务器实用程序。
还有一件很重要的事情需要提一下,我们需要在代码中实现 StatsService 接口。
下面是代码(转换部分没在里面,以突出重点):
package twirphandler
import (
"context"
"net/http"
"time"
"github.com/subzero112233/golang-twirp/entity"
"github.com/subzero112233/golang-twirp/rpc/stats"
"github.com/subzero112233/golang-twirp/usecase/playerstats"
"github.com/twitchtv/twirp"
"google.golang.org/protobuf/types/known/timestamppb"
)
type TwirpHandler struct {
Usecase playerstats.UseCase
}
func NewTwirpHandler(usecase playerstats.UseCase) http.Handler {
t := &TwirpHandler{
Usecase: usecase,
}
return stats.NewStatsServiceServer(t)
}
// errors may not be working well. check this by returning an error from the usecase
func (t *TwirpHandler) GetStats(ctx context.Context, input *stats.GetStatsRequest) (*stats.GetStatsResponse, error) {
var stat entity.Stats
stat.PlayerName = input.PlayerName
data, err := t.Usecase.GetStats(stat.PlayerName)
if err != nil {
return &stats.GetStatsResponse{}, twirp.InternalError(err.Error())
}
statsSlice := convertFromEntity(data)
return &stats.GetStatsResponse{Stats: statsSlice}, nil
}
// errors may not be working well. check this by returning an error from the usecase
func (t *TwirpHandler) AddStats(ctx context.Context, input *stats.AddStatsRequest) (*stats.AddStatsResponse, error) {
e := convertToEntity(input.Stats)
err := t.Usecase.AddStats(e)
if err != nil {
return &stats.AddStatsResponse{}, twirp.InternalError(err.Error())
}
return &stats.AddStatsResponse{Status: "success"}, nil
}
我们看看它是如何工作的。
首先,需要启动服务器。
~ $ go run cmd/main.go
现在发送请求。首先是 AddStats,然后是 GetStats。
我创建了一个示例客户端实现来演示请求:
package main
import (
"context"
"fmt"
"net/http"
"github.com/subzero112233/golang-twirp/rpc/stats"
"github.com/twitchtv/twirp"
"google.golang.org/protobuf/types/known/timestamppb"
)
func main() {
endpoint := "http://localhost:8000"
client := stats.NewStatsServiceProtobufClient(endpoint, &http.Client{})
header := make(http.Header)
ctx := context.Background()
ctx, err := twirp.WithHTTPRequestHeaders(ctx, header)
if err != nil {
return
}
var statz []*stats.Stats
statz = append(statz, &stats.Stats{
PlayerName: "Devin Booker",
Minutes: 44,
FieldGoals: 18,
FieldGoalAttempts: 27,
ThreePointersMade: 6,
ThreePointerAttempts: 10,
FreeThrowsMade: 4,
FreeThrowAttempts: 4,
OffensiveRebounds: 0,
DefensiveRebounds: 5,
Assists: 3,
Steals: 1,
Blocks: 0,
Turnovers: 3,
PersonalFouls: 3,
Points: 55,
Team: "Phoenix Suns",
Opponent: "Milwaukee_Bucks",
GameDate: timestamppb.Now(),
})
respAdd, err := client.AddStats(ctx, &stats.AddStatsRequest{
Stats: statz})
if err != nil {
fmt.Println("AddStats returned an error :", err)
}
fmt.Println(respAdd)
respGet, err := client.GetStats(ctx, &stats.GetStatsRequest{
PlayerName: "Nicolas Batum"})
if err != nil {
fmt.Println("GetStats returned an error :", err)
}
fmt.Println(respGet)
}
如你所见,请求发送就像常规函数调用一样!
~ $ go run example/example.go
status:”success”
stats:{player_name:”Reggie Jackson” minutes:32.9 field_goals:14 field_goal_attempts:20 three_pointers_made:4 three_pointer_attempts:7 free_throws_made:6 free_throw_attempts:6 offensive_rebounds:1 defensive_rebounds:3 assists:6 steals:1 turnovers:2 personal_fouls:3 points:38 game_date:{seconds:1625916051}}
还有很酷的一点是我们也可以使用 curl 来发送请求。调试和初始设置时这非常方便:
echo 'player_name:"Jae Crowder"' \
| protoc --encode stats.GetStatsRequest ./rpc/stats/stats.proto \
| curl -s --request POST \
--header "Content-Type: application/protobuf" \
--data-binary @- \
http://localhost:8000/twirp/stats.StatsService/GetStats \
| protoc --decode stats.GetStatsResponse ./rpc/stats/stats.proto
为了测试性能差异,我创建了两个测试文件(rest_test.go、twirp_test.go):
~ $ go test -bench=. -benchtime=5000x
goos: linux
goarch: amd64
pkg: github.com/subzero112233/golang-twirp
cpu: Intel(R) Core(TM) i7–8550U CPU @ 1.80GHz
BenchmarkRestAdd-8 5000 533270 ns/op
BenchmarkRestGet-8 5000 475062 ns/op
BenchmarkTwirpAdd-8 5000 90284 ns/op
BenchmarkTwirpGet-8 5000 91833 ns/op
PASS
ok github.com/subzero112233/golang-twirp 5.966s
在较小的负载上差异可能会小一些,但也足够明显了,意味着必要时还是应该使用 RPC。
感谢阅读。
本文由哈喽比特于2年以前收录,如有侵权请联系我们。
文章来源:https://mp.weixin.qq.com/s/iaFCf2aTtmXeuOelb--h6A
京东创始人刘强东和其妻子章泽天最近成为了互联网舆论关注的焦点。有关他们“移民美国”和在美国购买豪宅的传言在互联网上广泛传播。然而,京东官方通过微博发言人发布的消息澄清了这些传言,称这些言论纯属虚假信息和蓄意捏造。
日前,据博主“@超能数码君老周”爆料,国内三大运营商中国移动、中国电信和中国联通预计将集体采购百万台规模的华为Mate60系列手机。
据报道,荷兰半导体设备公司ASML正看到美国对华遏制政策的负面影响。阿斯麦(ASML)CEO彼得·温宁克在一档电视节目中分享了他对中国大陆问题以及该公司面临的出口管制和保护主义的看法。彼得曾在多个场合表达了他对出口管制以及中荷经济关系的担忧。
今年早些时候,抖音悄然上线了一款名为“青桃”的 App,Slogan 为“看见你的热爱”,根据应用介绍可知,“青桃”是一个属于年轻人的兴趣知识视频平台,由抖音官方出品的中长视频关联版本,整体风格有些类似B站。
日前,威马汽车首席数据官梅松林转发了一份“世界各国地区拥车率排行榜”,同时,他发文表示:中国汽车普及率低于非洲国家尼日利亚,每百户家庭仅17户有车。意大利世界排名第一,每十户中九户有车。
近日,一项新的研究发现,维生素 C 和 E 等抗氧化剂会激活一种机制,刺激癌症肿瘤中新血管的生长,帮助它们生长和扩散。
据媒体援引消息人士报道,苹果公司正在测试使用3D打印技术来生产其智能手表的钢质底盘。消息传出后,3D系统一度大涨超10%,不过截至周三收盘,该股涨幅回落至2%以内。
9月2日,坐拥千万粉丝的网红主播“秀才”账号被封禁,在社交媒体平台上引发热议。平台相关负责人表示,“秀才”账号违反平台相关规定,已封禁。据知情人士透露,秀才近期被举报存在违法行为,这可能是他被封禁的部分原因。据悉,“秀才”年龄39岁,是安徽省亳州市蒙城县人,抖音网红,粉丝数量超1200万。他曾被称为“中老年...
9月3日消息,亚马逊的一些股东,包括持有该公司股票的一家养老基金,日前对亚马逊、其创始人贝索斯和其董事会提起诉讼,指控他们在为 Project Kuiper 卫星星座项目购买发射服务时“违反了信义义务”。
据消息,为推广自家应用,苹果现推出了一个名为“Apps by Apple”的网站,展示了苹果为旗下产品(如 iPhone、iPad、Apple Watch、Mac 和 Apple TV)开发的各种应用程序。
特斯拉本周在美国大幅下调Model S和X售价,引发了该公司一些最坚定支持者的不满。知名特斯拉多头、未来基金(Future Fund)管理合伙人加里·布莱克发帖称,降价是一种“短期麻醉剂”,会让潜在客户等待进一步降价。
据外媒9月2日报道,荷兰半导体设备制造商阿斯麦称,尽管荷兰政府颁布的半导体设备出口管制新规9月正式生效,但该公司已获得在2023年底以前向中国运送受限制芯片制造机器的许可。
近日,根据美国证券交易委员会的文件显示,苹果卫星服务提供商 Globalstar 近期向马斯克旗下的 SpaceX 支付 6400 万美元(约 4.65 亿元人民币)。用于在 2023-2025 年期间,发射卫星,进一步扩展苹果 iPhone 系列的 SOS 卫星服务。
据报道,马斯克旗下社交平台𝕏(推特)日前调整了隐私政策,允许 𝕏 使用用户发布的信息来训练其人工智能(AI)模型。新的隐私政策将于 9 月 29 日生效。新政策规定,𝕏可能会使用所收集到的平台信息和公开可用的信息,来帮助训练 𝕏 的机器学习或人工智能模型。
9月2日,荣耀CEO赵明在采访中谈及华为手机回归时表示,替老同事们高兴,觉得手机行业,由于华为的回归,让竞争充满了更多的可能性和更多的魅力,对行业来说也是件好事。
《自然》30日发表的一篇论文报道了一个名为Swift的人工智能(AI)系统,该系统驾驶无人机的能力可在真实世界中一对一冠军赛里战胜人类对手。
近日,非营利组织纽约真菌学会(NYMS)发出警告,表示亚马逊为代表的电商平台上,充斥着各种AI生成的蘑菇觅食科普书籍,其中存在诸多错误。
社交媒体平台𝕏(原推特)新隐私政策提到:“在您同意的情况下,我们可能出于安全、安保和身份识别目的收集和使用您的生物识别信息。”
2023年德国柏林消费电子展上,各大企业都带来了最新的理念和产品,而高端化、本土化的中国产品正在不断吸引欧洲等国际市场的目光。
罗永浩日前在直播中吐槽苹果即将推出的 iPhone 新品,具体内容为:“以我对我‘子公司’的了解,我认为 iPhone 15 跟 iPhone 14 不会有什么区别的,除了序(列)号变了,这个‘不要脸’的东西,这个‘臭厨子’。