开箱即用的GO后台管理系统 Kratos Admin - 后端项目结构说明

开箱即用的GO后台管理系统 Kratos Admin - 后端项目结构说明

text 复制代码
├─.docker
│  └─compose
├─api
│  ├─gen
│  │  └─go
│  │      ├─admin
│  │      │  └─service
│  │      │      └─v1
│  │      ├─file
│  │      │  └─service
│  │      │      └─v1
│  │      ├─system
│  │      │  └─service
│  │      │      └─v1
│  │      └─user
│  │          └─service
│  │              └─v1
│  └─protos
│      ├─admin
│      │  └─service
│      │      └─v1
│      ├─file
│      │  └─service
│      │      └─v1
│      ├─system
│      │  └─service
│      │      └─v1
│      └─user
│          └─service
│              └─v1
├─app
│  └─admin
│      └─service
│          ├─cmd
│          │  └─server
│          │      └─assets
│          ├─configs
│          └─internal
│              ├─data
│              │  └─ent
│              ├─middleware
│              │  ├─auth
│              │  └─logging
│              ├─server
│              └─service
├─pkg
├─script
├─sql
└─tools
    └─config-importer
  1. .docker:存放 Docker 相关配置文件
  2. api:存放 API 相关代码,API使用Protobuf定义,使用Buf进行编译管理。
    • gen:存放 API 服务生成的代码,目前只有 Go 语言的代码;
    • protos:存放 API 服务的 Protobuf的 proto 文件,它的目录结构是{服务名}/service/{版本号}
    • buf.gen.yaml:buf 配置文件,用于生成 API 服务的 Go 代码。
    • buf.admin.openapi.gen.yaml buf 配置文件,用于生成 Admin 服务的 OpenAPI 文档。
    • buf.admin.typescript.gen.yaml buf 配置文件,用于生成 Admin 服务的 TypeScript 代码。
    • buf.yaml buf 配置文件。
  3. app:存放应用服务相关代码,它的目录结构是{服务名/service},目前只有 Admin 服务。
    • admin/service:存放 Admin 服务相关代码
      • Makefile:Makefile 文件,调用项目根目录下的app.mk,用于构建、运行、测试 Admin 服务。
      • cmd:存放 Admin 服务的命令行代码
        • server:存放 Admin 服务的入口代码
          • assets:存放 Admin 服务的静态资源文件,现在只存放了OpenAPI的静态资源文件。
      • configs:存放 Admin 服务的配置文件
      • internal:存放 Admin 服务的内部代码,使用internal目录是为了避免被外部代码引用。
        • data:存放 Admin 服务的数据访问代码
          • ent:存放 Admin 服务的 Ent 数据库 ORM 代码
        • middleware:存放 Admin 服务的中间件代码
          • auth:存放 Admin 服务的认证中间件代码
          • logging:存放 Admin 服务的日志中间件代码
        • server:存放 Admin 服务的服务端代码
        • service:存放 Admin 服务的服务代码
  4. pkg:存放通用代码
  5. script:存放Shell脚本代码,用于项目的构建、部署等,如果系统新装,需要执行prepare_{OS}.sh脚本,安装依赖软件;以及 install_docker_dependences.sh安装第三方Docker中间件的容器;平时就使用build_install.sh安装项目的服务,使用PM2进行进程管理。
  6. sql:存放 SQL 文件,里面存放了数据库的初始化 SQL 文件,以及一些测试数据的 SQL 文件。
  7. tools:存放工具代码
    • config-importer:存放配置导入工具代码
  8. app.mk:存放应用服务使用的 Makefile 文件,它由app/{服务名}/service下的Makefile调用,用于构建、运行、测试应用服务。
  9. Makefile:项目根目录下的 Makefile 文件,可以用来安装cli,生成api代码等。
  10. README.md:项目后端的说明文档。

项目代码

相关推荐
这里有鱼汤29 分钟前
写Python被嘲笑是“调库侠”,真的很可耻吗?
后端·python
这里有鱼汤32 分钟前
您的 Python 应用程序不安全?别骗自己了!
后端
冼紫菜1 小时前
[特殊字符]实战:使用 Canal + MQ + ES + Redis + XXL-Job 打造高性能地理抢单系统
java·redis·分布式·后端·elasticsearch·rabbitmq·全文检索
风象南2 小时前
Redis缓存穿透的6种防范策略
redis·后端
白泽来了10 小时前
2个小时1.5w字| React & Golang 全栈微服务实战
笔记·go·react
柏油10 小时前
MySQL InnoDB 行锁
数据库·后端·mysql
咖啡调调。10 小时前
使用Django框架表单
后端·python·django
白泽talk10 小时前
2个小时1w字| React & Golang 全栈微服务实战
前端·后端·微服务
摆烂工程师10 小时前
全网最详细的5分钟快速申请一个国际 “edu教育邮箱” 的保姆级教程!
前端·后端·程序员
一只叫煤球的猫10 小时前
你真的会用 return 吗?—— 11个值得借鉴的 return 写法
java·后端·代码规范