modify readme

astaxie
Showing 1 changed file with 22 additions and 413 deletions
README.md
--- a/README.md
View file @da1fe2f
+++ b/README.md
View file @da1fe2f
-## Beego
+## beego
 =======
-Beego is an open source version of the scalable, non-blocking web server
+beego is a Go Framework which is inspired from tornado and sinatra. 
-and tools that power SNDA's CDN system. Documentation and downloads are
-available at http://astaxie.github.com/beego
-Beego is licensed under the Apache Licence, Version 2.0
+It is a simply & powerful web framework.
-(http://www.apache.org/licenses/LICENSE-2.0.html).
-[中文文档](https://github.com/astaxie/beego/tree/master/docs/zh)
-## Installation
-============
-To install:
-    go get github.com/astaxie/beego
-## Quick Start
-============
-Here is the canonical "Hello, world" example app for beego:
-```go
-package main
-import (
-	"github.com/astaxie/beego"
-)
-type MainController struct {
-	beego.Controller
-}
-func (this *MainController) Get() {
-	this.Ctx.WriteString("hello world")
-}
-func main() {
-	beego.Router("/", &MainController{})
-	//beego.HttpPort = 8080 // default
-	beego.Run()
-}
-```
-	http get http://localhost:8080/
-	HTTP/1.1 200 OK
-	Content-Type: text/plain; charset=utf-8
-	Date: Sat, 15 Dec 2012 16:03:00 GMT
-	Transfer-Encoding: chunked
-	hello world
-A more complete example use of beego exists here:[beepkg](https://github.com/astaxie/beepkg)
-Some associated tools for beego reside in:[bee](https://github.com/astaxie/bee)		
-## Router
-============
-In beego, a route is a struct paired with a URL-matching pattern. The struct has many method with the same name of http method to serve the http response. Each route is associated with a block.
-```go
-beego.Router("/", &controllers.MainController{})
-beego.Router("/admin", &admin.UserController{})
-beego.Router("/admin/index", &admin.ArticleController{})
-beego.Router("/admin/addpkg", &admin.AddController{})
-```
-You can specify custom regular expressions for routes:
-```go
-beego.Router("/admin/editpkg/:id([0-9]+)", &admin.EditController{})
-beego.Router("/admin/delpkg/:id([0-9]+)", &admin.DelController{})
-beego.Router("/:pkg(.*)", &controllers.MainController{})
-```	
-You can also create routes for static files:
-	beego.BeeApp.SetStaticPath("/static","/public")
-This will serve any files in /static, including files in subdirectories. For example request `/static/logo.gif` or `/static/style/main.css` will server with the file in the path `/pulic/logo.gif` or `/public/style/main.css`
-## Filters / Middleware
-============
-You can apply filters to routes, which is useful for enforcing security, redirects, etc.
-You can, for example, filter all request to enforce some type of security:
-```go
-var FilterUser = func(w http.ResponseWriter, r *http.Request) {
-    if r.URL.User == nil || r.URL.User.Username() != "admin" {
-        http.Error(w, "", http.StatusUnauthorized)
-    }
-}
-beego.Filter(FilterUser)
-```	
-You can also apply filters only when certain REST URL Parameters exist:
-```go
-beego.Router("/:id([0-9]+)", &admin.EditController{})
-beego.FilterParam("id", func(rw http.ResponseWriter, r *http.Request) {
-    ...
-})
-```	
-Additionally, You can apply filters only when certain prefix URL path exist:
-```go
-beego.FilterPrefixPath("/admin", func(rw http.ResponseWriter, r *http.Request) {
-    … auth 
-})
-```		
-## Controller / Struct
-============ 	
-To implement a beego Controller, embed the `beego.Controller` struct:
-```go
-type xxxController struct {
-	beego.Controller
-}
-```
-`beego.Controller` satisfieds the `beego.ControllerInterface` interface, which defines the following methods:
- Init(ct *Context, cn string)
-	this function is init the Context, ChildStruct' name and the Controller's variables.
- Prepare()
-   this function is Run before the HTTP METHOD's Function,as follow defined. In the ChildStruct you can define this function to auth user or init database et.
- Get()
-	When the HTTP' Method is GET, the beego router will run this function.Default is HTTP-403. In the ChildStruct you must define the same functon to logical processing.
- Post()
-	When the HTTP' Method is POST, the beego router will run this function.Default is HTTP-403. In the ChildStruct you must define the same functon to logical processing.
- Delete()
-	When the HTTP' Method is DELETE, the beego router will run this function.Default is HTTP-403. In the ChildStruct you must define the same functon to logical processing.
- Put()
-	When the HTTP' Method is PUT, the beego router will run this function.Default is HTTP-403. In the ChildStruct you must define the same functon to logical processing.
- Head()
-	When the HTTP' Method is HEAD, the beego router will run this function.Default is HTTP-403. In the ChildStruct you must define the same functon to logical processing.
- Patch()
-	When the HTTP' Method is PATCH, the beego router will run this function.Default is HTTP-403. In the ChildStruct you must define the same functon to logical processing.
- Options()
-	When the HTTP' Method is OPTIONS, the beego router will run this function.Default is HTTP-403. In the ChildStruct you must define the same functon to logical processing.
- Finish()
-	this function is run after the HTTP METHOD's Function,as previous defined. In the ChildStruct you can define this function to close database et.
- Render() error
-	this function is to render the template as user defined. In the strcut you need to call.
-So you can define ChildStruct method to accomplish the interface's method, now let us see an example:
-```go
-type AddController struct {
-	beego.Controller
-}
-func (this *AddController) Prepare() {
-}
-func (this *AddController) Get() {
-	this.Layout = "admin/layout.html"
-	this.TplNames = "admin/add.tpl"
-}
-func (this *AddController) Post() {
-	//data deal with
-	this.Ctx.Request.ParseForm()
-	pkgname := this.Ctx.Request.Form.Get("pkgname")
-	content := this.Ctx.Request.Form.Get("content")
-	beego.Info(this.Ctx.Request.Form)
-	pk := models.GetCruPkg(pkgname)
-	if pk.Id == 0 {
-		var pp models.PkgEntity
-		pp.Pid = 0
-		pp.Pathname = pkgname
-		pp.Intro = pkgname
-		models.InsertPkg(pp)
-		pk = models.GetCruPkg(pkgname)
-	}
-	var at models.Article
-	at.Pkgid = pk.Id
-	at.Content = content
-	models.InsertArticle(at)
-	this.Ctx.Redirect(302, "/admin/index")
-}
-```
-## View / Template
-============ 		
-### template view path
-The default viewPath is `/views`, you can put the template file in the views. beego will find the template from viewpath.
-also you can modify the viewpaths like this:
-	beego.ViewsPath = "/myviewpath"
-### template names
-beego will find the template from viewpath. the file is set by user like：
-	this.TplNames = "admin/add.tpl"
-then beego will find the file in the path:`/views/admin/add.tpl`
-if you don't set TplNames,beego will find like this:
-	c.TplNames = c.ChildName + "/" + c.Ctx.Request.Method + "." + c.TplExt
-So if the ChildName="AddController",Request Method= "POST",default TplEXT="tpl"	
-So beego will file the file in the path:`/view/AddController/POST.tpl`
-### autoRender
-In the controller you needn't to call render function. beego will auto call this function after HTTP Method Call.
-You can disable automatic invokation of autorender via the AutoRender Flag:
-```go
-beego.AutoRender = false
-```
-### layout
+Have this features:
-beego supports layouts for views. For example:
-```go
-this.Layout = "admin/layout.html"
-this.TplNames = "admin/add.tpl"	
-```
-In layout.html you must define the variable like this to show sub template's content:
+* RESTFul support
+* MVC architecture 
+* Session support memory/file/redis/mysql
+* Cache support memory/redis/memcache
+* Global Config
+* Intelligent routing
+* thread safe map
+* Friendly error display
+* Useful template functions
-	{{.LayoutContent}}
+[English Documents](https://github.com/astaxie/beego/tree/master/docs/en)
-beego first parses the TplNames files, renders their content, and appends it to data["LayoutContent"].
+[API](http://gowalker.org/github.com/astaxie/beego)
-### template function
+[中文文档](https://github.com/astaxie/beego/tree/master/docs/zh)
-beego support users to define template function like this:
-```go
-func hello(in string)(out string){
-	out = in + "world"
-	return
-}
-beego.AddFuncMap("hi",hello)
-```
-then in you template you can use it like this:
-	{{.Content | hi}}
-beego has three default defined funtion:
- beegoTplFuncMap["markdown"] = MarkDown
-	MarkDown parses a string in MarkDown format and returns HTML. Used by the template parser as "markdown"
- beegoTplFuncMap["dateformat"] = DateFormat
-	DateFormat takes a time and a layout string and returns a string with the formatted date. Used by the template parser as "dateformat"
- beegoTplFuncMap["compare"] = Compare	
-	Compare is a quick and dirty comparison function. It will convert whatever you give it to strings and see if the two values are equal.Whitespace is trimmed. Used by the template parser as "eq"
-### JSON/XML output
-You can use `beego.Controller.ServeJson` or `beego.Controller.ServeXml` for serializing to Json and Xml. I found myself constantly writing code to serialize, set content type, content length, etc. Feel free to use these functions to eliminate redundant code in your app.
-Helper function for serving Json, sets content type to application/json:
-```go
-func (this *AddController) Get() {
-    mystruct := { ... }
-	this.Data["json"] = &mystruct
-    this.ServeJson()
-}
-```
-Helper function for serving Xml, sets content type to application/xml:
-```go
-func (this *AddController) Get() {
-    mystruct := { ... }
-	this.Data["xml"]=&mystruct
-    this.ServeXml()
-}
-```
-## Beego Variables
-============ 
-beego has many default variables, as follow is a list to show:
- BeeApp       *App
-	global app init by the beego. You needn't to init it, just use it.
- AppName      string
-	appname is what you project named, default is beego
- AppPath      string
-	this is the project path
- StaticDir    map[string]string
-	staticdir store the map which request url to the static file path
-	default is the request url has prefix `static`, then server the path in the app path
- HttpAddr     string
-	http listen address, defult is ""
- HttpPort     int
-	http listen port, default is 8080
- RecoverPanic bool
-	RecoverPanic mean when the program panic  whether the process auto recover,default is true
- AutoRender   bool
-	whether run the Render function, default is true
- ViewsPath    string
-	the template path, default is /views
- RunMode      string //"dev" or "prod"
-	the runmode ,default is prod
- AppConfig    *Config
-    Appconfig is a result that parse file from conf/app.conf, if this file not exist then the variable is nil. if the file exist, then return the Config as follow.
- PprofOn bool
-	default is false. turn on pprof, if set to true. you can visit like this:
-		/debug/pprof
-		/debug/pprof/cmdline
-		/debug/pprof/profile
-		/debug/pprof/symbol	
-	this serves via its HTTP server runtime profiling data in the format expected by the pprof visualization tool. For more information about pprof, see	http://golang.org/pkg/net/http/pprof/
-## Config
-============ 
-beego support parse ini file, beego will parse the default file in the path `conf/app.conf`
-throw this conf file you can set many Beego Variables to change default values.
-app.conf
-	appname = beepkg
-	httpaddr = "127.0.0.1"
-	httpport = 9090
-	runmode ="dev"
-	autorender = false
-	autorecover = false
-	viewspath = "myview"
-this variables will replace the default beego variable's values
-you can also set you own variables such as database setting
-	mysqluser = "root"
-	mysqlpass = "rootpass"
-	mysqlurls = "127.0.0.1"
-	mysqldb   = "beego"
-In you app you can get the config like this:
-	beego.AppConfig.String("mysqluser")
-	beego.AppConfig.String("mysqlpass")
-	beego.AppConfig.String("mysqlurls")
-	beego.AppConfig.String("mysqldb")
-## Logger
-============ 	
-beego has a default log named BeeLogger which output to os.Stdout.
-you can change it output with the standard log.Logger like this:
-	fd,err := os.OpenFile("/opt/app/beepkg/beepkg.log", os.O_RDWR|os.O_APPEND, 0644)
-	if err != nil {
-		beego.Critical("openfile beepkg.log:", err)
-		return
-	}
-	lg := log.New(fd, "", log.Ldate|log.Ltime)
-	beego.SetLogger(lg)
-### Supported log levels
- Trace - For pervasive information on states of all elementary constructs. Use 'Trace' for in-depth debugging to find problem parts of a function, to check values of temporary variables, etc.
- Debug - For detailed system behavior reports and diagnostic messages to help to locate problems during development.
- Info - For general information on the application's work. Use 'Info' level in your code so that you could leave it 'enabled' even in production. So it is a 'production log level'.
- Warn - For indicating small errors, strange situations, failures that are automatically handled in a safe manner.
- Error - For severe failures that affects application's workflow, not fatal, however (without forcing app shutdown).
- Critical - For producing final messages before application’s death. Note: critical messages force immediate flush because in critical situation it is important to avoid log message losses if app crashes.
- Off - A special log level used to turn off logging
-beego has follow functions:
- Trace(v ...interface{})
- Debug(v ...interface{})
- Info(v ...interface{})
- Warn(v ...interface{})
- Error(v ...interface{})
- Critical(v ...interface{})
-you can set log levels like this :
-	beego.SetLevel(beego.LevelError)
+## LICENSE
+beego is licensed under the Apache Licence, Version 2.0
+(http://www.apache.org/licenses/LICENSE-2.0.html).
-after set the log levels, in the logs function which below the setlevels willn't output anything
+## Use Case
-after set levels to beego.LevelError
+- API documentation [gowalker](https://github.com/Unknwon/gowalker)
+- CMS [toropress](https://github.com/insionng/toropress)
-Trace, Debug, Info, Warn will not output anything. So you can change it when in dev and prod mode.
\ No newline at end of file