1. 初识Erlang宏

在Erlang的魔法世界里，宏就像哈利波特的魔杖，能让代码在编译阶段施展变形术。想象你正在编写一个分布式日志系统，突然发现多个模块都需要重复定义调试标志：

%% 传统方式在每个模块重复定义
-define(DEBUG_MODE, true).

此时宏的魔法价值就显现了。通过公共头文件集中定义：

%% lib/debug.hrl
-ifdef(DEBUG).
-define(LOG(Format, Args), io:format("DEBUG: "++Format, Args)).
-else.
-define(LOG(Format, Args), ok).
-endif.

这个简单的例子展示了宏的三大特征：编译期替换、条件控制、代码复用。但别急着欢呼，当我们尝试在函数中使用时：

handle_call(Request, _From, State) ->
    ?LOG("Received request: ~p", [Request]),  % 宏展开为io:format或ok
    {reply, ok, State}.

编译时根据DEBUG标志的不同，生成的beam文件体积可能相差数倍。这种"代码分身术"正是宏的独特魅力所在。

2. 宏的核心语法全解析

2.1 基础变形术（简单宏）

-define(PI, 3.1415926).                     % 常量替换
-define(SQUARE(X), X * X).                  % 函数式宏
-define(PRINT_VAR(Var), io:format(#Var)).   % #符号展开变量名

test() ->
    Radius = 5,
    Circumference = 2 * ?PI * ?SQUARE(Radius),  % 展开为2*3.1415926*5*5
    ?PRINT_VAR(Radius).                         % 展开为io:format("Radius")

注意参数宏中的陷阱：

-define(DOUBLE(X), X+X).
bad_usage() ->
    Value = 5,
    ?DOUBLE(Value++).  % 展开为Value++++，导致语法错误

2.2 高阶变形术（带参数的复杂宏）

-define(IF(Cond, TrueExpr, FalseExpr),
    case (Cond) of
        true -> TrueExpr;
        false -> FalseExpr
    end).

calculate_discount(Price, VipLevel) ->
    ?IF(VipLevel > 3, Price * 0.7, Price * 0.9).  % 生成case结构

更复杂的元编程示例：

-define(CREATE_GETTER(Field),
    Field(State) ->
        State#state.Field).

-record(state, {counter, timer}).
% 自动生成访问函数
?CREATE_GETTER(counter).
?CREATE_GETTER(timer).

2.3 常见错误集

危险案例一（符号冲突）：

-define(list, [1,2,3]).  % 重定义系统保留字

危险案例二（无限递归）：

-define(INFINITE, ?INFINITE).  % 编译时导致栈溢出

3. 宏的最佳实践场景

3.1 性能调优利器

在热路径代码中消除函数调用开销：

-define(MAX(A,B), if A > B -> A; true -> B end).

fast_sort([Pivot|Rest]) ->
    {Smaller, Bigger} = lists:partition(fun(X) -> X < Pivot end, Rest),
    [?MAX(X,Y) || X <- Smaller, Y <- Bigger].  % 避免函数调用的性能损耗

3.2 协议版本控制

优雅处理多版本协议兼容：

-define(PROTOCOL_VERSION, 2).

handle_packet(BinData) ->
    case ?PROTOCOL_VERSION of
        1 -> decode_v1(BinData);
        2 -> decode_v2(BinData)
    end.

3.3 DSL构建

创建领域特定语言：

-define(GIVEN(Description, Setup),
    {given, ??Description, fun() -> Setup end}).

test_suite() ->
    [
        ?GIVEN("用户有100余额", 
            #user{balance = 100}),
        ?GIVEN("商品库存为5", 
            #item{stock = 5})
    ].

4. 优缺点深度分析

4.1 闪耀优势

  • 编译期确定性：宏展开在编译阶段完成，不影响运行时性能
  • 元编程能力：实现DSL、代码生成等高级特性
  • 条件编译：通过-feature参数控制代码生成

4.2 暗黑诅咒

  • 调试困难：crash堆栈指向展开后的代码
  • 作用域污染：宏定义具有全局性
  • 版本兼容问题：不同OTP版本的宏支持可能有差异

典型陷阱案例：

-define(ADD(X,Y), X + Y).

bug_demo() ->
    Result = ?ADD(1, 2) * 3.  % 预期9，实际得到7（展开为1+2*3）

5. 注意事项

5.1 命名规范

采用全大写下划线命名法：

-define(HTTP_TIMEOUT, 5000).        % 常量
-define(VALIDATE_EMAIL(Addr), ...). % 函数式宏

5.2 防御性编程

添加类型保护：

-define(SAFE_DIV(A,B), 
    case {is_number(A), is_number(B), B =/= 0} of
        {true, true, true} -> A / B;
        _ -> {error, badarg}
    end).

5.3 文档约定

使用特殊注释格式：

%% @macro PARAMETERIZED_MACRO
%% @doc 带参数的示例宏
%% @param Arg1 第一个参数的说明
-define(PARAMETERIZED_MACRO(Arg1, Arg2), ...).

6. 关联技术对比

与C语言宏对比：

// C语言示例
#define SQUARE(x) ((x)*(x))

Erlang宏的优势：

  • 支持模式匹配
  • 更好的类型安全性
  • 集成模块系统

与Elixir宏的传承关系：

# Elixir示例
defmacro debug(expr) do
    quote do
        if Application.get_env(:myapp, :debug) do
            IO.inspect(unquote(expr))
        end
    end
end

Erlang宏更底层，Elixir宏更强调元编程能力

7. 总结与展望

在多年Erlang开发实践中，我发现宏的最佳使用场景是：

  • 需要编译期优化的关键路径
  • 多版本协议/配置管理
  • 重复模式抽象

未来发展方向：

  • 结合类型规范（如Dialyzer）
  • 与parse_transform深度集成
  • 改进调试工具链