帶你十天輕鬆搞定 Go 微服務系列（三）

原創 Kevin Wan 2022-01-25 14:27

序言

我們通過一個系列文章跟大家詳細展示一個 go-zero 微服務示例，整個系列分十篇文章，目錄結構如下：

  1. 環境搭建
  2. 服務拆分
  3. 用戶服務（本文）
  4. 產品服務
  5. 訂單服務
  6. 支付服務
  7. RPC 服務 Auth 驗證
  8. 服務監控
  9. 鏈路追蹤
  10. 分佈式事務

期望通過本系列帶你在本機利用 Docker 環境利用 go-zero 快速開發一個商城系統，讓你快速上手微服務。

完整示例代碼：https://github.com/nivin-studio/go-zero-mall

首先，我們來更新一下上篇文章中的服務拆分圖片，由於微信公衆號手機和電腦端不同步，導致美化的圖片沒有跟大家見面，特此補上，如圖：

3 用戶服務（user）

  • 進入服務工作區
$ cd mall/service/user

3.1 生成 user model 模型

  • 創建 sql 文件
$ vim model/user.sql
  • 編寫 sql 文件
CREATE TABLE `user` (
  `id` bigint unsigned NOT NULL AUTO_INCREMENT,
  `name` varchar(255)  NOT NULL DEFAULT '' COMMENT '用戶姓名',
  `gender` tinyint(3) unsigned NOT NULL DEFAULT '0' COMMENT '用戶性別',
  `mobile` varchar(255)  NOT NULL DEFAULT '' COMMENT '用戶電話',
  `password` varchar(255)  NOT NULL DEFAULT '' COMMENT '用戶密碼',
  `create_time` timestamp NULL DEFAULT CURRENT_TIMESTAMP,
  `update_time` timestamp NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
  PRIMARY KEY (`id`),
  UNIQUE KEY `idx_mobile_unique` (`mobile`)
) ENGINE=InnoDB  DEFAULT CHARSET=utf8mb4;
  • 運行模板生成命令
$ goctl model mysql ddl -src ./model/user.sql -dir ./model -c

3.2 生成 user api 服務

  • 創建 api 文件
$ vim api/user.api
  • 編寫 api 文件
type (
  // 用戶登錄
  LoginRequest {
    Mobile   string `json:"mobile"`
    Password string `json:"password"`
  }
  LoginResponse {
    AccessToken  string `json:"accessToken"`
    AccessExpire int64  `json:"accessExpire"`
  }
  // 用戶登錄

  // 用戶註冊
  RegisterRequest {
    Name     string `json:"name"`
    Gender   int64  `json:"gender"`
    Mobile   string `json:"mobile"`
    Password string `json:"password"`
  }
  RegisterResponse {
    Id     int64  `json:"id"`
    Name   string `json:"name"`
    Gender int64  `json:"gender"`
    Mobile string `json:"mobile"`
  }
  // 用戶註冊

  // 用戶信息
  UserInfoResponse {
    Id     int64  `json:"id"`
    Name   string `json:"name"`
    Gender int64  `json:"gender"`
    Mobile string `json:"mobile"`
  }
  // 用戶信息
)

service User {
  @handler Login
  post /api/user/login(LoginRequest) returns (LoginResponse)
  
  @handler Register
  post /api/user/register(RegisterRequest) returns (RegisterResponse)
}

@server(
  jwt: Auth
)
service User {
  @handler UserInfo
  post /api/user/userinfo() returns (UserInfoResponse)
}
  • 運行模板生成命令
$ goctl api go -api ./api/user.api -dir ./api

3.3 生成 user rpc 服務

  • 創建 proto 文件
$ vim rpc/user.proto
  • 編寫 proto 文件
syntax = "proto3";

package userclient;

option go_package = "user";

// 用戶登錄
message LoginRequest {
    string Mobile = 1;
    string Password = 2;
}
message LoginResponse {
    int64 Id = 1;
    string Name = 2;
    int64 Gender = 3;
    string Mobile = 4;
}
// 用戶登錄

// 用戶註冊
message RegisterRequest {
    string Name = 1;
    int64 Gender = 2;
    string Mobile = 3;
    string Password = 4;
}
message RegisterResponse {
    int64 Id = 1;
    string Name = 2;
    int64 Gender = 3;
    string Mobile = 4;
}
// 用戶註冊

// 用戶信息
message UserInfoRequest {
    int64 Id = 1;
}
message UserInfoResponse {
    int64 Id = 1;
    string Name = 2;
    int64 Gender = 3;
    string Mobile = 4;
}
// 用戶信息

service User {
    rpc Login(LoginRequest) returns(LoginResponse);
    rpc Register(RegisterRequest) returns(RegisterResponse);
    rpc UserInfo(UserInfoRequest) returns(UserInfoResponse);
}
  • 運行模板生成命令
$ goctl rpc proto -src ./rpc/user.proto -dir ./rpc

  • 添加下載依賴包

    回到 mall 項目根目錄執行如下命令：

$ go mod tidy

3.4 編寫 user rpc 服務

3.4.1 修改配置文件

  • 修改 user.yaml 配置文件
$ vim rpc/etc/user.yaml
  • 修改服務監聽地址，端口號爲0.0.0.0:9000，Etcd 服務配置，Mysql 服務配置，CacheRedis 服務配置
Name: user.rpc
ListenOn: 0.0.0.0:9000

Etcd:
  Hosts:
  - etcd:2379
  Key: user.rpc

Mysql:
  DataSource: root:123456@tcp(mysql:3306)/mall?charset=utf8mb4&parseTime=true&loc=Asia%2FShanghai

CacheRedis:
- Host: redis:6379
  Type: node
  Pass:

3.4.2 添加 user model 依賴

  • 添加 Mysql 服務配置，CacheRedis 服務配置的實例化
$ vim rpc/internal/config/config.go

package config

import (
  "github.com/tal-tech/go-zero/core/stores/cache"
  "github.com/tal-tech/go-zero/zrpc"
)

type Config struct {
  zrpc.RpcServerConf

  Mysql struct {
    DataSource string
  }
  
  CacheRedis cache.CacheConf
}
  • 註冊服務上下文 user model 的依賴
$ vim rpc/internal/svc/servicecontext.go

package svc

import (
  "mall/service/user/model"
  "mall/service/user/rpc/internal/config"

  "github.com/tal-tech/go-zero/core/stores/sqlx"
)

type ServiceContext struct {
  Config config.Config
    
  UserModel model.UserModel
}

func NewServiceContext(c config.Config) *ServiceContext {
  conn := sqlx.NewMysql(c.Mysql.DataSource)
  return &ServiceContext{
    Config:    c,
    UserModel: model.NewUserModel(conn, c.CacheRedis),
  }
}

3.4.3 添加用戶註冊邏輯 Register

  • 添加密碼加密工具

    在根目錄 common 新建 crypt 工具庫，此工具方法主要用於密碼的加密處理。

$ vim common/cryptx/crypt.go

package cryptx

import (
  "fmt"

  "golang.org/x/crypto/scrypt"
)

func PasswordEncrypt(salt, password string) string {
  dk, _ := scrypt.Key([]byte(password), []byte(salt), 32768, 8, 1, 32)
  return fmt.Sprintf("%x", string(dk))
}
  • 添加密碼加密 Salt 配置
$ vim rpc/etc/user.yaml

Name: user.rpc
ListenOn: 0.0.0.0:9000

...

Salt: HWVOFkGgPTryzICwd7qnJaZR9KQ2i8xe

$ vim rpc/internal/config/config.go

package config

import (
  "github.com/tal-tech/go-zero/core/stores/cache"
  "github.com/tal-tech/go-zero/zrpc"
)

type Config struct {
  ...
  Salt string
}

  • 添加用戶註冊邏輯

    用戶註冊流程，先判斷註冊手機號是否已經被註冊，手機號未被註冊，將用戶信息寫入數據庫，用戶密碼需要進行加密存儲。

$ vim rpc/internal/logic/registerlogic.go

package logic

import (
  "context"

  "mall/common/cryptx"
  "mall/service/user/model"
  "mall/service/user/rpc/internal/svc"
  "mall/service/user/rpc/user"

  "github.com/tal-tech/go-zero/core/logx"
  "google.golang.org/grpc/status"
)

type RegisterLogic struct {
  ctx    context.Context
  svcCtx *svc.ServiceContext
  logx.Logger
}

