1
0
mirror of https://github.com/gofiber/fiber.git synced 2025-02-25 14:03:48 +00:00
fiber/.github/README_zh-CN.md

488 lines
15 KiB
Markdown
Raw Normal View History

2020-02-12 00:03:54 +01:00
<p align="center">
<a href="https://fiber.wiki">
2020-02-21 16:56:32 +01:00
<img alt="Fiber" height="125" src="https://github.com/gofiber/docs/blob/master/static/fiber_v2_logo.svg">
2020-02-12 00:03:54 +01:00
</a>
2020-02-21 16:56:32 +01:00
<br>
2020-02-14 02:05:39 +01:00
<a href="https://github.com/gofiber/fiber/blob/master/.github/README.md">
2020-02-12 00:03:54 +01:00
<img height="20px" src="https://cdnjs.cloudflare.com/ajax/libs/flag-icon-css/3.4.6/flags/4x3/gb.svg">
</a>
<a href="https://github.com/gofiber/fiber/blob/master/.github/README_ru.md">
<img height="20px" src="https://cdnjs.cloudflare.com/ajax/libs/flag-icon-css/3.4.6/flags/4x3/ru.svg">
</a>
2020-02-13 00:06:25 +03:00
<a href="https://github.com/gofiber/fiber/blob/master/.github/README_es.md">
<img height="20px" src="https://cdnjs.cloudflare.com/ajax/libs/flag-icon-css/3.4.6/flags/4x3/es.svg">
</a>
2020-02-12 00:03:54 +01:00
<a href="https://github.com/gofiber/fiber/blob/master/.github/README_ja.md">
<img height="20px" src="https://cdnjs.cloudflare.com/ajax/libs/flag-icon-css/3.4.6/flags/4x3/jp.svg">
</a>
<a href="https://github.com/gofiber/fiber/blob/master/.github/README_pt.md">
<img height="20px" src="https://cdnjs.cloudflare.com/ajax/libs/flag-icon-css/3.4.6/flags/4x3/pt.svg">
</a>
2020-02-13 00:06:25 +03:00
<!--<a href="https://github.com/gofiber/fiber/blob/master/.github/README_zh-CN.md">
2020-02-12 00:03:54 +01:00
<img height="20px" src="https://cdnjs.cloudflare.com/ajax/libs/flag-icon-css/3.4.6/flags/4x3/cn.svg">
2020-02-13 00:06:25 +03:00
</a>-->
2020-02-12 00:03:54 +01:00
<a href="https://github.com/gofiber/fiber/blob/master/.github/README_de.md">
<img height="20px" src="https://cdnjs.cloudflare.com/ajax/libs/flag-icon-css/3.4.6/flags/4x3/de.svg">
</a>
2020-02-12 01:04:01 +01:00
<a href="https://github.com/gofiber/fiber/blob/master/.github/README_ko.md">
<img height="20px" src="https://cdnjs.cloudflare.com/ajax/libs/flag-icon-css/3.4.6/flags/4x3/kr.svg">
</a>
<a href="https://github.com/gofiber/fiber/blob/master/.github/README_fr.md">
<img height="20px" src="https://cdnjs.cloudflare.com/ajax/libs/flag-icon-css/3.4.6/flags/4x3/fr.svg">
</a>
2020-02-12 00:03:54 +01:00
<br><br>
<a href="https://github.com/gofiber/fiber/releases">
<img src="https://img.shields.io/github/release/gofiber/fiber?style=flat-square">
</a>
<a href="https://fiber.wiki">
<img src="https://img.shields.io/badge/api-documentation-blue?style=flat-square">
</a>
2020-02-22 11:09:32 +08:00
<a href="https://pkg.go.dev/github.com/gofiber/fiber?tab=doc">
<img src="https://img.shields.io/badge/go.dev-reference-007d9c?logo=go&logoColor=white&style=flat-square">
</a>
2020-02-12 00:03:54 +01:00
<a href="#">
<img src="https://img.shields.io/badge/goreport-A%2B-brightgreen?style=flat-square">
</a>
<a href="https://gocover.io/github.com/gofiber/fiber">
<img src="https://img.shields.io/badge/coverage-91%25-brightgreen?style=flat-square">
</a>
<a href="https://travis-ci.org/gofiber/fiber">
<img src="https://img.shields.io/travis/gofiber/fiber/master.svg?label=linux&style=flat-square">
</a>
<a href="https://travis-ci.org/gofiber/fiber">
<img src="https://img.shields.io/travis/gofiber/fiber/master.svg?label=windows&style=flat-square">
</a>
</p>
<p align="center">
2020-02-26 12:03:11 +08:00
<b>Fiber</b>是一个基于<a href="https://github.com/expressjs/express">Express的</a> <b>Web框架</b>,建立在<a href="https://golang.org/doc/">Go</a>语言写的 <b>最快的</b><a href="https://github.com/valyala/fasthttp">Fasthttp</a>HTTP引擎的基础上。皆在</b>简化</b> <b>零内存分配</b><b>提高性能</b>,以便<b>快速</b>开发。
2020-02-12 00:03:54 +01:00
</p>
2020-02-11 00:33:05 +00:00
2020-02-11 01:50:56 +01:00
## ⚡️ 快速入门
2020-02-11 00:33:05 +00:00
```go
package main
import "github.com/gofiber/fiber"
func main() {
app := fiber.New()
app.Get("/", func(c *fiber.Ctx) {
c.Send("Hello, World!")
})
app.Listen(3000)
}
```
2020-02-11 01:50:56 +01:00
## ⚙️ 安装
2020-02-11 00:33:05 +00:00
2020-02-11 01:36:29 +01:00
首先, [下载](https://golang.org/dl/)并安装Go。 `1.11`或更高。
2020-02-11 00:33:05 +00:00
2020-02-11 01:36:29 +01:00
使用[`go get`](https://golang.org/cmd/go/#hdr-Add_dependencies_to_current_module_and_install_them)命令完成安装:
2020-02-11 00:33:05 +00:00
```bash
2020-02-26 12:03:11 +08:00
export GO111MODULE=on
2020-02-19 14:13:46 +01:00
export GOPROXY=https://goproxy.cn
2020-03-01 08:44:10 +01:00
go get -u github.com/gofiber/fiber/...
2020-02-11 00:33:05 +00:00
```
2020-02-11 10:54:36 +08:00
## 🤖 性能
2020-02-11 00:33:05 +00:00
2020-02-11 01:36:29 +01:00
这些测试由[TechEmpower](https://github.com/TechEmpower/FrameworkBenchmarks)和[Go Web执行](https://github.com/smallnest/go-web-framework-benchmark) 。如果要查看所有结果,请访问我们的[Wiki](https://fiber.wiki/benchmarks) 。
2020-02-11 00:33:05 +00:00
<p float="left" align="middle">
2020-02-11 04:06:43 +01:00
<img src="https://github.com/gofiber/docs/blob/master/.gitbook/assets/benchmark-pipeline.png" width="49%">
<img src="https://github.com/gofiber/docs/blob/master/.gitbook/assets/benchmark_alloc.png" width="49%">
2020-02-11 00:33:05 +00:00
</p>
2020-02-11 01:50:56 +01:00
## 🎯 特点
2020-02-11 00:33:05 +00:00
2020-02-11 01:36:29 +01:00
- 强大的[路由](https://fiber.wiki/routing)
2020-02-11 10:54:36 +08:00
- [静态文件](https://fiber.wiki/application#static)服务
2020-02-11 01:36:29 +01:00
- 极限[表现](https://fiber.wiki/benchmarks)
2020-02-11 10:54:36 +08:00
- [内存占用低](https://fiber.wiki/benchmarks)
2020-02-11 01:36:29 +01:00
- Express [API端点](https://fiber.wiki/context)
2020-02-11 10:54:36 +08:00
- 中间件和[Next](https://fiber.wiki/context#next)支持
2020-02-11 01:36:29 +01:00
- [快速的](https://dev.to/koddr/welcome-to-fiber-an-express-js-styled-fastest-web-framework-written-with-on-golang-497)服务器端编程
2020-02-14 02:24:06 +01:00
- Available in [5 languages](https://fiber.wiki/)
2020-02-11 10:54:36 +08:00
- 以及更多[文档](https://fiber.wiki/)
2020-02-11 00:33:05 +00:00
2020-02-11 01:50:56 +01:00
## 💡 哲学
2020-02-11 00:33:05 +00:00
2020-02-26 12:03:11 +08:00
从[Node.js](https://nodejs.org/en/about/)切换到[Go的](https://golang.org/doc/)新gopher在开始构建Web应用程序或微服务之前正在应对学习过程。 Fiber作为一个**Web框架** ,是按照**极简主义**的思想并遵循**UNIX方式创建的**因此新的gopher可以以热烈和可信赖的欢迎**方式**迅速进入Go的世界。
2020-02-11 00:33:05 +00:00
2020-02-26 12:03:11 +08:00
Fiber **受** Internet上最流行的Web框架Expressjs的**启发** 。我们结合了Express的**易用**性和Go的**原始性能** 。如果您曾经在Node.js上实现过Web应用程序(*使用Express.js或类似工具*),那么许多方法和原理对您来说似乎**非常易懂**。
2020-02-11 00:33:05 +00:00
2020-02-26 12:03:11 +08:00
## 👀 示例
2020-02-11 00:33:05 +00:00
2020-02-11 01:36:29 +01:00
下面列出了一些常见示例。如果您想查看更多代码示例,请访问我们的[Recipes存储库](https://github.com/gofiber/recipes)或访问我们的[API文档](https://fiber.wiki) 。
2020-02-11 00:33:05 +00:00
2020-03-04 13:55:12 +01:00
### Routing
2020-02-11 00:33:05 +00:00
2020-02-16 18:00:14 +01:00
```go
func main() {
app := fiber.New()
2020-02-11 00:33:05 +00:00
2020-02-16 18:00:14 +01:00
// GET /john
app.Get("/:name", func(c *fiber.Ctx) {
fmt.Printf("Hello %s!", c.Params("name"))
// => Hello john!
})
2020-02-11 00:33:05 +00:00
2020-02-16 18:00:14 +01:00
// GET /john
app.Get("/:name/:age?", func(c *fiber.Ctx) {
fmt.Printf("Name: %s, Age: %s", c.Params("name"), c.Params("age"))
// => Name: john, Age:
})
2020-02-14 02:08:37 +01:00
2020-02-16 18:00:14 +01:00
// GET /api/register
app.Get("/api*", func(c *fiber.Ctx) {
fmt.Printf("/api%s", c.Params("*"))
// => /api/register
})
2020-02-14 02:08:37 +01:00
2020-02-16 18:00:14 +01:00
app.Listen(3000)
}
```
2020-02-14 02:08:37 +01:00
2020-03-04 13:55:12 +01:00
### Serve static files
https://fiber.wiki/application#static
2020-02-26 12:03:11 +08:00
```go
func main() {
app := fiber.New()
2020-03-04 13:55:12 +01:00
app.Static("/", "/public")
2020-02-26 12:03:11 +08:00
// => http://localhost:3000/js/script.js
// => http://localhost:3000/css/style.css
app.Static("/prefix", "/public")
// => http://localhost:3000/prefix/js/script.js
// => http://localhost:3000/prefix/css/style.css
app.Static("*", "/public/index.html")
// => http://localhost:3000/any/path/shows/index/html
app.Listen(3000)
}
```
2020-03-04 13:55:12 +01:00
### Middleware & Next
https://fiber.wiki/routing#middleware
https://fiber.wiki/context#next
2020-02-16 18:00:14 +01:00
```go
func main() {
app := fiber.New()
2020-02-11 00:33:05 +00:00
2020-02-16 18:00:14 +01:00
// Match any route
app.Use(func(c *fiber.Ctx) {
fmt.Println("First middleware")
c.Next()
})
2020-02-11 00:33:05 +00:00
2020-02-16 18:00:14 +01:00
// Match all routes starting with /api
app.Use("/api", func(c *fiber.Ctx) {
fmt.Println("Second middleware")
c.Next()
})
2020-02-11 00:33:05 +00:00
2020-02-16 18:00:14 +01:00
// POST /api/register
app.Post("/api/register", func(c *fiber.Ctx) {
fmt.Println("Last middleware")
c.Send("Hello, World!")
})
app.Listen(3000)
}
```
2020-02-11 00:33:05 +00:00
2020-02-14 02:24:06 +01:00
<details>
2020-03-04 13:55:12 +01:00
<summary>📚 Show more code examples</summary>
2020-02-26 12:03:11 +08:00
2020-03-04 13:55:12 +01:00
### Template engines
https://fiber.wiki/application#settings
https://fiber.wiki/context#render
2020-02-26 12:03:11 +08:00
2020-03-04 13:55:12 +01:00
Supported engines:
2020-02-26 12:03:11 +08:00
- [html](https://golang.org/pkg/html/template/)
- [amber](https://github.com/eknkc/amber)
- [handlebars](https://github.com/aymerick/raymond)
- [mustache](https://github.com/cbroglie/mustache)
- [pug](https://github.com/Joker/jade)
```go
func main() {
// You can setup template engine before initiation app:
app := fiber.New(&fiber.Settings{
2020-02-27 05:37:48 -05:00
TemplateEngine: "mustache",
TemplateFolder: "./views",
TemplateExtension: ".tmpl",
2020-02-26 12:03:11 +08:00
})
// OR after initiation app at any convenient location:
2020-02-27 05:37:48 -05:00
app.Settings.TemplateEngine = "mustache"
app.Settings.TemplateFolder = "./views"
app.Settings.TemplateExtension = ".tmpl"
2020-02-26 12:03:11 +08:00
// And now, you can call template `./views/home.tmpl` like this:
app.Get("/", func(c *fiber.Ctx) {
c.Render("home", fiber.Map{
"title": "Homepage",
"year": 1999,
})
})
// ...
}
```
2020-02-16 18:00:14 +01:00
2020-03-04 13:55:12 +01:00
### Grouping routes into chains
https://fiber.wiki/application#group
2020-02-26 12:03:11 +08:00
```go
func main() {
app := fiber.New()
// Root API route
api := app.Group("/api", cors()) // /api
// API v1 routes
v1 := api.Group("/v1", mysql()) // /api/v1
v1.Get("/list", handler) // /api/v1/list
v1.Get("/user", handler) // /api/v1/user
// API v2 routes
v2 := api.Group("/v2", mongodb()) // /api/v2
v2.Get("/list", handler) // /api/v2/list
v2.Get("/user", handler) // /api/v2/user
// ...
}
```
2020-03-04 13:55:12 +01:00
### Middleware logger
https://fiber.wiki/middleware#logger
```go
import (
"github.com/gofiber/fiber"
"github.com/gofiber/fiber/middleware"
)
func main() {
app := fiber.New()
// If you want to change default Logger config
loggerConfig := middleware.LoggerConfig{
Format: "${time} - ${method} ${path}\n",
TimeFormat: "Mon, 2 Jan 2006 15:04:05 MST",
}
// Middleware for Logger with config
app.Use(middleware.Logger(loggerConfig))
// ...
}
```
### Cross-Origin Resource Sharing (CORS)
https://fiber.wiki/middleware#cors
[CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) is a mechanism that uses additional HTTP headers to tell browsers to give a web application running at one origin, access to selected resources from a different origin. A web application executes a cross-origin HTTP request when it requests a resource that has a different origin (domain, protocol, or port) from its own.
```go
import (
"github.com/gofiber/fiber"
"github.com/gofiber/fiber/middleware"
)
func main() {
app := fiber.New()
// Connect CORS for each route as middleware
app.Use(middleware.CORS())
app.Get("/", func(c *fiber.Ctx) {
c.Send("CORS is enabled!")
})
app.Listen(3000)
}
```
Check CORS by passing any domain in `Origin` header:
```bash
curl -H "Origin: http://example.com" --verbose http://localhost:3000
```
### Custom 404 response
2020-02-16 18:00:14 +01:00
```go
func main() {
app := fiber.New()
app.Static("/public")
2020-03-04 13:55:12 +01:00
2020-02-16 18:00:14 +01:00
app.Get("/demo", func(c *fiber.Ctx) {
c.Send("This is a demo!")
})
2020-03-04 13:55:12 +01:00
2020-02-16 18:00:14 +01:00
app.Post("/register", func(c *fiber.Ctx) {
c.Send("Welcome!")
})
// Last middleware to match anything
app.Use(func(c *fiber.Ctx) {
c.SendStatus(404) // => 404 "Not Found"
})
2020-02-11 00:33:05 +00:00
2020-02-16 18:00:14 +01:00
app.Listen(3000)
}
```
2020-02-11 00:33:05 +00:00
2020-03-04 13:55:12 +01:00
### JSON Response
https://fiber.wiki/context#json
2020-02-16 18:00:14 +01:00
```go
2020-03-04 13:55:12 +01:00
type User struct {
Name string `json:"name"`
Age int `json:"age"`
}
2020-02-16 18:00:14 +01:00
func main() {
app := fiber.New()
2020-02-11 00:33:05 +00:00
2020-03-04 13:55:12 +01:00
app.Get("/user", func(c *fiber.Ctx) {
c.JSON(&User{"John", 20})
// {"name":"John", "age":20}
})
2020-02-11 00:33:05 +00:00
2020-02-16 18:00:14 +01:00
app.Get("/json", func(c *fiber.Ctx) {
2020-03-04 13:55:12 +01:00
c.JSON(&fiber.Map{
"success": true,
"message": "Hi John!",
})
// {"success":true, "message":"Hi John!"}
2020-02-16 18:00:14 +01:00
})
app.Listen(3000)
}
```
2020-03-04 13:55:12 +01:00
### WebSocket support
https://fiber.wiki/application#websocket
2020-02-26 12:03:11 +08:00
```go
func main() {
app := fiber.New()
2020-03-04 13:55:12 +01:00
app.WebSocket("/ws", func(c *fiber.Conn) {
2020-02-26 12:03:11 +08:00
for {
mt, msg, err := c.ReadMessage()
if err != nil {
log.Println("read:", err)
break
}
log.Printf("recovery: %s", msg)
err = c.WriteMessage(mt, msg)
if err != nil {
log.Println("write:", err)
break
}
}
})
2020-03-04 13:55:12 +01:00
// Listen on ws://localhost:3000/ws
2020-02-26 12:03:11 +08:00
app.Listen(3000)
}
```
2020-02-11 00:33:05 +00:00
2020-03-04 13:55:12 +01:00
### Recover middleware
https://fiber.wiki/middleware#recover
2020-02-16 18:00:14 +01:00
```go
2020-03-04 13:55:12 +01:00
package main
import (
"github.com/gofiber/fiber"
"github.com/gofiber/fiber/middleware"
)
2020-02-16 18:00:14 +01:00
func main() {
app := fiber.New()
2020-02-11 00:33:05 +00:00
2020-03-04 13:55:12 +01:00
app.Use(middleware.Recover(func(c *fiber.Ctx, err error) {
log.Println(err) // "Something went wrong!"
c.SendStatus(500) // Internal Server Error
})))
2020-02-16 18:00:14 +01:00
app.Get("/", func(c *fiber.Ctx) {
panic("Something went wrong!")
})
2020-02-11 00:33:05 +00:00
2020-02-16 18:00:14 +01:00
app.Listen(3000)
}
```
2020-02-14 02:24:06 +01:00
</details>
2020-02-14 02:05:39 +01:00
2020-02-11 00:33:05 +00:00
2020-02-11 01:50:56 +01:00
## 💬 媒体
2020-02-11 00:33:05 +00:00
2020-02-26 12:03:11 +08:00
- [欢迎使用Fiber —用Go语言编写的Express.js风格的Web框架 ❤️](https://dev.to/koddr/welcome-to-fiber-an-express-js-styled-fastest-web-framework-written-with-on-golang-497) *作者[维克·肖斯塔克(VicShóstak)](https://github.com/koddr)2020年2月3日*
- [Fiber 1.7 已经发布! 🎉 他仍然快速、灵活且友善](https://dev.to/koddr/fiber-v2-is-out-now-what-s-new-and-is-he-still-fast-flexible-and-friendly-3ipf) *作者[维克·肖斯塔克(VicShóstak)](https://github.com/koddr), 2020年2月21日)
2020-02-11 00:33:05 +00:00
2020-02-11 01:50:56 +01:00
## 👍 贡献
2020-02-11 00:33:05 +00:00
2020-02-13 00:06:25 +03:00
如果您要说声**谢谢**或支持`Fiber`的积极发展:
2020-02-11 00:33:05 +00:00
2020-02-11 01:36:29 +01:00
1. 将[GitHub Star](https://github.com/gofiber/fiber/stargazers)添加到项目中。
2020-02-26 12:03:11 +08:00
2. [在Twitter上](https://twitter.com/intent/tweet?text=%F0%9F%9A%80%20Fiber%20%E2%80%94%20is%20an%20Express.js%20inspired%20web%20framework%20build%20on%20Fasthttp%20for%20%23Go%20https%3A%2F%2Fgithub.com%2Fgofiber%2Ffiber)发布有关项目[的推文](https://twitter.com/intent/tweet?text=%F0%9F%9A%80%20Fiber%20%E2%80%94%20is%20an%20Express.js%20inspired%20web%20framework%20build%20on%20Fasthttp%20for%20%23Go%20https%3A%2F%2Fgithub.com%2Fgofiber%2Ffiber)。
3. 在[Medium](https://medium.com/)[Dev.to](https://dev.to/)或个人博客上写评论或教程。
4. 帮助我们将此`README文件`翻译成其它语言。
2020-02-14 02:05:39 +01:00
## ☕ Supporters
2020-02-11 00:33:05 +00:00
2020-02-16 18:00:14 +01:00
<a href="https://www.buymeacoffee.com/fenny" target="_blank">
<img src="https://github.com/gofiber/docs/blob/master/static/buy-morning-coffee-3x.gif" alt="Buy Me A Coffee" height="100" >
</a>
2020-02-14 02:05:39 +01:00
<table>
<tr>
2020-03-04 14:02:22 +01:00
<td align="center">
<a href="https://github.com/gofiber/fiber">
<img src="https://i.stack.imgur.com/frlIf.png" width="100px"></br>
<sub><b>JustDave</b></sub>
</a>
</td>
2020-02-14 02:05:39 +01:00
<td align="center">
<a href="https://github.com/bihe">
2020-02-16 18:00:14 +01:00
<img src="https://avatars1.githubusercontent.com/u/635852?s=460&v=4" width="100px"></br>
2020-02-14 02:05:39 +01:00
<sub><b>HenrikBinggl</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/koddr">
2020-02-16 18:00:14 +01:00
<img src="https://avatars0.githubusercontent.com/u/11155743?s=460&v=4" width="100px"></br>
2020-03-04 14:02:22 +01:00
<sub><b>Vic&nbsp;Shóstak</b></sub>
2020-02-14 02:05:39 +01:00
</a>
</td>
<td align="center">
<a href="https://github.com/MarvinJWendt">
2020-02-16 18:00:14 +01:00
<img src="https://avatars1.githubusercontent.com/u/31022056?s=460&v=4" width="100px"></br>
2020-02-14 02:05:39 +01:00
<sub><b>MarvinJWendt</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/toishy">
2020-02-16 18:00:14 +01:00
<img src="https://avatars1.githubusercontent.com/u/31921460?s=460&v=4" width="100px"></br>
2020-02-14 02:05:39 +01:00
<sub><b>ToishY</b></sub>
</a>
</td>
</tr>
</table>
2020-02-11 00:33:05 +00:00
2020-02-11 01:50:56 +01:00
### ⭐️ 星星
2020-02-11 00:33:05 +00:00
<a href="https://starchart.cc/gofiber/fiber" rel="nofollow"><img src="https://starchart.cc/gofiber/fiber.svg" alt="Stars over time" style="max-width:100%;"></a>
2020-02-11 01:50:56 +01:00
## ⚠️ 许可证
2020-02-11 00:33:05 +00:00
2020-02-13 00:06:25 +03:00
`Fiber`是根据[MIT许可证许可的](https://github.com/gofiber/fiber/blob/master/LICENSE)免费开源软件。