golang目录设置

2023-05-22 15:05:16 设置 目录 Golang

golang是一种开源编程语言,被广泛用于网络服务开发高并发的应用程序以及云服务。在使用Golang编写项目时,一个良好的目录结构可以使得项目更加清晰、易于维护,今天我们就来讨论一下golang目录结构的设置。

  1. 根据功能划分

将项目按照功能模块进行划分是golang中常见的一种目录结构设置。具体做法是在项目根目录下创建多个子目录,每个子目录对应一个功能模块。比如下面这个例子:

myproject/
├── cmd/
│   ├── server/
│   │   ├── main.go
│   ├── client/
│   │   ├── main.go
├── pkg/
│   ├── user/
│   │   ├── user.go
│   ├── util/
│   │   ├── util.go
├── internal/
│   ├── auth/
│   │   ├── auth.go
│   ├── db/
│   │   ├── db.go
├── vendor/
├── go.mod
├── go.sum

上面的结构中,我们根据项目的功能模块将其分为了cmdpkginternal三个部分:

  • cmd目录下存放的是可以直接运行的命令行工具,比如服务器程序 server和客户端程序client
  • pkg目录下存放的是项目的业务逻辑代码,按照功能模块进行划分,比如user模块和util模块。
  • internal目录下存放的是项目的内部代码,只在项目中使用,外部包不会使用它。

值得注意的是,虽然pkginternal目录的作用看起来很相似,但是它们的区别在于,pkg目录下的代码可以被外部包使用,而internal目录下的代码只能在本项目中使用。

  1. 根据代码类型划分

将代码按照类型进行划分,是另一种常见的golang目录结构设置方式。具体做法是在项目根目录下创建多个子目录,每个子目录对应一种代码类型。比如下面这个例子:

myproject/
├── cmd/
│   ├── main.go
├── pkg/
│   ├── Http/
│   │   ├── server.go
│   │   ├── router.go
│   ├── database/
│   │   ├── db.go
│   ├── log/
│   │   ├── log.go
├── vendor/
├── go.mod
├── go.sum

上面的结构中,我们根据代码类型将其分为了cmdpkgvendor三个部分:

  • cmd目录下的是可执行程序的入口文件,比如main.go
  • pkg目录下按照代码类型进行划分,比如将HTTP相关的代码放在http目录下,将数据库相关的代码放在database目录下等等。
  • vendor目录下存放的是项目所依赖的第三方包。

相对于按照功能划分的方式,这种按照代码类型划分的方式更加灵活,但是可能会导致目录结构比较深,需要更多的时间去查找代码所在的位置。

  1. 根据mvc模式进行划分

大多数WEB框架都采用了MVC(Model-View-Controller)模式,将程序按照这种模式进行划分也是很常见的一种golang目录结构设置方式。比如下面这个例子:

myproject/
├── cmd/
│   ├── main.go
├── pkg/
│   ├── models/
│   │   ├── user.go
│   ├── views/
│   │   ├── index.gohtml
│   ├── controllers/
│   │   ├── user.go
├── vendor/
├── go.mod
├── go.sum

上面的结构中,我们根据MVC模式将其分为了modelsviewscontrollers三个部分:

  • models目录中存放的是模型层代码,通常是与数据库打交道的代码。
  • views目录中存放的是视图层代码,通常是网页模板等。
  • controllers目录中存放的是控制器层代码,负责将模型层和视图层连接起来。

这种按照MVC模式进行划分的方式,可以使得代码更加有条理,易于维护。

综上所述,golang的目录设置有多种方式,不同的方式适用于不同的项目。我们可以根据自己的需求选用相应的目录设置方式。

以上就是golang目录设置的详细内容,更多请关注其它相关文章!

相关文章