Golang Common 项目使用教程

最新推荐文章于 2024-09-01 09:07:52 发布

戴艺音

最新推荐文章于 2024-09-01 09:07:52 发布

阅读量270

点赞数 4

本文链接：https://blog.csdn.net/gitblog_00074/article/details/141084234

版权

Golang Common 项目使用教程

golang_commonA Quick start, Lightweight, Golang Public Class Library项目地址:https://gitcode.com/gh_mirrors/go/golang_common

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

Golang Common 项目的目录结构如下：

.
├── app
├── chart
├── common
├── conf
├── excel
├── gtypes
├── installer
├── log
├── mapstruct
├── qcloudsms
├── sqltype
├── timeutil
├── tpl
├── urlvals
├── validutil
├── editorconfig
├── gitignore
├── LICENSE
├── Makefile
├── README.md
├── go.mod
└── go.sum

目录介绍

app: 应用程序的主要代码目录。
chart: 用于 Helm chart 的目录。
common: 包含一组可重用的组件库。
conf: 配置文件目录。
excel: Excel 数据快速导出工具。
gtypes: 自定义类型目录。
installer: Systemd 脚本安装工具。
log: 基础日志工具。
mapstruct: 用于结构体映射的工具。
qcloudsms: 腾讯云短信服务工具。
sqltype: SQL 类型工具。
timeutil: 时间处理工具。
tpl: 模板文件目录。
urlvals: URL 参数处理工具。
validutil: 数据校验工具。
editorconfig: 编辑器配置文件。
gitignore: Git 忽略文件配置。
LICENSE: 项目许可证。
Makefile: 用于构建项目的 Makefile。
README.md: 项目说明文档。
go.mod: Go 模块文件。
go.sum: Go 模块校验文件。

2. 项目的启动文件介绍

项目的启动文件通常位于 app 目录下。假设启动文件名为 main.go，其内容可能如下：

package main

import (
    "github.com/e421083458/golang_common/log"
    "github.com/e421083458/golang_common/conf"
)

func main() {
    // 初始化配置
    conf.Init()
    
    // 初始化日志
    log.Init()
    
    // 启动应用程序
    app.Run()
}

启动文件介绍

main.go: 主程序入口文件，负责初始化配置、日志和启动应用程序。

3. 项目的配置文件介绍

项目的配置文件通常位于 conf 目录下。假设配置文件名为 config.yaml，其内容可能如下：

server:
  host: "0.0.0.0"
  port: 8080

database:
  driver: "mysql"
  source: "user:password@tcp(127.0.0.1:3306)/dbname"

log:
  level: "info"
  path: "/var/log/app.log"