stargo

README

Usage

main.go

import (
	"flag"
	"service/app/internal/server"
	pb "your/proto/path/v1"

	"github.com/starfork/stargo"
	"github.com/starfork/stargo/store/mysql"
	"github.com/starfork/stargo/store/redis"
	"google.golang.org/grpc/reflection"
)

func main() {
	cf := flag.String("c", "../../config/debug.yaml", "config file path")
	flag.Parse()
	sc := server.LoadConfig(*cf)
	c := sc.Server
	app := stargo.New(
		stargo.Org("park"),
		stargo.Name("app"),
		stargo.Config(sc.Server),
		stargo.UnaryInterceptor(your inteceprot1),
		stargo.UnaryInterceptor(your inteceprot2),
        ...
	)

	s := app.Server()
	if c.Environment == "debug" {
		reflection.Register(s)
	}
	pb.RegisterAppServer(s, server.New(app))
	app.Run()
}

server/handler.go

type handler struct {
	logger logger.Logger
	c      cache.Cache
	pb.UnimplementedAppServer
}

// New handler
func New(app *stargo.App) *handler {
    rdc:=app.Store("redis").(*redis.Redis).GetInstance()
	h := &handler{
		logger: app.GetLogger(),
		c:      credis.New(rdc),
	}
	return h
}

更多参考 stargo-examples

环境、工具

protobuf 安装

#Debian
apt-get install protobuf-compiler
#Ubuntu
apt-get install protobuf-compiler
#Alpine
apk add protobuf
#Arch Linux
pacman -S protobuf
#Kali Linux
apt-get install protobuf-compiler
#CentOS
yum install protobuf-compiler
#Fedora
dnf install protobuf-compiler

#OS X
brew install protobuf

#Raspbian
apt-get install protobuf-compiler

#Docker
docker run cmd.cat/protoc protoc

环境相关

go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest
go install github.com/favadi/protoc-go-inject-tag@latest
go install github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-grpc-gateway@latest
go install github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-openapiv2@latest
go install golang.org/x/tools/cmd/stringer@latest
go install github.com/infobloxopen/protoc-gen-gorm@latest

工具相关

grpc-client-cli 命令行调试工具

go install github.com/vadimi/grpc-client-cli/cmd/grpc-client-cli@latest

vscocde 插件

go install github.com/yoheimuta/protolint/cmd/protolint@latest

gostar 项目生成工具

go install  github.com/starfork/gostar@latest

相关库

slice 操作相关

https://github.com/starfork/go-slice

加密

https://github.com/starfork/go-crypto

Documentation

Index

• Variables
• type App
  • func New(name string, conf *config.Config) *App
  • func (s *App) Broker() broker.Broker
  • func (s *App) Client() *client.Client
  • func (s *App) Config() *config.Config
  • func (s *App) Init(opt ...Option)
  • func (s *App) Logger(l ...logger.Logger) logger.Logger
  • func (s *App) Registry() naming.Registry
  • func (s *App) Resolver() naming.Resolver
  • func (s *App) Restart()
  • func (s *App) RpcServer() *grpc.Server
  • func (s *App) Run(desc *grpc.ServiceDesc, impl any)
  • func (s *App) Service() naming.Service
  • func (s *App) Stop()
  • func (s *App) Store(name string, st ...store.Store) store.Store
  • func (s *App) Tracer() tracer.Tracer
• type Option
  • func WithAddr(c string) Option
  • func WithServer(opt ...grpc.ServerOption) Option
  • func WithStreamnIterceptor(opt grpc.StreamServerInterceptor) Option
  • func WithTimezome(c string) Option
  • func WithUnaryInterceptor(opt grpc.UnaryServerInterceptor) Option
• type Options
  • func DefaultOptions() *Options

Variables

var Name = "stargo"

Types

type App

type App struct {
	Tz *time.Location
	// contains filtered or unexported fields
}

App App

func New

func New(name string, conf *config.Config) *App

func (*App) Broker

func (s *App) Broker() broker.Broker

func (*App) Client

func (s *App) Client() *client.Client

func (*App) Config

func (s *App) Config() *config.Config

func (*App) Init

func (s *App) Init(opt ...Option)

初始化数据库之类的东西

func (*App) Logger

func (s *App) Logger(l ...logger.Logger) logger.Logger

func (*App) Registry

func (s *App) Registry() naming.Registry

func (*App) Resolver

func (s *App) Resolver() naming.Resolver

func (*App) Restart

func (s *App) Restart()

Restart server

func (*App) RpcServer

func (s *App) RpcServer() *grpc.Server

Server

func (*App) Run

func (s *App) Run(desc *grpc.ServiceDesc, impl any)

func (*App) Service

func (s *App) Service() naming.Service

返回标准服务格式

func (*App) Stop

func (s *App) Stop()

Stop server

func (*App) Store

func (s *App) Store(name string, st ...store.Store) store.Store

获取或者创建一个store

func (*App) Tracer

func (s *App) Tracer() tracer.Tracer

type Option

type Option func(o *Options)

Option Option

func WithAddr

func WithAddr(c string) Option

func WithServer

func WithServer(opt ...grpc.ServerOption) Option

Server option

func WithStreamnIterceptor

func WithStreamnIterceptor(opt grpc.StreamServerInterceptor) Option

StreamInterceptor Stream server interceptor

func WithTimezome

func WithTimezome(c string) Option

func WithUnaryInterceptor

func WithUnaryInterceptor(opt grpc.UnaryServerInterceptor) Option

UnaryInterceptor Unary server interceptor

type Options

type Options struct {
	Addr     string
	Server   *server.Config
	Timezone string
}

Options 参数

func DefaultOptions

func DefaultOptions() *Options

DefaultOptions default options