beego入门教程

已于 2022-06-22 09:57:36 修改
阅读量6.1k 收藏 12
点赞数 5
分类专栏： beego 文章标签： golang 开发语言 后端 beego bee
于 2022-06-08 17:42:11 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_34060435/article/details/125189217
版权

beego快速上手使用

安装beego和bee

beego

go get -u github.com/beego/beego/v2

bee

go get -u github.com/beego/bee/v2

安装完之后，bee 可执行文件默认存放在 $GOPATH/bin 里面，所以你需要把 $GOPATH/bin 添加到你的环境变量中，才可以进行下一步。

如果发现 $GOPATH/bin 里面没有bee.exe，那就去下载的bee依赖包中（一般是pkg/mod/github.com/beego/bee）去使用go build -o bee.exe执行生成bee.exe，然后把这个exe放到 $GOPATH/bin 里面，然后添加到环境变量。

bee工具命令

new命令

new 命令是新建一个 Web 项目，我们在命令行下执行 bee new <项目名> 就可以创建一个新的项目。但是注意该命令必须在 $GOPATH/src 下执行。最后会在 $GOPATH/src 相应目录下生成如下目录结构的项目：

请添加图片描述

new这个命令生成的一般是前后端没分离的项目。

api命令

上面的 new 命令是用来新建 Web 项目，不过很多用户使用 beego 来开发 API 应用。所以这个 api 命令就是用来创建 API 应用的，执行命令之后如下所示：

请添加图片描述

从上面的目录我们可以看到和 Web 项目相比，少了 static 和 views 目录，多了一个 test 模块，用来做单元测试的。

api命令一般生成前后端分离的项目

generate命令

这个命令是用来自动化的生成代码的，包含了从数据库一键生成 model，还包含了 scaffold 的，通过这个命令，让大家开发代码不再慢

例如：bee generate docs

bee generate docs
此命令含义generate swagger doc file 生成swagger文档文件

项目初始构建

bee api quickstart
go mod tidy
bee generate docs

注意执行目录

运行项目

在项目目录下使用bee run -gendoc=true -downdoc=true运行项目。第一次运行时会自动下载调试工具swagger。

-gendoc=true 表示每次自动化的 build 文档。当项目文件中controller或者routers目录下有变动时，就需要添加这一句

-downdoc=true 会自动的下载 swagger 文档查看器。仅需要在第一次运行时使用，他会自动下载调试工具swagger

如下图：

请添加图片描述

访问http://127.0.0.1:8080/swagger/可以看到调试界面。

源码分析

在使用 bee 工具快速构建出项目后，我们来看看他生成的代码，对代码进行一个初步的分析。

main.go

首先看入口文件，main.go

package main

import (
   _ "quickstart/routers"

   beego "github.com/beego/beego/v2/server/web"
)

func main() {
   if beego.BConfig.RunMode == "dev" {
      beego.BConfig.WebConfig.DirectoryIndex = true
      beego.BConfig.WebConfig.StaticDir["/swagger"] = "swagger"
   }
   beego.Run()
}

main函数中首先进行配置设置（if语句中的内容），然后beego.Run启动服务。

BConfig就是beego里面默认的配置。

beego.BConfig.RunMode 是 应用的运行模式。在conf文件中我们可以看到beego默认配置的运行模式，如下：

请添加图片描述

beego.BConfig.WebConfig.DirectoryIndex 属于web配置部分，DirectoryIndex 表示 是否开启静态目录的列表显示，默认不显示目录(为false)，返回 403 错误。

beego.BConfig.WebConfig.StaticDir 属于web配置部分，StaticDir 是静态文件目录设置，默认是static，此处设置为swagger，就可以访问到swagger/index.html。使用swagger工具。如下图：

请添加图片描述

在这个index.html中，需要把第42行的url进行修改，如下图：

请添加图片描述>修改原因：…

最后是我们的beego.Run()方法，使用它来运行整个程序。如何运行呢？从import可以找到一个引入 _ "quickstart/routers"，这个包只引入了init函数，所以接下去就去routers/router.go查看

routers.go

// @APIVersion 1.0.0
// @Title beego Test API
// @Description beego has a very cool tools to autogenerate documents for your API
// @Contact astaxie@gmail.com
// @TermsOfServiceUrl http://beego.me/
// @License Apache 2.0
// @LicenseUrl http://www.apache.org/licenses/LICENSE-2.0.html
package routers

