# go-spring **Repository Path**: MBZJ/go-spring ## Basic Information - **Project Name**: go-spring - **Description**: Go-Spring 是模仿 Java Spring 全家桶实现的一套 GoLang 应用程序框架 - **Primary Language**: Shell - **License**: Apache-2.0 - **Default Branch**: master - **Homepage**: https://www.oschina.net/p/go-spring - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 34 - **Created**: 2021-12-26 - **Last Updated**: 2021-12-26 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README
logo
license go-version release
Go-Spring 的愿景是让 Go 程序员也能用上如 Java Spring 那般威力强大的编程框架。 其特性如下： 1. 提供了完善的 IoC 容器，支持依赖注入、属性绑定； 2. 提供了强大的启动器框架，支持自动装配、开箱即用； 3. 提供了常见组件的抽象层，支持灵活地替换底层实现； Go-Spring 当前使用 Go1.14 进行开发，使用 Go Modules 进行依赖管理。 - [spring-base](#spring-base) - [apcu](#apcu) - [assert](#assert) - [atomic](#atomic) - [spring-core](#spring-core) - [gs](#gs) - [redis](#redis) - [web](#web) ### spring-base golang 准标准库 (like cpp boost to go)。 #### apcu 提供了进程内缓存组件。 #### assert 提供了一些常用的断言函数。 #### atomic 封装标准库 atomic 包的操作函数。 ### spring-core Go-Spring 核心模块，依赖注入框架 (IoC)，web 框架 (web framework)，redis 封装 (redis)，mysql 封装 (gem) ... #### gs 实现了 go-spring 的核心骨架，包含 IoC 容器、基于 IoC 容器的 App 以及全局 App 对象封装三个部分，可以应用于多种使用场景。 #### redis #### web 为社区优秀的 Web 服务器提供一个抽象层，使得底层可以灵活切换。 ### IoC 容器 Go-Spring 不仅实现了如 Java Spring 那般功能强大的 IoC 容器，还扩充了 Bean 的概念。在 Go 中，对象(即指针)、数组、Map、函数指针，这些都是 Bean，都可以放到 IoC 容器里。 | 常用的 Java Spring 注解 | 对应的 Go-Spring 实现 | | :-- | :-- | | `@Value` | `value:"${}"` | | `@Autowired` `@Qualifier` `@Required` | `autowire:"?"` | | `@Configurable` | `WireBean()` | | `@Profile` | `ConditionOnProfile()` | | `@Primary` | `Primary()` | | `@DependsOn` | `DependsOn()` | | `@ConstructorBinding` | `RegisterBeanFn()` | | `@ComponentScan` `@Indexed` | Package Import | | `@Conditional` | `NewConditional()` | | `@ConditionalOnExpression` | `NewExpressionCondition()` | | `@ConditionalOnProperty` | `NewPropertyValueCondition()` | | `@ConditionalOnBean` | `NewBeanCondition()` | | `@ConditionalOnMissingBean` | `NewMissingBeanCondition()` | | `@ConditionalOnClass` | Don't Need | | `@ConditionalOnMissingClass` | Don't Need | | `@Lookup` | —— | ### 属性绑定 Go-Spring 不仅支持对普通数据类型进行属性绑定，也支持对自定义值类型进行属性绑定，而且还支持对结构体属性的嵌套绑定。 ``` type DB struct { UserName string `value:"${username}"` Password string `value:"${password}"` Url string `value:"${url}"` Port string `value:"${port}"` DB string `value:"${db}"` } type DbConfig struct { DB []DB `value:"${db}"` } ``` 上面这段代码可以通过下面的配置进行绑定： ``` db: - username: root password: 123456 url: 1.1.1.1 port: 3306 db: db1 - username: root password: 123456 url: 1.1.1.1 port: 3306 db: db2 ``` ### Boot 框架 Go-Spring 提供了一个功能强大的启动器框架，不仅实现了自动加载、开箱即用，而且可以非常容易的开发自己的启动器模块，使得代码不仅仅是库层面的复用。 ### 快速示例 下面的示例使用 v1.1.0-rc2 版本测试通过。 ``` import ( "fmt" "github.com/go-spring/spring-core/gs" "github.com/go-spring/spring-core/web" _ "github.com/go-spring/starter-echo" ) func init() { gs.Object(new(Controller)).Init(func(c *Controller) { gs.GetMapping("/", c.Hello) }) } type Controller struct { GOPATH string `value:"${GOPATH}"` } func (c *Controller) Hello(ctx web.Context) { ctx.String("%s - hello world!", c.GOPATH) } func main() { fmt.Println(gs.Run()) } ``` 启动上面的程序，控制台输入 `curl http://localhost:8080/`， 可得到如下结果： ``` /Users/didi/go - hello world! ``` 更多示例： https://github.com/go-spring/go-spring/tree/master/examples ### 普通路由 ``` package main import ( "fmt" "github.com/go-spring/spring-core/gs" "github.com/go-spring/spring-core/web" _ "github.com/go-spring/starter-echo" ) func main() { gs.GetMapping("/a/b/c", func(ctx web.Context) { ctx.String("OK") }) fmt.Println(gs.Run()) } ``` ``` ➜ curl http://127.0.0.1:8080/a/b/c OK ``` ### java 风格路由 ``` package main import ( "fmt" "github.com/go-spring/spring-core/gs" "github.com/go-spring/spring-core/web" _ "github.com/go-spring/starter-echo" ) func main() { gs.GetMapping("/:a/b/:c/{*:d}", func(ctx web.Context) { ctx.String("a=%s b=%s *=%s\n", ctx.PathParam("a"), ctx.PathParam("c"), ctx.PathParam("*")) ctx.String("a=%s b=%s *=%s\n", ctx.PathParam("a"), ctx.PathParam("c"), ctx.PathParam("d")) }) fmt.Println(gs.Run()) } ``` ``` ➜ curl http://127.0.0.1:8080/a/b/c/d a=a b=c *=d a=a b=c *=d ``` ### echo 风格路由 ``` package main import ( "fmt" "github.com/go-spring/spring-core/gs" "github.com/go-spring/spring-core/web" _ "github.com/go-spring/starter-echo" ) func main() { gs.GetMapping("/:a/b/:c/*", func(ctx web.Context) { ctx.String("a=%s c=%s *=%s", ctx.PathParam("a"), ctx.PathParam("c"), ctx.PathParam("*")) }) fmt.Println(gs.Run()) } ``` ``` ➜ curl http://127.0.0.1:8080/a/b/c/d a=a c=c *=d ``` ### gin 风格路由 ``` package main import ( "fmt" "github.com/go-spring/spring-core/gs" "github.com/go-spring/spring-core/web" _ "github.com/go-spring/starter-echo" ) func main() { gs.GetMapping("/:a/b/:c/*d", func(ctx web.Context) { ctx.String("a=%s b=%s *=%s\n", ctx.PathParam("a"), ctx.PathParam("c"), ctx.PathParam("*")) ctx.String("a=%s b=%s *=%s\n", ctx.PathParam("a"), ctx.PathParam("c"), ctx.PathParam("d")) }) fmt.Println(gs.Run()) } ``` ``` ➜ curl http://127.0.0.1:8080/a/b/c/d a=a b=c *=d a=a b=c *=d ``` ### 文件服务器 ``` package main import ( "fmt" "net/http" "github.com/go-spring/spring-core/gs" "github.com/go-spring/spring-core/web" _ "github.com/go-spring/starter-echo" ) func main() { gs.HandleGet("/public/*", web.WrapH(http.StripPrefix("/public/", http.FileServer(http.Dir("public"))))) fmt.Println(gs.Run()) } ``` 然后在项目下创建一个 public 目录，里面创建一个内容为 hello world! 的 a.txt 文件。 ``` ➜ curl http://127.0.0.1:8080/public/a.txt hello world! ``` ### BIND 模式 ``` package main import ( "context" "fmt" "github.com/go-spring/spring-core/gs" "github.com/go-spring/spring-core/web" _ "github.com/go-spring/starter-echo" ) type HelloReq struct { Name string `form:"name"` } type HelloResp struct { Body string `json:"body"` } func main() { gs.GetBinding("/hello", func(ctx context.Context, req *HelloReq) *web.RpcResult { return web.SUCCESS.Data(&HelloResp{Body: "hello " + req.Name + "!"}) }) fmt.Println(gs.Run()) } ``` ``` ➜ curl 'http://127.0.0.1:8080/hello?name=lvan100' {"code":200,"msg":"SUCCESS","data":{"body":"hello lvan100!"}} ``` ### 中间件 #### Basic Auth ``` package main import ( "fmt" "github.com/go-spring/spring-core/gs" "github.com/go-spring/spring-core/web" "github.com/go-spring/spring-echo" _ "github.com/go-spring/starter-echo" "github.com/labstack/echo" "github.com/labstack/echo/middleware" ) func main() { gs.Provide(func( /* 可以通过配置将用户名密码传进来 */ ) web.Filter { m := middleware.BasicAuth(func(u string, p string, e echo.Context) (bool, error) { if u == "lvan100" && p == "123456" { return true, nil } return false, nil }) return SpringEcho.Filter(m) }) gs.GetMapping("/hello", func(ctx web.Context) { ctx.String("hello %s!", ctx.QueryParam("name")) }) fmt.Println(gs.Run()) } ``` ``` ➜ curl 'http://127.0.0.1:8080/hello?name=lvan100' Unauthorized ➜ curl 'http://127.0.0.1:8080/hello?name=lvan100' -H'Authorization: Basic bHZhbjEwMDoxMjM0NTY=' {"code":200,"msg":"SUCCESS","data":{"body":"hello lvan100!"}} ``` ### 详细文档 [https://docs.lavend.net/](https://docs.lavend.net/) ### 项目成员 #### 发起者 [@lvan100 (LiangHuan)](https://github.com/lvan100) #### 贡献者 #### 特别鸣谢 [@shenqidebaozi](https://github.com/shenqidebaozi) 如何成为贡献者？提交有意义的 PR 或者需求，并被采纳。 ### QQ 交流群
QQ群号:721077608 ### 微信公众号 ### 支持我们！ 为了更好地吸引和激励开发者，我们需要您的捐赠，帮助项目快速发展。 ### License The Go-Spring is released under version 2.0 of the Apache License.