【Go Web开发】新手入门

开始

在本书的第一部分,我们将建一个项目框架,并为构建我们的Greenlight API打下基础。我们将:

  • 为项目创建一个框架目录结构,并从宏观上解释我们的Go代码和其他文件将如何组织。
  • 建立HTTP服务器来监听传入的HTTP请求。
  • 介绍一个合适的管理配置模式(通过命令行flags)并使用依赖项注入使依赖项在我们的处理程序可用。
  • 使用httprouter包实现API路由,达到标准RESTful结构。

项目配制和代码结构

首先创建一个greenlight目录,作为这个项目的家目录。我将在$HOME/Projects/greenlight上创建我的项目目录,但如果你愿意,可以自由选择不同的位置。

 $ mkdir -p $HOME/Projects/greenlight

然后切换到这个目录,使用go mod init命令为项目启用模块。

运行此命令时,您需要指定模块路径,这实际上是项目的唯一标识符。在本书中,我将使用greenlight.alexedwards.net作为我的模块路径,如果你跟随操作的话,你应该把它替换成你自己的路径。

$ cd $HOME/Projects/greenlight
$ go mod init greenlight.alexedwards.net
go: creating new go.mod: module greenlight.alexedwards.net

此时你将在项目的根目录下看到go.mod文件被创建了。如果你打开该文件,内容类似如下所示:

File: go.mod

module greenlight.alexedwards.net

go 1.16

在第一本Let’s Go书中详细讨论了Go module,但作为快速复习,我们在这里回顾一下要点。

  • 当在你项目的根路径下面有一个合法的go.mod文件的话,说明你的项目是一个模块。
  • 当你在项目中工作时,使用go get去下载依赖包,然后对应特定版本的依赖包将在go.mod中记录。因为版本是确定的,所以很容易在其他的机器或环境中执行代码。
  • 当你在项目中运行或构建代码,Go将使用go.mod中记录的特定依赖。如果需要的依赖并不在当前机器中,Go将自动为你下载,以及任何递归依赖。
  • go.mod文件还定义了模块路径(就是前面说的greenlight.alexedwards.net)。这将用作项目中包导入的根路径标识符。
  • 让模块根路径保持唯一性,是一个好的编码习惯。Go社区的常见约定是使用你的URL作为模块根路径。

如果你不确定go module的工作原理,可以查看Go module wiki,包含很多FAQ-注意可能有些内容已经过时。

生成目录结构

现在project目录已经创建好了并包含go.mod文件,可以继续执行以下命令创建项目结构:

$ mkdir -p bin cmd/api internal migrations remote 
$ touch Makefile
$ touch cmd/api/main.go

此时项目的目录结构应该如下所示的样子:

.
|____cmd
| |____api
|      |____main.go
|____migrations
|____go.mod
|____bin
|____Makefile
|____internal
|____remote

我们花点时间来讨论这些文件和文件夹,并解释它们在项目中所起的作用。

  • bin目录包含应用编译后的二进制文件,可直接部署到生成环境中。
  • cmd/api目录包含Greenlight项目的API代码文件。包括运行HTTP服务器、读写HTTP请求以及认证管理等代码。
  • internal目录包含API使用的各种辅助包。包括与数据库交互、数据校验、发送邮件等。基本上任何非应用特定但可复用的代码都放在这里。在cmd/api中的代码会导入internal目录的代码(但从来没有反过来导入的)
  • imgrations目录包含数据库SQL迁移文件。
  • remote目录包含配制文件和设置脚本。
  • go.mod文件申明项目依赖,版本和module路径。
  • Makefile文件包含常见自动执行管理任务的方法,例如:代码审计、构建二进制文件和执行数据库迁移。

要重点指出的是internal目录在Go中有特殊的含义:在这个目录中的任何包,只能被该目录的父目录导入使用。在我们的项目中,这意味着internal中的所有包只能被greenlight项目中代码所引用。或者,从另一个角度来说,这意味着internal的任何包都不能通过项目外部的代码导入。这是有用的,因为它可以防止其他代码库导入和依赖我们internal目录中的(可能未版本化和不支持的)包——即使项目代码在GitHub中公开可用。

hello world

在继续下一步之前,我们快速检查下所有设置是否正确。用文本编辑器打开cmd/api/main.go文件,添加以下代码:

package main

import "fmt"

func main() { fmt.Println("Hello world!")
}

保存文件,并在终端中使用go run命令编译和执行cmd/api包中的代码。如果一切正常,您将看到以下输出:

$ go run ./cmd/api
Hello world!
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 217,406评论 6 503
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,732评论 3 393
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 163,711评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,380评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,432评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,301评论 1 301
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,145评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,008评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,443评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,649评论 3 334
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,795评论 1 347
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,501评论 5 345
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,119评论 3 328
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,731评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,865评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,899评论 2 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,724评论 2 354

推荐阅读更多精彩内容