func NewRegisterLogic(ctx context.Context, svcCtx *svc.ServiceContext) *RegisterLogic {
  return &RegisterLogic{
    ctx:    ctx,
    svcCtx: svcCtx,
    Logger: logx.WithContext(ctx),
  }
}

func (l *RegisterLogic) Register(in *user.RegisterRequest) (*user.RegisterResponse, error) {
  // 判斷手機號是否已經註冊
  _, err := l.svcCtx.UserModel.FindOneByMobile(in.Mobile)
  if err == nil {
    return nil, status.Error(100, "該用戶已存在")
  }

  if err == model.ErrNotFound {

    newUser := model.User{
      Name:     in.Name,
      Gender:   in.Gender,
      Mobile:   in.Mobile,
      Password: cryptx.PasswordEncrypt(l.svcCtx.Config.Salt, in.Password),
    }

    res, err := l.svcCtx.UserModel.Insert(&newUser)
    if err != nil {
      return nil, status.Error(500, err.Error())
    }

    newUser.Id, err = res.LastInsertId()
    if err != nil {
      return nil, status.Error(500, err.Error())
    }

    return &user.RegisterResponse{
      Id:     newUser.Id,
      Name:   newUser.Name,
      Gender: newUser.Gender,
      Mobile: newUser.Mobile,
    }, nil

  }

  return nil, status.Error(500, err.Error())
}

3.4.4 添加用戶登錄邏輯 Login

用戶登錄流程，通過手機號查詢判斷用戶是否是註冊用戶，如果是註冊用戶，需要將用戶輸入的密碼進行加密與數據庫中用戶加密密碼進行對比驗證。

$ vim rpc/internal/logic/loginlogic.go

package logic

import (
  "context"

  "mall/common/cryptx"
  "mall/service/user/model"
  "mall/service/user/rpc/internal/svc"
  "mall/service/user/rpc/user"

  "github.com/tal-tech/go-zero/core/logx"
  "google.golang.org/grpc/status"
)

type LoginLogic struct {
  ctx    context.Context
  svcCtx *svc.ServiceContext
  logx.Logger
}

func NewLoginLogic(ctx context.Context, svcCtx *svc.ServiceContext) *LoginLogic {
  return &LoginLogic{
    ctx:    ctx,
    svcCtx: svcCtx,
    Logger: logx.WithContext(ctx),
  }
}

func (l *LoginLogic) Login(in *user.LoginRequest) (*user.LoginResponse, error) {
  // 查詢用戶是否存在
  res, err := l.svcCtx.UserModel.FindOneByMobile(in.Mobile)
  if err != nil {
    if err == model.ErrNotFound {
      return nil, status.Error(100, "用戶不存在")
    }
    return nil, status.Error(500, err.Error())
  }

  // 判斷密碼是否正確
  password := cryptx.PasswordEncrypt(l.svcCtx.Config.Salt, in.Password)
  if password != res.Password {
    return nil, status.Error(100, "密碼錯誤")
  }

  return &user.LoginResponse{
    Id:     res.Id,
    Name:   res.Name,
    Gender: res.Gender,
    Mobile: res.Mobile,
  }, nil
}

3.4.5 添加用戶信息邏輯 UserInfo

$ vim rpc/internal/logic/userinfologic.go

package logic

import (
  "context"

  "mall/service/user/model"
  "mall/service/user/rpc/internal/svc"
  "mall/service/user/rpc/user"

  "github.com/tal-tech/go-zero/core/logx"
  "google.golang.org/grpc/status"
)

type UserInfoLogic struct {
  ctx    context.Context
  svcCtx *svc.ServiceContext
  logx.Logger
}

func NewUserInfoLogic(ctx context.Context, svcCtx *svc.ServiceContext) *UserInfoLogic {
  return &UserInfoLogic{
    ctx:    ctx,
    svcCtx: svcCtx,
    Logger: logx.WithContext(ctx),
  }
}

func (l *UserInfoLogic) UserInfo(in *user.UserInfoRequest) (*user.UserInfoResponse, error) {
  // 查詢用戶是否存在
  res, err := l.svcCtx.UserModel.FindOne(in.Id)
  if err != nil {
    if err == model.ErrNotFound {
      return nil, status.Error(100, "用戶不存在")
    }
    return nil, status.Error(500, err.Error())
  }

  return &user.UserInfoResponse{
    Id:     res.Id,
    Name:   res.Name,
    Gender: res.Gender,
    Mobile: res.Mobile,
  }, nil
}

