• bee 工具简介
    • bee 工具的安装
    • bee 工具命令详解
      • new 命令
      • api 命令
      • run 命令
      • pack 命令
      • bale 命令
      • version 命令
      • generate 命令
      • migrate 命令
    • bee 工具配置文件

    bee 工具简介

    bee 工具是一个为了协助快速开发 beego 项目而创建的项目，通过 bee 您可以很容易的进行 beego 项目的创建、热编译、开发、测试、和部署。

    bee 工具的安装

    您可以通过如下的方式安装 bee 工具：

    1. go get github.com/beego/bee

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

    如何添加环境变量，请自行搜索
    如果你本机设置了 GOBIN，那么上面的命令就会安装到 GOBIN 下，请添加 GOBIN 到你的环境变量中

    bee 工具命令详解

    我们在命令行输入 bee，可以看到如下的信息：

    1. Bee is a tool for managing beego framework.
    3. Usage:
    5.     bee command [arguments]
    7. The commands are:
    9.     new         create an application base on beego framework
    10.     run         run the app which can hot compile
    11.     pack        compress an beego project
    12.     api         create an api application base on beego framework
    13.     bale        packs non-Go files to Go source files
    14.     version     show the bee & beego version
    15.     generate    source code generator
    16.     migrate     run database migrations

    new 命令

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

    1. bee new myproject
    2. [INFO] Creating application...
    3. /gopath/src/myproject/
    4. /gopath/src/myproject/conf/
    5. /gopath/src/myproject/controllers/
    6. /gopath/src/myproject/models/
    7. /gopath/src/myproject/static/
    8. /gopath/src/myproject/static/js/
    9. /gopath/src/myproject/static/css/
    10. /gopath/src/myproject/static/img/
    11. /gopath/src/myproject/views/
    12. /gopath/src/myproject/conf/app.conf
    13. /gopath/src/myproject/controllers/default.go
    14. /gopath/src/myproject/views/index.tpl
    15. /gopath/src/myproject/main.go
    16. 13-11-25 09:50:39 [SUCC] New application successfully created!
    1. myproject
    2. ├── conf
    3. │   └── app.conf
    4. ├── controllers
    5. │   └── default.go
    6. ├── main.go
    7. ├── models
    8. ├── routers
    9. │   └── router.go
    10. ├── static
    11. │   ├── css
    12. │   ├── img
    13. │   └── js
    14. ├── tests
    15. │   └── default_test.go
    16. └── views
    17.     └── index.tpl
    19. 8 directories, 4 files

    api 命令

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

    1. bee api apiproject
    2. create app folder: /gopath/src/apiproject
    3. create conf: /gopath/src/apiproject/conf
    4. create controllers: /gopath/src/apiproject/controllers
    5. create models: /gopath/src/apiproject/models
    6. create tests: /gopath/src/apiproject/tests
    7. create conf app.conf: /gopath/src/apiproject/conf/app.conf
    8. create controllers default.go: /gopath/src/apiproject/controllers/default.go
    9. create tests default.go: /gopath/src/apiproject/tests/default_test.go
    10. create models object.go: /gopath/src/apiproject/models/object.go
    11. create main.go: /gopath/src/apiproject/main.go

    这个项目的目录结构如下：

    1. apiproject
    2. ├── conf
    3. │   └── app.conf
    4. ├── controllers
    5. │   └── object.go
    6. │   └── user.go
    7. ├── docs
    8. │   └── doc.go
    9. ├── main.go
    10. ├── models
    11. │   └── object.go
    12. │   └── user.go
    13. ├── routers
    14. │   └── router.go
    15. └── tests
    16.     └── default_test.go

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

    同时，该命令还支持一些自定义参数自动连接数据库创建相关 model 和 controller:
    bee api [appname] [-tables=""] [-driver=mysql] [-conn="root:<password>@tcp(127.0.0.1:3306)/test"]
    如果 conn 参数为空则创建一个示例项目，否则将基于链接信息链接数据库创建项目。

    run 命令

    我们在开发 Go 项目的时候最大的问题是经常需要自己手动去编译再运行，bee run 命令是监控 beego 的项目，通过 fsnotify监控文件系统。但是注意该命令必须在 $GOPATH/src/appname 下执行。
    这样我们在开发过程中就可以实时的看到项目修改之后的效果：

    1. bee run
    2. 13-11-25 09:53:04 [INFO] Uses 'myproject' as 'appname'
    3. 13-11-25 09:53:04 [INFO] Initializing watcher...
    4. 13-11-25 09:53:04 [TRAC] Directory(/gopath/src/myproject/controllers)
    5. 13-11-25 09:53:04 [TRAC] Directory(/gopath/src/myproject/models)
    6. 13-11-25 09:53:04 [TRAC] Directory(/gopath/src/myproject)
    7. 13-11-25 09:53:04 [INFO] Start building...
    8. 13-11-25 09:53:16 [SUCC] Build was successful
    9. 13-11-25 09:53:16 [INFO] Restarting myproject ...
    10. 13-11-25 09:53:16 [INFO] ./myproject is running...

    我们打开浏览器就可以看到效果 http://localhost:8080/:

    beerun.png

    如果我们修改了 Controller 下面的 default.go 文件，我们就可以看到命令行输出：

    1. 13-11-25 10:11:20 [EVEN] "/gopath/src/myproject/controllers/default.go": DELETE|MODIFY
    2. 13-11-25 10:11:20 [INFO] Start building...
    3. 13-11-25 10:11:20 [SKIP] "/gopath/src/myproject/controllers/default.go": CREATE
    4. 13-11-25 10:11:23 [SKIP] "/gopath/src/myproject/controllers/default.go": MODIFY
    5. 13-11-25 10:11:23 [SUCC] Build was successful
    6. 13-11-25 10:11:23 [INFO] Restarting myproject ...
    7. 13-11-25 10:11:23 [INFO] ./myproject is running...

    刷新浏览器我们看到新的修改内容已经输出。

    pack 命令

    pack 目录用来发布应用的时候打包，会把项目打包成 zip 包，这样我们部署的时候直接把打包之后的项目上传，解压就可以部署了：

    1. bee pack
    2. app path: /gopath/src/apiproject
    3. GOOS darwin GOARCH amd64
    4. build apiproject
    5. build success
    6. exclude prefix:
    7. exclude suffix: .go:.DS_Store:.tmp
    8. file write to `/gopath/src/apiproject/apiproject.tar.gz`

    我们可以看到目录下有如下的压缩文件：

    1. rwxr-xr-x  1 astaxie  staff  8995376 11 25 22:46 apiproject
    2. -rw-r--r--  1 astaxie  staff  2240288 11 25 22:58 apiproject.tar.gz
    3. drwxr-xr-x  3 astaxie  staff      102 11 25 22:31 conf
    4. drwxr-xr-x  3 astaxie  staff      102 11 25 22:31 controllers
    5. -rw-r--r--  1 astaxie  staff      509 11 25 22:31 main.go
    6. drwxr-xr-x  3 astaxie  staff      102 11 25 22:31 models
    7. drwxr-xr-x  3 astaxie  staff      102 11 25 22:31 tests

    bale 命令

    这个命令目前仅限内部使用，具体实现方案未完善，主要用来压缩所有的静态文件变成一个变量申明文件，全部编译到二进制文件里面，用户发布的时候携带静态文件，包括 js、css、img 和 views。最后在启动运行时进行非覆盖式的自解压。

    version 命令

    这个命令是动态获取 bee、beego 和 Go 的版本，这样一旦用户出现错误，可以通过该命令来查看当前的版本

    1. $ bee version
    2. bee   :1.2.2
    3. beego :1.4.2
    4. Go    :go version go1.3.3 darwin/amd64

    generate 命令

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

    1. bee generate scaffold [scaffoldname] [-fields=""] [-driver=mysql] [-conn="root:@tcp(127.0.0.1:3306)/test"]
    2.     The generate scaffold command will do a number of things for you.
    3.     -fields: a list of table fields. Format: field:type, ...
    4.     -driver: [mysql | postgres | sqlite], the default is mysql
    5.     -conn:   the connection string used by the driver, the default is root:@tcp(127.0.0.1:3306)/test
    6.     example: bee generate scaffold post -fields="title:string,body:text"
    8. bee generate model [modelname] [-fields=""]
    9.     generate RESTful model based on fields
    10.     -fields: a list of table fields. Format: field:type, ...
    12. bee generate controller [controllerfile]
    13.     generate RESTful controllers
    15. bee generate view [viewpath]
    16.     generate CRUD view in viewpath
    18. bee generate migration [migrationfile] [-fields=""]
    19.     generate migration file for making database schema update
    20.     -fields: a list of table fields. Format: field:type, ...
    22. bee generate docs
    23.     generate swagger doc file
    25. bee generate test [routerfile]
    26.     generate testcase
    28. bee generate appcode [-tables=""] [-driver=mysql] [-conn="root:@tcp(127.0.0.1:3306)/test"] [-level=3]
    29.     generate appcode based on an existing database
    30.     -tables: a list of table names separated by ',', default is empty, indicating all tables
    31.     -driver: [mysql | postgres | sqlite], the default is mysql
    32.     -conn:   the connection string used by the driver.
    33.              default for mysql:    root:@tcp(127.0.0.1:3306)/test
    34.              default for postgres: postgres://postgres:postgres@127.0.0.1:5432/postgres
    35.     -level:  [1 | 2 | 3], 1 = models; 2 = models,controllers; 3 = models,controllers,router

    migrate 命令

    这个命令是应用的数据库迁移命令，主要是用来每次应用升级，降级的SQL管理。

    1. bee migrate [-driver=mysql] [-conn="root:@tcp(127.0.0.1:3306)/test"]
    2.     run all outstanding migrations
    3.     -driver: [mysql | postgresql | sqlite], the default is mysql
    4.     -conn:   the connection string used by the driver, the default is root:@tcp(127.0.0.1:3306)/test
    6. bee migrate rollback [-driver=mysql] [-conn="root:@tcp(127.0.0.1:3306)/test"]
    7.     rollback the last migration operation
    8.     -driver: [mysql | postgresql | sqlite], the default is mysql
    9.     -conn:   the connection string used by the driver, the default is root:@tcp(127.0.0.1:3306)/test
    11. bee migrate reset [-driver=mysql] [-conn="root:@tcp(127.0.0.1:3306)/test"]
    12.     rollback all migrations
    13.     -driver: [mysql | postgresql | sqlite], the default is mysql
    14.     -conn:   the connection string used by the driver, the default is root:@tcp(127.0.0.1:3306)/test
    16. bee migrate refresh [-driver=mysql] [-conn="root:@tcp(127.0.0.1:3306)/test"]
    17.     rollback all migrations and run them all again
    18.     -driver: [mysql | postgresql | sqlite], the default is mysql
    19.     -conn:   the connection string used by the driver, the default is root:@tcp(127.0.0.1:3306)/test

    bee 工具配置文件

    您可能已经注意到，在 bee 工具的源码目录下有一个 bee.json 文件，这个文件是针对 bee 工具的一些行为进行配置。该功能还未完全开发完成，不过其中的一些选项已经可以使用：

    • "version": 0：配置文件版本，用于对比是否发生不兼容的配置格式版本。
    • "go_install": false：如果您的包均使用完整的导入路径（例如：github.com/user/repo/subpkg）,则可以启用该选项来进行 go install 操作，加快构建操作。
    • "watch_ext": []：用于监控其它类型的文件（默认只监控后缀为 .go 的文件）。
    • "dir_structure":{}：如果您的目录名与默认的 MVC 架构的不同，则可以使用该选项进行修改。
    • "cmd_args": []：如果您需要在每次启动时加入启动参数，则可以使用该选项。
    • "envs": []：如果您需要在每次启动时设置临时环境变量参数，则可以使用该选项。