harbor

package module
v1.0.1 Latest Latest
Warning

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

 Go to latest Published: May 17, 2026 License: MIT Imports: 28 Imported by: 0

README

harbor Framework 🦉

harbor 是一个模块化、功能完备的 Go 语言企业级开发框架。它采用依赖注入（Dependency Injection）设计模式，集成了现代 Web 开发所需的丰富组件，旨在帮助开发者快速构建高性能、可扩展的后端应用。

✨ 核心特性

harbor 框架采用 "Battery-Included" 理念，开箱即用以下功能：

  • 核心架构

    • 基于 Service Provider 的模块化设计
    • 强大的依赖注入容器 (Container)
    • 统一的配置管理 (YAML/Env)

  • Web & API

    • 集成 Gin Web 框架，提供高性能路由处理
    • 内置中间件：Recovery, Logger, CORS, RateLimit, Security, RequestID
    • 支持 Socket.IO 实时通信

  • 数据存储

    • 集成 GORM，支持 MySQL, PostgreSQL, SQLite
    • Redis 缓存与分布式锁支持
    • 多云对象存储抽象层 (Storage)：
      • 本地存储 (Local)
      • AWS S3 / MinIO
      • 阿里云 OSS
      • 腾讯云 COS
      • 七牛云 Kodo

  • 消息队列 & 事件

    • 内置 MQTT 客户端支持
    • 集成 RabbitMQ
    • 应用内事件总线 (EventBus)

  • 企业级能力

    • 支付聚合：支持微信支付、支付宝、银行卡支付
    • OCR 服务：集成阿里云、百度云、腾讯云 OCR
    • 权限管理：集成 Casbin 权限控制
    • 国际化 (i18n)：支持多语言响应
    • 日志系统：结构化日志记录与轮转

🛠️ 快速开始

环境要求
  • Go 1.20+
安装
git clone https://github.com/your-org/harbor.git
cd harbor
go mod download
运行
go run main.go

📂 项目结构

harbor/
├── contract/       # 接口定义 (Contracts)
├── provider/       # 服务提供者实现 (Providers)
│   ├── appconf/    # 应用配置
│   ├── db/         # 数据库连接 (GORM)
│   ├── router/     # HTTP 路由 (Gin)
│   ├── redis/      # Redis 缓存
│   ├── storage/    # 对象存储 (S3, OSS, etc.)
│   ├── pay/        # 支付网关
│   ├── ocr/        # OCR 服务
│   └── ...
├── utils/          # 通用工具库
├── lang/           # 国际化语言包
├── go.mod          # 依赖管理
└── application.go  # 应用入口

📚 开发文档

基于本框架**创建新子系统（独立项目）**或理解 SubApp、Provider、路由与配置的详细说明见 docs/ 目录，包含应用生命周期、SubApp 契约、Provider 与 DI、路由与配置、创建新子系统的标准步骤及常见坑与自检清单。适合开发人员与 AI 开发工具按顺序阅读后直接开发新项目。

📝 许可证

本项目采用 MIT License 许可证。

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func IsValidBinaryName 

func IsValidBinaryName(binName string) error

IsValidBinaryName 检查二进制文件名是否合法

func NewServiceCommandGetter 

func NewServiceCommandGetter(app Installable) *cobra.Command

func PanicIf 

func PanicIf(err error)

Types

type Application 

type Application struct {
	*dig.Container
	// contains filtered or unexported fields
}

func NewApp 

func NewApp(apps ...SubApp) *Application

func (*Application) Boot 

func (i *Application) Boot()

func (*Application) Booted 

func (i *Application) Booted(callback func(application foundation.Application))

func (*Application) Booting 

func (i *Application) Booting(callback func(application foundation.Application))

func (*Application) ConsoleShell 

func (i *Application) ConsoleShell(rootCmd *cobra.Command)

ConsoleShell 使用命令行壳（方法调用）使用系统

func (*Application) Environment 

func (i *Application) Environment(s ...string) (string, bool)

func (*Application) GetBasePath 

func (i *Application) GetBasePath() string

func (*Application) GetBootstrapPath 

func (i *Application) GetBootstrapPath() string

func (*Application) GetConfigPath 

func (i *Application) GetConfigPath() string

func (*Application) GetLangPath 

func (i *Application) GetLangPath() string

func (*Application) GetLocale 

func (i *Application) GetLocale() string

func (*Application) GetProviders 

func (i *Application) GetProviders(provider interface{}) []interface{}

func (*Application) GetPublicPath 

func (i *Application) GetPublicPath() string

func (*Application) GetResourcePath 

func (i *Application) GetResourcePath() string

func (*Application) GetStoragePath 

func (i *Application) GetStoragePath() string

func (*Application) HasBeenBootstrapped 

func (i *Application) HasBeenBootstrapped() bool

func (*Application) Invoke 

func (i *Application) Invoke(function interface{}, opts ...dig.InvokeOption) error

func (*Application) IsDownForMaintenance 

func (i *Application) IsDownForMaintenance() bool

func (*Application) MaintenanceMode 

func (i *Application) MaintenanceMode() context.Context

func (*Application) Provide 

func (i *Application) Provide(function interface{}, opts ...dig.ProvideOption) error

func (*Application) Register 

func (i *Application) Register(providers ...any)

func (*Application) SetLocale 

func (i *Application) SetLocale(locale string)

func (*Application) ShowProviders 

func (i *Application) ShowProviders()

func (*Application) ShowSubApps 

func (i *Application) ShowSubApps()

func (*Application) Terminate 

func (i *Application) Terminate()

func (*Application) Terminating 

func (i *Application) Terminating(callback interface{}) foundation.Application

func (*Application) Version 

func (i *Application) Version() string

func (*Application) WebShell 

func (i *Application) WebShell()

WebShell 使用Web壳(接口调用) 使用系统

type Installable 

type Installable interface {
	service.Interface
	GetBinName() string
	GetDisplayName() string
	GetDescription() string
	GetVersion() string
}

type ServiceCommandGetter 

type ServiceCommandGetter struct {
	// contains filtered or unexported fields
}

func (*ServiceCommandGetter) Lang 

func (i *ServiceCommandGetter) Lang()

type SubApp 

type SubApp interface {
	Name() string
	RegisterRouters()
	ServiceProviders() []foundation.ServiceProvider
	Binds() []any
	Menu() []*router.Menu
	Commands() []*cobra.Command
	// Bootstrap 应用启动前执行，如初始化配置,初始化数据，初始化表结构等
	Bootstrap()
}

SubApp 子应用

Source Files

  • application.go
  • service_installer.go

Directories

Path Synopsis
conf
container
errors
foundation
log
pay
provider
appconf
captcha
captcha/cache_captcha
clickhouse
conf
db
event
log
mqtt
ocr
pay
pay/impl
permission
rabbitmq
redis
router
router/middleware
socketio
storage
validator
cmd
file: url_match.go Package urlmatch 提供与 Gin 路由语义一致的 URL 匹配工具（对称匹配）
 file: url_match.go Package urlmatch 提供与 Gin 路由语义一致的 URL 匹配工具（对称匹配）
file
structs
Package structs contains various utilities functions to work with structs.
 Package structs contains various utilities functions to work with structs.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.