创建Go工程化项目布局详解

目录
  • 正文
    • /cmd
    • /internal
    • /pkg
    • /docs,/example,/pkg,/third_parth,/tools
    • 基础库项目布局
      • kit包应该具备的特点
  • 应用程序项目布局
    • /api
    • /configs
    • /test
    • 不应该包含/src目录
  • /internal
    • /biz
    • /data
    • /service
  • 布局示意图
    • 数据流向

正文

如果你尝试学习Go，或者你正在为自己建立一个Poc或者一个玩具项目，这个项目布局是没有啥必要的，从一些简单的事情开始（一个main文件绰绰有余）。当有更多的人参与这个项目的时候，你讲需要更多的结构，包括需要一个tookit来方便生成项目的模板，尽可能大家统一的工程目录布局

本文章围绕github.com/golang-stan… 进行说明

/cmd

本项目的主干。 每个应用程序的目录名应该与你想要的可执行文件的名称相匹配（例如：/cmd/myapp）

不要在这个项目中放置太多的代码，如果你认为代码导入并在其他项目中使用，那么他应该位于/pkg目录中，如果代码不是可重用的，或者你不希望其他人重用他，请将该代码放到/internal目录中。

/internal

不希望对外进行共享的代码，internal目录中也可以放置一些子包结构，已做到更加细化的切分，如：

|--internal
|   |
|   |--demo
|       |--biz
|       |--data
|       |--service

/pkg

外部应用程序可以使用的代码库，（例如：/pkg/publiclib)其他项目会导入这些代码库，所以放入到该目录下的代码要三思~注意：/internal目录是确保私有包不可导入的私有方法，因为他是由Go在编译时强制执行的。/pkg 仍然是一种更好的方式，可以显示的表示目录中的代码对于其他人来说是安全使用的好方法。

/pkg目录内可以参考GO标准库的组织形式，按照功能分类，/internal/pkg一般用于项目内的，跨多个应用的公共共享代码，但是其作用域仅在单个工程内。

|--pkg
|  |
|  |--cache
|  |   |--memcache
|  |   |--redis
|  |
|  |--conf
|      |--dsn
|      |--env
|      |--flagvar
|      |--paladin

/docs,/example,/pkg,/third_parth,/tools

这些跟上文说的/pkg和/internal都同属根目录下的目录结构

  • /docs 放置一些项目说明文档
  • /example 放置一些项目的使用示例
  • /thrid_parth 三方的一些依赖文件，如：idl文件
  • /tools 放置一些项目的脚手架工具，代码生成工具等

基础库项目布局

每个公司都应该为不同的微服务建立一个统一的kit基础包工具集。 基础库tookit为一个独立的项目，公司级建议只有一个，按照功能来拆分会带来不少的管理工作，因此建议并整合

kit包应该具备的特点

  • 统一
  • 标准库方式布局
  • 高度抽象
  • 支持插件

例如下面的布局

|--cache
|    |--memcache
|         |--test
|    |--redis
|         |--test
|--conf
|    |--dsn
|    |--env
|    |--flagvar
|    |--paladin
|          |--apollo
|               |--internal
|                     |--mockserver
|--container
|    |--group
|    |--pool
|    |--queue
|         |--aqm
|--database
|    |--hbase
|    |--sql
|    |--tidb
|--echo
|    |--types
|--log
|    |--internal
|         |--core
|         |--filewriter
|

应用程序项目布局

/api

API协议定义目录， xxapi.proto protobuf文件以及生成go的文件，我们通常把api文档定义在proto 文件中描述

/configs

配置文件模板或者默认配置

/test

