Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/readdig/her
A web framework for golang
https://github.com/readdig/her
Last synced: about 2 months ago
JSON representation
A web framework for golang
- Host: GitHub
- URL: https://github.com/readdig/her
- Owner: readdig
- Created: 2013-11-25T08:56:18.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2015-07-03T14:24:48.000Z (about 9 years ago)
- Last Synced: 2024-04-14T01:50:17.248Z (5 months ago)
- Language: Go
- Homepage:
- Size: 613 KB
- Stars: 79
- Watchers: 5
- Forks: 15
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
her
=====
a web framework for golang
### 介绍
用 Go 实现的一个简单的 MVC 模式框架，目前支持：
* 路由/RESTFUL(route)
* 控制器(handler)
* 模型(model)
* 视图(view)
* 表单(form)
* 静态文件(static)
* 数据库(database)
### 安装
请确保Go环境已经安装，如未安装请参考 [Go 环境安装](http://golang.org/doc/install.html)，请安装最新版。
``` go
go get github.com/go-code/her
```
### 快速使用
```go
package main
import (
"github.com/go-code/her"
)
func main() {
app := her.NewApplication()
app.Route.Handle("/", func() string {
return "hello world!"
})
app.Start()
}
```
启动程序访问8080端口，默认端口为8080
### her application
```go
app := her.NewApplication()
// app.Route and app.Database and app.Template
app.Start()
```
#### Config
```go
app := her.NewApplication(map[string]interface{}{
"TemplatePath": "view",
"CookieSecret": "book_secert",
"Address": "0.0.0.0",
"Port": 8080,
"XSRFCookies": true,
"Debug": true,
})
```
or config.json
```json
{
"Address": "127.0.0.1",
"Port": 8080,
"CookieSecret": "Rr3ItbiN+]3Yb_F/xu|rMg.QATsUetvR6+Y-L%pz!+m((/S:*!4:2#L1uu-_z5F",
"XSRFCookies": true,
"Debug": true
}
```
get config
```go
Address := her.Config.GetString("Address")
```
#### Route ([mux](http://www.gorillatoolkit.org/pkg/mux))
```go
app.Route.Handle("/", func() {
// handle code
}) // get
app.Route.Handle("/", func() {
// handle code
}).Methods("POST") //post
app.Route.Handle("/{key}", func(key string) {
// handle code
})
app.Route.Handle("/{key}/{id:[0-9]+}", func(key string, id string) {
// handle code
})
```
#### Handler
```go
app.Route.Handle("/", func() string {
return "hello world!"
})
app.Route.Handle("/", func(ctx *her.Context) {
ctx.WriteString("hello world!")
})
app.Route.Handle("/str/{val}", func(ctx *her.Context, val string) {
ctx.WriteString("str: " + val)
})
app.Route.Handle("/int/{val}", func(ctx *her.Context, val int) {
ctx.WriteString("int: " + strconv.Itoa(val))
})
app.Route.Handle("/par/{val}", func(ctx *her.Context) {
ctx.WriteString("par: " + ctx.Params["val"])
})
```
#### Static file handler
```go
app.Route.Handle("/static/{path:.*}", her.StaticFileHandler("static")) // static 为静态文件目录
```
#### Database
```go
// import go-sqlite3
import _ "github.com/mattn/go-sqlite3"
// config
app.Database.Connection("sqlite", "sqlite3", "./book.s3db") // key, driver, data source
// use
DB = her.NewDB("sqlite")
db := DB.Open()
defer db.Close()
// sql code
```
#### Template FunMap
```go
app.Template.FuncMap(map[string]interface{}{
"text": func(text string) template.HTML {
return template.HTML(text)
},
})
// use
{{text "her"}}
```
#### Form and Validator
```go
package form
import (
"github.com/go-code/her"
)
// form field
type BookForm struct {
Form *her.Form
UserName *her.TextField
Content *her.TextAreaField
}
// new form and field validetor
func NewBookForm(ctx *her.Context) *BookForm {
form := &BookForm{}
form.UserName = her.NewTextField("username", "用户名", "", her.Required{}, her.Length{Min: 3, Max: 10})
form.Content = her.NewTextAreaField("content", "内容", "", her.Required{}, her.Length{Min: 1, Max: 200})
form.Form = her.InitForm(ctx, form)
return form
}
```
```go
// use
form := form.NewBookForm(ctx)
tmpl := map[string]interface{}{}
tmpl["form"] = form
ctx.Render("create.html", tmpl)
// template
{{.form.UserName.Text}}
{{.form.UserName.Render `class="form-control"` `placeholder="用户名"`}}
{{.form.Content.Text}}
{{.form.Content.Render `class="form-control"` `placeholder="需要发布的内容"` `rows="5"`}}
{{.form.Form.ValidatorSummary}} // error msg
```
```go
// validetor
if ctx.Request.Method == "POST" {
if form.Form.Validate() {
// form.UserName.Value() form field value
}
}
```
### 参考、使用项目
- gorilla [mux](https://github.com/gorilla/mux) 路由
- jimmykuu [wtforms](https://github.com/jimmykuu/wtforms) 表单
- fsnotify [fsnotify](https://github.com/howeyc/fsnotify) 模版刷新
### LICENSE
[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html)