在 C++ 中模拟 Java 的静态初始化块 【翻译】

什么是静态初始化块?

在 Java 中,有一种称为静态初始化块的结构。静态初始化块将在 Java 第一次运行时被加载。例如,请考虑以下代码片段:

class Foo {
    static {
        // initialization code goes here
        // called only once, when the class is loaded by the runtime
        System.out.println("I'm the static initialization block of Foo\n");
    }

    public Foo() {
        System.out.println("I'm the constructor of Foo\n");
    }

    public static void Main(String[] args) {
        Foo foo1 = new Foo();
        Foo foo2 = new Foo();
    }
}

这产生类似下面的输出:

I'm the static initialization block of Foo
I'm the constructor of Foo
I'm the constructor of Foo

这种构造可以在各种情况下有用。在 Java 中,预期的用例是允许对类的静态成员进行多行初始化。它也可以用于日志记录和任何种类的“注册”或“订阅”代码(如脚本绑定)。

更多关于 Java 的静态初始化块的介绍可以参考这篇文章:http://www.jianshu.com/p/e10871b7cbd4

C++ 缺乏这种构造方法,但是通过巧妙地设计,可以模仿它的某些方面的特性。

什么可以模拟?

首先,在 C++ 中没有运行库这样的东西,至少不是 Java 的意义上的运行库。这意味着上述定义不能完全在 C++ 中复制。因此,目标是要有一个构造:

  • 使用最少的样板
  • 很容易理解(也就是说,语法很简单)
  • 作为静态函数,在类的范围内运行
  • 在确定点执行代码,最好在 main 的开始
语法

从上面的要求(以及一些要提到的限制)出发,以下是静态初始化块的预期语法:

In foo.h:

#pragma once
#include "static_init.h"

class Foo
{
public:
    Foo();
    DECLARE_STATIC_INIT(Foo);
};

In foo.cc:

#include <iostream>
#include "foo.h"

Foo::Foo()
{
    std::cout << "I'm the constructor of Foon";
}

STATIC_INIT(Foo)
{
    std::cout << "I'm the static initialization block of Foon";
}

In main.cc:

#include <iostream>
#include "static_init.h"
#include "foo.h"

int main()
{
    static_init::execute();
    Foo foo1, foo2;
}

我们期望这个代码将产生与上面的 Java 代码片段相同的输出。

实现上述想法

那么进入 static_init.h 呢? 从主要的代码中,不难猜出实现的一部分是某种注册表。我们没有猜错,它看起来像这样:

typedef void (*init_func_type)();

class static_init
{
public:
    static static_init& instance()
    {
        static static_init inst;
        return inst;
    }

    void add_init_func(init_func_type f) { funcs_.push_back(f); }

    static void execute()
    {
        auto& inst = instance();
        for (auto& c : inst.funcs_) c();
    }

private:
    static_init() {}

    std::vector<init_func_type> funcs_;
};

static_init 是一个管理和执行 void 函数的单例类。init_func_type 是一个函数指针的 typedef,它指向一个不带参数的函数。他们将被用来指向静态成员函数。std :: function 也可以在这里工作,但效率会比较低。执行成员函数设计成静态的,仅仅是为了在调用方面方便,没有别的意图。

add_init_func 在哪里调用? 诀窍是在一个静态成员的构造函数中调用它。这个构造函数将 init 函数作为参数传递给 add_init_func。 理论上,可以在那里调用该函数(并且不需要 “init 函数注册表”),但是这样做会使我们的代码受到 “静态初始化顺序失败” 的影响。 我们不想对我们的库的客户施加任何限制,所以我们正在采取这种方法:

对于在注册代码中偷偷引入的静态成员,我们需要定义一个助手类。这是非常简单的:

class static_init_helper
{
public:
   static_init_helper(init_func_type f)
   {
       static_init::instance().add_init_func(f);
   }
};

在这一点上,我们有我们所需要的一切功能。 Foo.h 会有这样的代码:

#pragma once
#include "static_init.h"

class Foo
{
public:
    Foo();
    static void static_init_func();
    static static_init_helper Foo_static_init_helper;
};

在 foo.cc 中:

#include <iostream>
#include "foo.h"

Foo::Foo()
{
    std::cout << "I'm the constructor of Foon";
}

// This is where the registration code (i.e. the constructor of the helper class) gets called:
static_init_helper Foo::Foo_static_init_helper(&Foo::static_init_func);

// And this is the implementation of the static init function,
// an actual static member function of the class.
void Foo::static_init_func()
{
    std::cout << "I'm the static initialization block of Foon";
}

它能够正常工作,但是一点也不漂亮和优雅。

使它更漂亮一点

我们有意安排了上面的代码,这样可以很容易地看到宏可以派上多大的用场啦。 声明部分非常简单:

#define DECLARE_STATIC_INIT(ClassName)
   static void static_init_func();
   static static_init_helper ClassName##_static_init_helper

注意最后缺少分号。这只是作者的一个个人喜好,我们可以根据自己的习惯进行添加。

同样,实现部分:

#define STATIC_INIT(ClassName)
   static_init_helper ClassName::ClassName##_static_init_helper(&ClassName::static_init_func);
   void ClassName::static_init_func()

但是,在这里,我们可能不会在最后添加一个分号,因为宏将在将要写入的成员函数的签名中结束。这就是允许宏充当函数定义的一部分的原因。

缺点

上面已经提到了一个问题:虽然静态初始化函数并不直接受到 “静态初始化顺序失败” 的影响(也就是说,它们可以期望任何类的静态成员被完全构建),但它们可能并不相互依赖,因为他们将被称为未定义的顺序。

这个解决方案在 C++ 领域引入了一些有点陌生的概念。这意味着程序员阅读使用它的代码会增加开销。不过,用正确的代码命名将使我们的意图应该很容易被猜到。

另外,这也为类添加了一个数据成员。虽然这个数据成员是 0 大小,但它仍然需要存在于一个源文件中才能正确链接。这意味着静态的 init 函数不可能是 inline 的。

源代码

本文的源代码(以及一些示例代码)可在 Github repository 中查看

本文翻译自文章:

http://szelei.me/cpp-static-init-block/

感谢原文作者

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,524评论 5 460
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,869评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,813评论 0 320
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,210评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,085评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,117评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,533评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,219评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,487评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,582评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,362评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,218评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,589评论 3 299
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,899评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,176评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,503评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,707评论 2 335

推荐阅读更多精彩内容