【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!