# bsfgo

**Repository Path**: luckearth/bsfgo

## Basic Information

- **Project Name**: bsfgo
- **Description**: bsf的go版本，一个轻量级的go gin框架,用于web站点和api开发。
- **Primary Language**: Go
- **License**: Apache-2.0
- **Default Branch**: v1.0.8
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 2
- **Created**: 2025-07-24
- **Last Updated**: 2025-07-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# bsfgo
![bsfgo](./demo/web/public/images/favicon.ico)<br/>一个轻量级的go gin框架,用于web站点和api开发，也是[bsf java](https://gitee.com/chejiangyi/free-bsf-all)的go版本。
#### 介绍
1. bsf的go版本bsfgo,期望通过集成常用组件，沉淀一系列工具及ai辅助编程，提高go的开发效率和开发标准化(集成和使用)。
2. 基于bsfgo,提供一套标准脚手架及配套cicd,让开发人员快速构建应用。
3. 目标: 简单,高效 (新人10分钟上手项目开发，1小时了解框架实现)。


#### 软件架构
```
-- core   (核心工具库,提供基础类及一系列Util工具) 
-- redis2 (redis集成工具库)
-- kafka2 (kafka集成工具库)
-- gorm2  (gorm集成工具库)
-- gin2   (gin集成web及api标准开发基础框架)
-- demo   (提供拷贝即用的标准项目开发脚手架模版)
go.work   项目工作区管理文件
replace_version.go 模块版本升级工具
publish_tags.sh    模块打包提交工具
project_init.go    脚手架快速生成工具
```

#### 设计理念
```
1. 工具优先: 开箱即用,不用也可。
2. 默认优先: 默认最佳调优,无需额外配置。
3. 效率优先: 效率简洁高于性能极致追求。
```

#### 快速使用
```
require (
	gitee.com/chejiangyi/bsfgo/core v1.0.6-beta.1
	gitee.com/chejiangyi/bsfgo/gin2 v1.0.6-beta.1
	gitee.com/chejiangyi/bsfgo/kafka2 v1.0.6-beta.1
	gitee.com/chejiangyi/bsfgo/redis2 v1.0.6-beta.1
	...
)
```

#### 常用集成库
* [redis 使用](_doc/redis.md)
* [kafka 使用](_doc/kafka.md)
* [gorm 使用](_doc/gorm.md)
* [db 使用](_doc/db.md)
* [http 使用](_doc/http.md)

#### gin Web集成库
* [快速开发](_doc/quick_start.md)
* [middleware 扩展](_doc/middleware.md)
* [route 工具](_doc/route.md)
* [session 工具](_doc/session.md)
* [swagger 工具](_doc/swagger.md)
* [template 模版渲染](_doc/template.md)
* [token 开发](_doc/token.md)
* [分页组件](_doc/page.md)
* [配置使用](_doc/config.md)

#### 脚手架集成
* [demo 脚手架](_doc/demo.md)

#### 组件打包发布
* [模块版本升级及打包提交](_doc/publish.md)

#### 未来扩展
1. health健康监控及上报
2. elasticsearch 集成
3. ...

#### 版本更新记录
```
2025-7-22 v1.0.8分支版本
初步完善所有相关文档及上传第一版代码
```

#### 参考
[bsf java版本](https://gitee.com/chejiangyi/free-bsf-all)

by 车江毅