旅游网站建设价格,住房和城乡建设部网站执业资格注册中心,做博客网站需要工具吗,企业对比网站序言
逛GitHub的时候发现有个4.5k对goalng项目结构的推荐的项目#xff0c;这里就简单的推荐下
文件目录
/cmd
项目主要的应用程序。
对于每个应用程序来说这个目录的名字应该和项目可执行文件的名字相匹#xff08;例如#xff0c;/cmd/myapp#xff09;。不要在这个…序言
逛GitHub的时候发现有个4.5k对goalng项目结构的推荐的项目这里就简单的推荐下
文件目录
/cmd
项目主要的应用程序。
对于每个应用程序来说这个目录的名字应该和项目可执行文件的名字相匹例如/cmd/myapp。不要在这个目录中放太多的代码。如果目录中的代码可以被其他项目导入并使用那么应该把他们放在/pkg目录。如果目录中的代码不可重用或者不希望被他人使用应该将代码放在/internal目录。显式地表明意图比较好
通常来说项目都应该拥有一个小的main函数并在main函数中导入或者调用/internal和/pkg目录中的代码。
/internal
私有的应用程序代码库。
这些是不希望被其他人导入的代码。请注意这种模式是Go编译器强制执行的。详细内容情况Go 1.4的release notes。再次注意在项目的目录树中的任意位置都可以有internal目录而不仅仅是在顶级目录中。可以在内部代码包中添加一些额外的结构来分隔共享和非共享的内部代码。这不是必选项尤其是在小项目中但是有一个直观的包用途是很棒的。应用程序实际的代码可以放在/internal/app目录如internal/app/myapp而应用程序的共享代码放在/internal/pkg目录如internal/pkg/myprivlib中。
/pkg
外部应用程序可以使用的库代码如/pkg/mypubliclib。
其他项目将会导入这些库来保证项目可以正常运行所以在将代码放在这里前一定要三思而行。请注意internal目录是一个更好的选择来确保项目私有代码不会被其他人导入因为这是Go强制执行的。使用/pkg目录来明确表示代码可以被其他人安全的导入仍然是一个好方式。
/vendor
应用程序的依赖关系通过手动或者使用喜欢的依赖管理工具如新增的内置Go Modules特性。
执行go mod vendor命令将会在项目中创建/vendor目录注意如果使用的不是Go 1.14版本在执行go build进行编译时需要添加-modvendor命令行选项因为它不是默认选项。构建库文件时不要提交应用程序依赖项。请注意从1.13开始Go也启动了模块代理特性使用https//proxy.golang.org作为默认的模块代理服务器。
服务端应用程序的目录
/api
OpenAPI/Swagger规范JSON模式文件协议定义文件。
Web应用程序的目录
/web
Web应用程序特定的组件静态Web资源服务器端模板和单页应用Single-Page AppSPA。
通用应用程序的目录
/configs
配置文件模板或默认配置。
将confd或者consul-template文件放在这里。
/init
系统初始化systemd、upstart、sysv和进程管理runit、supervisord配置。
/scripts
用于执行各种构建安装分析等操作的脚本。
/build
打包和持续集成。
将云AMI容器Docker操作系统debrpmpkg软件包配置和脚本放在/build/package目录中。将CItravis、circle、drone配置文件和就脚本放在build/ci目录中。请注意有一些CI工具如travis CI对于配置文件的位置有严格的要求。尝试将配置文件放在/build/ci目录然后链接到CI工具想要的位置。
/deployments
IaaSPaaS系统和容器编排部署配置和模板docker-composekubernetes/helmmesosterraformbosh。请注意在某些存储库中尤其是使用kubernetes部署的应用程序该目录的名字是/deploy。
/test
外部测试应用程序和测试数据。随时根据需要构建/test目录。对于较大的项目有一个数据子目录更好一些。例如如果需要Go忽略目录中的内容则可以使用/test/data或/test/testdata这样的目录名字。请注意Go还将忽略以“.”或“_”开头的目录或文件因此可以更具灵活性的来命名测试数据目录。
其他
/docs
设计和用户文档除了godoc生成的文档。
/tools
此项目的支持工具。请注意这些工具可以从/pkg和/internal目录导入代码。
/examples
应用程序或公共库的示例。
/third_party
外部辅助工具fork的代码和其他第三方工具例如Swagger UI。
/githooks
Git的钩子。
/assets
项目中使用的其他资源图像Logo等。
/website
如果不使用Github pages则在这里放置项目的网站数据。
不应该出现的目录
/src
有一些Go项目确实包含src文件夹但通常只有在开发者是从Java这是Java中一个通用的模式转过来的情况下才会有。如果可以的话请不要使用这种Java模式。你肯定不希望你的Go代码和项目看起来像Java。
不要将项目级别的/src目录与Go用于其工作空间的/src目录混淆就像How to Write Go Code中描述的那样。$GOPATH环境变量指向当前的工作空间默认情况下指向非Windows系统中的$HOME/go。此工作空间包括顶级/pkg/bin和/src目录。实际的项目最终变成/src下的子目录。因此如果项目中有/src目录则项目路径将会变成/some/path/to/workspace/src/your_project/src/your_code.go。请注意使用Go 1.11可以将项目放在GOPATH之外但这并不意味着使用此布局模式是个好主意。
项目地址
https://github.com/golang-standards/project-layout