3.5 編寫 user api 服務

3.5.1 修改配置文件

  • 修改 user.yaml 配置文件
$ vim api/etc/user.yaml
  • 修改服務地址，端口號爲0.0.0.0:8000，Mysql 服務配置，CacheRedis 服務配置，Auth 驗證配置
Name: User
Host: 0.0.0.0
Port: 8000

Mysql:
  DataSource: root:123456@tcp(mysql:3306)/mall?charset=utf8mb4&parseTime=true&loc=Asia%2FShanghai

CacheRedis:
- Host: redis:6379
  Pass:
  Type: node

Auth:
  AccessSecret: uOvKLmVfztaXGpNYd4Z0I1SiT7MweJhl
  AccessExpire: 86400

3.5.2 添加 user rpc 依賴

  • 添加 user rpc 服務配置
$ vim api/etc/user.yaml

Name: User
Host: 0.0.0.0
Port: 8000

......

UserRpc:
  Etcd:
    Hosts:
    - etcd:2379
    Key: user.rpc
  • 添加 user rpc 服務配置的實例化
$ vim api/internal/config/config.go

package config

import (
  "github.com/tal-tech/go-zero/rest"
  "github.com/tal-tech/go-zero/zrpc"
)

type Config struct {
  rest.RestConf

  Auth struct {
    AccessSecret string
    AccessExpire int64
  }

  UserRpc zrpc.RpcClientConf
}
  • 註冊服務上下文 user rpc 的依賴
$ vim api/internal/svc/servicecontext.go

package svc

import (
  "mall/service/user/api/internal/config"
  "mall/service/user/rpc/userclient"

  "github.com/tal-tech/go-zero/zrpc"
)

type ServiceContext struct {
  Config config.Config
    
  UserRpc userclient.User
}

func NewServiceContext(c config.Config) *ServiceContext {
  return &ServiceContext{
    Config:  c,
    UserRpc: userclient.NewUser(zrpc.MustNewClient(c.UserRpc)),
  }
}

3.5.3 添加用戶註冊邏輯 Register

$ vim api/internal/logic/registerlogic.go

package logic

import (
  "context"

  "mall/service/user/api/internal/svc"
  "mall/service/user/api/internal/types"
  "mall/service/user/rpc/userclient"

  "github.com/tal-tech/go-zero/core/logx"
)

type RegisterLogic struct {
  logx.Logger
  ctx    context.Context
  svcCtx *svc.ServiceContext
}

func NewRegisterLogic(ctx context.Context, svcCtx *svc.ServiceContext) RegisterLogic {
  return RegisterLogic{
    Logger: logx.WithContext(ctx),
    ctx:    ctx,
    svcCtx: svcCtx,
  }
}

func (l *RegisterLogic) Register(req types.RegisterRequest) (resp *types.RegisterResponse, err error) {
  res, err := l.svcCtx.UserRpc.Register(l.ctx, &userclient.RegisterRequest{
    Name:     req.Name,
    Gender:   req.Gender,
    Mobile:   req.Mobile,
    Password: req.Password,
  })
  if err != nil {
    return nil, err
  }

  return &types.RegisterResponse{
    Id:     res.Id,
    Name:   res.Name,
    Gender: res.Gender,
    Mobile: res.Mobile,
  }, nil
}

3.5.4 添加用戶登錄邏輯 Login

  • 添加 JWT 工具

    在根目錄 common 新建 jwtx 工具庫，用於生成用戶 token。

$ vim common/jwtx/jwt.go

package jwtx

import "github.com/golang-jwt/jwt"

func GetToken(secretKey string, iat, seconds, uid int64) (string, error) {
  claims := make(jwt.MapClaims)
  claims["exp"] = iat + seconds
  claims["iat"] = iat
  claims["uid"] = uid
  token := jwt.New(jwt.SigningMethodHS256)
  token.Claims = claims
  return token.SignedString([]byte(secretKey))
}

  • 添加用戶登錄邏輯

    通過調用 user rpc 服務進行登錄驗證，登錄成功後，使用用戶信息生成對應的 token 以及 token 的有效期。

