golang martini 源码阅读笔记之martini核心
继上一篇关于inject注入的笔记,理解了martini的关键核心之一:依赖注入。注入回调函数,由运行时进行主动调用执行。这一篇主要是注解martini的骨架martini.go的实现,下面先从一个简单的martini使用实例,即创建一个最简单的http服务器开始。
server.go
//martini使用简单实例
package main import "github.com/go-martini/martini" func main() {
m := martini.Classic() //获取一个martini实例 m.Get("/", func() string { // 用户自定义路由规则
return "Hello world!"
}) m.Run() // 运行服务器
}
martini.go
package martini import (
"log"
"net/http"
"os"
"reflect" "github.com/codegangsta/inject"
) // Martini represents the top level web application. inject.Injector methods can be invoked to map services on a global level.
type Martini struct {
inject.Injector // 注入工具,利用反射实现函数回调
handlers []Handler // 存储处理http请求的所有中间件
action Handler // 路由匹配以及路由处理,在所有中间件都处理完之后执行
logger *log.Logger // 日志工具
} // 基础骨架:具备基本的注入与反射调用功能
// New creates a bare bones Martini instance. Use this method if you want to have full control over the middleware that is used.
func New() *Martini {
m := &Martini{Injector: inject.New(), action: func() {}, logger: log.New(os.Stdout, "[martini] ", 0)}
m.Map(m.logger)
m.Map(defaultReturnHandler())
return m
} // Handlers sets the entire middleware stack with the given Handlers. This will clear any current middleware handlers.
// Will panic if any of the handlers is not a callable function
// 设置所有的中间件
func (m *Martini) Handlers(handlers ...Handler) {
m.handlers = make([]Handler, 0)
for _, handler := range handlers {
m.Use(handler)
}
} // Action sets the handler that will be called after all the middleware has been invoked. This is set to martini.Router in a martini.Classic().
// 设置真正的路由处理器,所有中间件执行完之后才会执行
func (m *Martini) Action(handler Handler) {
validateHandler(handler)
m.action = handler
} // Logger sets the logger
func (m *Martini) Logger(logger *log.Logger) {
m.logger = logger
m.Map(m.logger)
}
// Use adds a middleware Handler to the stack. Will panic if the handler is not a callable func. Middleware Handlers are invoked in the order that they are added.
// 添加一个中间件处理器,每一个http请求都会先执行, 按照添加的顺序依次执行
func (m *Martini) Use(handler Handler) {
validateHandler(handler)
m.handlers = append(m.handlers, handler)
} // http接口,每一次http请求 用户级别处理的入口
// ServeHTTP is the HTTP Entry point for a Martini instance. Useful if you want to control your own HTTP server.
func (m *Martini) ServeHTTP(res http.ResponseWriter, req *http.Request) {
println("call....")
m.createContext(res, req).run() // 每一个请求创建一个上下文,保存一些必要的信息,之后开始处理请求
} // Run the http server on a given host and port.
// http 服务器启动
func (m *Martini) RunOnAddr(addr string) {
// TODO: Should probably be implemented using a new instance of http.Server in place of
// calling http.ListenAndServer directly, so that it could be stored in the martini struct for later use.
// This would also allow to improve testing when a custom host and port are passed. logger := m.Injector.Get(reflect.TypeOf(m.logger)).Interface().(*log.Logger)
logger.Printf("listening on %s (%s)\n", addr, Env)
logger.Fatalln(http.ListenAndServe(addr, m)) // m是整个框架控制的开始
} // Run the http server. Listening on os.GetEnv("PORT") or 3000 by default.
func (m *Martini) Run() {
port := os.Getenv("PORT")
if len(port) == 0 {
port = "3000"
}
host := os.Getenv("HOST")
m.RunOnAddr(host + ":" + port)
} //创建请求上下文,与大部分的web框架一样,使用上下文的方式存储处理请求过程中的相关数据
func (m *Martini) createContext(res http.ResponseWriter, req *http.Request) *context {
// NewResponseWriter 对res进行了封装修饰,添加了一些其他功能,比如过滤器之类的
c := &context{inject.New(), m.handlers, m.action, NewResponseWriter(res), 0}
c.SetParent(m)
c.MapTo(c, (*Context)(nil)) //Context 为接口类型, c 是实现了Context接口的具体类型结构体
//这里就是做一种接口与实现的映射, 使用具体实现的时候只能使用映射类型已经实现的接口
c.MapTo(c.rw, (*http.ResponseWriter)(nil)) // rw 同样是映射到interface{}类型
c.Map(req) // req 是一种具体类型,这里只是想存储这个值
return c
} //经典的搭配,整合了路由以及martini核心功能
// ClassicMartini represents a Martini with some reasonable defaults. Embeds the router functions for convenience.
type ClassicMartini struct {
*Martini //
Router // 匿名变量类型,需要一个实现了所有的接口的对象,这样ClassicMartini实例可以无缝调用Router的接口,比如m.Get(pattern, handler)
} // Classic creates a classic Martini with some basic default middleware - martini.Logger, martini.Recovery and martini.Static.
// Classic also maps martini.Routes as a service.
func Classic() *ClassicMartini {
r := NewRouter() // 基础路由器,用于存储用户自定义路由规则以及处理器
m := New() // martini基础框架
m.Use(Logger()) // 添加日志处理中间件
m.Use(Recovery()) // 服务器异常错误时进行处理
m.Use(Static("public")) // 静态文件处理
m.MapTo(r, (*Routes)(nil)) // nil 表示这里只需要一个类型
m.Action(r.Handle) //所有router中间件执行完才执行的处理,相当于是正式的路由匹配处理,中间件做一些web常规必要的处理
return &ClassicMartini{m, r}
} // Handler can be any callable function. Martini attempts to inject services into the handler's argument list.
// Martini will panic if an argument could not be fullfilled via dependency injection.
// 定义Handler类型为一个泛型
type Handler interface{} //检查Handler是否为函数类型
func validateHandler(handler Handler) {
if reflect.TypeOf(handler).Kind() != reflect.Func {
panic("martini handler must be a callable func")
}
} // Context represents a request context. Services can be mapped on the request level from this interface.
type Context interface {
// 包含了另一个接口类型的所有接口,Context的实例必须实现所有的接口,或者包含一个匿名的具体事例实现该所有接口
inject.Injector
// 中间件的顺序执行过程中按顺序执行时,使用Next接口不断的更新索引指向下一个中间件
Next()
// Written returns whether or not the response for this context has been written.
// 返回是否 http请求已经处理完并发送应答的标识
Written() bool
} // http请求处理的上下文实例
type context struct {
// 包含一个接口类型,初始化的时候需要一个具体实现的实例, 一个依赖注入的事例,注入具体函数,运行时按顺序回调各个函数
inject.Injector
// handler数组,处理http请求时按顺序一个一个执行
handlers []Handler
// 其实就是最后一个handler
action Handler
// 对http.ResponseWriter的进一步封装,加入更多功能,比如过滤器,Before After等处理
rw ResponseWriter
// 表示当前第n个hanlder的索引
index int
} // 取出当前第n个处理器,如果索引值到达最大值,则返回action函数,即开始路由匹配逻辑
func (c *context) handler() Handler {
if c.index < len(c.handlers) {
return c.handlers[c.index]
}
if c.index == len(c.handlers) {
return c.action
}
panic("invalid index for context handler")
} // 更新指向下一个处理器,之后继续执行剩余处理器对请求的处理
func (c *context) Next() {
c.index += 1
c.run()
} // 判断是否已发送应答,若已发送,则不需要再进行处理
func (c *context) Written() bool {
return c.rw.Written()
} // 获取当前的处理器,并处理http请求,执行一连串的处理
func (c *context) run() {
for c.index <= len(c.handlers) {
_, err := c.Invoke(c.handler()) // Invoke 对初六进行回调,返回结构存储在context
if err != nil {
panic(err)
}
c.index += 1 // for循环先执行调用处理,再更新索引,因此与 Next中更新索引不冲突 if c.Written() {
return
}
}
}
如理解有错误,欢迎在评论指出,不胜感激!
golang martini 源码阅读笔记之martini核心的更多相关文章
- golang martini 源码阅读笔记之inject
martini是go语言写的一个超级轻量的web开源框架,具体源码可在github搜索找到.13年那会开始接触go语言时有稍微看过这个框架,由于之后没有继续使用go就慢慢忽略了,最近由于手头项目可能会 ...
- gogs 源码阅读笔记 001
gogs 源码阅读笔记 001 gogs项目相当不错,本笔记实际是基于gogs fork版本 git-122a66f. gitea (gitea版本由来)[https://blog.gitea.io/ ...
- CI框架源码阅读笔记5 基准测试 BenchMark.php
上一篇博客(CI框架源码阅读笔记4 引导文件CodeIgniter.php)中,我们已经看到:CI中核心流程的核心功能都是由不同的组件来完成的.这些组件类似于一个一个单独的模块,不同的模块完成不同的功 ...
- CI框架源码阅读笔记4 引导文件CodeIgniter.php
到了这里,终于进入CI框架的核心了.既然是“引导”文件,那么就是对用户的请求.参数等做相应的导向,让用户请求和数据流按照正确的线路各就各位.例如,用户的请求url: http://you.host.c ...
- CI框架源码阅读笔记3 全局函数Common.php
从本篇开始,将深入CI框架的内部,一步步去探索这个框架的实现.结构和设计. Common.php文件定义了一系列的全局函数(一般来说,全局函数具有最高的加载优先权,因此大多数的框架中BootStrap ...
- CI框架源码阅读笔记2 一切的入口 index.php
上一节(CI框架源码阅读笔记1 - 环境准备.基本术语和框架流程)中,我们提到了CI框架的基本流程,这里再次贴出流程图,以备参考: 作为CI框架的入口文件,源码阅读,自然由此开始.在源码阅读的过程中, ...
- 源码阅读笔记 - 1 MSVC2015中的std::sort
大约寒假开始的时候我就已经把std::sort的源码阅读完毕并理解其中的做法了,到了寒假结尾,姑且把它写出来 这是我的第一篇源码阅读笔记,以后会发更多的,包括算法和库实现,源码会按照我自己的代码风格格 ...
- Three.js源码阅读笔记-5
Core::Ray 该类用来表示空间中的“射线”,主要用来进行碰撞检测. THREE.Ray = function ( origin, direction ) { this.origin = ( or ...
- PHP源码阅读笔记一(explode和implode函数分析)
PHP源码阅读笔记一一.explode和implode函数array explode ( string separator, string string [, int limit] )此函数返回由字符 ...
随机推荐
- 深度学习的集成方法——Ensemble Methods for Deep Learning Neural Networks
本文主要参考Ensemble Methods for Deep Learning Neural Networks一文. 1. 前言 神经网络具有很高的方差,不易复现出结果,而且模型的结果对初始化参数异 ...
- 让nodepad++编辑时链接能双击打开
让nodepad++编辑时链接能双击打开,Notepad++自动把代码或编辑状态里的链接或URL地址转成可点击的链接,当你双击该URL会打开相应的网页地址,不用复制地址到浏览器打开了,非常方便好用. ...
- web前端----css属性
一.文本 1.文本颜色:color 颜色属性被用来设置文字的颜色. 颜色是通过CSS最经常的指定: 十六进制值 - 如: #FF0000 一个RGB值 - 如: RGB(255,0,0) 颜色的名称 ...
- php json_decode返回null
在使用json_decode函数想把json串转化为数组的时候,出现了null,当时还以为是因为json对字符串的长度有限制,还以为是因为两边少了引号,经过多次处理,发现都没有效果. 百度各种帖子,发 ...
- Android http通信 HttpURLConnection
post 请求: package com.example.administrator.eschool; import android.os.Bundle; import android.os.Hand ...
- 20145118 《Java程序设计》 实验报告四
实验要求 基于Android Studio开发简单的Android应用并部署测试; 了解Android组件.布局管理器的使用: 掌握Android中事件处理机制: Android Studio安装 实 ...
- 20145312袁心《网络对抗》Web基础实践
20145312袁心<网络对抗>Web基础实践 问题回答 1.什么是表单: 表单在网页中主要负责数据采集功能. 一个表单有三个基本组成部分: 表单标签:这里面包含了处理表单数据所用CGI程 ...
- 2018-2019-1 1723《程序设计与数据结构》第1&2周作业 总结
作业地址 第一周作业: https://edu.cnblogs.com/campus/besti/CS-IMIS-1723-2/homework/2092 提交情况如图: 第二周作业: https:/ ...
- RHEL7使用NAT方式上网
1.首先,Windows7无法设置网络共享VMNet8的问题,是因为禁用了Firewall服务,设置为自动,启用即可:且需要启动VMWare的DHCP和NAT两个服务,这两个服务在我的机器上是关闭的, ...
- 【异常记录(11)】 Web应用程序项目 已配置为使用 IIS。无法访问 元数据库。您没有足够的特权访问计算机上的 IIS 网站
解决办法: 1.项目上右键, 编辑 xxxx.csproj 2.找到 <UseIIS> 标签, 改为 <UseIIS>False</UseIIS> 3.右键,重新 ...