Categorygithub.com/FarmerChillax/tkit-layout
repositorypackage
0.0.0-20240218072757-eea2202e054d
Repository: https://github.com/farmerchillax/tkit-layout.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# README

tkit-layout

tkit 的示例项目

在线文档:https://farmerchillax.github.io/tkit/

各层级的作用

目前该 layout 只用作 tkit 框架食用方法展示,项目结构还没想好,仅供参考。

  • server层: 用于参数校验、参数准备(从 metadata、request 或 context 等地方获取)
  • service层: 处理主要流程代码、处理各类错误与记录相关日志
.
├── api // 用于与外部对接的接口格式,维护接口 schema(对应微服务使用的proto文件以及根据它们所生成的go文件)
├── internal
│   ├── model // 内部模型存储
│   │   ├── dto // (该路径貌似与 api 有冲突?)这里仅展示 dto、bo 等内部/临时结构体存放位置
│   │   └── mysql // MySQL 数据模型
│   ├── repository // 仓储层
│   ├── router // 用于路由注册
│   └── server // 用于参数校验、参数准备(从 metadata、request 或 context 等地方获取)
├── pkg
│   ├── errcode // 错误码存放,错误码一般是需要对外提供/公司内部统一的
│   └── utils // 工具包
├── service // 处理主要流程代码。入参默认是正确的,无需处理的(也许应该放到 internal 下?)
└── startup // 程序启动依赖, 用于各种初始化(如 全局变量、配置、路由注册等)