$ vim api/internal/logic/loginlogic.go

package logic

import (
  "context"
  "time"

  "mall/common/jwtx"
  "mall/service/user/api/internal/svc"
  "mall/service/user/api/internal/types"
  "mall/service/user/rpc/userclient"

  "github.com/tal-tech/go-zero/core/logx"
)

type LoginLogic struct {
  logx.Logger
  ctx    context.Context
  svcCtx *svc.ServiceContext
}

func NewLoginLogic(ctx context.Context, svcCtx *svc.ServiceContext) LoginLogic {
  return LoginLogic{
    Logger: logx.WithContext(ctx),
    ctx:    ctx,
    svcCtx: svcCtx,
  }
}

func (l *LoginLogic) Login(req types.LoginRequest) (resp *types.LoginResponse, err error) {
  res, err := l.svcCtx.UserRpc.Login(l.ctx, &userclient.LoginRequest{
    Mobile:   req.Mobile,
    Password: req.Password,
  })
  if err != nil {
    return nil, err
  }

  now := time.Now().Unix()
  accessExpire := l.svcCtx.Config.Auth.AccessExpire

  accessToken, err := jwtx.GetToken(l.svcCtx.Config.Auth.AccessSecret, now, accessExpire, res.Id)
  if err != nil {
    return nil, err
  }

  return &types.LoginResponse{
    AccessToken:  accessToken,
    AccessExpire: now + accessExpire,
  }, nil
}

3.5.5 添加用戶信息邏輯 UserInfo

$ vim api/internal/logic/userinfologic.go

package logic

import (
  "context"
  "encoding/json"

  "mall/service/user/api/internal/svc"
  "mall/service/user/api/internal/types"
  "mall/service/user/rpc/userclient"

  "github.com/tal-tech/go-zero/core/logx"
)

type UserInfoLogic struct {
  logx.Logger
  ctx    context.Context
  svcCtx *svc.ServiceContext
}

func NewUserInfoLogic(ctx context.Context, svcCtx *svc.ServiceContext) UserInfoLogic {
  return UserInfoLogic{
    Logger: logx.WithContext(ctx),
    ctx:    ctx,
    svcCtx: svcCtx,
  }
}

func (l *UserInfoLogic) UserInfo() (resp *types.UserInfoResponse, err error) {
  uid, _ := l.ctx.Value("uid").(json.Number).Int64()
  res, err := l.svcCtx.UserRpc.UserInfo(l.ctx, &userclient.UserInfoRequest{
    Id: uid,
  })
  if err != nil {
    return nil, err
  }

  return &types.UserInfoResponse{
    Id:     res.Id,
    Name:   res.Name,
    Gender: res.Gender,
    Mobile: res.Mobile,
  }, nil
}

通過 l.ctx.Value("uid") 可獲取 jwt token 中自定義的參數

3.6 啓動 user rpc 服務

提示：啓動服務需要在 golang 容器中啓動

$ cd mall/service/user/rpc
$ go run user.go -f etc/user.yaml
Starting rpc server at 127.0.0.1:9000...

3.7 啓動 user api 服務

提示：啓動服務需要在 golang 容器中啓動

$ cd mall/service/user/api
$ go run user.go -f etc/user.yaml
Starting server at 0.0.0.0:8000...

項目地址

https://github.com/zeromicro/go-zero

歡迎使用 go-zero 並 star 支持我們！

微信交流羣

關注『微服務實踐』公衆號並點擊 交流羣 獲取社區羣二維碼。

發表評論
所有評論
還沒有人評論，想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章

致遠OA及相關OA系統集成與二次開發

發現一個名爲臺部落的繁體字網站，一直採集我的個人博客及個人網站的網站，並且在他自己的網站上面創建了一個跟我名稱的賬戶，並把文章標記爲“原創”且沒有標註原文鏈接。實在是無恥至極。 在此作出聲明，本人的文章的發佈地址爲lrach.com（龍淵個

秀常 2024-04-20 14:33:53

EXCEL公式使用總結

1.ROUND 四捨五入的用法(ROUNDUP 向上取整 ROUNDDOWUN 向下取整)

