Gin-Vue-Blog 项目使用教程
1. 项目的目录结构及介绍
Gin-Vue-Blog 是一个基于 Go 语言和 Vue.js 的全栈博客项目。以下是项目的目录结构及各部分功能的简要介绍:
gin-vue-blog/
├── gin-blog-admin -- 博客后台前端
├── gin-blog-front -- 博客前台前端
├── gin-blog-server -- 博客后端
├── deploy -- 部署相关的脚本和配置
├── .gitignore -- git 忽略文件
├── Dockerfile -- Docker 构建文件
├── LICENSE -- 项目许可证
├── README.md -- 项目说明文件
├── main.go -- 后端程序的入口文件
└── ...
gin-blog-admin
: 博客后台前端项目,使用 Vue.js 构建的管理界面。gin-blog-front
: 博客前台前端项目,用于展示博客文章和用户交互。gin-blog-server
: 博客后端项目,使用 Go 语言和 Gin 框架构建,提供 API 服务。deploy
: 包含项目部署所需的 Dockerfile、docker-compose.yml 等配置文件和启动脚本。.gitignore
: 指定 Git 忽略的文件和目录。Dockerfile
: 用于构建后端服务 Docker 镜像的文件。LICENSE
: 项目遵循的许可证信息。README.md
: 项目的基本介绍和说明。main.go
: 后端服务的主入口文件,用于启动 API 服务。
2. 项目的启动文件介绍
后端服务的启动文件是 gin-blog-server
目录下的 main.go
文件。以下是 main.go
文件的主要部分:
package main
import (
"gin-vue-blog/gin-blog-server/config"
"gin-vue-blog/gin-blog-server/routes"
"log"
)
func main() {
// 加载配置文件
cfg, err := config.LoadConfig()
if err != nil {
log.Fatalf("加载配置文件失败: %v", err)
}
// 初始化路由
r := routes.InitRouter(cfg)
// 启动服务
log.Printf("服务启动在 %s", cfg.App.Addr)
log.Fatal(r.Run(cfg.App.Addr))
}
该文件负责加载配置文件、初始化路由并启动服务。
3. 项目的配置文件介绍
项目的配置文件位于 gin-blog-server/config
目录下,主要包括以下文件:
config.toml
: 默认的配置文件,使用 TOML 格式。config.go
: 包含配置结构体的定义和加载配置文件的函数。
config.toml
文件示例内容如下:
[app]
name = "Gin-Vue-Blog"
version = "1.0.0"
addr = ":8080"
[mysql]
username = "root"
password = "123456"
host = "127.0.0.1"
port = "3306"
database = "gin_vue_blog"
[redis]
host = "127.0.0.1"
port = "6379"
password = ""
该文件定义了应用程序的基本配置,如服务名称、版本、监听地址、数据库连接信息等。通过 config.LoadConfig()
函数加载这些配置,供应用程序使用。
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考