Go语言微服务框架 - 6.用Google风格的API接口打通MySQL操作

--- micro_web_service            项目目录
 |-- gen                            从idl文件夹中生成的文件，不可手动修改
    |-- idl                             对应idl文件夹
       |-- demo                             对应idl/demo服务
          |-- demo.pb.go                        demo.proto的基础结构
          |-- demo.pb.gw.go                     demo.proto的HTTP接口，对应gRPC-Gateway
          |-- demo_grpc.pb.go                   demo.proto的gRPC接口代码
      |-- order                            新增：对应idl/order服务
          |-- order.pb.go                       新增：order.proto的基础结构
          |-- order.pb.gw.go                    新增：order.proto的HTTP接口，对应gRPC-Gateway
          |-- order_grpc.pb.go                  新增：order.proto的gRPC接口代码
 |-- idl                            原始的idl定义
    |-- demo                            业务package定义
       |-- demo.proto                       protobuffer的原始定义
    |-- order                           新增：业务order定义
       |-- order.proto                      新增：protobuffer的原始定义
 |-- internal                       项目的内部代码，不对外暴露
    |-- config                          配置相关的文件夹
       |-- viper.go                         viper的相关加载逻辑
    |-- dao                             Data Access Object层
       |-- order.go                         更新：Order对象，订单表，实现model层的OrderRepository
       |-- order_test.go                    Order的单元测试
    |-- model                           新增：model层，定义对象的接口方法
       |-- order.go                         新增：OrderRepository接口，具体实现在dao层
    |-- mysql                           MySQL连接
       |-- init.go                          初始化连接到MySQL的工作
    |-- server                          服务器的实现
       |-- demo.go                          server中对demo这个服务的接口实现
       |-- server.go                        server的定义，须实现对应服务的方法
    |-- service                         新增：service层，作为领域实现的核心部分
       |-- order.go                         新增：Order相关的服务，目前仅简单的CRUD
     |-- zlog                            封装日志的文件夹
        |-- zap.go                           zap封装的代码实现
 |-- buf.gen.yaml                   更新：buf生成代码的定义，从v1beta升到v1
 |-- buf.yaml                       更新：buf工具安装所需的工具，从v1beta升到v1
 |-- gen.sh                         buf生成的shell脚本
 |-- go.mod                         Go Module文件
 |-- main.go                        项目启动的main函数

message CreateOrderRequest {
  Order order = 1;
}

message UpdateOrderRequest {
  Order order = 1;
  google.protobuf.FieldMask update_mask = 2;
}

message GetOrderRequest {
  string name = 1;
}

// Order服务
service OrderService {
  rpc ListOrders(ListOrdersRequest) returns (ListOrdersResponse) {
    option (google.api.http) = {
      get: "/v1/orders"
    };
  }

  // 这里body中的order表示HTTP的body里的数据填充到CreateOrderRequest结构中的order对象
  rpc CreateOrder(CreateOrderRequest) returns (Order) {
    option (google.api.http) = {
      post: "/v1/orders"
      body: "order"
    };
  }

  rpc UpdateOrder(UpdateOrderRequest) returns (google.protobuf.Empty) {
    option (google.api.http) = {
      patch: "/v1/orders"
      body: "*"
    };
  }

  // 这里{name=*}表示这个字段填充到GetOrderRequest里的name字段
  rpc GetOrder(GetOrderRequest) returns (Order) {
    option (google.api.http) = {
      get: "/v1/orders/{name=*}"
    };
  }

  rpc DeleteBook(DeleteBookRequest) returns (google.protobuf.Empty) {
    option (google.api.http) = {
      delete: "/v1/books"
    };
  }
}

// Order针对的是 orders 表中的一行数据
// 在这里定义，是为了分离Model与Dao
type Order struct {
 Id    int64
 Name  string
 Price float32
}

// OrderFields 作为一个 数据库Order对象+fields字段的组合
// fields用来指定Order中的哪些字段生效
type OrderFields struct {
 Order  *Order
 Fields []string
}

type OrderRepository interface {
 AddOrder(order *Order) (err error)
 QueryOrders(pageNumber, pageSize int, condition *OrderFields) (orders []Order, err error)
 UpdateOrder(updated, condition *OrderFields) (err error)
}

type OrderRepo struct {
 db *gorm.DB
}

// 将gorm.DB作为一个参数，在初始化时赋值：方便测试时，放一个mock的db
func NewOrderRepo(db *gorm.DB) *OrderRepo {
 return &OrderRepo{db: db}
}

// 定义Service的实现，注意orderRepo的定义是model层的interface
type OrderService struct {
 orderRepo model.OrderRepository
}

// 创建对象，注意orderRepo的实现为dao层代码
func NewOrderService() *OrderService {
 return &OrderService{
  orderRepo: dao.NewOrderRepo(mysql.GormDB),
 }
}

// 以List为例，透传查询
func (orderSvc *OrderService) List(ctx context.Context, pageNumber, pageSize int, condition *model.OrderFields) ([]model.Order, error) {
 orders, err := orderSvc.orderRepo.QueryOrders(pageNumber, pageSize, condition)
 if err != nil {
  return nil, errors.Wrapf(err, "OrderService List pageNumber %d pageSize %d", pageNumber, pageSize)
 }
 return orders, nil
}

// List
curl --request GET 'http://127.0.0.1:8081/v1/orders'

// Create
curl --request POST 'http://127.0.0.1:8081/v1/orders' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "order1",
    "price": 100.3
}'

// Update 这里 order 表示数据，update_mask表示更新的字段是price
curl --request PATCH 'http://127.0.0.1:8081/v1/orders' \
--header 'Content-Type: application/json' \
--data-raw '{
    "order": {
        "id": "1",
        "name": "order1",
        "price": 110.9
    },
    "update_mask": "price"
}'

// Get 查询name=order1的对象
curl --request GET 'http://127.0.0.1:8081/v1/orders/order1'