import (
   "quickstart/controllers"

   beego "github.com/beego/beego/v2/server/web"
)

func init() {
   ns := beego.NewNamespace("/v1",
      beego.NSNamespace("/object",
         beego.NSInclude(
            &controllers.ObjectController{},
         ),
      ),
      beego.NSNamespace("/user",
         beego.NSInclude(
            &controllers.UserController{},
         ),
      ),
   )
   beego.AddNamespace(ns)
}

routers.go中只有一个init函数，这个函数简单来说就是 把不同的请求对应到不同的控制器。请求分发。

具体分析：

beego.NewNamespace 是创建命名空间

beego.NSNamespace 是希望namespace内部嵌套namespace时使用，NSNamespace 来注入一个子namespace。

beego.NSInclude 该方法是注解路由的配套方法，只对注解路由生效。

最后使用beego.AddNamespace(ns) 来注册命名空间。

beego的命名空间就和 gin的路由组是差不多的

在routers.go目录中还有另一个文件commentsRouter_controllers.go

部分代码如下：

package routers

import (
	beego "github.com/beego/beego/v2/server/web"
	"github.com/beego/beego/v2/server/web/context/param"
)

func init() {

    beego.GlobalControllerRouter["quickstart/controllers:UserController"] = append(beego.GlobalControllerRouter["quickstart/controllers:UserController"],
        beego.ControllerComments{
            Method: "Get",
            Router: "/:uid",
            AllowHTTPMethods: []string{"get"},
            MethodParams: param.Make(),
            Filters: nil,
            Params: nil})

}

这个文件是自动生成的，当删除掉后，重新运行项目他就会自动生成。

quickstart/controllers:UserController 就对应了一层controller。

每个controller中更加具体的方法体现在 Method上，Method: "Get"，这是该控制器实现的一个方法。

这个文件就可以看作是注册控制器与函数

这个文件是通过注解路由自动生成的，仅在dev模式下生成

Router: "/:uid"。这个配置的意思是当有 Get 请求http://127.0.0.1:8080/v1/user/xxx（可以直接用浏览器访问该地址）时，会执行控制器中的Get函数。

至此，就知道怎么使用不同的请求执行不同的函数。请求被分发到控制器下面的函数，所以下一步就是控制器了。

Controllers/user.go

package controllers

import (
   "quickstart/models"
   "encoding/json"

   beego "github.com/beego/beego/v2/server/web"
)

// Operations about Users
type UserController struct {
   beego.Controller
}

// @Title CreateUser
// @Description create users
// @Param  body      body   models.User    true      "body for user content"
// @Success 200 {int} models.User.Id
// @Failure 403 body is empty
// @router / [post]
func (u *UserController) Post() {
   var user models.User
   json.Unmarshal(u.Ctx.Input.RequestBody, &user)
   uid := models.AddUser(user)
   u.Data["json"] = map[string]string{"uid": uid}
   u.ServeJSON()
}

// @Title GetAll
// @Description get all Users
// @Success 200 {object} models.User
// @router / [get]
func (u *UserController) GetAll() {
   users := models.GetAllUsers()
   u.Data["json"] = users
   u.ServeJSON()
}

// @Title Get
// @Description get user by uid
// @Param  uid       path   string true      "The key for staticblock"
// @Success 200 {object} models.User
// @Failure 403 :uid is empty
// @router /:uid [get]
func (u *UserController) Get() {
   uid := u.GetString(":uid")
   if uid != "" {
      user, err := models.GetUser(uid)
      if err != nil {
         u.Data["json"] = err.Error()
      } else {
         u.Data["json"] = user
      }
   }
   u.ServeJSON()
}

// @Title Update
// @Description update the user
// @Param  uid       path   string true      "The uid you want to update"
// @Param  body      body   models.User    true      "body for user content"
// @Success 200 {object} models.User
// @Failure 403 :uid is not int
// @router /:uid [put]
func (u *UserController) Put() {
   uid := u.GetString(":uid")
   if uid != "" {
      var user models.User
      json.Unmarshal(u.Ctx.Input.RequestBody, &user)
      uu, err := models.UpdateUser(uid, &user)
      if err != nil {
         u.Data["json"] = err.Error()
      } else {
         u.Data["json"] = uu
      }
   }
   u.ServeJSON()
}

