thinkgo

package module
v0.0.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 16, 2019 License: Apache-2.0 Imports: 12 Imported by: 0

README

ThinkGo

ThinkGo is a lightweight MVC framework written in Go (Golang).

Go Report Card GoDoc Open Source Helpers Join the chat Latest Stable Version License

Installation

The only requirement is the Go Programming Language

go get -u github.com/thinkoner/thinkgo

Quick start

package main

import (
	"github.com/thinkoner/thinkgo"
	"fmt"
	"github.com/thinkoner/thinkgo/route"
	"github.com/thinkoner/thinkgo/context"
)

func main() {
	app := thinkgo.BootStrap()
	app.RegisterRoute(func(route *route.Route) {

		route.Get("/", func(req *context.Request) thinkgo.Response {
			return thinkgo.Text("Hello ThinkGo !")
		})

		route.Get("/ping", func(req *context.Request) thinkgo.Response {
			return thinkgo.Json(map[string]string{
				"message": "pong",
		    })
		})

		// Dependency injection
		route.Get("/user/{name}", func(req *context.Request, name string) thinkgo.Response {
			return thinkgo.Text(fmt.Sprintf("Hello %s !", name))
		})
	})
	// listen and serve on 0.0.0.0:9011
	app.Run()
}

Features

Routing

Basic Routing

The most basic routes accept a URI and a Closure, providing a very simple and expressive method of defining routes:

app.RegisterRoute(func(route *route.Route) {
	route.Get("/foo", func(req *context.Request) thinkgo.Response {
		return thinkgo.Text("Hello ThinkGo !")
	})
})
Available Router Methods

The router allows you to register routes that respond to any HTTP verb:

route.Get("/someGet", getting)
route.Post("/somePost", posting)
route.Put("/somePut", putting)
route.Delete("/someDelete", deleting)
route.Patch("/somePatch", patching)
route.Options("/someOptions", options)

Sometimes you may need to register a route that responds to multiple HTTP verbs. You may even register a route that responds to all HTTP verbs using the Any method:

route.Any("/someAny", any)
Parameters in path

Of course, sometimes you will need to capture segments of the URI within your route. For example, you may need to capture a user's ID from the URL. You may do so by defining route parameters:

route.Get("/user/{id}", func(req *context.Request, id string) thinkgo.Response {
	return thinkgo.Text(fmt.Sprintf("User %s", id))
})

You may define as many route parameters as required by your route:

route.Get("/posts/{post}/comments/{comment}", func(req *context.Request, postId, commentId string) thinkgo.Response {
	//
})

Controller

Basic Controller

Below is an example of a basic controller class.

package controller

import (
	"github.com/thinkoner/thinkgo"
	"github.com/thinkoner/thinkgo/context"
)

func Index(req *context.Request) thinkgo.Response {
	return thinkgo.Text("Hello ThinkGo !")
}

You can define a route to this controller like so:

route.Get("/", controller.Index)
Resource Controller

This feature will be supported in a future release.

HTTP Request

Accessing The Request

To obtain an instance of the current HTTP request via dependency injection

func Handler(req *context.Request) thinkgo.Response {
	name := req.Input("name")
}
Dependency Injection & Route Parameters

If your controller method is also expecting input from a route parameter you should list your route parameters after the request dependencies. For example, you can access your route parameter name like so:

route.Put("/user/{name}", func(req *context.Request, name string) thinkgo.Response {
	//
})
Request Path & Method

The path method returns the request's path information. So, if the incoming request is targeted at http://domain.com/foo/bar, the path method will return foo/bar:

uri := req.GetPath()

The method method will return the HTTP verb for the request.

method := req.GetMethod();
Retrieving Cookies From Requests
name, _ := request.Cookie("name")

HTTP Response

an HTTP Response Must implement the thinkgo.Response interface

Creating Responses

a simple strings or json Response:

thinkgo.Text("Hello ThinkGo !")

thinkgo.Json(map[string]string{
				"message": "pong",
			})
Attaching Cookies To Responses
response.Cookie("name", "alice")

View

views are stored in the views directory, A simple view might look something like this:

views/layout.html like this:

{{ define "layout" }}
<!DOCTYPE html>
<html lang="en">
<head>
	<meta charset="UTF-8">
	<title>{{ .Title }}</title>
</head>
<body>
	{{ template "content" .}}
</body>
</html>
{{ end }}

views/tpl.html like this:

{{ define "content" }}
<h2>{{ .Message }}</h2>
{{ end }}
{{ template "layout" . }}

we may return it using the Render function like so:

route.Get("/tpl", func(request *context.Request) thinkgo.Response {
	data := map[string]interface{}{"Title": "ThinkGo", "Message": "Hello ThinkGo !"}
	return thinkgo.Render("tpl.html", data)
})

