rebar工具使用备忘录 (4)

haogongju、人人IT网、59n南龙、360doc、ask3不要抄我的烂博客了，私人备忘用。


4.应用的发布与配置

具体的，erlang里的发布是将应用系统及其依赖的第三方库，以及erlang运行时打包，这样的一个发布可以作为一个独立的系统，安装到其它的机器上。

这里的发布类似JEE里的war发行包，但是并不完全相同。如果要类比的话，我觉得有点像将JRE、Tomcat，War包及其它第三方jar包打成一个完整的包发布，用户拿到这个发布包后不用自己安装JRE，tomcat，直接就可以运行了。我记得atlassia的Jira好像就是这样发布的。

4.1 应用的发布

假设我们的应用xxx完成了，该应用直接依赖3个第三方应用（此外还有1个应用，它是依赖的依赖），这些依赖的应用是：lager,poolboy,webmachine（它依赖mochiweb），它们放在xxx应用的deps目录下，显示目录结构如前。

写完应用后就准备发布（release）了，在xxx工程的根目录下新建一个rel目录（实际上这个目录不一定非要在工程当前目录下，在任意其它目录下都可以，稍后看例子），进入该目录。

mkdir rel && cd rel

准备生产发布的配置文件：

rebar create-node nodeid=xxx

会看到当前目录（rel）下自动生成了许多文件：

tree -L 2 ./rel

./rel                                                                    
├── files                                                                                      
│   ├── erl                                                                       
│   ├── xxx                                                 
│   ├── nodetool
│   ├── xxx.cmd
│   ├── install_upgrade.escript
│   ├── start_erl.cmd
│   ├── sys.config
│   └── vm.args
└── reltool.config

绿色的是可执行文件，这些将是xxx系统的运行脚本。

蓝色的是发布相关的系统的发布配置文件。常做的修改有：

1) reltool.config是发布的配置文件，它一般需要做如下修改：

a). 指出应用依赖的其他应用（这里是lager这类应用）库所在的路径：
{lib_dirs, ["../deps"]}

b). 指出本应用的路径（这里就是上一级目录）：
{app, xxx, [{mode_cond, app}, {incl_cond, include},
                       {lib_dir, ".."}
                      ]}
实际上本应用的路径也可以在第一步里指定，不过在这里路径成了上一级的上一级：
{lib_dirs, ["../deps", "../.."]}


c). 其它
{excl_archive_filters, [".*"]}, %% 不要在 lib目录下为每个应用生成ez归档文件
{mod_cond, derived}, %% erlang本身自带的lib是很庞大的，但是我们的应用可能不会用到所有lib下的应用，这个参数将自动去除应用没有用到的lib。（例如appmon,edoc,et,gs,observer,tools,webtools和wx）


2) 红色的sys.config用来配置xxx系统的运行参数

对所有应用运行时的配置参数（例如环境参数）可以在sys.config文件中配置（例如lager的参数配置就可以在sys.config中设置）。

本应用依赖的其它应用，要在'rel'中指出：
{rel, "xxx", "1",
  [kernel, stdlib, sasl,
   lager, poolboy, webmachine,
   xxx
  ]}
  

（注：在riak中，对应的这个文件叫app.config，sys.config是最新的名字，app.config是老版本rebar使用的名字，因为某些原因riak中的这个名字一直保持到现在）

现在回到应用的根目录，修改rebar.config文件以指出发布及其配置所在的路径

cd ..
vim rebar.config

增加如下内容指定发布及其配置的路径：
{sub_dirs, ["rel"]}.

最后，就可以用rebar自动发布了
1） 重新编译:
rebar clean compile
2） 打包发布:
rebar generate

（有个灵异的事情，如果rebar在项目根目录下，用这个目录下的rebar就不能generate，卡在那不动了，但是将同样的rebar拷贝到/usr/local/bin目录下，就可以了）

发布包在rel目录下，bin目录下有各种运行脚本，假设应用叫xxx，从当前目录启动应用如下：
rel/xxx/bin/xxx start


为了加深理解，举个例子

引用

如果本应用的工程目录是/home/foo/workspace/xxx
故意将rel目录建立在其它目录下，比如/home/foo/build目录下，我们需要在配置好这两个路径：
1). 修改xxx工程的rebar.config文件，指出rel所在位置，修改的片断：
{sub_dirs, ["/home/foo/build/rel"]}.

2). 修改rel目录下的reltool.config文件，指出应用及其依赖所在的路径，修改的片断：
第三方应用的所在路径
{lib_dirs, ["/home/foo/workspace/xxx/deps"]}
应用本身所在路径
{app, xxx, [{mode_cond, app}, {incl_cond, include},
                       {lib_dir, "/home/foo/workspace/xxx/"}
                      ]}

