当前位置: 首页 > 工具软件 > mux > 使用案例 >

golang路由mux的介绍及基本使用

司徒兴德
2023-12-01

github地址:

  • https://github.com/gorilla/mux#matching-routes
  • https://gitee.com/mirrors/mux#examples
  • http://www.gorillatoolkit.org/pkg/mux
  • https://github.com/gorilla/mux#examples

代码示例:

import (
	"encoding/json"
	"github.com/gorilla/mux"
	"log"
	"math/rand"
	"net/http"
	"strconv"
	"strings"
)

// 定义Book的结构体
type Book struct {
	ID		string	`json:"id"`
	Isbn	string	`json:"isbn"`
	Title	string	`json:"title"`
	Author  *Author	`json:"author"`
}

// 定义Author的结构体
type Author struct {
	Firstname		string	`json:"firstname"`
	Lastname		string 	`json:"lastname"`
}

// 初始化book的切片
var books []Book

// 查询所有的Book
func getBooks(w http.ResponseWriter, r *http.Request) {
	w.Header().Set("Content-Type", "application/json")
	w.WriteHeader(http.StatusOK)
	json.NewEncoder(w).Encode(books)
}

// 根据ID查询Book
func getBook(w http.ResponseWriter, r *http.Request) {
	w.Header().Set("Content-Type", "application/json")
	params := mux.Vars(r) // Get params
	log.Println(params)
	// Loop through books and find with id
	for _, item := range books {
		if item.ID == params["id"] {
			json.NewEncoder(w).Encode(item)
			return
		}
	}
	json.NewEncoder(w).Encode(&Book{})
}

// 根据Title查询
func getBookByTitle(w http.ResponseWriter, r *http.Request) {
	var newBooks []Book
	params := mux.Vars(r) // Get params
	for _, item := range books {
		if strings.Contains(item.Title, params["title"]) {
			newBooks = append(newBooks, item)
		}
	}
	json.NewEncoder(w).Encode(newBooks)
}

// 创建Book
func createBook(w http.ResponseWriter, r *http.Request) {
	w.Header().Set("Content-Type", "application/json")
	var book Book
	_ = json.NewDecoder(r.Body).Decode(&book)
	book.ID = strconv.Itoa(rand.Intn(10000000)) // Mock ID - not safe
	books = append(books, book);
	json.NewEncoder(w).Encode(books)
}

// 修改Book
func updateBook(w http.ResponseWriter, r *http.Request) {
	w.Header().Set("Content-Type", "application/json")
	params := mux.Vars(r) // Get params
	var book Book
	json.NewDecoder(r.Body).Decode(&book)
	for index, item := range books {
		if item.ID == params["id"] {
			books[index] = book
			books[index].ID = item.ID
			break
		}
	}
	json.NewEncoder(w).Encode(books)
}

// 删除Book
func deleteBook(w http.ResponseWriter, r *http.Request) {
	w.Header().Set("Content-Type", "application/json")
	params := mux.Vars(r) // Get params
	for index, item := range books {
		if item.ID == params["id"] {
			books = append(books[:index], books[index+1:]...)
			break
		}
	}
	json.NewEncoder(w).Encode(books)
}

func main() {
	// 初始化路由
	r := mux.NewRouter()

	// 增加mock数据
	books = append(books, Book{ID: "1", Isbn: "448743", Title: "Go语言", Author: &Author{Firstname: "John", Lastname: "Doe"}})
	books = append(books, Book{ID: "2", Isbn: "448744", Title: "Java语言", Author: &Author{Firstname: "Steve", Lastname: "Smith"}})
	books = append(books, Book{ID: "3", Isbn: "448745", Title: "java程序设计", Author: &Author{Firstname: "Steve", Lastname: "Smith"}})

	// 普通路由
	r.HandleFunc("/api/books", getBooks).Methods("GET")
	// 普通路由参数
	r.HandleFunc("/api/books/{id}", getBook).Methods("GET")
	//r.HandleFunc("/api/books/byTitle/{title}", getBookByTitle).Methods("GET")
	// 正则路由参数,title的查询限制为英文字母,并且是小写字母,否则报:404 page not found
	r.HandleFunc("/api/books/byTitle/{title:[a-z]+}", getBookByTitle).Methods("GET")

	r.HandleFunc("/api/books", createBook).Methods("POST")
	r.HandleFunc("/api/books/{id}", updateBook).Methods("PUT")
	r.HandleFunc("/api/books/{id}", deleteBook).Methods("DELETE")
	// 监听8000端口,并打出日志
	log.Fatal(http.ListenAndServe(":8000", r))
}

