从零到以搭建一套快速可复用的前后端体系（一）

前言

一个不了解前端的后端不是一个好的程序员，那么在实际业务开发中如何快速开发接口，并且编写最为麻烦的接口文档呢，让我在下面的文章中描述下我的开发历程

基于 go 语言的服务

目录结构

在我所开发的服务中，其实都遵循一个原则那就是模块化，且所有的服务都是按照 go 推荐的目录格式进行设计的

markdown 复制代码

|-- cmd/
| |-- your-app-name/
| |-- main.go
|
|-- internal/
| |-- service/
| |-- ...
| |-- dao/
| |-- ...
|-- api/
| |-- openapi.yaml
|
|-- configs/
| |-- config.yaml
|
|-- scripts/
| |-- ...
|
|--pkg/
|--proto/
|-- test/
| |-- unit/
| | |-- ...
| |-- integration/
| |-- ...
|
|-- .gitignore
|-- README.md
|-- go.mod
|-- go.sum
|-- Dockerfile
|-- Makefile

举个自己项目的实际例子

在我的项目中均是采用这种项目结构进行业务开发的，其中比较重要的目录包括 proto, pkg, internal/service/, internal/dao 目录，包含了业务中的代码生成，接口定义，数据库操作等等

开发我的第一个服务

下面重点来了，大家品鉴下我是如何在项目中进行服务开发一个用户管理服务的。

一、定义接口

在很多 web 服务中，我们需要与前端进行交互。那么前端主要关注的点在于如何在什么情况下使用哪些数据对前端进行渲染。

shell 复制代码

mkdir -r proto/http/usersrv && touch user.proto

定义 proto

proto 复制代码

syntax="proto3";
package tools;

option go_package="pkg/gen/http/usersrv";

message GetUserRQ{}
message GetUserRS{}


service UserService{
  // @method:GET
  rpc GetUser(GetUserRQ)returns(GetUserRS);
}

执行如下代码会生成代码，其中--plugin=protoc-gen-hip=pwd/scripts/protoc-gen-hip 指定 protoc-gen-hip。不指定工具则会默认获取 GOPATH/bin 目录下的工具。

shell 复制代码

protoc --plugin=protoc-gen-hip=`pwd`/scripts/protoc-gen-hip  --proto_path=proto/http/usersrv --hip_out=./ --go_out=./  proto/http/usersrv/user.proto

现在我们已经定义好和前端交互的接口请求参数和返回参数了，现在需要在我们的服务中注册路由并且使用。在我开发的服务中都是使用模块化的。所以我定义了一个接口，所有的业务模块都需要实现

模快接口

go 复制代码

package module

import "github.com/gin-gonic/gin"

type Module interface {
	Run(e *gin.Engine)
}

注册路由 mkdir -r internal/service/usersrv & cd internal/service/usersrv & touch server.go

go 复制代码

package usersrv

import (
	"github.com/GodWY/book-server/internal/module"
	"github.com/GodWY/book-server/pkg/gen/http/usersrv"
	"github.com/gin-gonic/gin"
)

type UserService struct {
}

func (u *UserService) GetUser(ctx *gin.Context, in *usersrv.GetUserRQ) (out *usersrv.GetUserRS, err error) {
	out = &usersrv.GetUserRS{Name: "王哥"}
	return
}

func (u *UserService) Run(e *gin.Engine) {
	usersrv.RegisterUserServiceHttpHandler(e, u)
}

func Module() module.Module {
	return &UserService{}
}

编辑启动代码

创建启动文件

shell 复制代码

cd cmd && mkdir usersrv && touch main.go

编辑代码

go 复制代码

package main

import (
	"github.com/GodWY/book-server/internal/service/usersrv"
	"github.com/gin-gonic/gin"
)

func main() {
	e := gin.New()
	usersrv.Module().Run(e)
	e.Run()
}

启动

shell 复制代码

 go run cmd/usersrv/main.go

访问

shell 复制代码

curl http://localhost:8080/api/userservice/getUser

返回结构

json 复制代码

{
  "code": 0,
  "detail": "success",
  "data": {
  "name": "王哥"
  }
}

总结：

本篇文章作为《从零到以搭建一套快速可复用的前后端体系》的第一篇主要介绍如何创建一个简单的服务，下一期介绍如何在不用编写文档的前提下与前端交互

工具地址

protoc-gen-hip