3). 修改/home/foo/build/rel目录下的reltool.config文件，指出所依赖的所有第三方应用：
{rel, "xxx", "1",
  [kernel, stdlib, sasl,
   lager, poolboy, webmachine,
   xxx
  ]}

修改完毕，进入工程目录进行发布
cd /home/foo/workspace/xxx
rebar generate

生成的发布文件在/home/foo/build/rel的目录xxx下
tree -L 2 xxx
xxx
├── bin
│   ├── install_upgrade.escript
│   ├── start_erl.cmd
│   ├── xxx
│   └── xxx.cmd
├── erts-5.9.1
│   └── bin
├── lib
│   ├── compiler-4.8.1
│   ├── crypto-2.1
│   ├── erts-5.9.1
│   ├── hipe-3.9.1
│   ├── kernel-2.15.1
│   ├── lager-1.2.0
│   ├── poolboy-0.8.1
│   ├── mochiweb-1.5.1
│   ├── webmachine-1.9.2
│   ├── sasl-2.2.1
│   ├── stdlib-1.18.1
│   ├── syntax_tools-1.6.8
│   ├── tools-2.6.7
│   └── xxx-1
├── log
│   └── sasl
└── releases
    ├── 1
    ├── RELEASES
    └── start_erl.data

启动该应用
cd /home/foo/build/rel
./xxx/bin/xxx console

可以看到本应用，和其它第三方应用都自动启动了。
Erlang R15B01 (erts-5.9.1) [source] [64-bit] [smp:4:4] [async-threads:0] [hipe] [kernel-poll:false] [systemtap]

19:41:16.609 [info] Application lager started on node 'xxx@127.0.0.1'
19:41:16.610 [info] Application poolboy started on node 'xxx@127.0.0.1'
19:41:16.610 [info] Application crypto started on node 'xxx@127.0.0.1'
19:41:16.611 [info] Application inets started on node 'xxx@127.0.0.1'
19:41:16.611 [info] Application mochiweb started on node 'xxx@127.0.0.1'
19:41:16.611 [info] Application webmachine started on node 'xxx@127.0.0.1'
19:41:16.612 [info] Application xxx started on node 'xxx@127.0.0.1'

4.2 应用的配置

我们的应用可能在启动时或者运行时需要配置一些参数。一般这些参数以{Key, Value}的形式配置在应用的env中，系统运行时通过application:get_env(key_1)读取参数的值。env可以在应用的app文件中配置，例如(下面假设xxx系统是erlcount）

{application, erlcount,
[{vsn, "1.0.0"},
{modules, [erlcount, erlcount_sup, erlcount_lib,
erlcount_dispatch, erlcount_counter]},
{applications, [ppool]},
{registered, [erlcount]},
{mod, {erlcount, []}},
{env,
    [{directory, "."},
    {regex, ["if\\s.+->", "case\\s.+\\sof"]},
    {max_files, 10}]}
]}

这个app文件有3个配置参数: directory, regex和max_files，这些参数在应用启动和运行时读取，从而达到控制应用的目的。

通过rebar create-node生产的一系列文件中有一个叫做sys.config的文件，在这个文件可以为各个应用配置参数。例如，实际上我们可以在这个文件中为某个应用（以erlcount应用为例子）配置同样的参数，在sys.config中的这些参数会覆盖掉应用中的同名参数。例如在sys.config为erlcount应用配置参数的例子：
{erlcount, [
    [{directory, "/my_src"},
    {max_files, 12345}]}
]},

4.3 应用的使用：应用的启动、停止和其他
rebar generate生成的发布一般在rel目录下，查看一下发布应用的目录结构：

tree -L 2 ./rel/erlcount

./rel/erlcount/
├── bin
│   ├── erlcount
│   ├── erlcount.cmd
│   ├── install_upgrade.escript
│   └── start_erl.cmd
├── erts-5.9.1
│   └── bin
├── lib
│   ├── compiler-4.8.1
│   ├── crypto-2.1
│   ├── erts-5.9.1
│   ├── erlcount-1.0
│   ├── hipe-3.9.1
│   ├── kernel-2.15.1
│   ├── lager-1.0.0
│   ├── ppool-1.0
│   ├── sasl-2.2.1
│   ├── stdlib-1.18.1
│   ├── syntax_tools-1.6.8
│   └── tools-2.6.7
├── log
│   └── sasl
└── releases
    ├── 1.0
    ├── RELEASES
    └── start_erl.data

基本上这是一个包括的Erlang VM的可发布应用了。大小大概有35MB，其中Erlang VM相关的可执行文件有23MB。

可以看到发布目录的bin下有个与应用同名的可执行脚本文件，它有个帮助参数：

rel/erlcount/bin/erlcount help

主要用到的命令参数有start, stop, restart和attach

前3个顾名思义，启动/停止/重启应用，attach是挂在运行应用的shell上，注意erl不结束的退出是Ctrl+D