50. RESTful API的简单实现 | 厚土Go学习笔记

RESTfull API是现在很流行的 API 设计风格。众所周知的 HTTP 1.1规范正是基于 REST 架构风格的指导原理来设计的。需要注意的是，REST 是一种风格而不是标准。如果一个架构符合 REST 原则，我们就称它为 RESTful 架构。

先来实现一个最简单的，启动一个 RESTful 服务。代码示例

package main

import (
    "net/http"
    "fmt"
    "html"
    "log"
)

func main() {
    http.HandleFunc("/", func(writer http.ResponseWriter, request *http.Request) {
        fmt.Fprintln(writer, "Hello, ", html.EscapeString(request.URL.Path))
    })
    log.Fatal(http.ListenAndServe(":8080",nil))
}

运行这段代码，然后打开浏览器访问 http://localhost:8080

然后再加上路径看看 http://localhost:8080/joel/mak

你会发现网页输出了如下内容

Hello,  /joel/mak

是的，它输出了当前的路径。

路径又称“终点”（endpoint），用来表示 API 的具体地址。在 RESTful 架构中，每个网址代表一个资源（resource）。为了更好的使用这些网址，我们需要有统一的路径分发功能。这里使用第三方的包（Gorilla Mux package）："github.com/gorilla/mux"

实现根据不同的访问路径，给出不同的页面内容的功能。

那么根据路径的不同，需要有不同的函数来各自实现。代码中，我们用 Index、TodoIndex、TodoShow 三个函数来实现不同内容的页面打印。

package main

import (
    "github.com/gorilla/mux"
    "net/http"
    "fmt"
    "log"
)

func main() {
    router := mux.NewRouter().StrictSlash(true)
    router.HandleFunc("/", Index)
    router.HandleFunc("/todos", TodoIndex)
    router.HandleFunc("/todos/{todoId}", TodoShow)

    log.Fatal(http.ListenAndServe(":8080", router))
}
func TodoShow(writer http.ResponseWriter, request *http.Request) {
    vars := mux.Vars(request)
    todoId := vars["todoId"]
    fmt.Fprintln(writer, "Todo show:", todoId)
}
func TodoIndex(writer http.ResponseWriter, request *http.Request) {
    fmt.Fprintln(writer, "Todo Index!",request.URL.Path)
}
func Index(writer http.ResponseWriter, request *http.Request) {
    fmt.Fprintln(writer, "Welcome!")
}

运行以上代码。然后，

在浏览器中输入 http://localhost:8080

页面显示

Welcome!

在浏览器中输入 http://localhost:8080/todos

页面显示

Todo Index! /todos

在浏览器中输入 http://localhost:8080/todos/{123}

页面显示

Todo show: {123}

按照一般的软件过程，我们再把上面的代码进行抽象。分别把数据模型和功能抽象成 Todo.go、Routes.go、Handlers.go

以下为代码示例

main.go

package main

import (
    "net/http"
    "log"
)

func main() {
    router := NewRouter()
    log.Fatal(http.ListenAndServe(":8080", router))
}

是不是主函数 main 清爽了呢？因为其他的部分都被抽象出去了。

Todo.go

package main

import "time"

type Todo struct {
    Id      int     `json:"id"`
    Name    string  `json:"name"`
    Completed   bool    `json:"completed"`
    Due     time.Time   `json:"due"`
}

type Todos  []Todo

go 语言没有 class，必须使用结构来构造数据模型 Todo

Routes.go

package main

import "net/http"

type Route struct {
    Name        string
    Method      string
    Pattern     string
    HandlerFunc http.HandlerFunc
}

type Routes []Route

var routes = Routes{
    Route{Name:"Index",     Method:"GET",   Pattern:"/",                HandlerFunc:Index},
    Route{Name:"TodoIndex", Method:"GET",   Pattern:"/todos",           HandlerFunc:TodoIndex},
    Route{Name:"TodoShow",  Method:"GET",   Pattern:"/todos/{todoId}",  HandlerFunc:TodoShow},
}

go 语言没有 class，必须使用结构来构造数据模型 Route 。

建立了一个变量 routes ，按照 Route 结构存放了多个 Route。而每个 Route 对应了不同的路径。其中不同的 HandlerFunc在 Handlers.go 中实现。

Handlers.go

package main

import (
    "net/http"
    "fmt"
    "encoding/json"
    "github.com/gorilla/mux"
    "time"
)

func Index(w http.ResponseWriter, r *http.Request)  {
    fmt.Fprintln(w, "Welcome!")
}

func TodoIndex(w http.ResponseWriter, r *http.Request)  {
    todos := Todos{
        Todo{Name:"Write presentation"},
        Todo{Name:"Host meetup"},
        Todo{Id:22,Name:"Joel",Completed:true,Due:time.Now()},
    }
    if err := json.NewEncoder(w).Encode(todos); err != nil{
        panic(err)
    }
}

func TodoShow(w http.ResponseWriter, r *http.Request)  {
    vars := mux.Vars(r)
    todoId := vars["todoId"]
    fmt.Fprintln(w, "Todo show:", todoId)
}

分别实现了 Index、TodoIndex、TodoShow，以便 Route 调用。

Router.go

package main

import (
    "github.com/gorilla/mux"
    "net/http"
)

func NewRouter() *mux.Router {
    router := mux.NewRouter().StrictSlash(true)
    for _, route := range routes {
        var handler http.Handler
        handler = route.HandlerFunc 
        handler = logger(handler, route.Name)

        router.
        Methods(route.Method).
        Path(route.Pattern).
        Name(route.Name).
        Handler(handler)
    }
    return router
}

Router 里的 handler = logger(handler, route.Name) 是做什么用的？这是日志。多数现代的 web 服务都会有一个日志。go 语言的标准库里没有 web loging 包。所以我们自己建一个。

这样当程序运行的时候，就会有运行日志记录下来。

Logger.go

package main

import (
    "net/http"
    "time"
    "log"
)

func logger(inner http.Handler, name string) http.Handler {
    return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
        start := time.Now()
        inner.ServeHTTP(w, r)
        log.Printf("CofoxAPI: %st%st%st%s", r.Method, r.RequestURI, name, time.Since(start))
    })
}

记录每次访问的时间、方法、路径及耗时。

因为没有做什么业务，所以运行是相当的快。

运行效果