首页
/ Golang 项目 `golang-good-code-bad-code` 使用教程

Golang 项目 `golang-good-code-bad-code` 使用教程

2024-09-10 11:39:43作者:幸俭卉

1. 项目目录结构及介绍

golang-good-code-bad-code/
├── cmd/
│   └── main.go
├── internal/
│   ├── bad/
│   │   └── bad_code.go
│   └── good/
│       └── good_code.go
├── configs/
│   └── config.yaml
├── go.mod
├── go.sum
└── README.md

目录结构说明

  • cmd/: 存放项目的启动文件,通常包含 main.go 文件。
  • internal/: 存放项目的内部代码,通常分为 bad/good/ 两个子目录,分别存放不符合 Go 语言习惯的代码和符合 Go 语言习惯的代码。
  • configs/: 存放项目的配置文件,通常包含 config.yaml 文件。
  • go.modgo.sum: Go 模块管理文件,用于管理项目的依赖。
  • README.md: 项目的说明文档。

2. 项目的启动文件介绍

cmd/main.go

cmd/main.go 是项目的启动文件,负责初始化项目并启动应用程序。通常包含以下内容:

package main

import (
    "fmt"
    "golang-good-code-bad-code/internal/bad"
    "golang-good-code-bad-code/internal/good"
)

func main() {
    fmt.Println("Running bad code example:")
    bad.RunBadCode()

    fmt.Println("Running good code example:")
    good.RunGoodCode()
}

启动文件说明

  • main 函数: 项目的入口函数,负责调用 badgood 包中的代码示例。
  • bad.RunBadCode(): 调用不符合 Go 语言习惯的代码示例。
  • good.RunGoodCode(): 调用符合 Go 语言习惯的代码示例。

3. 项目的配置文件介绍

configs/config.yaml

configs/config.yaml 是项目的配置文件,通常包含应用程序的配置信息。示例如下:

app:
  name: "golang-good-code-bad-code"
  version: "1.0.0"
  environment: "development"

database:
  host: "localhost"
  port: 5432
  username: "user"
  password: "password"
  name: "dbname"

配置文件说明

  • app: 包含应用程序的基本信息,如名称、版本和运行环境。
  • database: 包含数据库的连接信息,如主机、端口、用户名、密码和数据库名称。

通过以上配置文件,可以方便地管理应用程序的运行环境和数据库连接信息。

登录后查看全文
热门项目推荐

热门内容推荐

最新内容推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
149
1.95 K
kernelkernel
deepin linux kernel
C
22
6
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
980
395
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
274
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
931
555
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
190
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
75
66
openHiTLS-examplesopenHiTLS-examples
本仓将为广大高校开发者提供开源实践和创新开发平台,收集和展示openHiTLS示例代码及创新应用,欢迎大家投稿,让全世界看到您的精巧密码实现设计,也让更多人通过您的优秀成果,理解、喜爱上密码技术。
C
65
519
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.11 K
0