Skip to content
This repository has been archived by the owner on Jan 4, 2018. It is now read-only.
/ xingyun Public archive
forked from sipin/xingyun

a simple and flexible web framework

Notifications You must be signed in to change notification settings

xiaoenai/xingyun

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

77 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

XingYun

XingYun is a web framework with negroni like middleware and web.go like API.

Difference compare to negroni and web.go

  • negroni: XingYun have Context that wrap Request and ResponseWriter. The Context have a easy to use API. XingYun have pipe to manage middleware.

  • web.go: All feature in XingYun is composed by middleware and every middleware can replaced by user. The middleware also can do other pre-request or post-request features.

Usage

package main

import (
	"net/http"

	"github.com/xiaoenai/xingyun"
)

func main() {
	cfg := &xingyun.Config{}
	server := xingyun.NewServer(cfg)
	logger := server.Logger()

	pipe := server.NewPipe("test", xingyun.PipeHandlerFunc(func(w http.ResponseWriter, r *http.Request, next http.HandlerFunc) {
		logger.Tracef("before")
		next(w, r)
		logger.Tracef("after")
	}))

	server.Get("/hello", pipe.Wrap(func(ctx *xingyun.Context) {
		logger.Tracef("hello world")
		ctx.WriteString("hello world")
	}))

	err := server.ListenAndServe("127.0.0.1:9000")
	logger.Errorf("%s", err)
}

Object

Important object

  • Server: Server contains everything and implement router. Server also is a pipe container to manage pipe.
  • Pipe: PipeHandler queue. Pipe is also a PipeHandler and http.Handler
  • Context: contain request related data and have easy to use API.

Interface

Interface in XingYun

  • ContextHandler: process request with context

      type ContextHandler interface {
      	ServeContext(ctx *Context)
      }
    
  • PipeHandler (like negroni.Handler)

  • Logger: used to print log

  • Router: set route

Context

context support features below

  • Cookie
  • Session
  • XSRF
  • Flash
  • Render

Default PipeHandler

  • Logger
  • Recover
  • Static
  • XSRF
  • ErrorPage
  • Context
  • URLVarLoader

About

a simple and flexible web framework

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Go 100.0%