使用rk-boot快速构建企业级Gin和gRPC微服务

rk-boot是一个基于Gin和gRPC的企业级微服务快速开发框架，它提供了许多开箱即用的功能，如配置管理、日志、监控、链路追踪等，可以显著提高开发效率。

安装rk-boot

首先安装rk-boot库：

go get -u github.com/rookie-ninja/rk-boot

快速启动Gin服务

以下是一个最简单的Gin服务示例：

package main

import (
	"context"
	"github.com/rookie-ninja/rk-boot"
	"github.com/rookie-ninja/rk-gin/boot"
)

func main() {
	// 创建启动器
	boot := rkboot.NewBoot()
	
	// 注册Gin服务
	ginEntry := rkgin.GetGinEntry("gin-service")
	ginEntry.Router.GET("/v1/greeting", func(ctx *gin.Context) {
		ctx.JSON(200, gin.H{
			"message": "Hello World!",
		})
	})
	
	// 启动服务
	boot.Bootstrap(context.Background())
	
	// 等待关闭信号
	boot.WaitForShutdownSig(context.Background())
}

快速启动gRPC服务

以下是一个简单的gRPC服务示例：

1. 首先定义proto文件greeter.proto:

syntax = "proto3";

package api.v1;

option go_package = "api/v1;greeter";

service Greeter {
  rpc Hello (HelloRequest) returns (HelloResponse) {}
}

message HelloRequest {
  string name = 1;
}

message HelloResponse {
  string message = 1;
}

1. 实现gRPC服务：

package main

import (
	"context"
	"github.com/rookie-ninja/rk-boot"
	"github.com/rookie-ninja/rk-grpc/boot"
	"google.golang.org/grpc"
)

func main() {
	// 创建启动器
	boot := rkboot.NewBoot()
	
	// 注册gRPC服务
	grpcEntry := rkgrpc.GetGrpcEntry("grpc-service")
	grpcEntry.AddRegFuncGrpc(registerGreeter)
	
	// 启动服务
	boot.Bootstrap(context.Background())
	
	// 等待关闭信号
	boot.WaitForShutdownSig(context.Background())
}

func registerGreeter(server *grpc.Server) {
	api.RegisterGreeterServer(server, &greeterServer{})
}

type greeterServer struct {
	api.UnimplementedGreeterServer
}

func (s *greeterServer) Hello(ctx context.Context, req *api.HelloRequest) (*api.HelloResponse, error) {
	return &api.HelloResponse{
		Message: "Hello " + req.Name,
	}, nil
}

常用功能配置

1. 配置文件

rk-boot使用boot.yaml进行配置：

gin:
  - name: gin-service       # 服务名称
    port: 8080              # 端口
    enabled: true           # 是否启用
    commonService:
      enabled: true         # 启用通用接口

2. 日志配置

logger:
  zap:
    - name: my-logger       # 日志名称
      level: info           # 日志级别
      encoding: console     # 输出格式
      outputPaths: ["logs"] # 输出路径

3. 监控和健康检查

rk-boot自动提供了Prometheus指标和健康检查端点：

• /rk/v1/healthy: 健康检查
• /metrics: Prometheus指标

4. 中间件

rk-boot内置了许多有用的中间件：

ginEntry.Router.Use(rkginauth.AuthMiddleware())
ginEntry.Router.Use(rkginprom.PromMiddleware())
ginEntry.Router.Use(rkgintrace.TraceMiddleware())

完整示例

以下是一个结合了Gin和gRPC的完整示例：

package main

import (
	"context"
	"github.com/gin-gonic/gin"
	"github.com/rookie-ninja/rk-boot"
	"github.com/rookie-ninja/rk-gin/boot"
	"github.com/rookie-ninja/rk-grpc/boot"
	"google.golang.org/grpc"
)

func main() {
	// 创建启动器
	boot := rkboot.NewBoot()
	
	// 注册Gin服务
	ginEntry := rkgin.GetGinEntry("gin-service")
	ginEntry.Router.GET("/v1/greeting", func(ctx *gin.Context) {
		ctx.JSON(200, gin.H{
			"message": "Hello from Gin!",
		})
	})
	
	// 注册gRPC服务
	grpcEntry := rkgrpc.GetGrpcEntry("grpc-service")
	grpcEntry.AddRegFuncGrpc(registerGreeter)
	
	// 启动服务
	boot.Bootstrap(context.Background())
	
	// 等待关闭信号
	boot.WaitForShutdownSig(context.Background())
}

func registerGreeter(server *grpc.Server) {
	api.RegisterGreeterServer(server, &greeterServer{})
}

type greeterServer struct {
	api.UnimplementedGreeterServer
}

func (s *greeterServer) Hello(ctx context.Context, req *api.HelloRequest) (*api.HelloResponse, error) {
	return &api.HelloResponse{
		Message: "Hello " + req.Name + " from gRPC!",
	}, nil
}

总结

rk-boot提供了以下优势：

1. 快速启动Gin和gRPC服务
2. 内置企业级功能：日志、监控、链路追踪等
3. 统一的配置管理
4. 丰富的中间件支持
5. 开箱即用的健康检查和指标收集

通过使用rk-boot，开发者可以专注于业务逻辑的实现，而不必花费大量时间在基础设施的搭建上，大大提高了开发效率。