写点什么

开箱即用的 GoWind Admin|风行,企业级前后端一体中后台框架:后端项目结构说明

作者:喵个咪
  • 2025-12-27
    湖南
  • 本文字数:1374 字

    阅读完需:约 5 分钟

开箱即用的 GoWind Admin|风行,企业级前后端一体中后台框架:后端项目结构说明

├─.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│              ├─server│              └─service├─pkg├─script└─sql
复制代码


  1. .docker:存放 Docker 相关配置文件

  2. api:存放 API 相关代码,API 使用 Protobuf 定义,使用 Buf 进行编译管理。

  3. gen:存放 API 服务生成的代码,目前只有 Go 语言的代码;

  4. protos:存放 API 服务的 Protobuf 的 proto 文件,它的目录结构是{服务名}/service/{版本号}

  5. buf.gen.yaml:buf 配置文件,用于生成 API 服务的 Go 代码。

  6. buf.admin.openapi.gen.yaml buf 配置文件,用于生成 Admin 服务的 OpenAPI 文档。

  7. buf.admin.typescript.gen.yaml buf 配置文件,用于生成 Admin 服务的 TypeScript 代码。

  8. buf.yaml buf 配置文件。

  9. app:存放应用服务相关代码,它的目录结构是{服务名/service},目前只有 Admin 服务。

  10. admin/service:存放 Admin 服务相关代码

  11. Makefile:Makefile 文件,调用项目根目录下的app.mk,用于构建、运行、测试 Admin 服务。

  12. cmd:存放 Admin 服务的命令行代码

  13. server:存放 Admin 服务的入口代码

  14. assets:存放 Admin 服务的静态资源文件,现在只存放了 OpenAPI 的静态资源文件。

  15. configs:存放 Admin 服务的配置文件

  16. internal:存放 Admin 服务的内部代码,使用 internal 目录是为了避免被外部代码引用。

  17. data:存放 Admin 服务的数据访问代码

  18. ent:存放 Admin 服务的 数据库 Ent ORM 代码

  19. gorm:存放 Admin 服务的 数据库 GORM ORM 代码

  20. server:存放 Admin 服务的服务端代码

  21. service:存放 Admin 服务的服务代码

  22. pkg:存放通用代码

  23. script:存放 Shell 脚本代码,用于项目的构建、部署等,如果系统新装,需要执行prepare_{OS}.sh脚本,安装依赖软件;以及install_docker_dependences.sh安装第三方 Docker 中间件的容器;平时就使用build_install.sh安装项目的服务,使用 PM2 进行进程管理。

  24. sql:存放 SQL 文件,里面存放了数据库的初始化 SQL 文件,以及一些测试数据的 SQL 文件。

  25. app.mk:存放应用服务使用的 Makefile 文件,它由app/{服务名}/service下的Makefile调用,用于构建、运行、测试应用服务。

  26. Makefile:项目根目录下的 Makefile 文件,可以用来安装 cli,生成 api 代码等。

  27. README.md:项目后端的说明文档。

项目代码


发布于: 刚刚阅读数: 4
用户头像

喵个咪

关注

还未添加个人签名 2025-12-16 加入

还未添加个人简介

评论

发布
暂无评论
开箱即用的 GoWind Admin|风行,企业级前后端一体中后台框架:后端项目结构说明_Go_喵个咪_InfoQ写作社区