• 如何使用 Gin 和 Gorm 搭建一个简单的 API 服务 (一)


    介绍

      Go 语言最近十分火热,但对于新手来说,想立马上手全新的语法和各种各样的框架还是有点难度的。即使是基础学习也很有挺有挑战性。
      在这篇文章中,我想用最少的代码写出一个可用的 API 服务。这个 API 可以提供增删改查(CRUD)这些基本功能,对象关系映射 (ORM) 让数据库操作变得非常简单,不用 100 行代码,都可以搞定。让我们开始吧。

      在下面这个连接中可以找到最后完成的全部代码:
      https://github.com/cgrant/gin-gorm-api-example

    起步

      这篇文章假设读者已经安装了 Go 的运行环境,如果您还没装好 Go,可以移步到这篇文章,参考一下:
      http://cgrant.io/tutorials/go/getting-started-with-go/

    Gin

      既然是搭建 API 服务,就需要一个 Web 框架来处理路由并响应 HTTP 请求,Go 语言有很多各式各样的开源框架,本文我们选用了 Gin https://github.com/gin-gonic/gin。Gin 的特点是响应速度快,结构简单。

      我们先来给 API 服务创建文件夹和 main.go 文件吧。

    $ mkdir -p $GOPATH/src/simple-api
    $ cd $GOPATH/src/simple-api
    $ touch main.go
    

      代码如下

    package main
    
    import "fmt"
    
    func main() {
            fmt.Println("Hello World")
    }
    

      我们先测试一下。

    $ go run main.go
    Hello World
    

      非常好,现在让我们把 Gin 框架的代码加进去。

    package main
    
    import "github.com/gin-gonic/gin"
    
    func main() {
            r := gin.Default()
            r.GET("/", func(c *gin.Context) {
                    c.String(200, "Hello World")
            })
            r.Run()
    }
    

      保存并运行。

    $ go run main.go
    [GIN-debug] [WARNING] Running in "debug" mode. Switch to "release" mode in production.
     — using env: export GIN_MODE=release
     — using code: gin.SetMode(gin.ReleaseMode)
    [GIN-debug] GET / → main.main.func1 (3 handlers)
    [GIN-debug] Environment variable PORT is undefined. Using port :8080 by default
    [GIN-debug] Listening and serving HTTP on :8080
    [GIN] 2016/12/02–14:57:52 | 200 | 33.798µs | ::1 | GET / 
    

    在浏览器中访问地址 http://localhost:8080

    Hello World
    

      成功了!!!

      不过我们是在写 API,没人会返回字符串的,把返回值改成 JSON 格式吧。

    package main
    
    import "github.com/gin-gonic/gin"
    
    func main() {
            r := gin.Default()
            r.GET("/", func(c *gin.Context) {
                    c.String(200, "Hello World")
                    c.JSON(200, gin.H{
                            "message": "Hello World",
                    })
            })
            r.Run()
    }
    

      保存文件,重新运行 API server,刷新浏览器,返回值变成了 JSON。
      {“message”: “Hello World”}

    用 GORM 把数据持久化

      现在让我们考虑一下服务的持久化层,在这部分中,我们将把数据保存在一个本地 SQLite 文件中,在稍后的章节中,我们将改为 MySQL。

      Gorm http://jinzhu.me/gorm/ 是一个 Go 语言实现的对象关系映射 (ORM) 框架。它简化了程序对数据库的操作,虽然我不是很赞同在大型的复杂系统中使用 ORM,但 ORM 在小项目中做做原型验证还是很不错的。Gorm 是 Go 的生态中很流行的工具,所以我们先从这里入手吧。

      我们从头开始,先把之前的代码去掉,在浏览了 GORM 的主要功能后,再把 Gin 的代码加回来。先来个简单的例子:

    package main
    
    import (
            "github.com/jinzhu/gorm"
            _ "github.com/jinzhu/gorm/dialects/sqlite"
    )
    
    func main() {
            db, _ := gorm.Open("sqlite3", "./gorm.db")
            defer db.Close()
    }
    

      执行程序后,在运行环境的文件系统里可以看到一个新文件 gorm.db。这就是 API 的数据库文件了。我们的 API 程序现在还没什么功能,让我们再加点代码吧。

    package main
    
    import (
            "github.com/jinzhu/gorm"
            _ "github.com/jinzhu/gorm/dialects/sqlite"
    )
    
    type Person struct {
            ID        uint   `json:"id"`
            FirstName string `json:"firstname"`
            LastName  string `json:"lastname"`
    }
    
    func main() {
            db, _ := gorm.Open("sqlite3", "./gorm.db")
            defer db.Close()
    
            p1 := Person{FirstName: "John", LastName: "Doe"}
            p2 := Person{FirstName: "Jane", LastName: "Smith"}
    
            fmt.Println(p1.FirstName)
            fmt.Println(p2.LastName)
    }
    

      我们刚刚加了一个叫 Person 的结构体,然后建了几个 Person 类型的实例,并打印了里面的值。请注意结构体 Person 里的每个域的名字必须是大写字母开头的,这样 Go 语言才认为这是一个共有域。

    package main
    
    import (
            "github.com/jinzhu/gorm"
            _ "github.com/jinzhu/gorm/dialects/sqlite"
    )
    
    type Person struct {
            ID        uint   `json:"id"`
            FirstName string `json:"firstname"`
            LastName  string `json:"lastname"`
    }
    
    func main() {
            db, _ := gorm.Open("sqlite3", "./gorm.db")
            defer db.Close()
    
            db.AutoMigrate(&Person{})
    
            p1 := Person{FirstName: "John", LastName: "Doe"}
            p2 := Person{FirstName: "Jane", LastName: "Smith"}
    
            db.Create(&p1)
            var p3 Person
            db.First(&p3)
    
            fmt.Println(p1.FirstName)
            fmt.Println(p2.LastName)
            fmt.Println(p3.LastName)
    }
    

      到目前为止都很顺利,执行一下程序看看能得到什么结果。

    $ go run main.go
    John
    Smith
    Doe
    

      写起来还是挺简单的吧,不用几行代码,我们就可以从数据库中存取信息了。Gorm 还有很多其他特性,接下来让我们再试试其中比较重要的功能,当然,要了解更多信息的话,请查看 Gorm 的文档。



    作者:blackpiglet
    链接:https://www.jianshu.com/p/35665b584347
    来源:简书
    著作权归作者所有。商业转载请联系作者获得授权,非商业转载请注明出处。
  • 相关阅读:
    SpringMVC学习笔记六:类型转换器及类型转换异常处理
    SpringMVC学习笔记五:HandlerExceptionResolver异常处理
    SpringMVC学习笔记四:SimpleMappingExceptionResolver异常处理
    SpringMVC学习笔记三:Controller的返回值
    SpringMVC学习笔记二:参数接受
    SSH+Ajax实现用户名重复检查(二)
    SSH+Ajax实现用户名重复检查(一)
    Java添加事件的四种方式
    用Java开发一个本地服务管理软件
    Java Web开发中的名词解释
  • 原文地址:https://www.cnblogs.com/php-linux/p/13074157.html
Copyright © 2020-2023  润新知