winterMVC

README

winterMvc

基于 go http 封装 简洁的web服务器框架
无须任何外部依赖，只需导入 winterMVC    

go get github.com/PandaManPMC/winterMVC@v1.0.18

结构体字符串参数

• 结构体参数对于必传参数，还可以增加 tag 来确保它的最小和最大长度，如 min:"3" max:"6".该参数字符长度不能少于 3 大于 6，而非字节长度。 其中 min 只作用于 required 参数，max 则可以作用于非 required 参数。
• 默认去除字符串参数的首尾空格，可以通过 tag 指定 trimSpace:"false" 来取消自动去除首尾空格，需要注意的是，min 和 max 是在这个操作之后执行的。

1.0.18

增加字符串类型过滤器，例如添加 XSS 过滤选项对字符参数进行 XSS 过滤。

• 实现 StringFilterInterface 接口，配置拦截器
• 如 example 中的 XSSFilterImplements

    mvc.SetStringFilterInterface(&XSSFilterImplements{})

1.0.13

1.0.13 改变 projectUrl 路由方式，如果 path[0] 是 v 开头后面是数字则合并 path[1]。

• 如 v1/app/member/Login，则 projectUrl = v1/app 。

go 升级为 1.19

1.0.6

1.0.6 增加了结构体参数 required:"true"，客户端必须上传这个参数才能通过基础参数校验。
当未传必须参数时可以通过回调接口 ParameterErrorInterface 获知，如 mvc.SetParameterError(&ParameterErrorImp{})。
type ParameterErrorInterface interface {
    ParameterError(http.ResponseWriter, *http.Request, error)
}

测试

运行 Application
request_test.go 运行测试
或者
访问连接

//	访问方式	xxx:port/项目url/控制器映射键/方法名
//	http://localhost:7080/example/test/QueryList
//	http://localhost:7080/example/test/QueryListMap?name=heih&age=99&activity=true&fighting=33.55&inDate=2021-12-09%2014:10:55
//	http://localhost:7080/example/test/QueryListWR?name=heih&age=99&activity=true&fighting=33.55&inDate=2021-12-09%2014:10:55
//	http://localhost:7080/example/test/QueryListStruct?name=heih&age=99&activity=true&fighting=33.55&inDate=2021-12-09%2014:10:55
//	http://localhost:7080/example/test/QueryListStructWR?name=heih&age=99&activity=true&fighting=33.55&inDate=2021-12-09%2014:10:55

//	POST 测试 Content-Type application/json
//	http://localhost:7080/example/test/QueryListStruct
//	{"name":"laoniqiu","age":0,"activity":true,"fighting":33.55,"inDate":"2022-08-31T09:08:29.837820+00:00"}

//	POST 测试 Content-Type application/x-www-form-urlencoded
//	time 类型可以传递 2006-01-02 15:04:05 格式，无法解析的格式会报错

配置

import "github.com/PandaManPMC/winterMVC"
mvc := winterMVC.GetInstanceByDispatcherHandler()

mvc := winterMVC.GetInstanceByDispatcherHandler()
projectPrefix := "example"
testC := GetInstanceByTestCtrl()
//	存入控制器
mvc.RouteCtrl(projectPrefix,"test",&testC)

//	配置拦截器
var inter myInterceptor
mvc.RouteProjectInterceptor(projectPrefix,inter)

//	配置过滤器
var f filter
mvc.SetHttpFilter(f)

//	错误处理
var fail failureResp
mvc.SetFailureResponse(fail)

//  配置日志输出
var lo logs
mvc.SetLogs(&lo)

//  参数封装错误回调
mvc.SetParameterError(&ParameterErrorImp{})

启动服务

启动http服务 方式1
http.HandleFunc("/winterMvc/", mvc.HandlerFun())
http.Handle("/favicon.ico",http.FileServer(http.Dir("./web/img")))
http.ListenAndServe(":7080",nil)


启动http服务 方式2
maxHeaderBytes := 1024 * 1024 * 20
server := http.Server{
	Addr: ":7080",
	//Handler: mvc,
	ReadTimeout: time.Second * 60,
	WriteTimeout: time.Second * 60,
	IdleTimeout: time.Second * 60,
	MaxHeaderBytes: maxHeaderBytes,
}
http.Handle("/favicon.ico",http.FileServer(http.Dir("./web/img")))
http.Handle("/",mvc)
fmt.Println(server.ListenAndServe())

控制器编写规则，参照testDemo下testCtrl

type testCtrl struct {
}

//  不接收任何参数
func (t *testCtrl) QueryList() result{}
//  接收 map[string]string参数
func (t *testCtrl) QueryList2(params map[string]string) result{}
//  接收 w http.ResponseWriter, request *http.Request
func (t *testCtrl) QueryList3(w http.ResponseWriter, request *http.Request) result{}
//  接收 一个struct
func (t *testCtrl) QueryList4(t structType) result{}
//  接收三个参数 struct， w http.ResponseWriter, request *http.Request
func (t *testCtrl) QueryList5(t structType,w http.ResponseWriter, request *http.Request) result{}

