参考资料
官方文档
https://beego.me/docs/intro/
官方Samples
- Web完整项目 聊天室项目
- API项目 Shorturl 项目
- 前后端分离项目 angularJS + API, Todo待办事项的项目
https://github.com/beego/samples
Beego的简介
中国人自己开发的Go应用框架,支持八大低耦合独立的模块,同时支持bee小工具,快速开发Go的应用程序,另外还自带了监控模块,类似于SpringBoot的 Actutar的功能
优点是大而全,缺点是过于臃肿了,在某些模块,比如mvc模块、orm模块,不如一些小而专的框架(Gin)
- Orm框架
- MVC路由
- 日志模块
- 缓存模块
- 配置文件
- session管理
- RestFul
配置文件的使用
bee工具生成的beego项目,会在conf路径下有app.conf文件,直接配置,然后就可以使用了。
包括了很多核心功能的配置:静态资源路径、端口、session、日志配置、Web配置、App配置等等
- 配置常用的参数
- httpport
- 项目不同类型的数据的配置和读取(字符串、数字)
mysqluser = "root"
numb = 1000
beego.AppConfig.String("mysqluser")
num,err :=beego.AppConfig.Int64("numb")
可以通过在app.conf里面include其它配置文件来实现不同功能的配置文件分开配置,比如database.conf文件
支持类似于pom.xml的runmode配置,从而减少不同环境的配置修改的数量
runmode ="dev"
[dev]
httpport = 8080
[prod]
httpport = 8088
[test]
httpport = 8888
支持配置beego.BConfig.RouterCaseSensitive(默认true)属性,来开启路由字母大小写的问题
AutoRender 属性默认是打开的,对于API类型的项目,应该手动关闭模板渲染功能
beego.BConfig.WebConfig.AutoRender = true
- 路由相关的配置 ViewsPath、TemplateLeft、TemplateRight、StaticDir
StaticDir="static" 静态文件css、js、图片的路径
TemplateLeft 模板左标签,默认值是{{。
TemplateLeft="{{"
TemplateRight 模板右标签,默认值是}}。
TemplateRight="}}"
ViewsPath 模板路径,默认值是 views。
ViewsPath="views"
- 监控配置,8088端口,默认关闭,可以通过这个端口查询到 QPS、CPU、内存、GC、goroutine、thread 等统计信息。
EnableAdmin = false
AdminAddr = "localhost"
AdminPort = 8088
Beego 路由功能
特性:
- 模板文件因为是预编译的,所以默认模板文件是无法热加载的,和普通模式下的加载方式不同,但是提升了模板渲染的速度
- 模板文件:默认支持 tpl 和 html 的后缀名
使用方式:
- 在 controllers里面根据业务配置相应的方法,通过成员变量的方式,间接的继承beego.Controller,并拥有了一些列常用的方法 Get() Post()等等
type MainController struct {
beego.Controller
}
func (c *MainController) Test() {
c.Data["Website"] = "QQQ"
c.Data["Email"] = "QQQ"
c.TplName = "index.tpl"
}
- 在 routers/router.go 里面配置路由规则
func init() {
beego.Router("/", &controllers.MainController{})
beego.Router("/test", &controllers.MainController{},"get:Test")
}
- 在main包里面,启动初始化的方式 引用到router包,并且启动beego
import (
_ "firstproject/routers"
"github.com/astaxie/beego"
)
func main() {
beego.Run()
}
注解式路由的使用
beego会自动进行源码分析,但是只会在dev模式下生成,生成的路由放在/routers/commentsRouter_controllers.go
- routers.go文件里面,直接通过.Include的方式引入MainController
beego.Include(&controllers.MainController{})
- Controller文件里面,通过 // @router注解 实现映射
// @router / [get]
func (this *MainController) Index() {
this.TplName = "templates/index.html"
}
- runmode 必须是 dev环境才行
runmode = dev
直接返回数据
this.Ctx.WriteString("hello 1111")
Beego日志功能
https://beego.me/docs/module/logs.md
依赖类库"github.com/astaxie/beego/logs"
- Console日志输出
logs.Debug("my book is bought in the year of ", 2016)
logs.Info("this %s cat is %v years old", "yellow", 3)
logs.Warn("json is a type of kv like", map[string]int{"key": 2016})
logs.Error(1024, "is a very", "good game")
logs.Critical("oh,crash")
- 可以通过设置从而输出到日志文件当中,因为默认用的是全局的logs,所以可以在main里面执行,就输出到对应的目录下面
//同时输出到console和file
beego.SetLogger("file", `{"filename":"logs/test.log"}`)
//通过配置这个,可以只输出到file当中
beego.BeeLogger.DelLogger("console")
- 默认级别 :LevelEmergency、LevelAlert、LevelCritical、LevelError、LevelWarning、LevelNotice、LevelInformational、LevelDebug
beego.SetLevel(beego.LevelInformational)
- logs.Async() 提升性能
Bee工具的安装和使用
https://beego.me/docs/install/bee.md
常用命令
- bee new testproject:创建标准格式的go web项目
- bee api testApiProject: 创建一个API接口类的Go项目
安装
- go get github.com/beego/bee
- 设置GOBIN 环境变量