fix: 设计原则审查修复 — DIP/ISP, LoD, DRY, OCP, URL, 301缓存
- P0 DIP+ISP: 全链路注入接口,消除零接口紧耦合 - P0 URL: auth 301→302,修复登出后浏览器缓存陷阱 - P1 DRY: JWT 认证逻辑收敛至 TokenService+中间件 - P2 DRY: 前后端角色/状态映射统一为 model 常量 - P2 LoD: 新增 SettingsController,router 不再跨层调 repo - P2 URL: settings ?tab= → /settings/:tab 伪静态 - P3 OCP: 角色权限 map 化,告别硬编码 switch
This commit is contained in:
119
README.md
119
README.md
@ -1,3 +1,118 @@
|
||||
# MetaLab
|
||||
<p align="center">
|
||||
<img src="https://img.shields.io/badge/Go-1.25-00ADD8?style=flat-square&logo=go" alt="Go 1.25">
|
||||
<img src="https://img.shields.io/badge/Gin-1.12-0096D6?style=flat-square&logo=go" alt="Gin 1.12">
|
||||
<img src="https://img.shields.io/badge/GORM-1.31-7A6F5D?style=flat-square" alt="GORM 1.31">
|
||||
<img src="https://img.shields.io/badge/PostgreSQL-16-4169E1?style=flat-square&logo=postgresql&logoColor=white" alt="PostgreSQL">
|
||||
<img src="https://img.shields.io/badge/license-AGPL--3.0-blue?style=flat-square" alt="AGPL 3.0">
|
||||
<img src="https://img.shields.io/badge/status-dev-orange?style=flat-square" alt="status">
|
||||
</p>
|
||||
|
||||
MetaLab - 下一代开源技术社区
|
||||
<h1 align="center">MetaLab</h1>
|
||||
|
||||
<p align="center"><em>下一代开源技术社区——为构建者准备的纯粹空间</em></p>
|
||||
|
||||
---
|
||||
|
||||
## 关于项目
|
||||
|
||||
MetaLab 是一个正在开发中的开源技术社区平台,旨在为开发者提供一个**平等、纯粹、开放**的技术交流空间。
|
||||
|
||||
> **当前状态:私有开发中**。社区上线后将完全开源。
|
||||
|
||||
**核心理念:**
|
||||
- 🎯 **专注技术**——代码、架构、逻辑与可验证的事实
|
||||
- 🤝 **平等交流**——没有特权,每个成员权利平等
|
||||
- 🔓 **开放共享**——鼓励开源、协作与知识共享
|
||||
|
||||
## 技术栈
|
||||
|
||||
| 类别 | 技术 | 版本 |
|
||||
|------|------|------|
|
||||
| 语言 | **Go** | 1.25 |
|
||||
| Web 框架 | **Gin** | 1.12 |
|
||||
| ORM | **GORM** | 1.31 |
|
||||
| 数据库 | **PostgreSQL** | 16+ |
|
||||
| 认证 | **JWT** (HS256) | v5 |
|
||||
| 密码加密 | **bcrypt** (cost=12) | — |
|
||||
| 配置 | **Viper** | 1.21 |
|
||||
| 前端 | **SSR 模板** (Gin HTML) + 原生 JS/CSS | — |
|
||||
| 架构 | 分层六边形架构 | — |
|
||||
|
||||
## 当前功能
|
||||
|
||||
- ✅ **用户系统**——注册、登录、登出
|
||||
- ✅ **双 Token 认证**——Access Token (15min) + Refresh Token (30d)
|
||||
- ✅ **"记住我"**——跨会话自动恢复登录态
|
||||
- ✅ **CSRF 保护**——全站 CSRF Token
|
||||
- ✅ **速率限制**——API 调用频率控制
|
||||
- ✅ **安全头**——Content-Security-Policy 等安全响应头
|
||||
- ✅ **管理后台**——用户管理、角色权限控制
|
||||
- ✅ **软删除**——用户数据可恢复
|
||||
- ✅ **多主题支持**——可切换的前端主题系统
|
||||
|
||||
## 计划中
|
||||
|
||||
- 🔲 帖子系统(CRUD + Markdown)
|
||||
- 🔲 话题/分类导航
|
||||
- 🔲 用户设置页
|
||||
- 🔲 邮箱验证
|
||||
- 🔲 全文搜索
|
||||
- 🔲 管理后台增强(内容审核、统计分析)
|
||||
|
||||
## 快速开始
|
||||
|
||||
```bash
|
||||
# 克隆仓库
|
||||
git clone git@git.metazone.cc:MetaZone/MetaLab.git
|
||||
cd MetaLab
|
||||
|
||||
# 创建 .env 文件
|
||||
cat > .env << EOF
|
||||
DATABASE_PASSWORD=your_db_password
|
||||
JWT_SECRET=your_jwt_secret
|
||||
EOF
|
||||
|
||||
# 确保 PostgreSQL 运行中
|
||||
# 默认连接: 127.0.0.1:5432, 数据库: metalab_dev
|
||||
|
||||
# 运行
|
||||
go run cmd/server/main.go
|
||||
```
|
||||
|
||||
启动后访问 `http://localhost:8080`。
|
||||
|
||||
## 项目结构
|
||||
|
||||
```
|
||||
MetaLab/
|
||||
├── cmd/server/ # 入口:初始化 → 启动
|
||||
├── internal/
|
||||
│ ├── config/ # 配置加载(YAML + .env)
|
||||
│ ├── router/ # 路由注册
|
||||
│ ├── controller/ # 控制器(参数绑定 → 调服务 → 返回)
|
||||
│ │ └── admin/ # 后台控制器
|
||||
│ ├── service/ # 业务逻辑层
|
||||
│ ├── repository/ # 数据访问层(DAO)
|
||||
│ ├── model/ # 数据模型 + DTO
|
||||
│ ├── middleware/ # 中间件(认证/CSRF/限流/安全)
|
||||
│ ├── common/ # 公共工具(响应/分页/加密)
|
||||
│ └── theme/ # 主题/模板管理
|
||||
├── templates/ # 前端模板(多主题)
|
||||
│ ├── MetaLab-2026/ # 前台主题
|
||||
│ └── admin/ # 后台模板
|
||||
└── docs/ # 开发文档
|
||||
```
|
||||
|
||||
## 许可
|
||||
|
||||
本项目采用 **[GNU Affero General Public License v3.0 (AGPL-3.0)](https://www.gnu.org/licenses/agpl-3.0.html)** 许可。
|
||||
|
||||
**社区版**(AGPL-3.0):可自由使用、修改、分发,但修改后通过网络提供服务时必须公开源码。
|
||||
|
||||
**商业授权**:如需闭源部署、私有化修改或商业技术支持,请联系 [metazone@foxmail.com](mailto:metazone@foxmail.com) 获取商业授权。
|
||||
|
||||
---
|
||||
|
||||
<p align="center">
|
||||
<sub>© 2024-2026 MetaZone | Built with ❤️ by <a href="https://metazone.cc">MetaZone</a> </sub>
|
||||
</p>
|
||||
|
||||
Reference in New Issue
Block a user