# Ngo

**Repository Path**: cygsxak/Ngo

## Basic Information

- **Project Name**: Ngo
- **Description**: Ngo是一个类似Java Spring Boot的框架，全部使用Go语言开发，主要目标是： 提供比原有Java框架更高的性能和更低的资源占用率 尽量为业务开发者提供所需的全部工具库
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: https://www.oschina.net/p/ngo
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 3
- **Created**: 2021-12-04
- **Last Updated**: 2022-06-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# [Ngo](https://github.com/NetEase-Media/ngo)

## 简介
Ngo是一个类似Java Spring Boot的框架，全部使用Go语言开发，主要目标是：
- 提供比原有Java框架更高的性能和更低的资源占用率
- 尽量为业务开发者提供所需的全部工具库
- 自动加载配置和初始化程序环境，开发者能直接使用各种库
- 与线上的健康检查、运维接口等运行环境匹配，无需用户手动开发配置

## 使用
使用 `go get -u github.com/NetEase-Media/ngo` 命令下载安装

## 快速开始
go main
```go
package main

import (
	"context"
	"github.com/NetEase-Media/ngo/adapter/log"
	"github.com/NetEase-Media/ngo/adapter/protocol"
	"github.com/NetEase-Media/ngo/server"
	"github.com/gin-gonic/gin"
)

// go run . -c ./app.yaml
func main() {
	s := server.Init()
	s.PreStart = func() error {
		log.Info("do pre-start...")
		return nil
	}

	s.PreStop = func(ctx context.Context) error {
		log.Info("do pre-stop...")
		return nil
	}

	s.AddRoute(server.GET, "/hello", func(ctx *gin.Context) {
		ctx.JSON(protocol.JsonBody("hello"))
	})
	s.Start()
}
```
配置文件app.yaml
```yaml
service:
  appName: ngo-demo
  clusterName: ngo-demo-local

```


### 更多示例

- [examples](/examples)
- [ngo-demo](https://github.com/NetEase-Media/ngo-demo)

# 使用文档
* [web server](docs/server.md)
    * [启动](docs/start.md)
        * [yaml配置说明](docs/config.md)
        * [多环境配置&&配置导入](docs/yamlimport.md)
        * [pprof](docs/pprof.md)
    * [优雅停服](docs/gracefulshutdown.md)
    * [web中间件](docs/middleware.md)
        * [accesslog](docs/accesslog.md)
        * [限流](docs/ratelimiter.md)
        * [超时](docs/timeout.md)
        * [admin auth](docs/jwt-auth.md)
        * [分号转换](docs/semicolon.md)
* [日志](docs/log.md)
* [协议](docs/protocol.md)
* [sentinel](docs/sentinel.md)
* [中间件client](docs/client.md)
    * [db](docs/db.md)
    * [httplib](docs/httplib.md)
    * [kafka](docs/kafka.md)
    * [memcache](docs/memcache.md)
    * [多级缓存](docs/multicache.md)
    * [redis](docs/redis.md)
    * [分布式锁](docs/dlock.md)
* [定时任务]()
    * [cron定时任务](docs/cron.md)
    * [k8s job](docs/k8sjob.md)
    * [xxljob](docs/xxljob.md)
* [工具](docs/util.md)


## 问题反馈
 对应bug上报、问题咨询和讨论，可以提交issue