把Parameterized Module作為一個Erlang的語法特性而不扯到OOP上去,可能更好理解: )
本文回答Erlang Parameterized Module是什么?有什么用?怎么實現的?我們能不能用?什么時候使用?
和很多人一樣我也是從mochiweb項目中第一次看到parameterized module的應用,mochiweb項目地址:
http://code.google.com/p/mochiweb/
-module(mochiweb_request, [Socket, Method, RawPath, Version, Headers]).
-author('bob@mochimedia.com').
-include_lib("kernel/include/file.hrl").
-include("internal.hrl").
-define(QUIP, "Any of you quaids got a smint?").
當時不明白-module(mochiweb_request, [Socket, Method, RawPath, Version, Headers]).甚至不知道如何稱呼這種做法;只能從形式上描述成module的attribute,在搜索引擎里面按照Erlang module attribute的線索搜索,在Stack Overflow的下面這個提問中找到了更多線索:
Erlang: module attribute - Stack Overflow
是什么?有什么用?
首先要明確的這種Erlang編程實踐的並不是叫什么"Erlang module attribute",而是被稱為Parameterized Module(還有一個名字:abstract module).提出這種方法的論文在這里:http://www.erlang.se/workshop/2003/paper/p29-carlsson.pdf 這篇論文里面可以看到Parameterized Erlang的簡單介紹:
A parameterized, or abstract module, is a module with free variables, much like a lambda expression (or \fun expression"). A lambda expression evaluates to a closure,which is a functional value and can be applied like any function. Similarly, an abstract module can be instantiated to yield a module instance,which can be used in a qualied function call just like any module name.
論文中描述的問題域並沒有帶來多少共鳴,從看到的開源項目的實踐Parameterized Module帶來的最大的好處就是模塊實例自己維護了部分狀態,而不必所有狀態和參數都通過方法的參數傳遞;下面我們就看看,Parameterized Module是怎么使用的,以及狀態是怎么維護的:
怎么用?如何實現的?
我們新建一個最簡單的Parameterized Module的例子:
-module(p,[Name,ID]).
-compile(export_all).
test() ->
{Name,ID}.
dump(Data) ->
Data.
為了方便做比較再建一個普通的module:
-module(p2).
-compile(export_all).
test(Name,ID) ->
{Name,ID}.
dump(Data) ->
Data.
編譯后調用:
Eshell V5.9 (abort with ^G)
1> P=p:new(zen,23).
{p,zen,23}
2> P:test().
{zen,23}
3> P:dump(12).
12
4> p:dump(12).
** exception error: undefined function p:dump/1
%%復習一下Function cal
1> list_to_tuple([a,b,c]).
{a,b,c}
2> tuple_to_list({a,b,c}).
[a,b,c]
3>
4> F={lists,append}.
{lists,append}
5> F([1,2],[3,4]).
[1,2,3,4]
6> fun lists:append/2([a,b],[c,d]).
[a,b,c,d]
7>
上面的代碼首先創建了p模塊的實例,然后調用P:test().雖然並沒有傳入什么參數,還是可以看到Name,ID的輸出;后面直接調用p:dump(12).的時候拋出了異常:undefined function p:dump/1 ;這就驅使我們查看p模塊的module_info,果然如此,{dump,2}dump的參數是標記成兩個!!!!
5> p:module_info().
[{exports,[{new,2},
{instance,2},
{test,1},
{dump,2}, %注意dump的參數是兩個
{module_info,0},
{module_info,1}]},
{imports,[]},
{attributes,[{vsn,[214441158221151374600508513707091486952]},
{abstract,[true]}]},
{compile,[{options,[error_summary]},
{version,"4.8"},
{time,{2012,2,16,7,23,32}},
{source,"/ligaoren/src/p.erl"}]}]
6>
dump參數數量變化的事情暫且放下,咱們先來明確一個更為基礎的問題,Parameterized Module自己維護了部分狀態,那這部分狀態在哪里呢?
我們第一行 P=p:new(zen,23).創建了一個p模塊的實例,這個實例是什么樣的呢?{p,zen,23}這就是P.也就是說實例化的結果實際上返回了一個{模塊+狀態}的結構;繼續做一些實驗來看:
7> P2=p:new(zen,23).
{p,zen,23}
8> P2=:= P.
true
9> {p,zen,34}:test().
{zen,34}
不錯吧,參數相同兩個實例也是相同的,使用同樣結構的tuple{p,zen,34}作為模塊名進行調用{p,zen,34}:test().效果和創建p:new(zen,34).實例一樣.
對比一下p2模塊的元數據:
11> p2:module_info().
[{exports,[{test,2},
{dump,1},
{module_info,0},
{module_info,1}]},
{imports,[]},
{attributes,[{vsn,[248741352456702936001456553656546909458]}]},
{compile,[{options,[error_summary]},
{version,"4.8"},
{time,{2012,2,16,7,26,8}},
{source,"/ligaoren/src/p2.erl"}]}]
能看到p模塊比p2模塊的差異:
- 導出的方法多了{new,2},{instance,2}
- 模塊attributes 多了一個{abstract,[true]}
顯然這樣的信息太少了,我們把這兩個模塊的Core Erlang代碼編譯出來,看看內部實現的差別!p2模塊是比較中規中矩的,基本上都是意料之中的內容:
module 'p2' ['dump'/1,
'module_info'/0,
'module_info'/1,
'test'/2]
attributes []
'test'/2 =
%% Line 10
fun (_cor1,_cor0) ->
%% Line 11
{_cor1,_cor0}
'dump'/1 =
%% Line 13
fun (_cor0) ->
_cor0
'module_info'/0 =
fun () ->
call 'erlang':'get_module_info'
('p2')
'module_info'/1 =
fun (_cor0) ->
call 'erlang':'get_module_info'
('p2', _cor0)
end
p模塊包含的信息量就比較大了,幾乎包含了之前所有問題的答案:
module 'p' ['dump'/2,
'instance'/2,
'module_info'/0,
'module_info'/1,
'new'/2,
'test'/1]
attributes ['abstract' =
['true']]
'new'/2 =
fun (_cor1,_cor0) ->
apply 'instance'/2
(_cor1, _cor0)
'instance'/2 =
fun (_cor1,_cor0) ->
{'p',_cor1,_cor0}
'test'/1 =
%% Line 11
fun (_cor0) ->
case _cor0 of
<THIS = {_cor2,Name,ID}> when 'true' ->
%% Line 12
{Name,ID}
( <_cor1> when 'true' ->
( primop 'match_fail'
({'function_clause',_cor1})
-| [{'function_name',{'test',1}}] )
-| ['compiler_generated'] )
end
'dump'/2 =
%% Line 15
fun (_cor1,_cor0) ->
case <_cor1,_cor0> of
<Data,THIS = {_cor4,Name,ID}> when 'true' ->
%% Line 16
Data
( <_cor3,_cor2> when 'true' ->
( primop 'match_fail'
({'function_clause',_cor3,_cor2})
-| [{'function_name',{'dump',2}}] )
-| ['compiler_generated'] )
end
'module_info'/0 =
fun () ->
call 'erlang':'get_module_info'
('p')
'module_info'/1 =
fun (_cor0) ->
call 'erlang':'get_module_info'
('p', _cor0)
end
-module(q,[Name]). -compile(export_all). dump()-> THIS. Erlang Shell中調用: 2> Q=q:new(zen). {q,zen} 3> Q:dump(). {q,zen}
我們上面已經判斷出來實例的創建過程實際上就是構造了{module,State}的結構,來驗證下:
'new'/2 =
fun (_cor1,_cor0) ->
apply 'instance'/2
(_cor1, _cor0)
'instance'/2 =
fun (_cor1,_cor0) ->
{'p',_cor1,_cor0} %%GOTCHA!!!!!
上面遺留的dump參數的問題至此也就昭然了,看代碼實現:
'dump'/2 =
%% Line 15
fun (_cor1,_cor0) ->
case <_cor1,_cor0> of
<Data,THIS = {_cor4,Name,ID}> when 'true' ->
%% Line 16
Data
( <_cor3,_cor2> when 'true' ->
( primop 'match_fail'
({'function_clause',_cor3,_cor2})
-| [{'function_name',{'dump',2}}] )
-| ['compiler_generated'] )
end
也就是說答案是:最后一個參數是模塊的實例,實驗一下
6> p:dump(12,{p,zen,23}).
12
GOTCHA!!!
When to Use
Parameterized Module通常適用的場景就是用它來維護部分狀態,不必每個方法都傳遞一堆參數;立濤寫的erl_redis的時候把
redis.erl
模塊設計成-module(redis, [Client, Pipeline]).請教了一下他這樣設計的目的,也是為了方便調用,不必每一次都傳遞Client和Pipeline參數.由於Parameterized Module屬於一個實驗特性,雖然已經有mochiweb這樣的項目已經使用,一方面這畢竟還不是一個標准的方法,另一方面Parameterized Module的確沒有m:f(a)直觀; 可以用,但是要控制使用的范圍;
Parameterized module相關的討論:
[1] Erlang questions mailing list ~ Parameterized module idioms http://forum.trapexit.org/viewtopic.php?t=18119&sid=6e84e0954f92e92abc0dbc2a7629058d
[2] about the use of parametrized modules
http://erlang.2086793.n4.nabble.com/about-the-use-of-parametrized-modules-td3216925.html
[3] Is “new” in Erlang part of the official standard and should we use it? http://stackoverflow.com/questions/2287403/is-new-in-erlang-part-of-the-official-standard-and-should-we-use-it