支持 application/json 和 application/x-www-form-urlencoded 参数的自动封装。 time.Time 类型只支持 rfc3339 格式，如 【2022-08-31T09:08:29.837820+00:00】，时间转为时间戳传递更方便。 w http.ResponseWriter, request *http.Request 和一个自由参数可以不用放置考虑顺序。

• application/json 格式如下

	{
		"category": "哺乳",
		"dog": {
			"name": "黑子",
				"age": 88,
				"fighting": 33.22,
				"activity": true,
				"inDate": "2022-08-31T09:08:29.837820+00:00"
		}
	}

过滤器 HttpFilterInterface

//	过滤
//	writer http.ResponseWriter
//	request *http.Request
//	bool	true继续执行，false中断本次请求
Filter(writer http.ResponseWriter, request *http.Request) bool

拦截器 HandlerInterceptorInterface

//	在处理器处理请求之前
//	writer http.ResponseWriter
//	request *http.Request
//	bool	响应 true 执行处理，false不继续执行处理也不会执行AfterHandler()
//	string	在bool为false拦截下请求时的响应数据
BeforeHandler(writer http.ResponseWriter, request *http.Request) (bool,string)

//	处理器处理请求之后
//	writer http.ResponseWriter
//	request *http.Request
AfterHandler(writer http.ResponseWriter, request *http.Request)

错误处理 FailureResponseInterface

//	错误处理回调404
//	找不到对应控制器或处理方法回调404
Failure404(writer http.ResponseWriter,request *http.Request)

//	错误处理回调500
//	出现预料之外的事，如url截取后长度不足3位
Failure500(writer http.ResponseWriter,request *http.Request)

Documentation

Index

• func ContentTypeIsJSON(request *http.Request) bool
• func GetContentType(request *http.Request) string
• func GetInstanceByDispatcherHandler() *dispatcherHandler
• func MustCompileVersion(path string) bool
• func StringToCharacterLen(s string) int
• type FailureResponseInterface
• type HandlerInterceptorInterface
• type HttpFilterInterface
• type LogsInterface
• type ParameterErrorInterface
• type StringFilterInterface

Functions

func ContentTypeIsJSON

func ContentTypeIsJSON(request *http.Request) bool

func GetContentType

func GetContentType(request *http.Request) string

func GetInstanceByDispatcherHandler

func GetInstanceByDispatcherHandler() *dispatcherHandler

GetInstanceByDispatcherHandler 获取 MVC 实例 dispatcherHandler 实例指针 获得dispatcherHandler 初始化MVC 初始化方式1 http.HandleFunc("/projectRoute/", winter-mvc-core.HandlerFun()) 初始化方式2 server := http.Server{ Handler: winter_mvc_core.GetInstanceByDispatcherHandler(), ...

func MustCompileVersion

func MustCompileVersion(path string) bool

MustCompileVersion path 为 version 则返回 true

func StringToCharacterLen

func StringToCharacterLen(s string) int

StringToCharacterLen 获取字符串准确字符长度，而非字节长度

Types

type FailureResponseInterface

type FailureResponseInterface interface {

	//	错误处理回调404
	//	找不到对应控制器或处理方法回调404
	Failure404(writer http.ResponseWriter, request *http.Request)

	//	错误处理回调500
	//	出现预料之外的事，如url截取后长度不足3位
	Failure500(writer http.ResponseWriter, request *http.Request)
}

type HandlerInterceptorInterface

type HandlerInterceptorInterface interface {

	//	BeforeHandler 在处理器处理请求之前执行
	//	writer http.ResponseWriter
	//	request *http.Request
	//	bool	响应 true 执行处理，false不继续执行处理也不会执行AfterHandler()
	//	string	在bool为false拦截下请求时的响应数据
	BeforeHandler(writer http.ResponseWriter, request *http.Request) (bool, string)

	//	AfterHandler 处理器处理请求之后执行
	//	writer http.ResponseWriter
	//	request *http.Request
	AfterHandler(writer http.ResponseWriter, request *http.Request)
}

拦截器 实现接口 BeforeHandler()和 AfterHandler()

type HttpFilterInterface

type HttpFilterInterface interface {

	//	Filter 过滤器
	//	writer *http.ResponseWriter
	//	request *http.Request
	//	bool	true继续执行，false中断本次请求
	Filter(writer *http.ResponseWriter, request *http.Request) bool
}

http过滤器 Filter 过滤任何请求

type LogsInterface

type LogsInterface interface {
	Info(string)
	Error(string, interface{})
}

type ParameterErrorInterface

type ParameterErrorInterface interface {
	ParameterError(http.ResponseWriter, *http.Request, error)
}

type StringFilterInterface

type StringFilterInterface interface {
	// Intercept 只会过滤进行参数装载的控制器，如果是 (writer http.ResponseWriter, request *http.Request) 控制器，不会进行字符串过滤
	// key, val string 字段的名称与原始值
	// 返回 true 则拦截下请求不会继续分发，会就此中断
	Intercept(key, val string, writer http.ResponseWriter, request *http.Request) bool
}