mirror of
https://github.com/astaxie/beego.git
synced 2024-11-05 12:40:56 +00:00
263 lines
8.4 KiB
Go
263 lines
8.4 KiB
Go
// Copyright 2014 beego Author. All Rights Reserved.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package adapter
|
|
|
|
import (
|
|
"net/http"
|
|
|
|
context2 "github.com/astaxie/beego/pkg/adapter/context"
|
|
"github.com/astaxie/beego/pkg/server/web"
|
|
"github.com/astaxie/beego/pkg/server/web/context"
|
|
)
|
|
|
|
var (
|
|
// BeeApp is an application instance
|
|
BeeApp *App
|
|
)
|
|
|
|
func init() {
|
|
// create beego application
|
|
BeeApp = (*App)(web.BeeApp)
|
|
}
|
|
|
|
// App defines beego application with a new PatternServeMux.
|
|
type App web.App
|
|
|
|
// NewApp returns a new beego application.
|
|
func NewApp() *App {
|
|
return (*App)(web.NewApp())
|
|
}
|
|
|
|
// MiddleWare function for http.Handler
|
|
type MiddleWare web.MiddleWare
|
|
|
|
// Run beego application.
|
|
func (app *App) Run(mws ...MiddleWare) {
|
|
newMws := oldMiddlewareToNew(mws)
|
|
(*web.App)(app).Run(newMws...)
|
|
}
|
|
|
|
func oldMiddlewareToNew(mws []MiddleWare) []web.MiddleWare {
|
|
newMws := make([]web.MiddleWare, 0, len(mws))
|
|
for _, old := range mws {
|
|
newMws = append(newMws, (web.MiddleWare)(old))
|
|
}
|
|
return newMws
|
|
}
|
|
|
|
// Router adds a patterned controller handler to BeeApp.
|
|
// it's an alias method of App.Router.
|
|
// usage:
|
|
// simple router
|
|
// beego.Router("/admin", &admin.UserController{})
|
|
// beego.Router("/admin/index", &admin.ArticleController{})
|
|
//
|
|
// regex router
|
|
//
|
|
// beego.Router("/api/:id([0-9]+)", &controllers.RController{})
|
|
//
|
|
// custom rules
|
|
// beego.Router("/api/list",&RestController{},"*:ListFood")
|
|
// beego.Router("/api/create",&RestController{},"post:CreateFood")
|
|
// beego.Router("/api/update",&RestController{},"put:UpdateFood")
|
|
// beego.Router("/api/delete",&RestController{},"delete:DeleteFood")
|
|
func Router(rootpath string, c ControllerInterface, mappingMethods ...string) *App {
|
|
return (*App)(web.Router(rootpath, c, mappingMethods...))
|
|
}
|
|
|
|
// UnregisterFixedRoute unregisters the route with the specified fixedRoute. It is particularly useful
|
|
// in web applications that inherit most routes from a base webapp via the underscore
|
|
// import, and aim to overwrite only certain paths.
|
|
// The method parameter can be empty or "*" for all HTTP methods, or a particular
|
|
// method type (e.g. "GET" or "POST") for selective removal.
|
|
//
|
|
// Usage (replace "GET" with "*" for all methods):
|
|
// beego.UnregisterFixedRoute("/yourpreviouspath", "GET")
|
|
// beego.Router("/yourpreviouspath", yourControllerAddress, "get:GetNewPage")
|
|
func UnregisterFixedRoute(fixedRoute string, method string) *App {
|
|
return (*App)(web.UnregisterFixedRoute(fixedRoute, method))
|
|
}
|
|
|
|
// Include will generate router file in the router/xxx.go from the controller's comments
|
|
// usage:
|
|
// beego.Include(&BankAccount{}, &OrderController{},&RefundController{},&ReceiptController{})
|
|
// type BankAccount struct{
|
|
// beego.Controller
|
|
// }
|
|
//
|
|
// register the function
|
|
// func (b *BankAccount)Mapping(){
|
|
// b.Mapping("ShowAccount" , b.ShowAccount)
|
|
// b.Mapping("ModifyAccount", b.ModifyAccount)
|
|
// }
|
|
//
|
|
// //@router /account/:id [get]
|
|
// func (b *BankAccount) ShowAccount(){
|
|
// //logic
|
|
// }
|
|
//
|
|
//
|
|
// //@router /account/:id [post]
|
|
// func (b *BankAccount) ModifyAccount(){
|
|
// //logic
|
|
// }
|
|
//
|
|
// the comments @router url methodlist
|
|
// url support all the function Router's pattern
|
|
// methodlist [get post head put delete options *]
|
|
func Include(cList ...ControllerInterface) *App {
|
|
newList := oldToNewCtrlIntfs(cList)
|
|
return (*App)(web.Include(newList...))
|
|
}
|
|
|
|
func oldToNewCtrlIntfs(cList []ControllerInterface) []web.ControllerInterface {
|
|
newList := make([]web.ControllerInterface, 0, len(cList))
|
|
for _, c := range cList {
|
|
newList = append(newList, c)
|
|
}
|
|
return newList
|
|
}
|
|
|
|
// RESTRouter adds a restful controller handler to BeeApp.
|
|
// its' controller implements beego.ControllerInterface and
|
|
// defines a param "pattern/:objectId" to visit each resource.
|
|
func RESTRouter(rootpath string, c ControllerInterface) *App {
|
|
return (*App)(web.RESTRouter(rootpath, c))
|
|
}
|
|
|
|
// AutoRouter adds defined controller handler to BeeApp.
|
|
// it's same to App.AutoRouter.
|
|
// if beego.AddAuto(&MainContorlller{}) and MainController has methods List and Page,
|
|
// visit the url /main/list to exec List function or /main/page to exec Page function.
|
|
func AutoRouter(c ControllerInterface) *App {
|
|
return (*App)(web.AutoRouter(c))
|
|
}
|
|
|
|
// AutoPrefix adds controller handler to BeeApp with prefix.
|
|
// it's same to App.AutoRouterWithPrefix.
|
|
// if beego.AutoPrefix("/admin",&MainContorlller{}) and MainController has methods List and Page,
|
|
// visit the url /admin/main/list to exec List function or /admin/main/page to exec Page function.
|
|
func AutoPrefix(prefix string, c ControllerInterface) *App {
|
|
return (*App)(web.AutoPrefix(prefix, c))
|
|
}
|
|
|
|
// Get used to register router for Get method
|
|
// usage:
|
|
// beego.Get("/", func(ctx *context.Context){
|
|
// ctx.Output.Body("hello world")
|
|
// })
|
|
func Get(rootpath string, f FilterFunc) *App {
|
|
return (*App)(web.Get(rootpath, func(ctx *context.Context) {
|
|
f((*context2.Context)(ctx))
|
|
}))
|
|
}
|
|
|
|
// Post used to register router for Post method
|
|
// usage:
|
|
// beego.Post("/api", func(ctx *context.Context){
|
|
// ctx.Output.Body("hello world")
|
|
// })
|
|
func Post(rootpath string, f FilterFunc) *App {
|
|
return (*App)(web.Post(rootpath, func(ctx *context.Context) {
|
|
f((*context2.Context)(ctx))
|
|
}))
|
|
}
|
|
|
|
// Delete used to register router for Delete method
|
|
// usage:
|
|
// beego.Delete("/api", func(ctx *context.Context){
|
|
// ctx.Output.Body("hello world")
|
|
// })
|
|
func Delete(rootpath string, f FilterFunc) *App {
|
|
return (*App)(web.Delete(rootpath, func(ctx *context.Context) {
|
|
f((*context2.Context)(ctx))
|
|
}))
|
|
}
|
|
|
|
// Put used to register router for Put method
|
|
// usage:
|
|
// beego.Put("/api", func(ctx *context.Context){
|
|
// ctx.Output.Body("hello world")
|
|
// })
|
|
func Put(rootpath string, f FilterFunc) *App {
|
|
return (*App)(web.Put(rootpath, func(ctx *context.Context) {
|
|
f((*context2.Context)(ctx))
|
|
}))
|
|
}
|
|
|
|
// Head used to register router for Head method
|
|
// usage:
|
|
// beego.Head("/api", func(ctx *context.Context){
|
|
// ctx.Output.Body("hello world")
|
|
// })
|
|
func Head(rootpath string, f FilterFunc) *App {
|
|
return (*App)(web.Head(rootpath, func(ctx *context.Context) {
|
|
f((*context2.Context)(ctx))
|
|
}))
|
|
}
|
|
|
|
// Options used to register router for Options method
|
|
// usage:
|
|
// beego.Options("/api", func(ctx *context.Context){
|
|
// ctx.Output.Body("hello world")
|
|
// })
|
|
func Options(rootpath string, f FilterFunc) *App {
|
|
return (*App)(web.Options(rootpath, func(ctx *context.Context) {
|
|
f((*context2.Context)(ctx))
|
|
}))
|
|
}
|
|
|
|
// Patch used to register router for Patch method
|
|
// usage:
|
|
// beego.Patch("/api", func(ctx *context.Context){
|
|
// ctx.Output.Body("hello world")
|
|
// })
|
|
func Patch(rootpath string, f FilterFunc) *App {
|
|
return (*App)(web.Patch(rootpath, func(ctx *context.Context) {
|
|
f((*context2.Context)(ctx))
|
|
}))
|
|
}
|
|
|
|
// Any used to register router for all methods
|
|
// usage:
|
|
// beego.Any("/api", func(ctx *context.Context){
|
|
// ctx.Output.Body("hello world")
|
|
// })
|
|
func Any(rootpath string, f FilterFunc) *App {
|
|
return (*App)(web.Any(rootpath, func(ctx *context.Context) {
|
|
f((*context2.Context)(ctx))
|
|
}))
|
|
}
|
|
|
|
// Handler used to register a Handler router
|
|
// usage:
|
|
// beego.Handler("/api", http.HandlerFunc(func (w http.ResponseWriter, r *http.Request) {
|
|
// fmt.Fprintf(w, "Hello, %q", html.EscapeString(r.URL.Path))
|
|
// }))
|
|
func Handler(rootpath string, h http.Handler, options ...interface{}) *App {
|
|
return (*App)(web.Handler(rootpath, h, options))
|
|
}
|
|
|
|
// InsertFilter adds a FilterFunc with pattern condition and action constant.
|
|
// The pos means action constant including
|
|
// beego.BeforeStatic, beego.BeforeRouter, beego.BeforeExec, beego.AfterExec and beego.FinishRouter.
|
|
// The bool params is for setting the returnOnOutput value (false allows multiple filters to execute)
|
|
func InsertFilter(pattern string, pos int, filter FilterFunc, params ...bool) *App {
|
|
opts := oldToNewFilterOpts(params)
|
|
return (*App)(web.InsertFilter(pattern, pos, func(ctx *context.Context) {
|
|
filter((*context2.Context)(ctx))
|
|
}, opts...))
|
|
}
|