golang api搭建

2023-05-21 13:05:13 api 搭建 Golang

golang是一种专门为构建高并发的服务和网络应用而设计的编程语言。Golang具有高效的并发和网络编程能力，这使得它成为许多开发者的首选。要构建一个Golang api，我们需要掌握许多基本概念和技能，从路由处理到数据库访问等等。本文将介绍如何使用Golang构建API。

一、环境准备

在开始构建Golang API之前，需要在计算机上安装Golang。可以通过Golang官方网站(https://golang.org/)下载最新版本的Golang，也可以通过包管理器来安装，如apt-get或yum等。安装完成后，在终端中输入“go version”来验证安装是否成功。

二、依赖包安装

在终端中使用“go get”命令安装需要的依赖包。依赖包是我们在API中经常使用的一些库，例如“gorilla/mux”和“gORM”等。安装方法如下：

go get GitHub.com/gorilla/mux 
go get github.com/jinzhu/gorm 
go get github.com/go-sql-driver/Mysql

三、路由处理

所有API请求都需要通过路由来完成。Golang中最流行的路由包之一是gorilla/mux，因此我们也将使用它。

为了使用gorilla/mux，我们需要导入包并创建一个新的mux对象。在这个例子中，我们将创建两个路由，一个用于显示API主页，另一个用于处理我们的GET请求。

package main

import (
    "fmt"
    "net/Http"

    "github.com/gorilla/mux"
)

func main() {
    router := mux.NewRouter()

    router.HandleFunc("/", Index)
    router.HandleFunc("/tasks", getTasks).Methods("GET")

    http.ListenAndServe(":8000", router)
}

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

func getTasks(w http.ResponseWriter, r *http.Request) {
    fmt.Fprintln(w, "You have requested all tasks")
}

在上面的代码中，我们创建了两个处理函数，Index和getTasks。Index函数用于显示API主页，getTasks处理所有的GET请求。

四、数据库访问

现在我们将向API中添加数据库功能。在本例中，我们将使用mysql数据库，并使用gorm库来管理数据。

首先，我们需要创建一个数据库连接。为此，我们需要创建一个Database struct，其中包含了连接的详细信息。接下来，我们将创建一个新的“openDB”函数来打开连接。

...

import (
    "database/sql"
    "log"

    _ "github.com/go-sql-driver/mysql"
    "github.com/jinzhu/gorm"
)

type Database struct {
    *gorm.DB
}

func (db *Database) openDB() {
    dsn := "username:passWord@tcp(127.0.0.1:3306)/godb?charset=utf8&parseTime=True"
    conn, err := sql.Open("mysql", dsn)
    if err != nil {
        log.Fatal(err)
    }

    db.DB = gorm.Open("mysql", conn)
}

我们现在需要在main函数中创建一个新的Database对象，并使用openDB函数打开连接。

db := new(Database)
db.openDB()

接下来，我们将创建一个Task Model，与我们的任务列表相关联。Model只是一个普通的Go结构体，它将被映射到我们的MySQL数据库中的表。

type Task struct {
    Id      int    `gorm:"primary_key;auto_increment"`
    Name    string `gorm:"not null"`
    Content string `gorm:"not null"`
}

为了创建一个新的任务，我们将创建一个名为“createTask”的处理函数。这个函数将从HTTP请求中接收JSON数据，解析它，并将它插入到我们的数据库中。

func createTask(w http.ResponseWriter, r *http.Request) {
    db := new(Database)
    db.openDB()

    task := &Task{}
    task.Name = r.FormValue("name")
    task.Content = r.FormValue("content")

    db.Create(&task)
    fmt.Fprintln(w, "Task successfully created")
}

我们看到“createTask”函数在开始时创建了一个新的Database对象和Task对象。然后，它从HTTP请求中解析jsON数据，并通过调用db.Create()方法将其插入到数据库中。

最后，我们将更新我们的路由“router.HandleFunc”以包括新的路由。

router.HandleFunc("/tasks", createTask).Methods("POST")

五、Middleware

中间件是一种常见的技术，用于在处理请求之前或之后执行操作。它们不仅在Golang中广泛使用，而且在其他语言中也很常见。来看看如何使用中间件在Golang API中添加一些附加功能。

在Golang中，中间件是一种以HTTP处理函数为参数的函数。它们允许在处理请求之前或之后执行一些逻辑。在下面的例子中，我们将创建一个名为“withLogging”的中间件，它将记录所有API请求的细节。

func withLogging(next http.Handler) http.Handler {
    return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
        log.Println(r.Method, r.URL.Path)
        next.ServeHTTP(w, r)
    })
}

我们看到在函数中返回了一个新的http.Handler函数，它记录了请求的方法和URL路径。 next.ServeHTTP(w, r)语句调用下一个处理程序，确保处理程序继续处理API请求。

接下来，我们将更新我们的路由和处理程序以包括新的日志记录中间件。

router := mux.NewRouter()

router.Use(withLogging)

router.HandleFunc("/", Index)
router.HandleFunc("/tasks", createTask).Methods("POST")
router.HandleFunc("/tasks", getTasks).Methods("GET")

现在，在路由之前添加“router.Use(withLogging)”语句，我们将在所有路由请求上执行withLogging中间件。

六、总结

在本文中，我们介绍了如何在Golang中使用gorilla/mux来处理路由，使用gorm来管理MySQL数据库，以及如何使用中间件来增强我们的API。通过理解这些基本概念和技能，我们可以开始构建更复杂的Golang API。

以上就是golang api搭建的详细内容，更多请关注其它相关文章！

相关文章