easy-ngo 项目使用教程

easy-ngo 项目使用教程

easy-ngo-layout项目地址:https://gitcode.com/gh_mirrors/ea/easy-ngo-layout

1. 项目的目录结构及介绍

easy-ngo 项目的目录结构如下：

easy-ngo-layout/
├── app/
│   ├── config/
│   ├── controller/
│   ├── service/
│   └── main.go
├── bin/
├── pkg/
├── scripts/
├── .gitignore
├── go.mod
├── go.sum
└── README.md

目录介绍

• app/: 应用代码的主要目录，包含配置、控制器和服务等。
  • config/: 存放应用的配置文件。
  • controller/: 存放控制器代码，处理HTTP请求。
  • service/: 存放服务层代码，处理业务逻辑。
  • main.go: 应用的入口文件。
• bin/: 编译生成的可执行文件存放目录。
• pkg/: 存放一些公共的库代码。
• scripts/: 存放一些脚本文件，如构建、部署脚本等。
• .gitignore: Git忽略文件配置。
• go.mod: Go模块文件，定义项目的依赖。
• go.sum: Go模块文件的校验和。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

项目的启动文件是 app/main.go，其主要内容如下：

package main

import (
    "github.com/NetEase-Media/easy-ngo/application"
    _ "github.com/NetEase-Media/easy-ngo/application/r/rconfig"
    "github.com/NetEase-Media/easy-ngo/application/r/rgin"
    _ "github.com/NetEase-Media/easy-ngo/examples/application/include"
    "github.com/gin-gonic/gin"
)

func main() {
    app := application.Default()
    app.Initialize(xgin)
    app.Startup()
}

func xgin() error {
    g := rgin.Gin()
    g.GET("/hello", func(ctx *gin.Context) {
        ctx.String(http.StatusOK, "hello world")
    })
    return nil
}

启动文件介绍

• main(): 应用的入口函数，初始化和启动应用。
• xgin(): 配置Gin框架的路由和处理函数。

3. 项目的配置文件介绍

项目的配置文件存放在 app/config/ 目录下，通常是一个 .toml 文件，例如 app.toml，其内容如下：

[ngo.app]
name = "quickstart-demo"

[ngo.server.gin]
port = 8888
enabledMetric = false

[ngo.app.healthz]
port = 10000

配置文件介绍

• [ngo.app]: 应用的基本配置。
  • name: 应用的名称。
• [ngo.server.gin]: Gin服务器的配置。
  • port: 服务器监听的端口。
  • enabledMetric: 是否启用监控。
• [ngo.app.healthz]: 健康检查的配置。
  • port: 健康检查的端口。

以上是 easy-ngo 项目的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对您有所帮助。

easy-ngo-layout项目地址:https://gitcode.com/gh_mirrors/ea/easy-ngo-layout