运行程序,通过postman或其它http请求工具发送请求,下面是测试的结果。

1、GET请求http://localhost:8000/api/books,结果如下:

[
    {
        "id": "1",
        "isbn": "448743",
        "title": "Go语言",
        "author": {
            "firstname": "John",
            "lastname": "Doe"
        }
    },
    {
        "id": "2",
        "isbn": "448744",
        "title": "Java语言",
        "author": {
            "firstname": "Steve",
            "lastname": "Smith"
        }
    },
    {
        "id": "3",
        "isbn": "448745",
        "title": "java程序设计",
        "author": {
            "firstname": "Steve",
            "lastname": "Smith"
        }
    }
]

2、GET请求http://localhost:8000/api/books/2,结果如下:

{
    "id": "2",
    "isbn": "448744",
    "title": "Java语言",
    "author": {
        "firstname": "Steve",
        "lastname": "Smith"
    }
}

3、POST请求http://localhost:8000/api/books, 参数(json格式):

{
    "Isbn": "448744",
    "Title": "python语言",
    "Author": {
        "Firstname": "py",
        "Lastname": "thon"
    }
}
结果如下:
[
    {
        "id": "1",
        "isbn": "448743",
        "title": "Go语言",
        "author": {
            "firstname": "John",
            "lastname": "Doe"
        }
    },
    {
        "id": "2",
        "isbn": "448744",
        "title": "Java语言",
        "author": {
            "firstname": "Steve",
            "lastname": "Smith"
        }
    },
    {
        "id": "3",
        "isbn": "448745",
        "title": "java程序设计",
        "author": {
            "firstname": "Steve",
            "lastname": "Smith"
        }
    },
    {
        "id": "8498081",
        "isbn": "448744",
        "title": "python语言",
        "author": {
            "firstname": "py",
            "lastname": "thon"
        }
    }
]
新增了id为8498081的Book

4、DELETE请求http://localhost:8000/api/books/8498081,结果如下:

[
    {
        "id": "1",
        "isbn": "448743",
        "title": "Go语言",
        "author": {
            "firstname": "John",
            "lastname": "Doe"
        }
    },
    {
        "id": "2",
        "isbn": "448744",
        "title": "Java语言",
        "author": {
            "firstname": "Steve",
            "lastname": "Smith"
        }
    },
    {
        "id": "3",
        "isbn": "448745",
        "title": "java程序设计",
        "author": {
            "firstname": "Steve",
            "lastname": "Smith"
        }
    }
]
删除了id为8498081的Book

5、PUT请求http://localhost:8000/api/books/1 , 参数(json格式):

{
    "Isbn": "44874300",
    "Title": "Go语言-1",
    "Author": {
        "Firstname": "John-2",
        "Lastname": "Doe-2"
    }
}
结果如下:
[
    {
        "id": "1",
        "isbn": "44874300",
        "title": "Go语言-1",
        "author": {
            "firstname": "John-2",
            "lastname": "Doe-2"
        }
    },
    {
        "id": "2",
        "isbn": "448744",
        "title": "Java语言",
        "author": {
            "firstname": "Steve",
            "lastname": "Smith"
        }
    },
    {
        "id": "3",
        "isbn": "448745",
        "title": "java程序设计",
        "author": {
            "firstname": "Steve",
            "lastname": "Smith"
        }
    }
]
可以看到id为1的Book已经修改了。

以上的例子为mux的基本使用。

代码地址:
https://gitee.com/sunzf/test-go.git

 类似资料: