# braid-go

**Repository Path**: pojol/braid-go

## Basic Information

- **Project Name**: braid-go
- **Description**: 简单易用的微服务框架
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://docs.braid-go.fun/
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2022-11-16
- **Last Updated**: 2023-09-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Go语言, 微服务, 游戏

## README

## Braid
**Braid** 轻量易读的微服务框架，使用模块化的结构编写，以及提供统一的消息模型。

---

[![Go Report Card](https://goreportcard.com/badge/github.com/pojol/braid-go)](https://goreportcard.com/report/github.com/pojol/braid-go)
[![CI](https://github.com/pojol/braid-go/actions/workflows/actions.yml/badge.svg?branch=develop)](https://github.com/pojol/braid-go/actions/workflows/actions.yml)
[![Coverage Status](https://coveralls.io/repos/github/pojol/braid-go/badge.svg?branch=develop)](https://coveralls.io/github/pojol/braid-go?branch=develop)
[![](https://img.shields.io/badge/sample-%E6%A0%B7%E4%BE%8B-2ca5e0?style=flat&logo=appveyor)](https://github.com/pojol/braidgo-sample)
[![](https://img.shields.io/badge/doc-%E6%96%87%E6%A1%A3-2ca5e0?style=flat&logo=appveyor)](https://docs.braid-go.fun)
[![](https://img.shields.io/badge/slack-%E4%BA%A4%E6%B5%81-2ca5e0?style=flat&logo=slack)](https://join.slack.com/t/braid-world/shared_invite/zt-mw95pa7m-0Kak8lwE3o4KGMaTuxatJw)


# 简介

> 这个图用于描述下面讲述到的几个关键字 `服务` `节点` `模块` `RPC` `Pub-sub`

[![image.png](https://i.postimg.cc/d3GX2X3S/image.png)](https://postimg.cc/CRwTD9J7)

---

> braid 可以通过`模块`的组合，构建出适用于大多数场景的微服务架构，默认提供了如下模块;

* **RPC** - 用于`服务`到`服务`之间的接口调用
* **Pub-sub** - 用于`模块`到`模块`之间的消息发布&接收
* **Discover** - 服务发现，用于感知微服务中各个服务中节点的状态变更（进入，离开，更新权重等，并将变更同步给进程内的其他模块
* **Balancer** - 负载均衡模块，主要用于将 RPC 调用，合理的分配到各个同名服务中
* **Elector** - 选举模块，为注册模块的同名服务，选出一个唯一的主节点
* **Tracer** - 分布式追踪，主要用于监控微服务中程序运行的内部状态
* **Linkcache** - 链路缓存，主要用于维护，传入用户唯一凭证（token，的调用链路，使该 token 的调用 a1->b1->c2 ... 保持不变

### 构建

```go
	
// 创建服务
b, _ := NewService("braid")

// 注册依赖
b.RegisterDepend(
	depend.Logger(),
	depend.Redis(redis.WithAddr(mock.RedisAddr)),
	depend.Tracer(
		tracer.WithHTTP(mock.JaegerAddr),
		tracer.WithProbabilistic(1),
	),
	depend.Consul(
		consul.WithAddress([]string{mock.ConsulAddr}),
	),
)

// 注册模块
b.RegisterModule(
	module.Pubsub(
		pubsub.WithLookupAddr([]string{mock.NSQLookupdAddr}),
		pubsub.WithNsqdAddr([]string{mock.NsqdAddr}, []string{mock.NsqdHttpAddr}),
	),
	module.Client(
		client.AppendInterceptors(grpc_prometheus.UnaryClientInterceptor),
	),
	module.Server(
		server.WithListen(":14222"),
		server.AppendInterceptors(grpc_prometheus.UnaryServerInterceptor),
	),
	module.Discover(),
	module.Elector(
		elector.WithLockTick(3*time.Second)),
	module.LinkCache(
		linkcache.WithMode(linkcache.LinkerRedisModeLocal),
	),
)

b.Init()
b.Run()
defer b.Close()

```

### 使用
* RPC - 
	```go
	// 发起一次 rpc 调用
	err = braid.Client().Invoke(
		ctx,
		"目标服务名 (login",
		"路径 (/login/guest",
		"token (可选，当开启linkcache功能，通过这个凭证可以保证带有凭证的调用链路是一致的",
		body,
		res,
	)
	```
* Pubsub
	```go
	// 订阅一个进程内的主题接收消息并处理
	lc := braid.Pubsub().LocalTopic("topic").Sub("name")
	lc.Arrived(func(msg *pubsub.Message){ 
		/* todo ... */ 
	})
	defer lc.Close()

	// 订阅一个集群中的主题
	cc := braid.ClusterTopic("topic").Sub("name")
	cc.Arrived(func(msg *pubsub.Message){ 
		/* todo ... */
	})
	defer cc.Close()
	```
* Tracer
	```go
	// 在注册阶段将需要用到的 span 注册到 tracer
	b.RegisterDepend(
		depend.Tracer(
			tracer.WithHTTP(jaegerAddr),
			tracer.WithProbabilistic(jaegerProbabilistic),
			tracer.WithSpanFactory(
				tracer.TracerFactory{
					Name:    mspan.Mongo,
					Factory: mspan.CreateMongoSpanFactory(),
				},
			),
		),
	)

	span := braid.Tracer().GetSpan(mspan.Mongo)

	span.Begin(ctx)
	defer span.End()

	// todo ...
	span.SetTag("key", val)
	```

#### **Pub-sub** Benchmark
*  ScopeProc

```shell
$ go test -benchmem -run=^$ -bench ^BenchmarkTestProc -cpu 2,4,8
cpu: 2.2 GHz 4 Cores Intel Core i7
goos: darwin
goarch: amd64
pkg: github.com/pojol/braid-go/modules/mailboxnsq
BenchmarkTestProc-2   4340389   302 ns/op   109 B/op   3 allocs/op
BenchmarkTestProc-4   8527536   151 ns/op   122 B/op   3 allocs/op
BenchmarkTestProc-8   7564869   161 ns/op   118 B/op   3 allocs/op
PASS
```

* ScopeCluster

```shell
$ go test -benchmem -run=^$ -bench ^BenchmarkClusterBroadcast -cpu 2,4,8
腾讯云 4 Cores
goos: linux
goarch: amd64
BenchmarkClusterBroadcast-2   70556   17234 ns/op   540 B/op   16 allocs/op
BenchmarkClusterBroadcast-4   71202   18975 ns/op   676 B/op   20 allocs/op
BenchmarkClusterBroadcast-8   62098   19037 ns/op   662 B/op   20 allocs/op
```