# mshare

**Repository Path**: kdisi_admin/mshare

## Basic Information

- **Project Name**: mshare
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-10-22
- **Last Updated**: 2026-10-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Share

`gitee.com/kdisi_admin/mshare` 是联犀项目使用的 Go 公共基础库，为多个业务模块提供可复用的基础能力。

## 主要能力

- 上下文、用户与鉴权相关辅助能力。
- 配置、客户端及数据库存储封装。
- 缓存、事件总线和对象存储支持。
- 错误码、多语言、HTTP 响应及协议定义。
- 通用工具、定时任务、WebSocket 与 AI 服务辅助能力。

## 目录结构

| 目录 | 说明 |
| --- | --- |
| `ai` | AI 服务相关能力 |
| `caches` | 缓存辅助能力 |
| `clients` | 外部服务客户端封装 |
| `conf` | 配置定义与加载辅助 |
| `crons` | 定时任务相关工具 |
| `ctxs` | 请求上下文与上下文辅助 |
| `def` | 公共常量、类型及定义 |
| `errors` | 错误类型、错误码与多语言资源 |
| `eventBus`、`events` | 事件总线及事件定义 |
| `i18ns` | 多语言支持 |
| `interceptors` | 拦截器辅助能力 |
| `oss` | 对象存储封装 |
| `proto` | Protocol Buffers 定义及生成代码 |
| `result` | 响应结果辅助类型 |
| `services` | 服务调用辅助能力 |
| `stores` | 数据存储及数据库辅助能力 |
| `systems` | 系统级辅助能力 |
| `tools`、`utils` | 通用工具函数 |
| `users`、`verify` | 用户及验证相关能力 |
| `websocket` | WebSocket 通信支持 |

## 环境要求

- Go 1.27.3 或兼容版本
- Go module：`gitee.com/kdisi_admin/mshare`

在其他 Go module 中使用时，按需引入所需子包，例如：

```go
import "gitee.com/kdisi_admin/mshare/utils"
```

## 测试

在仓库根目录运行全部 Go 测试：

```sh
go test ./...
```

各子包的专用说明和使用示例请参阅对应目录中的文档。