apache模块开发之helloworld

学习apache模块开发已经快两个星期了，感觉搞apache模块开发挺有意思的，下面来讲讲apache模块开发的helloworld，非常简单。
Apache  模块开发主要采用挂钩子的方法来实现模块开发的，这和linux内核模块开发有点像，说白了就是加一个回调函数。下面我们来讲 这个例子吧。
首先来介绍下apache的一个工具apxs。apxs是一个为Apache HTTP服务器编译和安装扩展模块的工具，用于编译一个或多个源程序或目标代码文件为动态共享对象，使之可以用由mod_so提供的LoadModule指令在运行时加载到Apache服务器中。

1.apxs -g -n helloworld

上面的命令可以帮助我们产生一个模块名字为helloworld的模板。
上面的命令会产生以下代码

#include "httpd.h"
#include "http_config.h"
#include "http_protocol.h"
#include "ap_config.h"

/* The sample content handler */
static int helloworld_handler(request_rec *r)
{
    if (strcmp(r->handler, "helloworld")) {
        return DECLINED;
    }
    r->content_type = "text/html";      

    if (!r->header_only)
        ap_rputs("The sample page from mod_helloworld.c\n", r);
    return OK;
}

static void helloworld_register_hooks(apr_pool_t *p)
{
    ap_hook_handler(helloworld_handler, NULL, NULL, APR_HOOK_MIDDLE);
}
/* Dispatch list for API hooks */
module AP_MODULE_DECLARE_DATA helloworld_module = {
    STANDARD20_MODULE_STUFF, //用于编译后的模块产生版本信息
    NULL,                  /* 创建目录配置结构*/
    NULL,                  /* 合并目录配置结构 */
    NULL,                  /* 创建主机配置结构 */
    NULL,                  /* 合并主机配置结构 */
    NULL,                  /* 为模块配置相关指令       */
    helloworld_register_hooks  /* 注册模块的钩子函数                      */
};

我们来看下helloworld_module这个结构体，它没个成员的具体作用请看注释。
它最关键的参数为最后一个，这个参数是一个注册钩子函数指针，也就是说当我们把模块加入到apache里面去的时候，他会执行这个注册函数。在这个函数里面我们将会注册我们所要添加的钩子。
本例子中我们用的是

ap_hook_handler(helloworld_handler, NULL, NULL, APR_HOOK_MIDDLE);

这个处理函数，这个处理函数注册了helloworld_handler这个函数。这个函数用于处理我们的请求。
我们来讲下执行的顺序，模块加载-》执行helloworld_register_hooks函数-》注册helloworld_handler这个函数到钩子上去。
这样一来：当一个http请求来的时候，我们就会自动去执行helloworld_handler这个函数。本例子是一个非常简单的内容生成器。

if (strcmp(r->handler, "helloworld")) {//判断是否是这个helloworld  handler
        return DECLINED;//
    }
    r->content_type = "text/html";      
    if (!r->header_only)
        ap_rputs("The sample page from mod_helloworld.c\n", r);//内容生成
    return OK;

下面我们将来进行编译
执行：apxs -c mod_helloworld.c
执行成功以后我们可以发现在.libs下面会出现mod_helloworld.so这个模块文件。这就是我们所需要的，对于apache一些自带的模块一般都放在安装目录的modules/下面。

下面我们来对其进行配置
打开httpd.conf文件，添加以下信息

LoadModule helloworld_module   *****// 指定.so文件的路径。

<Location /helloworld>
	setHandler helloworld
</Location>

Ok ，重启apache 然后输入 http://loacalhost/helloworld 就可以看到
The sample page from mod_helloworld.c

当然这里这里只是输出一句话，我们也可以打印很多html信息，就类似于servlet一样。

这样一来一个简单的apache内容生成器模块已经开发好了，当然应用比较广泛的是过滤器模块的开发，最近项目主要也是用过滤器来实现的。

apache 可以开发出一些功能非常强大的模块来，可以为我们定制更好的apache，比如容器中应用的流量统计，cpu统计等。

才学不久，还不怎么懂，欢迎大家交流。

评论

9 楼 andrew913 2009-06-02  

anry513 写道

www.loveopensource.com上有些apache module的开发文章，你可以看看，希望对你有帮助

非常感谢

8 楼 andrew913 2009-06-02  

annoation可以不可以看出hook?

rrsy23 写道

看了哈 不错;不过 很有感触;其实我们开发servlet也一样;只是apache通过hook,servlet通过xml配置文件;还有annoation可以不可以看出hook?

工作层次不一样，apache模块开发主要应用于一些服务器端开发，比如 流量限制，监控等，我也是最近才开始接触，这边要做一个类似于goole app的东西，所以需要开发一些apache模块。

7 楼 rrsy23 2009-06-02  

看了哈 不错;

不过 很有感触;

其实我们开发servlet也一样;

只是apache通过hook,servlet通过xml配置文件;

还有annoation可以不可以看出hook?

6 楼 anry513 2009-06-01  

www.loveopensource.com上有些apache module的开发文章，你可以看看，希望对你有帮助

5 楼 buluzhai 2009-05-31  

google_fans 写道

有一本叫apache 模块开发指南的书，我现在在看。这东西主要靠自己去琢磨。

谢谢，有空找来看一下

4 楼 jindw 2009-05-31  

看上去真的不错，呵呵，学习了

3 楼 google_fans 2009-05-31  

有一本叫apache 模块开发指南的书，我现在在看。
这东西主要靠自己去琢磨。

2 楼 buluzhai 2009-05-30  

请问在哪儿可以找到apache 核心机制的文章呢

1 楼 lmxbitihero 2009-05-30  

挺有意思。