Weffe 开源项目启动与配置教程

1. 项目目录结构及介绍

Weffe 的目录结构如下所示：

weffe/
├── .gitignore        # 指定git应该忽略的文件和目录
├── README.md         # 项目说明文件
├── go.mod            # Go语言依赖管理文件
├── go.sum            # Go语言依赖校验文件
├── config            # 配置文件目录
│   └── app.json      # 应用配置文件
├── internal          # 项目内部模块
│   ├── api           # API相关模块
│   │   └── handlers  # HTTP请求处理函数
│   ├── middleware    # 中间件模块
│   ├── model         # 数据模型模块
│   ├── repository    # 数据库仓库模块
│   └── service       # 业务逻辑模块
├── pkg               # 外部模块
│   └── util          # 工具包模块
└── main.go          # 项目入口文件

• .gitignore: 指定在执行git操作时不应该提交的文件和目录。
• README.md: 提供项目的基本信息和说明。
• go.mod 和 go.sum: 管理项目的Go语言依赖。
• config: 包含项目配置文件。
• internal: 包含项目内部所有模块，如API处理、中间件、数据模型、仓库和业务逻辑等。
• pkg: 包含可以被其他项目使用的模块。
• main.go: 项目启动和执行的入口。

2. 项目的启动文件介绍

项目的启动文件是 main.go。以下是该文件的主要内容：

package main

import (
    "log"
    "net/http"
    "weffe/internal/api"
    "weffe/internal/middleware"
)

func main() {
    // 设置路由处理
    mux := http.NewServeMux()
    api.RegisterHandlers(mux)
    
    // 设置中间件
    wrappedMux := middleware.Wrapper(mux)

    // 启动HTTP服务
    log.Println("Starting server on :8080")
    if err := http.ListenAndServe(":8080", wrappedMux); err != nil {
        log.Fatal("ListenAndServe: ", err)
    }
}

• main 函数初始化HTTP服务器，并监听8080端口。
• api.RegisterHandlers 函数用于注册HTTP请求的处理函数。
• middleware.Wrapper 函数用于添加中间件，如日志、错误处理等。

3. 项目的配置文件介绍

项目的配置文件位于 config/app.json。以下是一个示例配置文件：

{
    "port": 8080,
    "database": {
        "driver": "mysql",
        "source": "user:password@tcp(host:port)/dbname"
    }
}

• port: HTTP服务监听的端口号。
• database: 包含数据库配置，如驱动、数据源等。其中，driver 是数据库驱动类型，source 是数据库连接字符串。