Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fea dev #1

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.settings/*
.settings
.project
.env
.idea/
.git/
*.log
*.patch
.phpintel/
runtime/
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
# openjob-go
# openjob-go

> [中文说明](README.zh-CN.md) | [English](README.md)
23 changes: 23 additions & 0 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# openjob-go

> [中文说明](README.zh-CN.md) | [English](README.md)

提供 Go 对接 openjob-server 的基础封装。

## HTTP API

### 对接 server API

- 注册客户端 API: /server/register
- 客户端下线 API: /server/unregister
- 上报心跳 API: /server/heartbeat
- 上报执行状态/结果
- 上报执行日志
- 拉取主题信息

### 提供 client API

提供 client API 让 openjob-server 调用

- 响应检查
- 接收任务
7 changes: 7 additions & 0 deletions go.mod
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
module openjob-go

go 1.18

require github.com/gookit/goutil v0.6.11

require golang.org/x/text v0.11.0 // indirect
7 changes: 7 additions & 0 deletions go.sum
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
github.com/gookit/color v1.5.3 h1:twfIhZs4QLCtimkP7MOxlF3A0U/5cDPseRT9M/+2SCE=
github.com/gookit/goutil v0.6.11 h1:615nIGRpQHFmgJ1oaA48q/z7bTx6KzMvHmKTsp21T2E=
github.com/gookit/goutil v0.6.11/go.mod h1:bU9ghaM9uW23x2+jB0WcywRsFGbIP0hvdIKYl2OMiog=
github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e h1:JVG44RsyaB9T2KIHavMF/ppJZNG9ZpyihvCd0w101no=
golang.org/x/sys v0.10.0 h1:SqMFp9UcQJZa+pmYuAKjd9xq1f0j5rLcDIk0mj4qAsA=
golang.org/x/text v0.11.0 h1:LAntKIrcmeSKERyiOh0XMV39LXS8IE9UL2yP7+f5ij4=
golang.org/x/text v0.11.0/go.mod h1:TvPlkZtksWOMsz7fbANvkp4WM8x/WCo/om8BMLbz+aE=
63 changes: 63 additions & 0 deletions ojclient/client.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
package ojclient

const (
ServerRegisterPath = "/server/register"
ServerUnregisterPath = "/server/unregister"
ServerHeartbeatPath = "/server/heartbeat"
ServerSubmitLogsPath = "/server/submit-logs"
ServerFetchTopicPath = "/server/fetch-topic"
ServerReportStatusPath = "/server/report-status"
)

// Config of client
type Config struct {
ServerAddr string
}

func NewConfig() *Config {
return &Config{}
}

// Client of openjob-server
type Client struct {
cfg *Config
}

// New client instance
func New() *Client {
return &Client{}
}

// BuildAPI of request server
func (c *Client) BuildAPI(path string) string {
return c.cfg.ServerAddr + path
}

func (c *Client) Start(cfg *Config) error {
c.cfg = cfg

// register
err := c.Register()
if err != nil {
return err
}

// fetch topic
err = c.FetchTopic()
if err != nil {
return err
}

// start task queue

return nil
}

// Stop client
func (c *Client) Stop() {

}

func Start(cfg *Config) error {
return New().Start(cfg)
}
37 changes: 37 additions & 0 deletions ojclient/dto.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
package ojclient

type RegisterReq struct {
}

type RegisterResp struct {
}

type UnregisterReq struct {
}

type UnregisterResp struct {
}

type HeartbeatReq struct {
}

type HeartbeatResp struct {
}

type SubmitLogsReq struct {
}

type SubmitLogsResp struct {
}

type FetchTopicReq struct {
}

type FetchTopicResp struct {
}

type ReportStatusReq struct {
}

type ReportStatusResp struct {
}
117 changes: 117 additions & 0 deletions ojclient/server_apis.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
package ojclient

import "github.com/gookit/goutil/netutil/httpreq"

// Register client to server
func (c *Client) Register() error {
reqData := &RegisterReq{}
reqUrl := c.BuildAPI(ServerRegisterPath)

resp, err := httpreq.Post(reqUrl, reqData, httpreq.WithJSONType)
if err != nil {
return err
}

respData := &RegisterResp{}
err = httpreq.NewResp(resp).BindJSON(respData)
if err != nil {
return err
}

return nil
}

// Unregister client from server
func (c *Client) Unregister() error {
reqData := &UnregisterReq{}
reqUrl := c.BuildAPI(ServerUnregisterPath)

resp, err := httpreq.Post(reqUrl, reqData, httpreq.WithJSONType)
if err != nil {
return err
}

respData := &UnregisterResp{}
err = httpreq.NewResp(resp).BindJSON(respData)
if err != nil {
return err
}

return nil
}

// Heartbeat send heartbeat to server
func (c *Client) Heartbeat() error {
reqData := &HeartbeatReq{}
reqUrl := c.BuildAPI(ServerHeartbeatPath)

resp, err := httpreq.Post(reqUrl, reqData, httpreq.WithJSONType)
if err != nil {
return err
}

respData := &HeartbeatResp{}
err = httpreq.NewResp(resp).BindJSON(respData)
if err != nil {
return err
}

return nil
}

// SubmitLogs submit task logs
func (c *Client) SubmitLogs() error {
reqData := &SubmitLogsReq{}
reqUrl := c.BuildAPI(ServerSubmitLogsPath)

resp, err := httpreq.Post(reqUrl, reqData, httpreq.WithJSONType)
if err != nil {
return err
}

respData := &SubmitLogsResp{}
err = httpreq.NewResp(resp).BindJSON(respData)
if err != nil {
return err
}

return nil
}

// FetchTopic client API
func (c *Client) FetchTopic() error {
reqData := &FetchTopicReq{}
reqUrl := c.BuildAPI(ServerFetchTopicPath)

resp, err := httpreq.Post(reqUrl, reqData, httpreq.WithJSONType)
if err != nil {
return err
}

respData := &FetchTopicResp{}
err = httpreq.NewResp(resp).BindJSON(respData)
if err != nil {
return err
}

return nil
}

// ReportStatus report task status
func (c *Client) ReportStatus() error {
reqData := &ReportStatusReq{}
reqUrl := c.BuildAPI(ServerReportStatusPath)

resp, err := httpreq.Post(reqUrl, reqData, httpreq.WithJSONType)
if err != nil {
return err
}

respData := &ReportStatusResp{}
err = httpreq.NewResp(resp).BindJSON(respData)
if err != nil {
return err
}

return nil
}
15 changes: 15 additions & 0 deletions webapi/handlers.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
package webapi

import "net/http"

// ReplayStatus API
func ReplayStatus(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(200)
w.Write([]byte("ok"))
}

// ReceiveTask API, receive task from server
func ReceiveTask(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(200)
w.Write([]byte("ok"))
}
7 changes: 7 additions & 0 deletions webapi/webapi.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
package webapi

import "net/http"

func RegisterToMux(mux *http.ServeMux) {

}