代码篇从零开始一步步搭建自己的golang框架

Posted 2021-03-14

上篇文章讲到数据库和redis连接的初始化已经完成，接下这篇文章会比较重要一点，我们要启动一个http服务和一个rpc服务，同时抽象出一层数据处理层来封装接口。

开启http服务

老规矩，先添加配置，顺便把rpc的配置也写进去，config.json:

  "http_config": {
    "addr": ":8080"
  },
  "rpc_config": {
    "addr": ":8081"
  }

config.go:

type HttpConfig struct {
    Addr string `json:"addr"`
}

type RpcConfig struct {
    Addr string `json:"addr"`
}

接着，来看看process/http/http.go的内容：

package http

import (
    "github.com/gin-gonic/gin"
    "go.uber.org/zap"
    "os"
)

var engine *gin.Engine

//启动http服务
func StartHttpServer(addr string) {
    engine = gin.Default()
    Route()
    if err := engine.Run(addr); err != nil {
        zap.Error(err)
        os.Exit(1)
    }
}

//路由
func Route() {
    engine.GET("/server_time", GetServerTime)
}

我用了gin来提供http服务，具体路由分发的方法写在了dispatch.go里面，这里写了一个简单的示例接口，获取服务器系统时间：

type Request struct {
}

type Response struct {
    Code int         `json:"code"`
    Msg  string      `json:"msg"`
    Data interface{} `json:"data"`
}

func GetServerTime(ctx *gin.Context) {
    resp := Response{}
    resp.Data, resp.Code, resp.Msg = controller.GetServerTime()
    ctx.JSON(resp.Code, resp)
}

我定义了一个请求结构体和返回结构体来统一一下，请求和返回的数据格式。GetServerTime调用了controller.GetServerTime()方法。我希望有个数据处理层来隔离接口，达到下面这样的效果：

rpc服务

我现在想对外提供rpc服务，和http服务提供一样的数据。我用的是grpc。

使用grpc

1. 从 https://github.com/google/protobuf/releases下载对应的安装包，然后解压，把protoc的执行文件放到PATH里；

2. 安装 golang protobuf
   go get -u github.com/golang/protobuf/proto // golang protobuf 库
   go get -u github.com/golang/protobuf/protoc-gen-go //protoc 转换go工具

3. 安装 gRPC-go
   go get google.golang.org/grpc

编写protobuf文件

我在process/rpc/server目录下，创建了一个server.proto文件来定义接口协议：

syntax = "proto3"; //语法声明

package server; //包名

service Server {
    rpc GetServerTime (ServerTimeRequest) returns (ServerTimeResponse);
}

message ServerTimeRequest {
}

message ServerTimeResponse {
    uint32 code = 1;
    string msg = 2;
    ServerTimeResponseData data = 3;
}

message ServerTimeResponseData {
    uint64 server_time = 1;
}

接着，进到process/rpc/server目录，并执行生成go文件的命令，会生成一个go文件：

$ cd process/rpc/server
$ protoc --go_out=plugins=grpc:. server.proto

然后，我们写一下我们的rpc服务端：

package rpc

import (
    "context"
    "github.com/TomatoMr/awesomeframework/process/controller"
    "github.com/TomatoMr/awesomeframework/process/rpc/server"
    "net"
)
import "google.golang.org/grpc"

type Server struct {
}

//启动rpc服务
func StartRpcServer(addr string) {
    lis, err := net.Listen("tcp", addr)
    if err != nil {

    }
    s := grpc.NewServer() 
    server.RegisterServerServer(s, &Server{})
    if err := s.Serve(lis); err != nil {

    }
}

func (rp *Server) GetServerTime(ctx context.Context, request *server.ServerTimeRequest) (*server.ServerTimeResponse, error) {
    data, code, msg := controller.GetServerTime()
    resp := &server.ServerTimeResponse{}
    respData := &server.ServerTimeResponseData{}
    resp.Msg = msg
    resp.Code = uint32(code)
    respData.ServerTime = uint64(data.ServerTime)
    resp.Data = respData
    return resp, nil
}

调整入口文件

main.go

    //启动http服务
    go http.StartHttpServer(config.GetConfig().HttpConfig.Addr)

    //启动rpc服务
    go rpc.StartRpcServer(config.GetConfig().RpcConfig.Addr)

    logger.GetLogger().Info("Init success.")

    select {}

main.go添加了这几行代码，以go routine启动了http服务和rpc服务，因此，在最后用一个select来阻塞程序退出。

测试一下

写一个rpc客户端的test如下：

package main

import (
    "context"
    "github.com/TomatoMr/awesomeframework/process/rpc/server"
    "google.golang.org/grpc"
    "log"
    "time"
)

const (
    Addr = "127.0.0.1:8081"
)

func main() {
    conn, err := grpc.Dial(Addr, grpc.WithInsecure())
    if err != nil {
        log.Fatalf("did not connect: %v", err)
    }
    defer conn.Close()
    c := server.NewServerClient(conn)

    ctx, cancel := context.WithTimeout(context.Background(), time.Second)
    defer cancel()
    r, _ := c.GetServerTime(ctx, &server.ServerTimeRequest{})

    log.Printf("Data: %v", r.Data.ServerTime)
}

编译：

$ go build

运行：

$ awesomeframework --config=./config/config.json

测试：

$ curl localhost:8080/server_time
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100    56  100    56    0     0  18666      0 --:--:-- --:--:-- --:--:-- 28000
{"code":200,"msg":"","data":{"server_time":1579597891}}

测试rpc接口的文件我放在了process/rpc/test/request.go

$ go run request.go
2020/01/21 17:18:08 Data: 1579598288

小结

至此，我们已经可以用这个简易版的框架来完成我们的工作了，但还有很多东西没有细化，我会继续优化它，完整的代码请见：https://github.com/TomatoMr/awesomeframework。未完待续……

---

欢迎关注我的公众号：onepunchgo，给我留言。