// @Title Delete
// @Description delete the user
// @Param  uid       path   string true      "The uid you want to delete"
// @Success 200 {string} delete success!
// @Failure 403 uid is empty
// @router /:uid [delete]
func (u *UserController) Delete() {
   uid := u.GetString(":uid")
   models.DeleteUser(uid)
   u.Data["json"] = "delete success!"
   u.ServeJSON()
}

// @Title Login
// @Description Logs user into the system
// @Param  username      query  string true      "The username for login"
// @Param  password      query  string true      "The password for login"
// @Success 200 {string} login success
// @Failure 403 user not exist
// @router /login [get]
func (u *UserController) Login() {
   username := u.GetString("username")
   password := u.GetString("password")
   if models.Login(username, password) {
      u.Data["json"] = "login success"
   } else {
      u.Data["json"] = "user not exist"
   }
   u.ServeJSON()
}

// @Title logout
// @Description Logs out current logged in user session
// @Success 200 {string} logout success
// @router /logout [get]
func (u *UserController) Logout() {
   u.Data["json"] = "logout success"
   u.ServeJSON()
}

首先定义UserController结构体，该结构体“继承”beego.Controller。后面的所有内容则都是在重写这些方法。观察方法的名称可以发现，这些方法对应不同类型的 http 请求，但是也有一些方法名和请求类型看不出关系的，例如 Login()，但是可以通过看上面注释内容，所以就得提到注解路由了！

注解路由：

swagger的配置就是通过注解实现的，这些注释中写的内容最终都将呈现在swagger工具上。

注解路由通过结构体方法上面的注释进行生成，生成的文件就是routers/commentsRouter_controllers.go

注意如果conf配置文件中的RunMode模式不再是dev，那么commentsRouter_controllers.go不会再自动生成和修改，那么访问就会出问题。所以需要先在dev下修改测试好，然后再切换到prod模式。

注释写法如下：

// @Title CreateUser
// @Description create users
// @Param  body      body   models.User    true      "body for user content"
// @Success 200 {int} models.User.Id
// @Failure 403 body is empty
// @router / [post]

我们可以把注释分类：

  • @Title

    接口的标题，用来标示唯一性，唯一，可选

    格式：之后跟一个描述字符串

  • @Description

    接口的作用，用来描述接口的用途，唯一，可选

    格式：之后跟一个描述字符串

  • @Param

    请求的参数，用来描述接受的参数，多个，可选

    格式：变量名 传输类型 类型 是否必须 描述

    变量名：字符串

    传输类型：path or body or query or form or header

    • query 表示带在url串里面?aa=bb&cc=dd
    • form 表示使用表单递交数据
    • path 表示URL串中得字符，例如/user/{uid} 那么uid就是一个path类型的参数
    • body 表示使用raw body进行数据的传输
    • header 表示通过header进行数据的传输

    类型：

    • string
    • int
    • int64
    • 对象，这个地方大家写的时候需要注意，需要是相对于当前项目的路径.对象，例如models.Object表示models目录下的Object对象，这样bee在生成文档的时候会去扫描改对象并显示给用户改对象。

    是否必须：true 或者false

    描述：字符串

  • @Success

    成功返回的code和对象或者信息

    格式：code 对象类型 信息或者对象路径

    code：表示HTTP的标准status code，200 201等

    对象类型：{object}表示对象，其他默认都认为是字符类型，会显示第三个参数给用户，如果是{object}类型，那么就会去扫描改对象，并显示给用户

    对象路径和上面Param中得对象类型一样，使用路径.对象的方式来描述

  • @Failure

    错误返回的信息，

    格式： code 信息

    code:同上Success

    错误信息：字符串描述信息

  • @router

    上面已经描述过支持两个参数，第一个是路由，第二个表示支持的HTTP方法

方法内使用的结构体及其方法来自models/user.go。于是，再看models/user.go。

models/user.go

package models

import (
	"errors"
	"strconv"
	"time"
)

var (
	UserList map[string]*User
)

func init() {
	UserList = make(map[string]*User)
	u := User{"user_11111", "astaxie", "11111", Profile{"male", 20, "Singapore", "astaxie@gmail.com"}}
	UserList["user_11111"] = &u
}

type User struct {
	Id       string
	Username string
	Password string
	Profile  Profile
}

type Profile struct {
	Gender  string
	Age     int
	Address string
	Email   string
}

func AddUser(u User) string {
	u.Id = "user_" + strconv.FormatInt(time.Now().UnixNano(), 10)
	UserList[u.Id] = &u
	return u.Id
}

