编写第一个Apache模块——mod_helloworld
编写第一个Apache模块——mod_helloworld2008-11-08 14:20自Apache2.0以来Apache就是一个开放的平台，开发人员可以轻松的为Apache编写模块。我下面要讲的例子是摘自Apache Modules Book一书。
mod_helloworld是一个内容生成模块（content generator），它及其简单，但是他却可以反映编写Apache模块的基本概念。在以后的博文中，我会扩展这个helloworld模块，让它可以像简单的CGI一样访问request header、环境变量、处理表单数据等等。不过现在让我们尽快的开始我们的helloworld吧。
安装Apache
要编写Apache模块首先肯定要按照Aapche，这里选择从源码安装，笔者在写这篇文章时Apache的版本是2.2.10。
解压
tar zvxf httpd-2.2.10.tar.gz
配置
./configure --prefix=/usr/local/apache2 --enable-so --enable-mods-shared=most
编译安装
make
make install （超级用户）
功能
当用户在浏览器中输入http://www.xxx.com/hellworld/时，helloworld模块会在浏览器上显示一个大大的Hello Apache module的字样。
编写模块
好了，我们现在已经有环境了，bin目录下有个对开发人员最重要的工具apxs，它其实是个脚本，用来方便我们编译安装apache模块。
模块框架
所有Apache模块都要将它的module数据结构导出（exporting），对Apache2.x模块来说，导出module的形式如下：
module AP_MODULE_DECLARE_DATA some_module = {
STANDARD20_MODULE_STUFF,
some_dir_cfg, /* create per-directory config struct */
some_dir_merge, /* merge per-directory config struct */
some_svr_cfg, /* create per-host config struct */
some_svr_merge, /* merge per-host config struct */
some_cmds, /* configuration directives for this module */
some_hooks /* register module's hooks/etc. with the core */
};
STANDARD20_MODULE_STUFF宏展开，它提供了模块的版本信息。在这里我们不对他做深入的研究，有兴趣了解的可以阅读Apache的源代码。
对于helloworld模块，我们这里只考虑模块的最后一个字段，他注册模块个钩子（hooks）。helloworld模块的module结构如下：
module AP_MODULE_DECLARE_DATA helloworld_module = {
STANDARD20_MODULE_STUFF,
NULL,
NULL,
NULL,
NULL,
NULL,
helloworld_hooks
};
现在我们来写钩子注册函数，它会在Apache服务启动时调用。它的用途是把我们的处理函数注册给服务器核心（server core），这样模块的函数就会在适当的时机得到调用。对于helloworld来说，我们这样仅仅注册一个”内容生成“类型的钩子（Apache有很多类型的钩子）
static void helloworld_hooks(apr_pool_t *pool)
{
ap_hook_handler(helloworld_handler, NULL, NULL, APR_HOOK_MIDDLE);
}
最后当然是实现处理函数helloworld_handler啦。它是一个回调函数，他会在Apache处理HTTP请求的适当时机调用。处理函数可以选择处理或是忽略这个请求。
static int helloworld_handler(request_rec *r)
{
if (!r->handler || strcmp(r->handler, "helloworld")) {
return DECLINED;
}
if (r->method_number != M_GET) {
return HTTP_METHOD_NOT_ALLOWED;
}
ap_set_content_type(r, "text/html;charset=ascii");
ap_rputs("<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01//EN\">\n", r);
ap_rputs("<html><head><title>Hello Apache Module</title></head>", r);
ap_rputs("<body><h1>Hello Apache Module</h1>", r);
ap_rputs("</body></html>", r);
return OK;
}
我们开始做一些检查，来决定模块是处理这个请求还是忽略它。返回DECLINED表示忽略，OK表示成功处理，也可返回HTTP状态代码（HTTP status code）表示错误处理。
全部放在一起
/* The simplest HelloWorld module */
#include <httpd.h>
#include <http_protocol.h>
#include <http_config.h>
static int helloworld_handler(request_rec *r)
{
if (!r->handler || strcmp(r->handler, "helloworld")) {
return DECLINED;
}
if (r->method_number != M_GET) {
return HTTP_METHOD_NOT_ALLOWED;
}
ap_set_content_type(r, "text/html;charset=ascii");
ap_rputs("<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01//EN\">\n", r);
ap_rputs("<html><head><title>Hello Apache Module</title></head>", r);
ap_rputs("<body><h1>Hello Apache Module</h1>", r);
ap_rputs("</body></html>", r);
return OK;
}
static void helloworld_hooks(apr_pool_t *pool)
{
ap_hook_handler(helloworld_handler, NULL, NULL, APR_HOOK_MIDDLE);
}
module AP_MODULE_DECLARE_DATA helloworld_module = {
STANDARD20_MODULE_STUFF,
NULL,
NULL,
NULL,
NULL,
NULL,
helloworld_hooks
};
注意：helloworld_hooks和helloworld_handler都是static的。一般来说，只有模块结构被导出，其他的都是模块自己私有的。这是一个好的实践。
编译安装
apxs -c mod_helloworld.c （编译）
apxs -i mod_helloworld.la （安装）
这样我们的modules目录中就多了一个mod_helloworld.so的文件
运行
要运行我们还要修改配置文件httpd.conf
在最后添加
LoadModule helloworld_module modules/mod_helloworld.so
<Location /helloworld>
SetHandler helloworld
</Location>
第一行是让Apache动态的载入这个模块。
第二行设置浏览器的请求url的路径。
SetHandler helloworld其实是设置r->handler的值。
别忘了重启Apache哦！
最后在浏览器中敲入http://localhost/hellworld，就可以看到令人兴奋的效果了
注意：
如果linux系统自带的apache 卸载掉
方法如下
卸载步骤如下：
卸载Mysql
[root@localhost ~]# rpm -qa|grep mysql
mod_auth_mysql-2.6.1-2.2
php-mysql-4.3.9-3.15
mysql-devel-4.1.20-1.RHEL4.1
mysql-4.1.20-1.RHEL4.1
mysqlclient10-3.23.58-4.RHEL4.1
libdbi-dbd-mysql-0.6.5-10.RHEL4.1
说明：rpm –qa | grep mysql 命令是为了把mysql相关的包都列出来，我上面的例子是Linux AS4默认安装mysql的rpm软件包列表，如果是别的Linux版本列出来的列表有可能会不一样，不过不用担心，不管是什么，卸载都从最下面的一个包开始，直到卸载掉第一个为止。
比如：在这个例子中，我们应该先卸载libdbi-dbd-mysql-0.6.5-10.RHEL4.1 方法如下：rpm –e -dbd-mysql-0.6.5-10.RHEL4.1
说明：rpm –e 是卸载rpm包的命令，后面是包名称，最后的版本号是不用打的，比如我们下一步卸载mysqlclient10-3.23.58-4.RHEL4.1包，方法如下：
rpm –e mysqlclient
卸载Apache
[root@localhost ~]# rpm -qa|grep httpd
httpd-manual-2.0.52-25.ent
system-config-httpd-1.3.1-1
httpd-2.0.52-25.ent
httpd-suexec-2.0.52-25.ent
说明：方法跟卸载Mysql一样，不用说了吧
卸载PHP
[root@localhost ~]# rpm -qa|grep php
php-odbc-4.3.9-3.15
php-4.3.9-3.15
php-mysql-4.3.9-3.15
php-pear-4.3.9-3.15
php-ldap-4.3.9-3.15
php-pgsql-4.3.9-3.15
说明：方法跟卸载Mysql一样，不用说了吧
注意：卸载的时候如果卸载不掉，系统一般会提示包的依赖关系，并且列出依赖的包的名称，先卸载提示依赖的包就可以了。
如果实在实在有卸载不掉的包，可以加—nodeps这个参数来卸载，比如我们卸载php-4.3.9-3.15，实在卸不掉了。
就用：
[root@localhost ~]# rpm -e php-4.3.9-3.15 --nodeps
重新安装apache
安装apache httpd
1、
./configure --prefix=/usr/local/searchcommon/apache2.2.15 --enable-modules=so --enable-mods-shared=all --enable-proxy --enable-proxy-connect --enable-proxy-ftp --enable-proxy-http --enable-proxy-ajp --enable-proxy-balancer --enable-so --enable-deflate --enable-headers --enable-include -enable-forward
make
make install
2、
进入/usr/apache目录，运行apache ./apachectl -k start
运行apache后，浏览一下是否运行正常。
关闭apache ./apachectl -k stop
3、
把apache作为linux的启动就运行服务程序
执行如下操作：cp /usr/apache/bin/apachectl /etc/rc.d/init.d/httpd
确认linux以前安装的httpd（apache）不需要了，你可覆盖掉以前apache的httpd文件。
chkconfig --add httpd
运行linux的setup，把httpd服务默认设定为自动运行。
到现在，你就可用另一种方式来启动、关闭apache了。如service httpd start
mod_helloworld是一个内容生成模块（content generator），它及其简单，但是他却可以反映编写Apache模块的基本概念。在以后的博文中，我会扩展这个helloworld模块，让它可以像简单的CGI一样访问request header、环境变量、处理表单数据等等。不过现在让我们尽快的开始我们的helloworld吧。
安装Apache
要编写Apache模块首先肯定要按照Aapche，这里选择从源码安装，笔者在写这篇文章时Apache的版本是2.2.10。
解压
tar zvxf httpd-2.2.10.tar.gz
配置
./configure --prefix=/usr/local/apache2 --enable-so --enable-mods-shared=most
编译安装
make
make install （超级用户）
功能
当用户在浏览器中输入http://www.xxx.com/hellworld/时，helloworld模块会在浏览器上显示一个大大的Hello Apache module的字样。
编写模块
好了，我们现在已经有环境了，bin目录下有个对开发人员最重要的工具apxs，它其实是个脚本，用来方便我们编译安装apache模块。
模块框架
所有Apache模块都要将它的module数据结构导出（exporting），对Apache2.x模块来说，导出module的形式如下：
module AP_MODULE_DECLARE_DATA some_module = {
STANDARD20_MODULE_STUFF,
some_dir_cfg, /* create per-directory config struct */
some_dir_merge, /* merge per-directory config struct */
some_svr_cfg, /* create per-host config struct */
some_svr_merge, /* merge per-host config struct */
some_cmds, /* configuration directives for this module */
some_hooks /* register module's hooks/etc. with the core */
};
STANDARD20_MODULE_STUFF宏展开，它提供了模块的版本信息。在这里我们不对他做深入的研究，有兴趣了解的可以阅读Apache的源代码。
对于helloworld模块，我们这里只考虑模块的最后一个字段，他注册模块个钩子（hooks）。helloworld模块的module结构如下：
module AP_MODULE_DECLARE_DATA helloworld_module = {
STANDARD20_MODULE_STUFF,
NULL,
NULL,
NULL,
NULL,
NULL,
helloworld_hooks
};
现在我们来写钩子注册函数，它会在Apache服务启动时调用。它的用途是把我们的处理函数注册给服务器核心（server core），这样模块的函数就会在适当的时机得到调用。对于helloworld来说，我们这样仅仅注册一个”内容生成“类型的钩子（Apache有很多类型的钩子）
static void helloworld_hooks(apr_pool_t *pool)
{
ap_hook_handler(helloworld_handler, NULL, NULL, APR_HOOK_MIDDLE);
}
最后当然是实现处理函数helloworld_handler啦。它是一个回调函数，他会在Apache处理HTTP请求的适当时机调用。处理函数可以选择处理或是忽略这个请求。
static int helloworld_handler(request_rec *r)
{
if (!r->handler || strcmp(r->handler, "helloworld")) {
return DECLINED;
}
if (r->method_number != M_GET) {
return HTTP_METHOD_NOT_ALLOWED;
}
ap_set_content_type(r, "text/html;charset=ascii");
ap_rputs("<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01//EN\">\n", r);
ap_rputs("<html><head><title>Hello Apache Module</title></head>", r);
ap_rputs("<body><h1>Hello Apache Module</h1>", r);
ap_rputs("</body></html>", r);
return OK;
}
我们开始做一些检查，来决定模块是处理这个请求还是忽略它。返回DECLINED表示忽略，OK表示成功处理，也可返回HTTP状态代码（HTTP status code）表示错误处理。
全部放在一起
/* The simplest HelloWorld module */
#include <httpd.h>
#include <http_protocol.h>
#include <http_config.h>
static int helloworld_handler(request_rec *r)
{
if (!r->handler || strcmp(r->handler, "helloworld")) {
return DECLINED;
}
if (r->method_number != M_GET) {
return HTTP_METHOD_NOT_ALLOWED;
}
ap_set_content_type(r, "text/html;charset=ascii");
ap_rputs("<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01//EN\">\n", r);
ap_rputs("<html><head><title>Hello Apache Module</title></head>", r);
ap_rputs("<body><h1>Hello Apache Module</h1>", r);
ap_rputs("</body></html>", r);
return OK;
}
static void helloworld_hooks(apr_pool_t *pool)
{
ap_hook_handler(helloworld_handler, NULL, NULL, APR_HOOK_MIDDLE);
}
module AP_MODULE_DECLARE_DATA helloworld_module = {
STANDARD20_MODULE_STUFF,
NULL,
NULL,
NULL,
NULL,
NULL,
helloworld_hooks
};
注意：helloworld_hooks和helloworld_handler都是static的。一般来说，只有模块结构被导出，其他的都是模块自己私有的。这是一个好的实践。
编译安装
apxs -c mod_helloworld.c （编译）
apxs -i mod_helloworld.la （安装）
这样我们的modules目录中就多了一个mod_helloworld.so的文件
运行
要运行我们还要修改配置文件httpd.conf
在最后添加
LoadModule helloworld_module modules/mod_helloworld.so
<Location /helloworld>
SetHandler helloworld
</Location>
第一行是让Apache动态的载入这个模块。
第二行设置浏览器的请求url的路径。
SetHandler helloworld其实是设置r->handler的值。
别忘了重启Apache哦！
最后在浏览器中敲入http://localhost/hellworld，就可以看到令人兴奋的效果了
注意：
如果linux系统自带的apache 卸载掉
方法如下
卸载步骤如下：
卸载Mysql
[root@localhost ~]# rpm -qa|grep mysql
mod_auth_mysql-2.6.1-2.2
php-mysql-4.3.9-3.15
mysql-devel-4.1.20-1.RHEL4.1
mysql-4.1.20-1.RHEL4.1
mysqlclient10-3.23.58-4.RHEL4.1
libdbi-dbd-mysql-0.6.5-10.RHEL4.1
说明：rpm –qa | grep mysql 命令是为了把mysql相关的包都列出来，我上面的例子是Linux AS4默认安装mysql的rpm软件包列表，如果是别的Linux版本列出来的列表有可能会不一样，不过不用担心，不管是什么，卸载都从最下面的一个包开始，直到卸载掉第一个为止。
比如：在这个例子中，我们应该先卸载libdbi-dbd-mysql-0.6.5-10.RHEL4.1 方法如下：rpm –e -dbd-mysql-0.6.5-10.RHEL4.1
说明：rpm –e 是卸载rpm包的命令，后面是包名称，最后的版本号是不用打的，比如我们下一步卸载mysqlclient10-3.23.58-4.RHEL4.1包，方法如下：
rpm –e mysqlclient
卸载Apache
[root@localhost ~]# rpm -qa|grep httpd
httpd-manual-2.0.52-25.ent
system-config-httpd-1.3.1-1
httpd-2.0.52-25.ent
httpd-suexec-2.0.52-25.ent
说明：方法跟卸载Mysql一样，不用说了吧
卸载PHP
[root@localhost ~]# rpm -qa|grep php
php-odbc-4.3.9-3.15
php-4.3.9-3.15
php-mysql-4.3.9-3.15
php-pear-4.3.9-3.15
php-ldap-4.3.9-3.15
php-pgsql-4.3.9-3.15
说明：方法跟卸载Mysql一样，不用说了吧
注意：卸载的时候如果卸载不掉，系统一般会提示包的依赖关系，并且列出依赖的包的名称，先卸载提示依赖的包就可以了。
如果实在实在有卸载不掉的包，可以加—nodeps这个参数来卸载，比如我们卸载php-4.3.9-3.15，实在卸不掉了。
就用：
[root@localhost ~]# rpm -e php-4.3.9-3.15 --nodeps
重新安装apache
安装apache httpd
1、
./configure --prefix=/usr/local/searchcommon/apache2.2.15 --enable-modules=so --enable-mods-shared=all --enable-proxy --enable-proxy-connect --enable-proxy-ftp --enable-proxy-http --enable-proxy-ajp --enable-proxy-balancer --enable-so --enable-deflate --enable-headers --enable-include -enable-forward
make
make install
2、
进入/usr/apache目录，运行apache ./apachectl -k start
运行apache后，浏览一下是否运行正常。
关闭apache ./apachectl -k stop
3、
把apache作为linux的启动就运行服务程序
执行如下操作：cp /usr/apache/bin/apachectl /etc/rc.d/init.d/httpd
确认linux以前安装的httpd（apache）不需要了，你可覆盖掉以前apache的httpd文件。
chkconfig --add httpd
运行linux的setup，把httpd服务默认设定为自动运行。
到现在，你就可用另一种方式来启动、关闭apache了。如service httpd start