mulan

README

Mulan 木兰

Mulan 是一个基于 Go 语言的轻量级 Web 开发框架，旨在简化应用程序开发流程，提供一套全面且高效的工具集。

功能特性

• 模块化设计：核心组件可独立使用，也可无缝集成
• Web 服务：基于 Gin 的 HTTP 服务，支持路由、中间件和各种常用功能
• 数据库操作：集成 GORM 提供 ORM 功能
• Redis 支持：提供 Redis 客户端封装
• 接口认证：提供 API Key 和会话认证
• 验证码系统：内置图形验证码生成功能
• 日志系统：基于 Zap 的结构化日志
• 配置管理：基于 Viper 的灵活配置系统
• 命令行工具：基于 Cobra 的 CLI 工具

目录结构

mulan/
├── app/        # 应用核心组件和配置管理
├── auth/       # 认证相关功能
│   └── apikey/ # API Key 认证实现
├── captcha/    # 验证码生成模块
├── code/       # 状态码和错误管理
├── db/         # 数据库操作和模型
│   └── gen/    # GORM 代码生成
├── log/        # 日志系统
├── rdb/        # Redis 客户端封装
├── req/        # 请求处理相关
├── rsp/        # 响应处理相关
├── tests/      # 测试代码
├── utils/      # 实用工具集
└── web/        # Web 服务和路由管理

安装

前置条件

• Go 1.24+
• MySQL 或 PostgreSQL（可选）
• Redis（可选）

安装步骤

go get https://github.com/virzz/mulan.git

使用方法

基本用法

package main

import (
	"context"
	"github.com/virzz/mulan/app"
	"github.com/virzz/mulan/web"
)

func main() {
	// 创建应用
	meta := &app.Meta{
		ID:          "myapp",
		Name:        "MyApplication",
		Description: "My Awesome Application",
		Version:     "1.0.0",
	}
	application := app.New(meta)
	
	// 创建配置
	config := app.NewDefaultConfig()
	
	// 配置Web路由
	routers := web.NewRouters()
	routers.Register(func(r *web.Router) {
		r.GET("/hello", func(c *web.Context) {
			c.String(200, "Hello, Mulan!")
		})
	})
	
	application.SetRouters(routers)
	
	// 运行应用
	application.Run(context.Background(), config)
}

贡献

欢迎提交问题和合并请求，共同改进这个项目。

许可证

本项目基于 MIT 开源。