yanweidong
dbf68c38c1
docs(readme): 重构 README 文档结构并补充模块说明 - 重新组织 README 内容，明确划分私有仓库设置、功能模块等章节 - 补充 crypto、cache、database、middleware、queue 和 utils 模块的功能简介 - 统一代码示例格式，增加 bash 和 go 语言标识 feat(crypto): 优化 PKCS7 填充与去填充函数实现 - 新增 PKCS7Padding 和 PKCS7UnPadding 函数的详细注释 - 添加对输入参数的有效性校验，提升健壮性 - 修复可能引发越界 panic 的潜在问题 feat(database): 完善数据库连接及初始化逻辑 - 为 NewDatabase、NewMysql 和 NewPostgres 函数添加完整注释 - 修复 MaxOpenConns 配置未正确赋值的问题 - 在获取 *sql.DB 实例时增加错误处理逻辑 - 支持通过 Init 变量在连接建立后执行自定义初始化函数 feat(go.mod): 初始化项目依赖管理并引入核心组件 - 添加项目所需的主要依赖包，包括 gin、gorm、redis、nats 等 - 引入常用的工具库如 uuid、ulid、gopsutil 等 - 自动拉取并锁定所有间接依赖版本 ```
59 lines
1.1 KiB
Markdown
59 lines
1.1 KiB
Markdown
# BSM-SDK Core
|
|
|
|
BSM-SDK Core 是一个企业级后端开发工具包的核心模块，提供了加密解密、配置管理、缓存、数据库访问、中间件等基础功能。
|
|
|
|
## 私有仓库设置
|
|
|
|
```bash
|
|
go env -w GOPRIVATE=git.apinb.com/*
|
|
go env -w GONOPROXY=git.apinb.com/*
|
|
go env -w GOINSECURE=git.apinb.com/*
|
|
go env -w GONOSUMDB=git.apinb.com/*
|
|
```
|
|
|
|
## 功能模块
|
|
|
|
### 加密与解密 (crypto)
|
|
|
|
#### GCM加密
|
|
```go
|
|
AESGCMEncrypt // GCM 加密
|
|
AESGCMDecrypt // GCM 解密
|
|
```
|
|
|
|
#### CBC加密
|
|
```go
|
|
Encrypt // CBC加密
|
|
Decrypt // CBC解密
|
|
```
|
|
|
|
#### ECB加密
|
|
```go
|
|
AesEncryptECB // ECB加密
|
|
AesDecryptECB // ECB解密
|
|
```
|
|
|
|
#### 环境变量检测
|
|
```go
|
|
AesKeyCheck // 秘钥环境变量检测
|
|
```
|
|
|
|
### 缓存 (cache)
|
|
|
|
支持 Redis 和内存缓存。
|
|
|
|
### 数据库 (database)
|
|
|
|
支持 MySQL 和 PostgreSQL 数据库连接和管理。
|
|
|
|
### 中间件 (middleware)
|
|
|
|
提供 CORS、JWT 认证、运行模式控制等中间件功能。
|
|
|
|
### 消息队列 (queue)
|
|
|
|
集成 NATS 消息队列。
|
|
|
|
### 工具类 (utils)
|
|
|
|
提供 JSON 处理、时间处理、随机数生成等通用工具函数。 |