开发工具

使用 Vagrant 打造跨平台开发环境

目录
  1. 1. 安装步骤
    1. 1.1. 1. 安装 VirtualBox
    2. 1.2. 2. 安装 Vagrant 并添加镜像
    3. 1.3. 3. 初始化开发环境
  2. 2. 其他设置
  3. 3. 打包分发
  4. 4. 集成预安装
  5. 5. 常用命令
  6. 6. 注意事项

Vagrant 是一款用来构建虚拟开发环境的工具，非常适合 php/python/ruby/java 这类语言开发 web 应用，“代码在我机子上运行没有问题”这种说辞将成为历史。

我们可以通过 Vagrant 封装一个 Linux 的开发环境，分发给团队成员。成员可以在自己喜欢的桌面系统（Mac/Windows/Linux）上开发程序，代码却能统一在封装好的环境里运行，非常霸气。

安装步骤

1. 安装 VirtualBox

虚拟机还是得依靠 VirtualBox 来搭建，免费小巧。
下载地址：https://www.virtualbox.org/wiki/Downloads

提示：虽然 Vagrant 也支持 VMware，不过 VMware 是收费的，对应的 Vagrant 版本也是收费的

2. 安装 Vagrant 并添加镜像

下载地址：https://www.vagrantup.com/downloads.html 根据提示一步步安装。

装好以后运行vagrant box add hashicorp/precise64添加 Vagrant 官方的 box 镜像。这时将从官网下载名为hashicorp/precise64的 box，可能需要等待一段时间。

如果你要其他系统的镜像，可以来这里查询下载：
https://atlas.hashicorp.com/boxes/search
http://www.vagrantbox.es

提示：如果你因为网络原因添加不了上面的镜像，可以用工具将这些 box 下载下来（下载地址），参照后文的“打包分发”部分进行添加。

3. 初始化开发环境

创建一个开发目录（比如：~/dev），你也可以使用已有的目录，切换到开发目录里，用hashicorp/precise64镜像初始化当前目录的环境：

1
2
3
$ cd ~/dev  # 切换目录
$ vagrant init hashicorp/precise64  # 用 hashicorp/precise64 进行 box 初始化
$ vagrant up  # 启动环境

你会看到终端显示了启动过程，启动完成后，我们就可以用 SSH 登录虚拟机了，剩下的步骤就是在虚拟机里配置你要运行的各种环境和参数了。

1
2
$ vagrant ssh  # SSH 登录
$ cd /vagrant  # 切换到开发目录，也就是宿主机上的 ~/dev

~/dev目录对应虚拟机中的目录是/vagrant

Windows用户注意：Windows 终端并不支持ssh，所以需要安装第三方SSH客户端，比如：Putty、Cygwin等。

其他设置

Vagrant 初始化成功后，会在初始化的目录里生成一个Vagrantfile 配置文件，可以修改配置文件进行个性化的定制。

Vagrant 默认是使用端口映射方式将虚拟机的端口映射本地从而实现类似http://localhost:80这种访问方式，这种方式比较麻烦，新开和修改端口的时候都得编辑。相比较而言，host-only 模式显得方便多了。打开 Vagrantfile，将下面这行的注释去掉（移除#）并保存：
config.vm.network :private_network, ip: "192.168.33.10"

重启虚拟机，这样我们就能用192.168.33.10访问这台机器了，你可以把IP改成其他地址，只要不产生冲突就行。

打包分发

当你配置好开发环境后，退出并关闭虚拟机。在终端里对开发环境进行打包：
$ vagrant package

打包完成后会在当前目录生成一个package.box的文件，将这个文件传给其他用户，其他用户只要添加这个 box 并用其初始化自己的开发目录就能得到一个一模一样的开发环境了。

添加方法：

假设我们拿到的 box 存放路径是~/box/package.box，在终端里输入：

1
2
3
$ vagrant box add hahaha ~/box/package.box  # 添加 package.box 镜像并命名为 hahaha
$ cd ~/dev  # 切换到项目目录
$ vagrant init hahaha  # 用 hahaha 镜像初始化。

集成预安装

从上面这条看下来，你会发现每次都修改了一点点内容，再打包分发给其他用户其实很麻烦。为此Vagrant还提供了更为便捷的预安装定制。打开Vagrantfile文件末尾处有下面被注释的代码：

1
2
3
4
config.vm.provision "shell", inline: <<-SHELL
   apt-get update
   apt-get install -y apache2
SHELL

没错，这段代码就是让你在初次运行vagrant up后，虚拟机创建过程众自动运行的初始化命令。 取消注释，把要预先安装的 php/mysql/redis 和配置之类的通通都写进去。初始化时这些程序都会根据你写好的方法安装并配置。

如果你不是初次运行，同时又修改了这里的命令，想让系统再次运行这里面的命令，你可以使用vagrant reload --provision进行重载。所以在这种情况下，你只要将Vagrantfile共享给团队的其他成员就可以了，其他成员运行相同的命令即可，是不是比打包分发要方便许多。

你还可以把要运行的命令单独写在一个文件里存放在相同的目录下，比如bootstrap.sh：

1
2
3
4
5
6
7
8
#!/usr/bin/env bash

apt-get update
apt-get install -y apache2
if ! [ -L /var/www ]; then
  rm -rf /var/www
  ln -fs /vagrant /var/www
fi

然后在Vagrantfile里这样添加：

1
2
3
4
5
6
Vagrant.configure("2") do |config|
  config.vm.box = "hashicorp/precise64"
  ...

  config.vm.provision "shell", path: "bootstrap.sh"  # 添加这行
end

效果和直接写在Vagrantfile是一样的。

常用命令

1
2
3
4
5
6
7
$ vagrant init  # 初始化
$ vagrant up  # 启动虚拟机
$ vagrant halt  # 关闭虚拟机
$ vagrant reload  # 重启虚拟机
$ vagrant ssh  # SSH 至虚拟机
$ vagrant status  # 查看虚拟机运行状态
$ vagrant destroy  # 销毁当前虚拟机

更多内容请查阅官方文档 https://www.vagrantup.com/docs/cli/index.html

注意事项

使用 Apache/Nginx 时会出现诸如图片修改后但页面刷新仍然是旧文件的情况，是由于静态文件缓存造成的。需要对虚拟机里的 Apache/Nginx 配置文件进行修改：

1
2
3
4
5
# Apache 配置（httpd.conf 或者 apache.conf）添加：
EnableSendfile off

# Nginx 配置（nginx.conf）添加：
sendfile off;

SegmentFault 团队就是用这种方式统一开发环境的
本篇文章所用程序版本VirtualBox 5.0.*，Vagrant 1.8.*

这有一份我的配置示例，供参考 https://github.com/fenbox/Vagrantfile
如果你有任何疑问，可以在 vagrant 标签下提问：https://segmentfault.com/t/vagrant

延伸阅读：
《Go 语言开发环境配置》
Vagrant 启动失败，停留在 Waiting for VM to boot 的解决方法
开启 NFS 文件系统提升 Vagrant 共享目录的性能
用 Vagrantfile 配置虚拟机 — 共享目录