Compare commits

..

6 Commits

Author SHA1 Message Date
f2d8ae26f6 build(go): 移除 go.mod 中所有依赖项声明
清理 go.mod 文件,移除了所有直接和间接的依赖项引用,
可能为后续依赖管理或模块重构做准备。
2025-09-22 19:03:20 +08:00
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 等
- 自动拉取并锁定所有间接依赖版本
```
2025-09-22 19:02:38 +08:00
f70f8d94db fix(with): 修复 memory.go 中的配置初始化错误
将 bigcache.Config 结构体实例改为指针传递,确保配置能够正确初始化和传递。
2025-09-20 11:32:24 +08:00
257f0a6b6e fix(with): 优化 memory cache 配置初始化逻辑
移除未使用的 `encoding/json` 包导入。
调整配置初始化方式,避免不必要的结构体拷贝。
改进日志输出内容,仅显示关键配置项。
2025-09-20 11:21:02 +08:00
5e25e8eccc fix(with/etcd): 修改Etcd配置为空时的处理逻辑
当Etcd配置或端点为空时,将panic改为直接返回,避免程序崩溃
2025-09-20 11:08:47 +08:00
4f584726d6 ```
refactor(with): 调整Memory函数参数顺序

将Memory函数的参数顺序从(opts, cli)调整为(cli, opts),
使函数签名更加符合常规的客户端优先参数排列习惯,
提升代码可读性和一致性。
```
2025-09-20 10:59:45 +08:00
9 changed files with 158 additions and 66 deletions

View File

@@ -1,27 +1,59 @@
# 私有仓库core 设置 # 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/*
``` ```
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 解密
``` ```
# crypto 加密与解密
## GCM加密 #### CBC加密
```go
Encrypt // CBC加密
Decrypt // CBC解密
``` ```
AESGCMEncrypt GCM 加密
AESGCMDecrypt GCM 解 #### ECB加
```go
AesEncryptECB // ECB加密
AesDecryptECB // ECB解密
``` ```
## CBC加密
``` #### 环境变量检测
Encrypt CBC加密 ```go
Decrypt CBC解密 AesKeyCheck // 秘钥环境变量检测
```
## ECB加密
```
AesEncryptECB ECB加密
AesDecryptECB ECB解密
```
## 环境变量检测
```
AesKeyCheck 秘钥环境变量检测
``` ```
### 缓存 (cache)
支持 Redis 和内存缓存。
### 数据库 (database)
支持 MySQL 和 PostgreSQL 数据库连接和管理。
### 中间件 (middleware)
提供 CORS、JWT 认证、运行模式控制等中间件功能。
### 消息队列 (queue)
集成 NATS 消息队列。
### 工具类 (utils)
提供 JSON 处理、时间处理、随机数生成等通用工具函数。

View File

@@ -104,31 +104,41 @@ func AesDecryptCBC(cryted string) (b []byte, err error) {
return orig, nil return orig, nil
} }
// PKCS7Padding 使用PKCS7填充法对明文进行填充
func PKCS7Padding(ciphertext []byte, blocksize int) []byte { func PKCS7Padding(ciphertext []byte, blocksize int) []byte {
padding := blocksize - len(ciphertext)%blocksize padding := blocksize - len(ciphertext)%blocksize
padtext := bytes.Repeat([]byte{byte(padding)}, padding) padtext := bytes.Repeat([]byte{byte(padding)}, padding)
return append(ciphertext, padtext...) return append(ciphertext, padtext...)
} }
// 去码 // PKCS7UnPadding 去除PKCS7填充
// bug:runtime error: slice bounds out of range [:-22] // bug:runtime error: slice bounds out of range [:-22]
func PKCS7UnPadding(origData []byte, blocksize int) []byte { func PKCS7UnPadding(origData []byte, blocksize int) []byte {
// 检查块大小是否有效
if blocksize <= 0 { if blocksize <= 0 {
return nil return nil
} }
// 检查原始数据是否为空
if origData == nil || len(origData) == 0 { if origData == nil || len(origData) == 0 {
return nil return nil
} }
// 检查数据长度是否为块大小的整数倍
if len(origData)%blocksize != 0 { if len(origData)%blocksize != 0 {
return nil return nil
} }
length := len(origData) length := len(origData)
// 获取填充字节数
unpadding := int(origData[length-1]) unpadding := int(origData[length-1])
// 检查去填充后数据长度是否有效
if length-unpadding <= 0 { if length-unpadding <= 0 {
return nil return nil
} }
// 返回去除填充后的数据
return origData[:(length - unpadding)] return origData[:(length - unpadding)]
} }

View File

@@ -1,3 +1,4 @@
// Package database provides database connection and management functionality
package database package database
import ( import (
@@ -12,9 +13,14 @@ import (
) )
var ( var (
// MigrateTables holds the tables that need to be auto-migrated on database initialization
MigrateTables []any MigrateTables []any
// Init is an optional initialization function that can be executed after database connection is established
Init *func() = nil
) )
// NewDatabase creates a new database connection based on the provided driver type
// It supports both MySQL and PostgreSQL databases
func NewDatabase(driver string, dsn []string, options *types.SqlOptions) (db *gorm.DB, err error) { func NewDatabase(driver string, dsn []string, options *types.SqlOptions) (db *gorm.DB, err error) {
driver = strings.ToLower(driver) driver = strings.ToLower(driver)
switch driver { switch driver {
@@ -30,16 +36,21 @@ func NewDatabase(driver string, dsn []string, options *types.SqlOptions) (db *go
return nil, err return nil, err
} }
// Execute the Init function if it's not nil
if Init != nil {
(*Init)()
}
return db, nil return db, nil
} }
// NewMysql 创建MySQL数据库服务 // NewMysql creates a MySQL database service
func NewMysql(dsn []string, options *types.SqlOptions) (gormDb *gorm.DB, err error) { func NewMysql(dsn []string, options *types.SqlOptions) (gormDb *gorm.DB, err error) {
//set connection default val. //set connection default val.
if options == nil { if options == nil {
options = &types.SqlOptions{ options = &types.SqlOptions{
MaxIdleConns: vars.SqlOptionMaxIdleConns, MaxIdleConns: vars.SqlOptionMaxIdleConns,
MaxOpenConns: vars.SqlOptionMaxIdleConns, MaxOpenConns: vars.SqlOptionMaxOpenConns,
ConnMaxLifetime: vars.SqlOptionConnMaxLifetime, ConnMaxLifetime: vars.SqlOptionConnMaxLifetime,
LogStdout: false, LogStdout: false,
Debug: true, Debug: true,
@@ -58,7 +69,11 @@ func NewMysql(dsn []string, options *types.SqlOptions) (gormDb *gorm.DB, err err
} }
// 获取通用数据库对象 sql.DB ,然后使用其提供的功能 // 获取通用数据库对象 sql.DB ,然后使用其提供的功能
sqlDB, _ := gormDb.DB() sqlDB, err := gormDb.DB()
if err != nil {
return nil, err
}
// SetMaxIdleConns 用于设置连接池中空闲连接的最大数量。 // SetMaxIdleConns 用于设置连接池中空闲连接的最大数量。
sqlDB.SetMaxIdleConns(options.MaxIdleConns) sqlDB.SetMaxIdleConns(options.MaxIdleConns)
// SetMaxOpenConns 设置打开数据库连接的最大数量。 // SetMaxOpenConns 设置打开数据库连接的最大数量。
@@ -76,13 +91,13 @@ func NewMysql(dsn []string, options *types.SqlOptions) (gormDb *gorm.DB, err err
return gormDb, nil return gormDb, nil
} }
// NewPostgres 创建PostgreSQL数据库服务 // NewPostgres creates a PostgreSQL database service
func NewPostgres(dsn []string, options *types.SqlOptions) (gormDb *gorm.DB, err error) { func NewPostgres(dsn []string, options *types.SqlOptions) (gormDb *gorm.DB, err error) {
//set connection default val. //set connection default val.
if options == nil { if options == nil {
options = &types.SqlOptions{ options = &types.SqlOptions{
MaxIdleConns: vars.SqlOptionMaxIdleConns, MaxIdleConns: vars.SqlOptionMaxIdleConns,
MaxOpenConns: vars.SqlOptionMaxIdleConns, MaxOpenConns: vars.SqlOptionMaxOpenConns,
ConnMaxLifetime: vars.SqlOptionConnMaxLifetime, ConnMaxLifetime: vars.SqlOptionConnMaxLifetime,
LogStdout: false, LogStdout: false,
Debug: true, Debug: true,
@@ -98,6 +113,19 @@ func NewPostgres(dsn []string, options *types.SqlOptions) (gormDb *gorm.DB, err
gormDb = gormDb.Debug() gormDb = gormDb.Debug()
} }
// 获取通用数据库对象 sql.DB ,然后使用其提供的功能
sqlDB, err := gormDb.DB()
if err != nil {
return nil, err
}
// SetMaxIdleConns 用于设置连接池中空闲连接的最大数量。
sqlDB.SetMaxIdleConns(options.MaxIdleConns)
// SetMaxOpenConns 设置打开数据库连接的最大数量。
sqlDB.SetMaxOpenConns(options.MaxOpenConns)
// SetConnMaxLifetime 设置了连接可复用的最大时间。
sqlDB.SetConnMaxLifetime(options.ConnMaxLifetime)
if len(MigrateTables) > 0 { if len(MigrateTables) > 0 {
err = gormDb.AutoMigrate(MigrateTables...) err = gormDb.AutoMigrate(MigrateTables...)
if err != nil { if err != nil {
@@ -106,4 +134,4 @@ func NewPostgres(dsn []string, options *types.SqlOptions) (gormDb *gorm.DB, err
} }
return return
} }

View File

@@ -12,7 +12,7 @@ func SetOptions(options *types.SqlOptions) *types.SqlOptions {
if options == nil { if options == nil {
options = &types.SqlOptions{ options = &types.SqlOptions{
MaxIdleConns: vars.SqlOptionMaxIdleConns, MaxIdleConns: vars.SqlOptionMaxIdleConns,
MaxOpenConns: vars.SqlOptionMaxIdleConns, MaxOpenConns: vars.SqlOptionMaxOpenConns,
ConnMaxLifetime: vars.SqlOptionConnMaxLifetime, ConnMaxLifetime: vars.SqlOptionConnMaxLifetime,
LogStdout: false, LogStdout: false,
Debug: false, Debug: false,
@@ -30,7 +30,7 @@ func NewPostgreSql(dsn string, options *types.SqlOptions) (*gorm.DB, error) {
if options == nil { if options == nil {
options = &types.SqlOptions{ options = &types.SqlOptions{
MaxIdleConns: vars.SqlOptionMaxIdleConns, MaxIdleConns: vars.SqlOptionMaxIdleConns,
MaxOpenConns: vars.SqlOptionMaxIdleConns, MaxOpenConns: vars.SqlOptionMaxOpenConns,
ConnMaxLifetime: vars.SqlOptionConnMaxLifetime, ConnMaxLifetime: vars.SqlOptionConnMaxLifetime,
LogStdout: false, LogStdout: false,
Debug: true, Debug: true,
@@ -56,7 +56,11 @@ func NewPostgreSql(dsn string, options *types.SqlOptions) (*gorm.DB, error) {
} }
// 获取通用数据库对象 sql.DB ,然后使用其提供的功能 // 获取通用数据库对象 sql.DB ,然后使用其提供的功能
sqlDB, _ := gormDb.DB() sqlDB, err := gormDb.DB()
if err != nil {
return nil, err
}
// SetMaxIdleConns 用于设置连接池中空闲连接的最大数量。 // SetMaxIdleConns 用于设置连接池中空闲连接的最大数量。
sqlDB.SetMaxIdleConns(options.MaxIdleConns) sqlDB.SetMaxIdleConns(options.MaxIdleConns)
// SetMaxOpenConns 设置打开数据库连接的最大数量。 // SetMaxOpenConns 设置打开数据库连接的最大数量。
@@ -65,4 +69,4 @@ func NewPostgreSql(dsn string, options *types.SqlOptions) (*gorm.DB, error) {
sqlDB.SetConnMaxLifetime(options.ConnMaxLifetime) sqlDB.SetConnMaxLifetime(options.ConnMaxLifetime)
return gormDb, nil return gormDb, nil
} }

View File

@@ -94,7 +94,11 @@ func (s *ServiceRegister) Close() error {
func (s *ServiceRegister) SetAnonymous(key string, urls []string) { func (s *ServiceRegister) SetAnonymous(key string, urls []string) {
// remove reppeat, clear service all anonymous uri. // remove reppeat, clear service all anonymous uri.
anonymous, _ := s.cli.Get(context.Background(), key) anonymous, err := s.cli.Get(context.Background(), key)
if err != nil {
print.Error("[BSM Register] Get Anonymous Fail: %v", err)
return
}
var as []string var as []string
if len(anonymous.Kvs) > 0 { if len(anonymous.Kvs) > 0 {
@@ -106,7 +110,7 @@ func (s *ServiceRegister) SetAnonymous(key string, urls []string) {
newAnonymous := strings.Join(as, ",") newAnonymous := strings.Join(as, ",")
// put anonymous to etcd // put anonymous to etcd
_, err := s.cli.Put(context.Background(), key, newAnonymous) _, err = s.cli.Put(context.Background(), key, newAnonymous)
if err != nil { if err != nil {
print.Error("[BSM Register] Anonymous Fail.") print.Error("[BSM Register] Anonymous Fail.")

View File

@@ -6,36 +6,48 @@ import (
"strings" "strings"
) )
// 字符串转Int // String2Int 字符串转Int
// //
// intStr数字的字符串 // intStr数字的字符串
func String2Int(intStr string) (intNum int) { func String2Int(intStr string) (intNum int) {
intNum, _ = strconv.Atoi(intStr) intNum, err := strconv.Atoi(intStr)
if err != nil {
return 0
}
return return
} }
// 字符串转Int64 // String2Int64 字符串转Int64
// //
// intStr数字的字符串 // intStr数字的字符串
func String2Int64(intStr string) (int64Num int64) { func String2Int64(intStr string) (int64Num int64) {
intNum, _ := strconv.Atoi(intStr) intNum, err := strconv.Atoi(intStr)
if err != nil {
return 0
}
int64Num = int64(intNum) int64Num = int64(intNum)
return return
} }
// 字符串转Float64 // String2Float64 字符串转Float64
// //
// floatStr小数点数字的字符串 // floatStr小数点数字的字符串
func String2Float64(floatStr string) (floatNum float64) { func String2Float64(floatStr string) (floatNum float64) {
floatNum, _ = strconv.ParseFloat(floatStr, 64) floatNum, err := strconv.ParseFloat(floatStr, 64)
if err != nil {
return 0
}
return return
} }
// 字符串转Float32 // String2Float32 字符串转Float32
// //
// floatStr小数点数字的字符串 // floatStr小数点数字的字符串
func String2Float32(floatStr string) (floatNum float32) { func String2Float32(floatStr string) (floatNum float32) {
floatNum64, _ := strconv.ParseFloat(floatStr, 32) floatNum64, err := strconv.ParseFloat(floatStr, 32)
if err != nil {
return 0
}
floatNum = float32(floatNum64) floatNum = float32(floatNum64)
return return
} }

View File

@@ -25,11 +25,17 @@ func CreateDir(dirName string) bool {
} }
func GetRunPath() string { func GetRunPath() string {
path, _ := os.Executable() path, err := os.Executable()
if err != nil {
return ""
}
return path return path
} }
func GetCurrentPath() string { func GetCurrentPath() string {
path, _ := os.Getwd() path, err := os.Getwd()
if err != nil {
return ""
}
return path return path
} }

View File

@@ -13,7 +13,7 @@ import (
func Etcd(cfg *conf.EtcdConf, cli *clientv3.Client) { func Etcd(cfg *conf.EtcdConf, cli *clientv3.Client) {
if cfg == nil || len(cfg.Endpoints) == 0 { if cfg == nil || len(cfg.Endpoints) == 0 {
panic("Etcd endpoints is Empty!") return
} }
etcdCfg := clientv3.Config{ etcdCfg := clientv3.Config{

View File

@@ -2,7 +2,6 @@ package with
import ( import (
"context" "context"
"encoding/json"
"time" "time"
"git.apinb.com/bsm-sdk/core/print" "git.apinb.com/bsm-sdk/core/print"
@@ -10,30 +9,27 @@ import (
"github.com/allegro/bigcache/v3" "github.com/allegro/bigcache/v3"
) )
func Memory(opts *bigcache.Config, cli *bigcache.BigCache) { func Memory(cli *bigcache.BigCache, opts *bigcache.Config) {
config := bigcache.Config{ if opts == nil {
Shards: 1024, opts = &bigcache.Config{
LifeWindow: 10 * time.Minute, Shards: 1024,
CleanWindow: 5 * time.Minute, LifeWindow: 10 * time.Minute,
MaxEntriesInWindow: 1000 * 10 * 60, CleanWindow: 5 * time.Minute,
MaxEntrySize: 500, MaxEntriesInWindow: 1000 * 10 * 60,
Verbose: true, MaxEntrySize: 500,
HardMaxCacheSize: 8192, Verbose: true,
OnRemove: nil, HardMaxCacheSize: 8192,
OnRemoveWithReason: nil, OnRemove: nil,
} OnRemoveWithReason: nil,
}
if opts != nil {
config = *opts
} }
var err error var err error
cli, err = bigcache.New(context.Background(), config) cli, err = bigcache.New(context.Background(), *opts)
if err != nil { if err != nil {
print.Error("Memory Cache Fatal Error") print.Error("Memory Cache Fatal Error")
panic(err) panic(err)
} }
jsonBytes, _ := json.Marshal(config) print.Success("[BSM - %s] Memory Cache: Shards=%d, MaxEntrySize=%d", vars.ServiceKey, opts.Shards, opts.MaxEntrySize)
print.Success("[BSM - %s] Memory Cache: %s", vars.ServiceKey, jsonBytes)
} }