# go-kit

**Repository Path**: MM-Q/go-kit

## Basic Information

- **Project Name**: go-kit
- **Description**: 一个功能丰富的Go语言工具包，提供常用的实用工具和组件
- **Primary Language**: Go
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-08-31
- **Last Updated**: 2025-10-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Go语言

## README

<div align="center">

# 🛠️ Go-Kit

[![Go Version](https://img.shields.io/badge/Go-1.25+-00ADD8?style=for-the-badge&logo=go)](https://golang.org/)
[![License](https://img.shields.io/badge/License-MIT-blue?style=for-the-badge)](LICENSE)
[![Build Status](https://img.shields.io/badge/Build-Passing-brightgreen?style=for-the-badge)](https://gitee.com/MM-Q/go-kit)

**一个功能丰富的Go语言工具包，提供常用的实用工具和组件**

[📖 文档](https://gitee.com/MM-Q/go-kit) • [🚀 快速开始](#-快速开始) • [💡 示例](#-使用示例) • [🤝 贡献](#-贡献指南)

</div>

---

## 📋 项目简介

Go-Kit 是一个精心设计的Go语言工具包，集成了开发过程中常用的实用工具和组件。该项目旨在提高开发效率，减少重复代码，为Go开发者提供一套完整的基础工具集。

## ✨ 核心特性

- 🗂️ **文件系统工具** - 提供文件操作、路径处理等实用功能
- 🔐 **哈希工具** - 支持多种哈希算法的便捷封装
- 🆔 **ID生成器** - 提供UUID、雪花算法等ID生成方案
- 🏊 **对象池** - 高性能的对象池实现，优化内存使用
- 📝 **字符串工具** - 丰富的字符串处理和操作函数
- 🔧 **通用工具** - 其他常用的辅助函数和工具

## 🚀 快速开始

### 安装

使用 `go get` 命令从Gitee安装：

```bash
go get gitee.com/MM-Q/go-kit
```

## 📚 API文档

### 核心模块

| 模块 | 描述 | 主要功能 |
|------|------|----------|
| `fs` | 文件系统工具 | 文件操作、路径处理、目录管理 |
| `hash` | 哈希工具 | MD5、SHA1、SHA256等哈希算法 |
| `id` | ID生成器 | UUID、雪花算法、随机ID |
| `pool` | 对象池 | 高性能对象复用池 |
| `str` | 字符串工具 | 字符串转换、格式化、验证 |
| `utils` | 通用工具 | 其他实用函数 |

## 📁 项目结构

```
go-kit/
├── fs/                 # 文件系统工具
│   ├── fs.go          # 核心文件操作
│   └── fs_test.go     # 单元测试
├── hash/              # 哈希工具
│   ├── hash.go        # 哈希算法实现
│   └── hash_test.go   # 单元测试
├── id/                # ID生成器
│   ├── id.go          # ID生成实现
│   └── id_test.go     # 单元测试
├── pool/              # 对象池
│   ├── pool.go        # 对象池实现
│   └── pool_test.go   # 单元测试
├── str/               # 字符串工具
│   ├── str.go         # 字符串处理
│   └── str_test.go    # 单元测试
├── utils/             # 通用工具
│   ├── utils.go       # 实用函数
│   ├── utils_test.go  # 单元测试
│   ├── json.go        # JSON 工具
│   └── json_test.go   # 单元测试
│     
├── go.mod             # Go模块文件
├── go.sum             # 依赖校验文件
├── LICENSE            # 许可证文件
└── README.md          # 项目说明
```

## 🧪 测试说明

### 运行所有测试

```bash
go test ./...
```

### 运行特定模块测试

```bash
go test ./str
go test ./hash
go test ./pool
```

### 生成测试覆盖率报告

```bash
go test -coverprofile=coverage.out ./...
go tool cover -html=coverage.out -o coverage.html
```

### 基准测试

```bash
go test -bench=. ./...
```

## 🔧 开发环境

### 要求

- Go 1.25 或更高版本
- Git

### 本地开发

1. 克隆仓库：
```bash
git clone https://gitee.com/MM-Q/go-kit.git
# 或者从GitHub镜像克隆
git clone https://github.com/MM-Q/go-kit.git
```

2. 进入项目目录：
```bash
cd go-kit
```

3. 安装依赖：
```bash
go mod tidy
```

4. 运行测试：
```bash
go test ./...
```

## 🤝 贡献指南

我们欢迎所有形式的贡献！请遵循以下步骤：

1. **Fork** 本仓库
2. 创建你的特性分支 (`git checkout -b feature/AmazingFeature`)
3. 提交你的更改 (`git commit -m 'Add some AmazingFeature'`)
4. 推送到分支 (`git push origin feature/AmazingFeature`)
5. 打开一个 **Pull Request**

### 代码规范

- 遵循 Go 官方代码规范
- 添加适当的注释和文档
- 确保所有测试通过
- 保持测试覆盖率在 80% 以上

## 📄 许可证

本项目采用 MIT 许可证 - 查看 [LICENSE](LICENSE) 文件了解详情。

## 📞 联系方式

- 🐛 问题反馈: [Gitee Issues](https://gitee.com/MM-Q/go-kit/issues)
- 💬 讨论: [Gitee 评论区](https://gitee.com/MM-Q/go-kit)
- 🔗 GitHub镜像: [GitHub Repository](https://github.com/MM-Q/go-kit)

## 🔗 相关链接

- 📖 [在线文档](https://pkg.go.dev/gitee.com/MM-Q/go-kit)
- 🏠 [项目主页](https://gitee.com/MM-Q/go-kit)
- 🪞 [GitHub镜像](https://github.com/MM-Q/go-kit)
- 📊 [Go Report Card](https://goreportcard.com/report/gitee.com/MM-Q/go-kit)

---

<div align="center">

**⭐ 如果这个项目对你有帮助，请给它一个星标！**

Made with ❤️ by [MMQ](https://gitee.com/MM-Q)

</div>