https://github.com/cyj19/sparrow

A simple RPC framework, the sparrow may be small but it has all the vital organs. sparrow意为麻雀，俗话说“麻雀虽小，五脏俱全”，希望该项目也如此，能帮助大家更好地理解RPC原理
https://github.com/cyj19/sparrow

golang

Last synced: about 9 hours ago
JSON representation

A simple RPC framework, the sparrow may be small but it has all the vital organs. sparrow意为麻雀，俗话说“麻雀虽小，五脏俱全”，希望该项目也如此，能帮助大家更好地理解RPC原理

• Host: GitHub
• URL: https://github.com/cyj19/sparrow
• Owner: cyj19
• License: mit
• Created: 2022-02-24T06:44:39.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-05-13T06:28:11.000Z (over 2 years ago)
• Last Synced: 2024-06-20T06:36:05.472Z (5 months ago)
• Topics: golang
• Language: Go
• Homepage:
• Size: 109 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# sparrow

![](https://img.shields.io/badge/Go-v1.17-blue) 

![](https://img.shields.io/github/license/cyj19/sparrow)  

sparrow意为麻雀，俗话说“麻雀虽小，五脏俱全”，希望该项目也如此，能帮助大家更好地理解RPC原理

## RPC调用过程

![rpc流程](https://github.com/cyj19/sparrow/blob/main/pictures/rpc.png)

## 上手指南

以下指南帮助你在本地机器上运行该项目

### 下载项目

```

git clone https://github.com/cyj19/sparrow.git

```

### 运行项目

```

# 进入示例

cd examples/helloworld

# 启动注册中心

cd registry

go run registry.go

# 启动服务端

cd server

go run server.go

# 启动客户端

cd client

go run client.go

```

### 如何使用sparrow

1. 启动注册中心registry  

2. 在服务端引用sparrow的server 

```

import (

    "github.com/cyj19/sparrow/server"

    "github.com/cyj19/sparrow/registry"

)

func main() {

    // 创建rpc服务端

	s := server.NewServer()

	// 注册服务

	s.Register(&HelloWorld{})

	// 向注册中心发送心跳

	registry.HeartBeat("http://localhost:9999/sparrow/registry", "tcp", ":8787", 0)

	// 启动rpc服务端

	err := s.Run(server.UseTCP("0.0.0.0:8787"))

	if err != nil {

		log.Fatalln(err)

	}

}

```

3. 在客户端引用sparrow的client  

```

import (

    "github.com/cyj19/saprrow/client"

    "github.com/cyj19/sparrow/balance"

    "github.com/cyj19/sparrow/discovery"

    )

func main() {

    // discovery用于服务发现

	d := discovery.NewSparrowDiscovery("http://localhost:9999/sparrow/registry", 0, balance.NewRoundRobin())

	// 创建rpc客户端

	c, err := client.NewClient(d)

	if err != nil {

		log.Fatalln(err)

	}

	ctx, _ := context.WithTimeout(context.Background(), 3*time.Minute)

	reqArgs := RequestArg{Name: "cyj19"}

	respReply := ResponseReply{}

	// 远程调用

	err = c.Call(ctx, "HelloWorld", "Hello", &reqArgs, &respReply)

	if err != nil {

		log.Printf("call error:%v", err)

	}

	fmt.Println(respReply)

}

```