api/

directory
v0.0.0-...-2ddb557 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 14, 2026 License: MIT

README

internal/ - 项目私有代码

此目录存放手写的业务代码,仅供本项目使用,不可被外部项目导入。

目录结构

internal/
├── app/            # 应用层:业务逻辑(服务层)
├── transport/      # 传输层:协议适配(HTTP/RPC handler 实现)
├── repo/           # 数据层:数据访问(Repository 模式)
├── conf/           # 配置代码:配置结构体定义和加载逻辑
└── pkg/            # 内部工具库:项目专用工具包

分层职责

  1. app/ - 业务逻辑层

    • 实现核心业务逻辑
    • 不依赖具体的传输协议
    • 不直接操作数据库,通过 repo 层访问数据
  2. transport/ - 传输层

    • 适配不同的传输协议(HTTP、RPC)
    • 调用 app 层的服务处理业务
    • 处理协议相关的参数转换
  3. repo/ - 数据访问层

    • 实现数据持久化逻辑
    • 封装数据库、缓存、外部服务的访问
    • 提供统一的数据访问接口
  4. conf/ - 配置层

    • 配置结构体定义
    • 配置文件加载逻辑
    • 注意:配置 YAML 文件放在 configs/
  5. pkg/ - 内部工具库

    • 项目专用的工具函数
    • 不具备跨项目复用性

Directories

Path Synopsis
app
anonymous
Package anonymous 实现匿名取件 service(仿 vastsa/FileCodeBox UX)。
Package anonymous 实现匿名取件 service(仿 vastsa/FileCodeBox UX)。
notify
Package notify 实现系统通知(管理员公告 + per-user 取件通知)service。
Package notify 实现系统通知(管理员公告 + per-user 取件通知)service。
presign
Package presign 实现预签名上传 service。
Package presign 实现预签名上传 service。
pkg
errcode
Package errcode 提供全站统一业务码定义。
Package errcode 提供全站统一业务码定义。
middleware
Package middleware 提供 HTTP 中间件。
Package middleware 提供 HTTP 中间件。
repo
db
Package db 提供数据库连接与迁移。
Package db 提供数据库连接与迁移。
opendal
Package opendal 提供 OpenDAL 风格的存储抽象。
Package opendal 提供 OpenDAL 风格的存储抽象。
transport
http/handler
Package handler 提供定制 HTTP handlers(不走 thrift IDL 生成)。
Package handler 提供定制 HTTP handlers(不走 thrift IDL 生成)。

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL