Go + gRPC-Gateway(V2) 构建微服务实战系列,小程序登录鉴权服务:第一篇(内附开发 demo)

简介: Go + gRPC-Gateway(V2) 构建微服务实战系列,小程序登录鉴权服务:第一篇(内附开发 demo)

简介



小程序可以通过微信官方提供的登录能力方便地获取微信提供的用户身份标识,快速建立小程序内的用户体系。


系列


  1. 云原生 API 网关,gRPC-Gateway V2 初探


业务流程


微信图片_20220611155250.jpg


  • 官方开发接入文档


初始化项目


开发环境


为少 的本地开发环境


go version
# go version go1.14.14 darwin/amd64
protoc --version
# libprotoc 3.15.7
protoc-gen-go --version
# protoc-gen-go v1.26.0
protoc-gen-go-grpc --version
# protoc-gen-go-grpc 1.1.0
protoc-gen-grpc-gateway --version


初始代码结构


使用 go mod init server 初始化 Go 项目,这里(demo)我直接采用 server 作为当前 module 名字。


go-grpc-gateway-v2-microservice


├── auth // 鉴权微服务
│   ├── api
│   ├── ├── gen
│   ├── ├── ├── v1 // 生成的代码将放到这里,v1 表示第一个 API 版本
│   │   ├── auth.proto
│   │   └── auth.yaml
│   ├── auth
│   │   └── auth.go // service 的具体实现
│   ├── wechat 
│   └── main.go // 鉴权 gRPC server
├── gateway // gRPC-Gateway,反向代理到各个 gRPC Server
│   └── main.go
├── gen.sh // 根据 `auth.proto` 生成代码的命令
└── go.mod


领域(auth.proto)定义


syntax = "proto3";
package auth.v1;
option go_package="server/auth/api/gen/v1;authpb";
// 客户端发送一个 code
message LoginRequest {
    string code = 1;
}
// 开发者服务器返回一个自定义登录态(token)
message LoginResponse {
    string access_token = 1;
    int32 expires_in = 2; // 按 oauth2 约定走
}
service AuthService {
    rpc Login (LoginRequest) returns (LoginResponse);
}


使用 gRPC-Gateway 暴露 RESTful JSON API



auth.yaml 定义


type: google.api.Service
config_version: 3
http:
  rules:
  - selector: auth.v1.AuthService.Login
    post: /v1/auth/login
    body: "*"


根据配置生成代码



使用 gen.sh 生成 gRPC-Gateway 相关代码


PROTO_PATH=./auth/api
GO_OUT_PATH=./auth/api/gen/v1
protoc -I=$PROTO_PATH --go_out=paths=source_relative:$GO_OUT_PATH auth.proto
protoc -I=$PROTO_PATH --go-grpc_out=paths=source_relative:$GO_OUT_PATH auth.proto
protoc -I=$PROTO_PATH --grpc-gateway_out=paths=source_relative,grpc_api_configuration=$PROTO_PATH/auth.yaml:$GO_OUT_PATH auth.proto


运行:


sh gen.sh


成功后,会生成 auth.pb.go,auth_grpc.pb.go,auth.pb.gw.go 文件,代码结构如下:


├── auth
│   ├── api
│   ├── ├── gen
│   ├── ├── ├── v1
│   ├── ├── ├── ├── auth.pb.go // 生成的 golang 相关的 protobuf 代码
│   ├── ├── ├── ├── auth_grpc.pb.go  // 生成 golang 相关的 gRPC Server 代码
│   ├── ├── ├── ├── auth.pb.gw.go // 生成 golang 相关的 gRPC-Gateway 代码
│   │   ├── auth.proto
│   │   └── auth.yaml
│   ├── auth
│   │   └── auth.go
│   ├── wechat 
│   └── main.go
├── gateway
│   └── main.go
├── gen.sh
└── go.mod


整理一下包:


go mod tidy


初步实现 Auth gRPC Service Server



实现 AuthServiceServer 接口


我们查看生成 auth_grpc.pb.go 代码,找到 AuthServiceServer 定义:


……
// AuthServiceServer is the server API for AuthService service.
// All implementations must embed UnimplementedAuthServiceServer
// for forward compatibility
type AuthServiceServer interface {
  Login(context.Context, *LoginRequest) (*LoginResponse, error)
  mustEmbedUnimplementedAuthServiceServer()
}
……


我们在 auth/auth/auth.go 进行它的实现:

关键代码解读:


// 定义 Service 结构体
type Service struct {
  Logger         *zap.Logger
  OpenIDResolver OpenIDResolver
  authpb.UnimplementedAuthServiceServer
}
// 这里作为使用者来说做一个抽象
// 定义与微信第三方服务器通信的接口
type OpenIDResolver interface {
  Resolve(code string) (string, error)
}
// 具体的方法实现
func (s *Service) Login(c context.Context, req *authpb.LoginRequest) (*authpb.LoginResponse, error) {
  s.Logger.Info("received code",
    zap.String("code", req.Code))
  // 调用微信服务器,拿到用户的唯一标识 openId 
  openID, err := s.OpenIDResolver.Resolve(req.Code)
  if err != nil {
    return nil, status.Errorf(codes.Unavailable,
      "cannot resolve openid: %v", err)
  }
  // 调试代码,先这样写
  return &authpb.LoginResponse{
    AccessToken: "token for open id " + openID,
    ExpiresIn:   7200,
  }, nil
}


这里有一个非常重要的编程理念,用好可以事半功倍。接口定义由使用者定义而不是实现者,如这里的 OpenIDResolver 接口。


实现 OpenIDResolver 接口


这里用到了社区的一个第三方库,这里主要用来完成开发者服务器向微信服务器换取 用户唯一标识 OpenID 、 用户在微信开放平台帐号下的唯一标识 UnionID(若当前小程序已绑定到微信开放平台帐号) 和 会话密钥 session_key。当然,不用这个库,自己写也挺简单。


go get -u github.com/medivhzhan/weapp/v2


我们在 auth/wechat/wechat.go 进行它的实现:

关键代码解读:


// 相同的 Service 实现套路再来一遍
// AppID & AppSecret 要可配置,是从外面传进来的
type Service struct {
  AppID     string
  AppSecret string
}
func (s *Service) Resolve(code string) (string, error) {
  resp, err := weapp.Login(s.AppID, s.AppSecret, code)
  if err != nil {
    return "", fmt.Errorf("weapp.Login: %v", err)
  }
  if err = resp.GetResponseError(); err != nil {
    return "", fmt.Errorf("weapp response error: %v", err)
  }
  return resp.OpenID, nil
}


配置 Auth Service gRPC Server


auth/main.go


func main() {
  logger, err := zap.NewDevelopment()
  if err != nil {
    log.Fatalf("cannot create logger: %v", err)
  }
    // 配置服务器监听端口
  lis, err := net.Listen("tcp", ":8081")
  if err != nil {
    logger.Fatal("cannot listen", zap.Error(err))
  }
    // 新建 gRPC server
  s := grpc.NewServer()
  // 配置具体 Service
  authpb.RegisterAuthServiceServer(s, &auth.Service{
    OpenIDResolver: &wechat.Service{
      AppID:     "your-app-id",
      AppSecret: "your-app-secret",
    },
    Logger: logger,
  })
  // 对外开始服务
  err = s.Serve(lis)
  if err != nil {
      logger.Fatal("cannot server", zap.Error(err))   
  }
}


初步实现 API Gateway


gateway/main.go


// 创建一个可取消的上下文(如:请求发到一半可随时取消)
c := context.Background()
c, cancel := context.WithCancel(c)
defer cancel()
mux := runtime.NewServeMux(runtime.WithMarshalerOption(
  runtime.MIMEWildcard,
  &runtime.JSONPb{
    MarshalOptions: protojson.MarshalOptions{
      UseEnumNumbers: true, // 枚举字段的值使用数字
      UseProtoNames:  true, 
      // 传给 clients 的 json key 使用下划线 `_`
      // AccessToken string `protobuf:"bytes,1,opt,name=access_token,json=accessToken,proto3" json:"access_token,omitempty"`
      // 这里说明应使用 access_token
    },
    UnmarshalOptions: protojson.UnmarshalOptions{
      DiscardUnknown: true, // 忽略 client 发送的不存在的 poroto 字段
    },
  },
))
err := authpb.RegisterAuthServiceHandlerFromEndpoint(
  c,
  mux,
  "localhost:8081",
  []grpc.DialOption{grpc.WithInsecure()},
)
if err != nil {
  log.Fatalf("cannot register auth service: %v", err)
}
err = http.ListenAndServe(":8080", mux)
if err != nil {
  log.Fatalf("cannot listen and server: %v", err)
}


测试


// 发送 res.code 到后台换取 openId, sessionKey, unionId
wx.request({
  url: "http://localhost:8080/v1/auth/login",
  method: "POST",
  data: { code: res.code },
  success: console.log,
  fail: console.error,
})


微信图片_20220611155359.png