func GetUser(uid string) (u *User, err error) {
	if u, ok := UserList[uid]; ok {
		return u, nil
	}
	return nil, errors.New("User not exists")
}

func GetAllUsers() map[string]*User {
	return UserList
}

func UpdateUser(uid string, uu *User) (a *User, err error) {
	if u, ok := UserList[uid]; ok {
		if uu.Username != "" {
			u.Username = uu.Username
		}
		if uu.Password != "" {
			u.Password = uu.Password
		}
		if uu.Profile.Age != 0 {
			u.Profile.Age = uu.Profile.Age
		}
		if uu.Profile.Address != "" {
			u.Profile.Address = uu.Profile.Address
		}
		if uu.Profile.Gender != "" {
			u.Profile.Gender = uu.Profile.Gender
		}
		if uu.Profile.Email != "" {
			u.Profile.Email = uu.Profile.Email
		}
		return u, nil
	}
	return nil, errors.New("User Not Exist")
}

func Login(username, password string) bool {
	for _, u := range UserList {
		if u.Username == username && u.Password == password {
			return true
		}
	}
	return false
}

func DeleteUser(uid string) {
	delete(UserList, uid)
}

model层里面就是更加具体的函数操作。如CRUD一类的。

尤其是十月的风
关注
  • 5
    点赞
  • 踩
  • 12
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
beego——快速入门
H1517043456的博客
01-29 8021
beego——快速入门1，beego的安装2，bee工具的安装与使用3、beego的快速入门 1，beego的安装 打开命令行使用git安装 go get github.com/astaxie/beego beego升级方式： go get -u github.com/astaxie/beego 2，bee工具的安装与使用 bee工具的介绍：bee 工具是一个为了协助快速开发 beego 项目而创建的项目，通过 bee 可以很容易的进行 beego 项目的创建、热编译、开发、测试、和部署 bee的
全新Beego从入门到企业开发教程
06-14
张长志区块链、大数据项目讲师, Java开发、10余年软件...本课程是Go语言的中级课程Beego框架，通过几个小时的讲解，让你对Beego技术能快速用于企业实战，通过理论和实践的结合，让你能进行企业的Beego技术开发实战。
Go：Beego零基础到项目实战，2024年最新还在等机会
2401_84252820的博客
04-13 810
注册路由的时候可以指定第三个参数，这个参数就是用来自定义路由的用法： method ：函数名post:Login post请求的时候访问Login函数get:User get请求的时候访问User函数*:LoginOut 所有的请求方法都访问LoginOut函数4.3 自定义过滤器需要登录才能访问的不需要登录可以访问：/login/register第一个参数表示过滤的路由规则，支持通配符第二个参数就是过滤器的位置，beego支持的有5种BeforeStatic 静态地址之前。
2024年最新Beego框架实战教程：项目搭建及注册用户_搭建beego工程化目录，看完你还觉得算法不重要
2401_84254530的博客
05-11 999
还有兄弟不知道网络安全面试可以提前刷题吗？费时一周整理的160+网络安全面试题，金九银十，做网络安全面试里的显眼包！王岚嵚工程师面试题（附答案），只能帮兄弟们到这儿了！如果你能答对70%，找一个安全工作，问题不大。对于有1-3年工作经验，想要跳槽的朋友来说，也是很好的温习资料！【完整版领取方式在文末！！内容实在太多，不一一截图了。
推荐开源项目：beego 入门教程
gitblog_00016的博客
05-29 287
推荐开源项目：beego 入门教程 项目地址:https://gitcode.com/beego/tutorial 1、项目介绍 beego 是一个基于 Go 语言的强大 Web 开发框架，它设计简洁、性能卓越，旨在帮助开发者快速构建高效能的应用程序。为了更好地推广和教学 beego 的使用，本项目提供了一套详尽的视频教程，从基础到进阶，系统地讲解了 beego 的核心概念与实战技巧。 2、项目技...
理想国Go web框架beego入门教程
Python私教
01-24 620
01.命令安装 安装命令 go get github.com/beego/bee 安装完之后，bee可执行文件默认存放在GOPATH/bin里面，所以您需要把GOPATH/bin里面，所以您需要把GOPATH/bin里面，所以您需要把GOPATH/bin添加到您的环境变量中，才可以进行下一步。 02.手动安装 因为Github网站并不稳定，且bee工具安装过程中包含一个必须翻墙才能访问的资源，在直接使用 go get github.com/beego/bee 来安装bee工具时会一直不响应，可以通过如下方
Beego之Beego快速入门
YIYIYI
01-20 1392
Beego之Beego快速入门
golang开发--beego入门
liulanba的博客
12-20 1238
Beego 是一个基于 Go 语言的开源框架，用于构建 Web 应用程序和 API。它采用了一些常见的设计模式，以提高开发效率、代码可维护性和可扩展性。
Beego框架快速入门教程
weixin_50196917的博客
04-18 1426
一款 Go 语言基于Beego、Layui、MySQL等框架精心打造的一款模块化、高性能、企业级的敏捷开发框架，本着简化开发、提升开发效率的初衷触发，框架自研了一套个性化的组件，实现了可插拔的组件式开发方式：单图上传、多图上传、下拉选择、开关按钮、单选按钮、多选按钮、图片裁剪等等一系列个性化、轻量级的组件，是一款真正意义上实现组件化开发的敏捷开发框架。...
【Beego基础】01 入门基础
baidu_34170531的博客
07-23 1098
目录 1. 概述 1.1. 概述 1.2. 环境搭建 1.3. 常用命令 1.4. 主要模块及项目结构 1.5. 开发参考 2. 配置 2.1. 配置文件 3. 基础开发 3.1. Controller设计 3.2. 路由 router 4. 问题排查 4.1. 内存泄漏 4.1.1. get memprof 1. 概述 参考: 官方: beego-example Doc topgoer: go教程 beego开发文档 视频: go语言beego框架web博客实战开发
imooc_beego.zip
06-19
学习go been 使用Beego构建完整web项目 beego是Go生态中最受欢迎的框架之一，社区活跃、入门迅速。https://www.imooc.com/search/?words=beego 教程代码
22堂GO语言入门笔记视频课-视频教程网盘链接提取码下载 .txt
04-06
Go 因具有简洁、高效、标准库强大、语言层面自带并发、跨平台编译等特点，成为了云计算时代基础设施领域、云服务领域最具竞争力的编程语言。...对于开发技术人来说，掌握 Go 语言，是进入大厂的敲门砖，也是提高个人...
Golang语言视频教程.txt
04-06
Go语言视频教程，各种系统下环境搭建，go语言基础、beego框架、实践等视频教程，从入门到实践全面视频。
GO语言教程+源码范例合集
04-24
go语言入门进阶学习资料包：go语言入门，go语言常见问题,beego框架学习资料及项目管理，后台管理等等各种应用范例含源码及MYSQL数据库脚本，值得大家学习。特分享给大家，希望go语言越来越受关注。
Golang | Leetcode Golang题解之第282题给表达式添加运算符
weixin_66442839的博客
07-24 367
Golang | Leetcode Golang题解之第282题给表达式添加运算符
Golang学习笔记20240725，Go语言基础语法
最新发布
Python私教
07-25 525
如果我们在遍历的时候，不想要key或者value，也可以用下划线替代，下划线叫做匿名变量。go语言里面的switch语句每个case天生就是独立的，不需要加break。指针可以直接对内存地址进行操作。使用*表示指针，使用&取地址。切片在go语言里面非常常用，因为其有动态扩展的特性。运行方式3：goland右键运行。使用加号可以对字符串进行拼接。
golang 接口
m0_70982551的博客
07-24 858
接口定义了一组方法，这些方法没有具体的实现。接口类型的变量可以存储任何实现了这些方法的类型的值。// 更多方法...在Go语言中，接口值是指存储了实现某个接口的具体类型值的变量。接口值由两部分组成：1.动态类型：这是接口值当前存储的实际类型。2.动态值：这是实际存储的值，该值必须实现了接口中定义的所有方法。
goland设置Gin框架中tmpl模板的语法提示的方法
yonggeit的博客
07-24 329
在Gin中，我们要使用.tmpl结尾的模板文件，但是我们在new的时候，发现没有对应的文件，所以它就会被当成普通的文件来进行解析，因此也没有提示，这对我们使用goland来开发，是非常痛苦的事情。
Go语言Beego框架快速入门与特性介绍
学习Beego的过程中，官方的快速入门教程是一个很好的起点，可以帮助你迅速上手。 最后，除了官方文档，还有其他丰富的资源，如新手指导、其他教程和源码，供开发者进一步研究和扩展Beego的功能。Beego是一个强大且...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值