额外的外部测试应用程序和测试数据，你可以随时根据需求构造测试目录，对于较大的项目，有一个数据子目录是有意义的，例如你可以使用/test/testdata(如果你需要忽略目录中的内容）请注意，Go还会以“.”或者“_”开头的目录或者文件，因此在如何命名测试数据目录方便，有着很大的灵活性。

不应该包含/src目录

有些Go项目确实有src目录，这是因为开发人员通常有Java的开发背景。

/internal

/biz

业务逻辑的组装层，类似DDD中的domain，

/data

业务数据访问，包含cache和db等封装，实现了biz的repo接口，我们可能会把data和dao混合在一起，data偏重业务的含义，他所做的是将领域对象重新拿出来，我们去掉了DDD的infra层，

/service

实现了api定义的服务层，类似DDD的applocation层，处理DTO到biz领域实体的转换，（DTO->DO）同事协同个类biz交互，但是不应该处理复杂逻辑

布局示意图

|--api
|--configs
|--test
|--internal
|       |--biz
|       |--data
|       |--service

数据流向

以上就是创建Go工程化项目布局详解的详细内容，更多关于Go工程化项目布局的资料请关注我们其它相关文章！

赞 (0)

相关推荐

  • web项目中golang性能监控解析

    目录 性能监控 一.web项目(如gin中) 二.单个的go文件如果查看gc 性能监控 一.web项目(如gin中) 1.使用ginpprof import "github.com/DeanThompson/ginpprof" router := gin.Default() ginpprof.Wrap(router) 2.使用pprof 只需要在main.go中引入:_ “net/http/pprof” 访问:127.0.0.1:8080/debug/pprof /debug/ppro

  • Go开源项目分布式唯一ID生成系统

    Go开源项目分布式唯一ID生成系统

    目录 前言 项目背景 项目使用 HTTP 方式 gRPC 方式 本地开发 项目架构 前言 今天跟大家介绍一个开源项目:id-maker,主要功能是用来在分布式环境下生成唯一 ID.上周停更了一周,也是用来开发和测试这个项目的相关代码. 美团有一个开源项目叫 Leaf,使用 Java 开发.本项目就是在此思路的基础上,使用 Go 开发实现的. 项目整体代码量并不多,不管是想要在实际生产环境中使用,还是想找个项目练手,我觉得都是一个不错的选择. 项目背景 在大部分系统中,全局唯一 ID 都是一个强需

  • golang默认Logger日志库在项目中使用Zap日志库

    目录 在Go语言项目中使用Zap日志库介绍 默认的Go Logger日志库 实现Go Logger 设置Logger 使用Logger Logger的运行 Go Logger的优势和劣势 优势 劣势 Uber-go Zap日志库 为什么选择Uber-go zap 安装 配置Zap Logger Logger Sugared Logger 定制logger 将日志写入文件而不是终端 将JSON Encoder更改为普通的Log Encoder 更改时间编码并添加调用者详细信息 使用Lumberja

  • Go开发Gin项目添加jwt功能实例详解

    目录 啥是JWT 为什么要用在你的Gin中使用JWT JWT的基本原理 JWT TOKEN怎么组成 Header Base64URL Payload Signature 解密过程 一些特点(优点和缺点) GIN整合JWT 编写jwtutil GenToken方法 ParseToken方法 编写中间件 使用中间件 测试 其他 啥是JWT JWT全称JSON Web Token是一种跨域认证解决方案,属于一个开放的标准,它规定了一种Token实现方式,目前多用于前后端分离项目和OAuth2.0业务场

  • Go项目编写Makefile规则文件概述

    目录 make介绍 Makefile介绍 Makefile文件教程解析 规则概述 示例 make介绍 借助Makefile我们在编译过程中不再需要每次手动输入编译的命令和编译的参数,可以极大简化项目编译过程. make是一个构建自动化工具,会在当前目录下寻找Makefile或makefile文件.如果存在相应的文件,它就会依据其中定义好的规则完成构建任务. Makefile介绍 我们可以把Makefile简单理解为它定义了一个项目文件的编译规则.借助Makefile我们在编译过程中不再需要每次手

  • Golang项目搭配nginx部署反向代理负载均衡讲解

    Golang项目搭配nginx部署反向代理负载均衡讲解

    目录 部署Go语言项目 独立部署 编译 nohup supervisor 搭配nginx部署 正向代理与反向代理 使用yum安装nginx Nginx配置文件 Nginx常用命令 Nginx反向代理部署,无负载均衡 Nginx反向代理部署,有负载均衡 Nginx分离动静态文件请求 前后端分开部署 允许所有请求跨域 部署Go语言项目 本文以部署 Go Web 程序为例,介绍了在 CentOS7 服务器上部署 Go 语言程序的若干方法. 独立部署 Go 语言支持跨平台交叉编译,也就是说我们可以在 W

  • 创建Go工程化项目布局详解

    创建Go工程化项目布局详解

    目录 正文 /cmd /internal /pkg /docs,/example,/pkg,/third_parth,/tools 基础库项目布局 kit包应该具备的特点 应用程序项目布局 /api /configs /test 不应该包含/src目录 /internal /biz /data /service 布局示意图 数据流向 正文 如果你尝试学习Go,或者你正在为自己建立一个Poc或者一个玩具项目,这个项目布局是没有啥必要的,从一些简单的事情开始(一个main文件绰绰有余).当有更多的人

  • umi插件开发仿dumi项目实现页面布局详解

    目录 实现思路 使用默认项目提供的layout文件 自定义主题 准备工作 主题插件功能 modifyAppData 插件代码 生成layout路由对象 使用同步伪代码来描述上面流程 运行检查 实现思路 上一章我们已经完成/docs目录下文件自动生路由功能,本章我们将在此基础上,实现自动生成页面导航的功能. 使用默认模板提供的layout展示路由切换 使用自定义主题插件 使用默认项目提供的layout文件 在我们创建默认umi项目后,会在/src/layouts下生成一个布局文件: 同时在上一章节

  • node创建Vue项目步骤详解

    vue的安装 Vue.js不支持IE8及以下版本.因为Vue.js使用了ECMAScript5特性,IE8显然不能模拟. Vue.js支持所有兼容ECMAScript5的浏览器. 在用Vue.js构建大型应用时,推荐使用npm安装,npm能很好的和webpack等打包工具配合使用. 首先Vue的安装依赖于node.js,要保证你的计算机上已经安装过node.js. 如何查看node是否安装或者node版本呢? 进入cmd,输入命令 node -v,回车查看.node最好使用新一些的版本,否则后续

  • Android LayoutInflater加载布局详解及实例代码

    Android  LayoutInflater加载布局详解 对于有一定Android开发经验的同学来说,一定使用过LayoutInflater.inflater()来加载布局文件,但并不一定去深究过它的原理,比如 1.LayoutInflater为什么可以加载layout文件? 2.加载layout文件之后,又是怎么变成供我们使用的View的? 3.我们定义View的时候,如果需要在布局中使用,则必须实现带AttributeSet参数的构造方法,这又是为什么呢? 既然在这篇文章提出来,那说明这三

  • 使用Angular CLI生成 Angular 5项目教程详解

    如果您正在使用angular, 但是没有好好利用angular cli的话, 那么可以看看本文. Angular CLI 官网:https://github.com/angular/angular-cli 安装angular cli: npm install -g @angular/cli 不过首先要确保您安装了比较新版本的nodejs. 今天主要通过以下几个方面介绍Angular CLI: 生成项目 参数介绍 配置和自定义CLI 检查和修复代码 生成新项目: ng new my-app 这个命

  • vite2.0+vue3移动端项目实战详解

    一.涉及技术点 vite版本 vue3 ts 集成路由 集成vuex 集成axios 配置Vant3 移动端适配 请求代理 二.步骤 vite+ts+vue3只需要一行命令 npm init @vitejs/app my-vue-app --template vue-ts 配置路由 npm install vue-router@4 --save 在src下新建router目录,新建index.ts文件 import { createRouter, createWebHashHistory, Ro

  • SpringBoot集成mqtt的多模块项目配置详解

    SpringBoot集成mqtt的多模块项目配置详解

    前言 近期为了准备毕设,准备使用SpringBoot搭建mqtt后端,本篇主要记录了在IDEA中搭建SpringBoot mqtt的多模块项目的过程 开发工具及系统环境 IDE:IntelliJ IDEA 2020.2 操作系统:Windows 10 2004 Java Version:1.8 SpringBoot Version:2.1.17.RELEASE 项目路径 Study |----study-common # 存放公共类 |----study-mapper # mapper层 |--

  • Python MySQL数据库基本操作及项目示例详解

    目录 一.数据库基础用法 二.项目:银行管理系统 1.进行初始化操作 2.登录检查,并选择操作 3.加入查询功能 4.加入取钱功能 5.加入存钱功能 一.数据库基础用法 要先配置环境变量,然后cmd安装:pip install pymysql 1.连接MySQL,并创建wzg库 #引入decimal模块 import pymysql #连接数据库 db=pymysql.connect(host='localhost',user='root',password='1234',charset='ut

  • C# .NET创建虚拟目录的方法详解

    C# .NET创建虚拟目录的方法详解

    目录 使用背景 配置 创建 使用 结语 使用背景 虚拟目录(virtual directory),计算机术语,每个 Internet服务可以从多个目录中发布.通过以通用命名约定 (UNC) 名.用户名及用于访问权限的密码指定目录,可将每个目录定位在本地驱动器或网络上.指定客户 URL地址, 服务将整个发布目录集提交给客户作为一个目录树.宿主目录是“虚拟”目录树的根.虚拟目录的实际子目录对于客户也是可用的.只有http://www.服务支持虚拟服务器:而 FTP和 gopher服务则只能有一个宿主

  • Opencv创建车牌图片识别系统方法详解

    Opencv创建车牌图片识别系统方法详解

    目录 前言 包含功能 软件版本 软件架构 参考文档 效果图展示 车牌检测过程 图片车牌文字识别过程 部分核心代码 前言 这是一个基于spring boot + maven + opencv 实现的图像识别及训练的Demo项目 包含车牌识别.人脸识别等功能,贯穿样本处理.模型训练.图像处理.对象检测.对象识别等技术点 java语言的深度学习项目,在整个开源社区来说都相对较少: 拥有完整的训练过程.检测.识别过程的开源项目更是少之又少!! 包含功能 蓝.绿.黄车牌检测及车牌号码识别 网上常见的轮廓提

随机推荐