菜鳥你慢慢飛 2024-04-20 14:31:13

常見UserAgent整理

前言 UserAgent作爲客戶端與服務器之間交互的重要標識，對於瞭解用戶設備信息、優化用戶體驗以及網站或應用的兼容性測試等方面都具有重要的意義。通過解析不同的UserAgent，我們可以更好地理解用戶的需求和習慣，提供更個性化、優質的服務

水車 2024-04-20 14:23:32

vscode 的數據庫可視化插件

https://blog.csdn.net/youyudehan/article/details/133357915

張博的博客 2024-04-20 14:21:12

【Python】安裝配置gym

gym是python中的一個強化學習環境，想要完整配置並跑起來坑還是比較多的。 下面記錄一下Windows完整安裝過程，Linux下過程基本類似。 1. 執行pip install gym直接安裝的是0.26.2版本，網上常見的代碼無法兼容

Dsp Tian 2024-04-20 14:12:21

十六進制字符串每隔32個字母換行顯示

  //每32個字節換行打印 public static void formatPrint(String hexStr){ int no = 0; int length = hexStr.length(); for (

tono 2024-04-20 14:11:11

前端使用 Konva 實現可視化設計器（6）

請大家動動小手，給我一個免費的 Star 吧~ 這一章處理一下複製、粘貼、刪除、畫布歸位、層次調整，通過右鍵菜單控制。 github源碼 gitee源碼 示例地址 複製粘貼 複製粘貼（通過快捷鍵） // 複製暫存 pasteC

xachary 2024-04-20 14:09:11

遠程管理HP筆記本

http://t.csdnimg.cn/A8JZl

摩斯電碼 2024-04-20 14:07:01

使用純c#在本地部署多模態模型，讓本地模型也可以理解圖像

之前曾經分享過純c#運行開源本地大模型Mixtral-8x7B 當時使用的是llamasharp這個庫和Mixtral的模型在本地部署和推理，前段時間我看到llamasharp更新到了0.11.1版本，可以支持今年2月份開源的 llava-

a1010 2024-04-20 14:06:31

ROS2筆記6--ROS2常用命令工具

1、ros2 pkg create 功能：創建功能包，創建時指定包名、編譯方式、依賴項等 格式：ros2 pkg create --build-type <ament_python> <pkg_name> ros2 pkg create :

Lucky帥小武 2024-04-20 14:04:30

HttpClient 總是被添加traceparent 請求頭

最近在項目中發現，HttpClient中調用某Api總是出現403的異常，自己使用postman 調用即沒有問題，經排查是HttpClient 會自動添加traceparent請求頭 Accept-Encoding: gzip User-

明天以後 2024-04-20 14:02:50

web server apache tomcat11-10-Class Loader

前言 整理這個官方翻譯的系列，原因是網上大部分的 tomcat 版本比較舊，此版本爲 v11 最新的版本。 開源項目 從零手寫實現 tomcat minicat 別稱【嗅虎】心有猛虎，輕嗅薔薇。 系列文章 web server apac

葉止水 2024-04-20 14:00:50

web server apache tomcat11-08-JNDI Resources

前言 整理這個官方翻譯的系列，原因是網上大部分的 tomcat 版本比較舊，此版本爲 v11 最新的版本。 開源項目 從零手寫實現 tomcat minicat 別稱【嗅虎】心有猛虎，輕嗅薔薇。 系列文章 web server apac

葉止水 2024-04-20 14:00:50

IIS 執行此操作時出錯。 詳細信息:web.config 錯誤，.net core項目

一、IIS 執行此操作時出錯。 詳細信息:web.config 錯誤，.net core項目       運行報錯 錯誤信息提示的很明確：IIS Web Core模塊問題 二、解析： IIS下報錯，但是直接啓動exe文件可以正常運行。

天馬3798 2024-04-20 13:59:40

體系化帶你全面認識 Nginx ！

前言 作爲一名前端開發人員，你是不是經常碰到領導讓你上服務器去修改 Nginx 配置，然而你會以“我是前端，這個我不會”爲理由搪塞過去呢！今天就讓我們一起告別這種尷尬，向“真正”的程序員邁進！！！ 如果本文對你有所幫助，請點個👍 👍 👍

dint 2024-04-20 13:52:49