<project>
├── bin/                # 编译程序目录
├── configs/            # 配置文件目录
│   ├── production/     # 环境配置目录
│   │   ├── app.yaml
│   │   └── params.yaml
│   ├── testing/
│   ├── app.yaml        # 项目配置文件
│   └── params.yaml     # 自定义配置文件
├── makefile            # 编译打包
├── runtime/            # 运行时目录 主要用于存储日志
├── assets/             # 非web相关资源
├── web/                # 静态资源目录
│   ├── static          # 静态资源
│   ├── template        # 视图模板目录
├── cmd/                # 项目入口目录
└── pkg/                # 项目源码目录
    ├── command/        # 命令行控制器目录
    ├── controller/     # HTTP控制器目录
    ├── lib/            # 项目基础库目录
    ├── model/          # 模型目录(数据交互)
    ├── service/        # 服务目录(业务逻辑)
    ├── structs/         # 结构目录(数据定义)

快速开始

拷贝makefile

非IDE环境(命令行)下，推荐使用make做为编译打包的控制工具，从pgo2或pgo2-demo将makefile复制到项目目录下。

make start      # 编译并运行当前工程
make stop       # 停止当前工程的进程
make build      # 仅编译当前工程
make update     # go mod get
make install    # go mod download
make pgo2       # 安装pgo2框架到当前工程
make init       # 初始化工程目录
make help       # 输出帮助信息

创建项目目录(以下三种方法均可)
- 执行make init创建目录
- 参见《项目目录》手动创建
- 从pgo2-demo克隆目录结构

修改配置文件(conf/app.yaml)

name: "pgo2-demo"
GOMAXPROCS: 2
runtimePath: "@app/runtime"
publicPath: "@app/web/static"
viewPath: "@app/web/template"
server:
    httpAddr: "0.0.0.0:8000"
    readTimeout: "30s"
    writeTimeout: "30s"
components:
    log:
        levels: "ALL"
        targets:
            info:
                name: "file"
                levels: "DEBUG,INFO,NOTICE"
                filePath: "@runtime/info.log"
            error:
                name: "file"
                levels: "WARN,ERROR,FATAL"
                filePath: "@runtime/error.log"
            console: 
                levels: "ALL"

安装pgo2(以下两种方法均可)
- 在项目根目录执行make pgo2安装pgo2
- 在项目根目录执行go get -u github.com/pinguo/pgo2

创建service(pkg/service/Welcome.go)

package service

func NewWelcome() *Welcome{
   return &Welcome{}
}

type Welcome struct {
    pgo2.Object
}

func (w *Welcome) SayHello(name string, age int, sex string) {
    fmt.Printf("call in  service/Welcome.SayHello, name:%s age:%d sex:%s\n", name, age, sex)
}

创建控制器(pkg/controller/welcomeController.go)

package controller

type WelcomeController struct {
    pgo2.Controller
}

func (w *WelcomeController) ActionIndex() {
    w.Json("hello world", http.StatusOK)
}

// URL路由动作，根据url自动映射控制器及方法，不需要配置.
// 例如：/welcome/say-hello，控制器类名为
// controller/welcomeController 动作方法名为ActionSayHello
func (w *WelcomeController) ActionSayHello() {
    ctx := w.Context() // 获取pgo2请求上下文件

    // 验证参数，提供参数名和默认值，当不提供默认值时，表明该参数为必选参数。
    // 详细验证方法参见Validate.go
    name := ctx.ValidateParam("name").Min(5).Max(50).Do() // 验证GET/POST参数(string)，为空或验证失败时panic
    age := ctx.ValidateQuery("age", 20).Int().Min(1).Max(100).Do() // 只验证GET参数(int)，为空或失败时返回20
    ip := ctx.ValidatePost("ip", "").IPv4().Do() // 只验证POST参数(string), 为空或失败时返回空字符串

    // 打印日志
    ctx.Info("request from welcome, name:%s, age:%d, ip:%s", name, age, ip)
    ctx.PushLog("clientIp", ctx.ClientIp()) // 生成clientIp=xxxxx在pushlog中

    // 调用业务逻辑，一个请求生命周期内的对象都要通过GetObj()获取，
    // 这样可自动查找注册的类，并注入请求上下文(Context)到对象中。
    svc := w.GetObj(service.NewWelcome()).(*Service.Welcome)

    // 添加耗时到profile日志中
    ctx.ProfileStart("Welcome.SayHello")
    svc.SayHello(name, age, ip)
    ctx.ProfileStop("Welcome.SayHello")

    data := map[string]interface{}{
        "name": name,
        "age": age,
        "ip": ip,
    }

    // 输出json数据
    w.Json(data, http.StatusOK)
}

// 正则路由动作，需要配置Router组件(components.router.rules)
// 规则中捕获的参数通过动作函数参数传递，没有则为空字符串.
// eg. "^/reg/eg/(\\w+)/(\\w+)$ => /welcome/regexp-example"
func (w *WelcomeController) ActionRegexpExample(p1, p2 string) {
    data := map[string]interface{}{"p1": p1, "p2": p2}
    w.Json(data, http.StatusOK)
}

// RESTful动作，url中没有指定动作名，使用请求方法作为动作的名称(需要大写)
// 例如：GET方法请求GET(), POST方法请求POST()
func (w *WelcomeController) GET() {
   w.Context().End(http.StatusOK, []byte("call restfull GET"))
}

创建程序入口(cmd/projectName/main.go)

package main

import (
    _ "pgo2-demo/pkg/controller" // 导入控制器

    "github.com/pinguo/pgo2"
)

func main() {
    pgo2.Run() // 运行程序
}

编译运行

make update
make start
curl http://127.0.0.1:8000/welcome

其它

参见pgo2-docs