HTTP Session

retrieving Data like this:

request.Session().Get("user")

storing Data like this:

request.Session().Set("user", "alice")

Logging

The logger provides the eight logging levels defined in RFC 5424: emergency, alert, critical, error, warning, notice, info and debug.

import "github.com/thinkoner/thinkgo/log"

log.Debug("log with Debug")
log.Info("log with Info")
log.Notice("log with Notice")
log.Warn("log with Warn")
log.Error("log with Error")
log.Crit("log with Crit")
log.Alert("log with Alert")
log.Emerg("log with Emerg")

ORM

refer to ThinkORM

License

This project is licensed under the Apache 2.0 license.

Contact

If you have any issues or feature requests, please contact us. PR is welcomed.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Html 

func Html(s string) *context.Response

Text Create a new HTTP Response with HTML data

func Json 

func Json(v interface{}) *context.Response

Json Create a new HTTP Response with JSON data

func NewResponse 

func NewResponse() *context.Response

NewResponse Create a new HTTP Response

func Render 

func Render(name string, data interface{}) *context.Response

Render Create a new HTTP Response with the template

func Text 

func Text(s string) *context.Response

Text Create a new HTTP Response with TEXT data

Types

type Application 

type Application struct {
	View  View
	Route *route.Route
}

Application the ThinkGo Application

func NewApplication 

func NewApplication() *Application

NewApplication returns a new ThinkGo Application

func (*Application) RegisterRoute 

func (a *Application) RegisterRoute(r *route.Route)

RegisterRoute Register Route for Application

func (*Application) RegisterView 

func (a *Application) RegisterView(v View)

RegisterView Register View for Application

type Closure 

type Closure func(req *context.Request) interface {
}

Closure Anonymous function, Used in Middleware Handler

type Handler 

type Handler interface {
	Process(request *context.Request, next Closure) interface{}
}

Handler Middleware Handler interface

func NewRouteHandler 

func NewRouteHandler(app *Application) Handler

NewRouteHandler The default RouteHandler

func NewSessionHandler 

func NewSessionHandler(app *Application) Handler

SessionHandler The default SessionHandler

type Pipeline 

type Pipeline struct {
	// contains filtered or unexported fields
}

func NewPipeline 

func NewPipeline() *Pipeline

Pipeline returns a new Pipeline

func (*Pipeline) Passable 

func (p *Pipeline) Passable(passable *context.Request) *Pipeline

Passable set the request being sent through the pipeline.

func (*Pipeline) Pipe 

func (p *Pipeline) Pipe(m Handler) *Pipeline

Pipe Push a Middleware Handler to the pipeline

func (*Pipeline) Run 

func (p *Pipeline) Run() interface{}

Run run the pipeline

func (*Pipeline) ServeHTTP 

func (p *Pipeline) ServeHTTP(w http.ResponseWriter, r *http.Request)

func (*Pipeline) Through 

func (p *Pipeline) Through(hls []Handler) *Pipeline

Pipe Batch push Middleware Handlers to the pipeline

type Response 

type Response interface {
	Send(w http.ResponseWriter)
}

Response an HTTP response interface

func ErrorResponse 

func ErrorResponse() Response

NotFoundResponse Create a new HTTP ErrorResponse

func NotFoundResponse 

func NotFoundResponse() Response

NotFoundResponse Create a new HTTP NotFoundResponse

type RouteHandler 

type RouteHandler struct {
	Route *route.Route
}

func (*RouteHandler) Process 

func (h *RouteHandler) Process(request *context.Request, next Closure) interface{}

type SessionHandler 

type SessionHandler struct {
	// contains filtered or unexported fields
}

func (*SessionHandler) Process 

func (h *SessionHandler) Process(req *context.Request, next Closure) interface{}

type ThinkGo 

type ThinkGo struct {
	App *Application
	// contains filtered or unexported fields
}

func BootStrap 

func BootStrap() *ThinkGo

BootStrap Create The Application

func (*ThinkGo) RegisterConfig 

func (think *ThinkGo) RegisterConfig(register registerConfigFunc)

RegisterConfig Register Config

func (*ThinkGo) RegisterRoute 

func (think *ThinkGo) RegisterRoute(register registerRouteFunc)

RegisterRoute Register Route

func (*ThinkGo) Run 

func (think *ThinkGo) Run(params ...string)

Run thinkgo application. Run() default run on HttpPort Run("localhost") Run(":9011") Run("127.0.0.1:9011")

type View 

type View interface {
	Render(name string, data interface{}) []byte
}

Source Files

View all Source files

Directories

Path Synopsis
log
formatter
handler
record

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.