Golang Base Project 使用教程

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

Golang Base Project 是一个基础的 Go 项目模板，包含了用户认证功能。以下是项目的目录结构及其介绍：

golang-base-project/
├── admin/
│   └── admin.go
├── assets/
│   ├── css/
│   ├── img/
│   └── js/
├── cmd/
│   └── app/
│       └── main.go
├── config/
│   └── config.go
├── database/
│   └── database.go
├── handlers/
│   ├── auth.go
│   ├── home.go
│   └── user.go
├── middleware/
│   └── middleware.go
├── models/
│   └── user.go
├── static/
│   ├── css/
│   ├── img/
│   └── js/
├── templates/
│   ├── admin/
│   ├── auth/
│   ├── includes/
│   └── home.html
├── .env
├── .gitignore
├── Dockerfile
├── go.mod
├── go.sum
├── LICENSE
└── README.md

目录结构说明：

• admin/: 包含管理员相关的功能代码。
• assets/: 包含前端资源文件，如 CSS、图片和 JavaScript 文件。
• cmd/app/: 包含项目的启动文件 main.go。
• config/: 包含配置文件相关的代码。
• database/: 包含数据库操作相关的代码。
• handlers/: 包含各种请求处理函数。
• middleware/: 包含中间件相关的代码。
• models/: 包含数据模型定义。
• static/: 包含静态资源文件，如 CSS、图片和 JavaScript 文件。
• templates/: 包含 HTML 模板文件。
• .env: 环境变量配置文件。
• .gitignore: Git 忽略文件配置。
• Dockerfile: Docker 配置文件。
• go.mod 和 go.sum: Go 模块依赖管理文件。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

项目的启动文件位于 cmd/app/main.go。以下是 main.go 文件的主要内容：

package main

import (
    "log"
    "net/http"
    "github.com/uberswe/golang-base-project/config"
    "github.com/uberswe/golang-base-project/database"
    "github.com/uberswe/golang-base-project/handlers"
    "github.com/uberswe/golang-base-project/middleware"
)

func main() {
    // 加载配置
    config.LoadConfig()

    // 初始化数据库
    database.Init()

    // 设置路由
    mux := http.NewServeMux()
    mux.HandleFunc("/", handlers.HomeHandler)
    mux.HandleFunc("/login", handlers.LoginHandler)
    mux.HandleFunc("/register", handlers.RegisterHandler)
    mux.HandleFunc("/logout", handlers.LogoutHandler)

    // 应用中间件
    handler := middleware.LoggingMiddleware(mux)

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

启动文件说明：

• main 函数是程序的入口点。
• 加载配置文件：config.LoadConfig()。
• 初始化数据库：database.Init()。
• 设置路由：使用 http.NewServeMux() 创建路由器，并注册各个处理函数。
• 应用中间件：使用 middleware.LoggingMiddleware 中间件。
• 启动服务器：使用 http.ListenAndServe 启动 HTTP 服务器，监听端口 8080。

3. 项目的配置文件介绍

项目的配置文件是 .env，它包含了项目运行所需的各种环境变量。以下是一个示例 .env 文件的内容：

DB_HOST=localhost
DB_PORT=5432
DB_USER=postgres
DB_PASSWORD=password