Skip to content

Commit c6ff95a

Browse files
committed
README update for contrib/registry etcd/polaris
1 parent 17ab0e2 commit c6ff95a

File tree

4 files changed

+82
-10
lines changed

4 files changed

+82
-10
lines changed

cmd/gf/internal/cmd/cmd_gen_service.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ type (
2323
SrcFolder string `short:"s" name:"srcFolder" brief:"source folder path to be parsed. default: internal/logic" d:"internal/logic"`
2424
DstFolder string `short:"d" name:"dstFolder" brief:"destination folder path storing automatically generated go files. default: internal/service" d:"internal/service"`
2525
WatchFile string `short:"w" name:"watchFile" brief:"used in file watcher, it generates service go files only if given file is under srcFolder"`
26-
StPattern string `short:"a" name:"stPattern" brief:"regular expression matching struct name for generating service. default: s([A-Z]\\w+)" d:"s([A-Z]\\w+)"`
26+
StPattern string `short:"a" name:"stPattern" brief:"regular expression matching struct name for generating service. default: s([A-Z]\\\w+)" d:"s([A-Z]\\w+)"`
2727
Packages string `short:"p" name:"packages" brief:"produce go files only for given source packages, multiple packages joined with char ','"`
2828
ImportPrefix string `short:"i" name:"importPrefix" brief:"custom import prefix to calculate import path for generated importing go file of logic"`
2929
OverWrite bool `short:"o" name:"overwrite" brief:"overwrite service go files that already exist in generating folder. default: true" d:"true" orphan:"true"`

contrib/registry/etcd/README.MD

+79
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
# GoFrame Etcd Registry
2+
3+
4+
Use `etcd` as service registration and discovery management.
5+
6+
7+
## Installation
8+
```
9+
go get -u -v github.com/gogf/gf/contrib/registry/etcd/v2
10+
```
11+
suggested using `go.mod`:
12+
```
13+
require github.com/gogf/gf/contrib/registry/etcd/v2 latest
14+
```
15+
16+
17+
## Example
18+
19+
### Reference example
20+
21+
[server](example/registry/etcd/server/main.go)
22+
```go
23+
package main
24+
25+
import (
26+
"github.com/gogf/gf/contrib/registry/etcd/v2"
27+
"github.com/gogf/gf/v2/frame/g"
28+
"github.com/gogf/gf/v2/net/ghttp"
29+
"github.com/gogf/gf/v2/net/gsvc"
30+
)
31+
32+
func main() {
33+
gsvc.SetRegistry(etcd.New(`127.0.0.1:2379`))
34+
35+
s := g.Server(`hello.svc`)
36+
s.BindHandler("/", func(r *ghttp.Request) {
37+
g.Log().Info(r.Context(), `request received`)
38+
r.Response.Write(`Hello world`)
39+
})
40+
s.Run()
41+
}
42+
```
43+
44+
[client](example/registry/etcd/client/main.go)
45+
```go
46+
package main
47+
48+
import (
49+
"fmt"
50+
"time"
51+
52+
"github.com/gogf/gf/contrib/registry/etcd/v2"
53+
"github.com/gogf/gf/v2/frame/g"
54+
"github.com/gogf/gf/v2/net/gsel"
55+
"github.com/gogf/gf/v2/net/gsvc"
56+
"github.com/gogf/gf/v2/os/gctx"
57+
)
58+
59+
func main() {
60+
gsvc.SetRegistry(etcd.New(`127.0.0.1:2379`))
61+
gsel.SetBuilder(gsel.NewBuilderRoundRobin())
62+
63+
client := g.Client()
64+
for i := 0; i < 100; i++ {
65+
res, err := client.Get(gctx.New(), `http://hello.svc/`)
66+
if err != nil {
67+
panic(err)
68+
}
69+
fmt.Println(res.ReadAllString())
70+
res.Close()
71+
time.Sleep(time.Second)
72+
}
73+
}
74+
```
75+
76+
## License
77+
78+
`GoFrame etcd` is licensed under the [MIT License](../../../LICENSE), 100% free and open-source, forever.
79+

contrib/registry/polaris/README.MD

+1-8
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
English | [简体中文](README_ZH.MD)
44

5-
Use Polaris mesh as service registration, discovery management and heartbeat reporting
5+
Use `PolarisMesh` as service registration, discovery management and heartbeat reporting.
66

77

88
## Installation
@@ -14,11 +14,6 @@ suggested using `go.mod`:
1414
require github.com/gogf/gf/contrib/registry/polaris/v2 latest
1515
```
1616

17-
## Limitation
18-
```
19-
golang version >= 1.15
20-
```
21-
2217

2318
## Example
2419

@@ -50,7 +45,6 @@ func main() {
5045
})
5146
s.Run()
5247
}
53-
5448
```
5549

5650
[client](example/registry/polaris/client/main.go)
@@ -85,7 +79,6 @@ func main() {
8579
time.Sleep(time.Second)
8680
}
8781
}
88-
8982
```
9083

9184
## License

contrib/registry/polaris/README_ZH.MD

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[English](README.MD) | 简体中文
44

5-
使用Polarismesh作为服务注册、发现管理和心跳上报
5+
使用`PolarisMesh`作为服务注册、发现管理和心跳上报
66

77

88
## Installation

0 commit comments

Comments
 (0)