相关文章
|
监控 算法 NoSQL
Go 微服务限流与熔断最佳实践:滑动窗口、令牌桶与自适应阈值
🌟蒋星熠Jaxonic:Go微服务限流熔断实践者。分享基于滑动窗口、令牌桶与自适应阈值的智能防护体系,助力高并发系统稳定运行。
1307 1
Go 微服务限流与熔断最佳实践:滑动窗口、令牌桶与自适应阈值
|
12月前
|
小程序 Java 关系型数据库
基于微信小程序的智慧养老服务系统
本系统基于Java、MySQL和Spring Boot技术,构建高效、安全的养老院管理系统,提升信息处理速度与管理规范性,实现数据自动化备份与网络化管理,助力养老机构信息化升级。
|
算法 Java Go
【GoGin】(1)上手Go Gin 基于Go语言开发的Web框架,本文介绍了各种路由的配置信息;包含各场景下请求参数的基本传入接收
gin 框架中采用的路优酷是基于httprouter做的是一个高性能的 HTTP 请求路由器,适用于 Go 语言。它的设计目标是提供高效的路由匹配和低内存占用,特别适合需要高性能和简单路由的应用场景。
831 4
|
数据采集 数据挖掘 测试技术
Go与Python爬虫实战对比:从开发效率到性能瓶颈的深度解析
本文对比了Python与Go在爬虫开发中的特点。Python凭借Scrapy等框架在开发效率和易用性上占优,适合快速开发与中小型项目;而Go凭借高并发和高性能优势,适用于大规模、长期运行的爬虫服务。文章通过代码示例和性能测试,分析了两者在并发能力、错误处理、部署维护等方面的差异,并探讨了未来融合发展的趋势。
1326 0
|
JavaScript 前端开发 Java
【GoWails】Go做桌面应用开发?本篇文章带你上手Wails框架!一步步带你玩明白前后端双端的数据绑定!
wails是一个可以让你使用Go和Web技术编写桌面应用的项目 可以将它看作Go的快并且轻量级的Electron替代品。可以使用Go的功能,并结合现代化UI完成桌面应用程序的开发
1849 5
|
监控 安全 Go
使用Go语言构建网络IP层安全防护
在Go语言中构建网络IP层安全防护是一项需求明确的任务,考虑到高性能、并发和跨平台的优势,Go是构建此类安全系统的合适选择。通过紧密遵循上述步骤并结合最佳实践,可以构建一个强大的网络防护系统,以保障数字环境的安全完整。
337 12
|
Java Shell Maven
【Azure Container App】构建Java应用镜像时候遇无法编译错误:ERROR [build 10/10] RUN ./mvnw.cmd dependency:go-offline -B -Dproduction package
在部署Java应用到Azure Container App时,构建镜像过程中出现错误:“./mvnw.cmd: No such file or directory”。尽管项目根目录包含mvnw和mvnw.cmd文件,但依然报错。问题出现在Dockerfile构建阶段执行`./mvnw dependency:go-offline`命令时,系统提示找不到可执行文件。经过排查,确认是mvnw文件内容异常所致。最终通过重新生成mvnw文件解决该问题,镜像成功构建。
800 1
|
负载均衡 监控 Java
Spring Cloud Gateway 全解析:路由配置、断言规则与过滤器实战指南
本文详细介绍了 Spring Cloud Gateway 的核心功能与实践配置。首先讲解了网关模块的创建流程,包括依赖引入(gateway、nacos 服务发现、负载均衡)、端口与服务发现配置,以及路由规则的设置(需注意路径前缀重复与优先级 order)。接着深入解析路由断言,涵盖 After、Before、Path 等 12 种内置断言的参数、作用及配置示例,并说明了自定义断言的实现方法。随后重点阐述过滤器机制,区分路由过滤器(如 AddRequestHeader、RewritePath、RequestRateLimiter 等)与全局过滤器的作用范围与配置方式,提
Spring Cloud Gateway 全解析:路由配置、断言规则与过滤器实战指南
|
12月前
|
缓存 JSON NoSQL
别再手写过滤器!SpringCloud Gateway 内置30 个,少写 80% 重复代码
小富分享Spring Cloud Gateway内置30+过滤器,涵盖请求、响应、路径、安全等场景,无需重复造轮子。通过配置实现Header处理、限流、重试、熔断等功能,提升网关开发效率,避免代码冗余。
866 1
|
JSON Java API
利用Spring Cloud Gateway Predicate优化微服务路由策略
Spring Cloud Gateway 的路由配置中,`predicates`​(断言)用于定义哪些请求应该匹配特定的路由规则。 断言是Gateway在进行路由时,根据具体的请求信息如请求路径、请求方法、请求参数等进行匹配的规则。当一个请求的信息符合断言设置的条件时,Gateway就会将该请求路由到对应的服务上。
1908 69
利用Spring Cloud Gateway Predicate优化微服务路由策略