PHP加速 eAccelerator配置和使用指南

前一段时间完成了服务器从freebsd4.10到6.1的升级，同时把php也升级到了最新的php5.1.4，apache也升级到了最新的apache2.2，为了更好的提高系统的性能考虑对php再进行一些优化，前两年接触过mmcache和eaccelerator，尤其对eaccelerator非常喜欢，这次优化也选择了它，下面整理一些文档和大家分享。

目录：
一、eaccelerator介绍
1、背景
2、原理
二、安装和配置
1、支持平台
2、系统要求
3、安装
4、php.ini文件配置
5、验证安装
三、使用eaccelerator开发php代码
1、api文档和接口说明
2、开发范例
四、附录和参考资料

一、eaccelerator介绍

1、背景
eaccelerator 是一个免费开源的php加速、优化、编译和动态缓存的项目，它可以通过缓存php代码编译后的结果来提高php脚本的性能，使得一向很复杂和离我们很远的php脚本编译问题完全得到解决。通过使用eaccelerator，可以优化你的php代码执行速度，降低服务器负载，可以提高php应用执行速度最高达10倍。

eaccelerator 项目诞生于2004年，当时它是作为 turck mmcache 项目的一个分支提出并投入开发的。 turck mmcache 由 dmitry stogov 开发，是个非常优秀的php内存缓存加速系统，如今仍然有很大部分 eaccelerator 的代码应用到该项目中，目前该项目有很长时间没有更新了，对于最新的php5.x的支持还未推出。

2、原理
eaccelerator 通过把经过编译后的php代码缓存到共享内存中，并在用户访问的时候直接调用从而起到高效的加速作用。它的效率非常高，从创建共享内存到查找编译后的代码都在非常短的时间内完成，对于不能缓存到共享内存中的文件和代码，eaccelerator还可以把他们缓存到系统磁盘上。

eaccelerator 同样还支持php代码的编译和解释执行，你可以通过encoder.php脚本来对php代码进行编译达到保护代码的目的，经过编译后的代码必须运行在安装了eaccelerator的环境下。eaccelerator编译后的代码不能被反编译，它不象其他一些编译工具那样可以进行反编译，这将使得代码更加安全和高效。

二、eaccelerator安装配置

1、支持平台
由于aaccelerator提供了大部分基于共享内存的api，所以在*nix的平台上将得到更好的支持，虽然也发布了基于windows平台的binary版本，但我在这里就只提供基于*nix平台的配置和说明，目前可以支持的平台包括linux, freebsd, openbsd, mac os x, solaris, aix en hp-ux。

2、系统要求
php4 or php5
autoconf
automake
libtool
m4
eaccelerator 只支持使用 mod_php 或者 fastcgi mode 安装的php

3、安装
先去eaccelerator官方下载最新版的源码包：

#tar -zxvf ./eaccelerator-0.9.5-beta2.tar.bz2
#cd eaccelerator-0.9.5-beta2
#export php_prefix="/usr/local" （把php安装目录导入到环境变量，freebsd默认是/usr/local）
#$php_prefix/bin/phpize
#./configure --enable-eaccelerator=shared --with-php-config=$php_prefix/bin/php-config
#make
#make install

4、ini文件配置
安装完成，下面开始配置php.ini文件,eaccelerator提供了两种配置和调用方式，分别如下。

安装为 zend extension 模式：

zend_extension="/usr/local/lib/php/20050922/eaccelerator.so"
eaccelerator.shm_size="16"
eaccelerator.cache_dir="/tmp/eaccelerator"
eaccelerator.enable="1"
eaccelerator.optimizer="1"
eaccelerator.check_mtime="1"
eaccelerator.debug="0"
eaccelerator.log_file = "/var/log/httpd/eaccelerator_log"
eaccelerator.filter=""
eaccelerator.shm_max="0"
eaccelerator.shm_ttl="0"
eaccelerator.shm_prune_period="0"
eaccelerator.shm_only="0"
eaccelerator.compress="1"
eaccelerator.compress_level="9"

如果你使用了thread safe模式安装的php，你必须使用 “zend_extension_ts” 替换第一行的 “zend_extension”.

安装为 php extension 模式：（这是大部分采用的方式）

extension="eaccelerator.so"
eaccelerator.shm_size="16"
eaccelerator.cache_dir="/tmp/eaccelerator"
eaccelerator.enable="1"
eaccelerator.optimizer="1"
eaccelerator.check_mtime="1"
eaccelerator.debug="0"
eaccelerator.log_file = "/var/log/httpd/eaccelerator_log"
eaccelerator.filter=""
eaccelerator.shm_max="0"
eaccelerator.shm_ttl="0"
eaccelerator.shm_prune_period="0"
eaccelerator.shm_only="0"
eaccelerator.compress="1"
eaccelerator.compress_level="9"

有关php.ini文件的详细配置说明，请参照源码目录的readme文档或者访问官方文档：ini setting

完成安装配置后，我们最后要创建缓存目录

#mkdir /tmp/eaccelerator
#chmod 777 /tmp/eaccelerator

5、验证安装结果
通过浏览器访问您的phpinfo()页面或者运行 php -i 得到php配置信息，里面如果看到类似下面的信息就表示安装成功了。

this program makes use of the zend scripting language engine:
zend engine v2.1.0, copyright (c) 1998-2006 zend technologies
    with eaccelerator v0.9.5-beta2, copyright (c) 2004-2006 eaccelerator, by eaccelerator

我的机器上同时还安装了zend optimizer3.0.1，所以看到的信息如下：

this program makes use of the zend scripting language engine:
zend engine v2.1.0, copyright (c) 1998-2006 zend technologies
    with eaccelerator v0.9.5-beta2, copyright (c) 2004-2006 eaccelerator, by eaccelerator
    with zend extension manager v1.0.10, copyright (c) 2003-2006, by zend technologies
    with zend optimizer v3.0.1, copyright (c) 1998-2006, by zend technologies

如果你打开了eaccelerator的debug选项，可以从日志中看到类似下面的信息

#tail /var/log/httpd/eaccelerator_log
eaccelerator hit: "/var/www/toplee.com/blog/index.php"
eaccelerator hit: "/var/www/toplee.com/blog/wp-blog-header.php"
eaccelerator hit: "/var/www/toplee.com/blog/wp-config.php"
eaccelerator hit: "/var/www/toplee.com/blog/wp-settings.php"
eaccelerator hit: "/var/www/toplee.com/blog/wp-content/plugins/wp-cache/wp-cache-phase1.php"
...

以上信息表示文件都得到了缓存和命中。

至此，我们就完成了全部的安装和配置，好好享受eaccelerator带给你的惊喜吧，根据michael的测试，效果的确相当的好。

三、在php中可以使用eaccelerator的api开发

1、api和文档说明：

eaccelerator提供了便捷便捷而又稳定的本机缓存实现方式，由于大部分代码实现基于共享内存，所以只能在*nix平台中使用，windows平台michael就暂时不知道何时有这方面的支持了。
eaccelerator提供如下的api接口和文件：（下述文件均在源码包的doc/php/目录下）

文件列表：

cache.php
dasm.php
encoder.php
info.php
loader.php
session.php
shared_memory.php

接口列表：

array eaccelerator_cached_scripts ()
void eaccelerator_cache_output (string $key, string $eval_code, [int $ttl = 0])
void eaccelerator_cache_page (string $key, [int $ttl = 0])
void eaccelerator_cache_result (string $key, string $code, [int $ttl = 0])
void eaccelerator_caching (boolean $flag)
void eaccelerator_clean ()
void eaccelerator_clear ()
array eaccelerator_dasm_file (mixed $filename)
mixed eaccelerator_encode (mixed $src, [mixed $prefix = ''], [string $pre_content = ''], [string $post_content = '']) 
void eaccelerator_gc ()
mixed eaccelerator_get (string $key) 
array eaccelerator_info ()
array eaccelerator_list_keys ()
void eaccelerator_load ()
boolean eaccelerator_lock (string $key)
void eaccelerator_optimizer (boolean $flag) 
void eaccelerator_purge ()
boolean eaccelerator_put (string $key, mixed $value, [int $ttl = 0])
array eaccelerator_removed_scripts ()
boolean eaccelerator_rm (string $key)
void eaccelerator_rm_page (string $key) 
boolean eaccelerator_set_session_handlers ()
boolean eaccelerator_unlock (string $key)

有关上述文档详细说明请参考官方文档：api documents

下面有部分网友翻译后的接口说明：

eaccelerator_put($key, $value, $ttl=0)
  将 $value 以 $key 为键名存进缓存(php4下支持对像类型，看源码好像zend2里不支持了)，$ttl 是这个缓存的生命周期，单位是秒，省略该参数或指定为 0 表示不限时，直到服务器重启清空为止。

eaccelerator_get($key)
  根据 $key 从缓存中返回相应的 eaccelerator_put() 存进去的数据，如果这项缓存已经过期或不存在那么返回值是 null

eaccelerator_rm($key)
  根据 $key 移除缓存

eaccelerator_gc()
  移除清理所有已过期的 key

eaccelerator_lock($key)
  为 $key 加上锁定操作，以保证多进程多线程操作时数据的同步。需要调用 eaccelerator_unlock($key) 来释放这个锁或等待程序请求结束时自动释放这个锁。
  例如:
  <?php
    eaccelerator_lock("count");
    eaccelerator_put("count",eaccelerator_get("count")+1));
  ?>

eaccelerator_unlock($key)
  根据 $key 释放锁

eaccelerator_cache_output($key, $eval_code, $ttl=0)
  将 $eval_code 代码的输出缓存 $ttl 秒，（$ttl参数同 eacclerator_put）
  例如：
  <?php eaccelerator_cache_output('test', 'echo time(); phpinfo();', 30); ?>

eaccelerator_cache_result($key, $eval_code, $ttl=0)
  将 $eval_code 代码的执行结果缓存 $ttl 秒，（$ttl参数同 eacclerator_put），类似 cache_output
  例如：
  <?php eaccelerator_cache_result('test', ' time() . "hello";', 30); ?>

eaccelerator_cache_page($key, $ttl=0)
  将当前整页缓存 $ttl 秒。
  例如：
  <?php
    eaccelerator_cache_page($_server['php_self'].'?get='.serialize($_get),30);
    echo time();
    phpinfo();
  ?>

eaccelerator_rm_page($key)
  删除由  eaccelerator_cache_page() 执行的缓存，参数也是 $key

2、php代码中使用eaccelerator加速

下面有一个测试的代码，你可以测试一下eaccelerator强大的威力：（该代码在 cli 模式下可能无效）

<?php
class test_cache {
  var $pro = 'hello';

  function test_cache() {
    echo "object created!<br>\n";
  }
  function func() {
    echo ', the world!';
  }
  function now($t) {
    echo date('y-m-d h:i:s', $t);
  }
}

$tt = eaccelerator_get("test_tt");
if (!$tt)
{
  $tt = new test_cache;
  eaccelerator_put("test_tt", $tt);
  echo "no cached!<br>\n";
}
else {
  echo "cached<br>\n";
}

echo $tt->pro;
$tt->func();
$tt->now(time() + 86400);
?>

另外，据说在著名的vbulletin 3.60beta版里面已经集成了对eaccelerator的支持，下面是一段来自vbulletin里面的代码

// #############################################################################
// eaccelerator

/**
* class for fetching and initializing the vbulletin datastore from eaccelerator
*
* @package vbulletin
* @version $revision: 0.1 $
* @date $date: 2005/06/12 13:14:18 $
*/
class vb_datastore_eaccelerator extends vb_datastore
{
/**
* fetches the contents of the datastore from eaccelerator
*
* @param array array of items to fetch from the datastore
*
* @return void
*/
function fetch($itemarray)
{
if (!function_exists('eaccelerator_get'))
{
trigger_error("eaccelerator not installed", e_user_error);
}

foreach ($this->defaultitems as $item)
{
$this->do_fetch($item);
}

if (is_array($itemarray))
{
foreach ($itemarray as $item)
{
$this->do_fetch($item);
}
}

$this->check_options();

// set the version number variable
$this->registry->versionnumber =& $this->registry->options['templateversion'];
}

/**
* fetches the data from shared memory and detects errors
*
* @param string title of the datastore item
*
* @return void
*/
function do_fetch($title)
{
$data = eaccelerator_get($title);
if ($data === null)
{ // appears its not there, lets grab the data, lock the shared memory and put it in
$data = '';
$dataitem = $this->dbobject->query_first("
select title, data from " . table_prefix . "datastore
where title = '" . $this->dbobject->escape_string($title) ."'
");
if (!empty($dataitem['title']))
{
$data =& $dataitem['data'];
$this->build($dataitem['title'], $dataitem['data']);
}
}
$this->register($title, $data);
}




/**
* updates the appropriate cache file
*
* @param string title of the datastore item
*
* @return void
*/
function build($title, $data)
{
if (!function_exists('eaccelerator_put'))
{
trigger_error("eaccelerator not installed", e_user_error);
}
eaccelerator_lock($title);
eaccelerator_put($title, $data);
eaccelerator_unlock($title);
}
}

四、附录和参考资料
eaccelerator 官方网站 ：http://eaccelerator.net
websites using eaccelerator ?

http://www.advfn.com/ (2006/03/03) advanced financial network, serves over 7 million page hits per day.
http://www.domaincity.co.uk/ (2005/01/29) andrew hutchings - linux guru - just a quick message to say we are now using eaccelerator as a replacement for mmcache on 2 of our 3 node round robin clusters, 2.5million hits per day. we will be doubling this in the next few week, as well as implementing new clusters.
http://www.ets-online.de/ (2005/02/07) denny reeh - system developer - the e/t/s didactic media provides an elearning server (distance learning system) written in php. we are hosting the systems for our customers mainly by ourself. so we have 5 live-servers (freebsd, apache2, php4, eaccelerator) with 5.5 million hits per month. first without eaccelerator we should have installed more servers for good performance and secondly we improve the customer convenience by quartering the medium response time of a script.
http://www.gorgoyle.com/ (2005/08/03) gorgoyle.com is yet another debian personal server with just a few lost internet wanderers passing by, powered by a glorious celeron 433 that needed some fresh air… with eaccelerator the result is quite impressive: users say the server speed is now 10000% higher (no joke!) so thank you all and keep up the good work!!! server: eaccelerator 0.9.5 beta 1 apache/2.0.55 (debian) mod_python/3.1.3 python/2.3.5 php/4.4.2-1 mod_ssl/2.0.55 openssl/0.9.8a mod_perl/2.0.2
http://www.mafia-inc.de/ (2005/05/24) the mafia-incorporated is a succesfull browser game with around 2.500.000 page impressions each day and over 5000 users. server: php version 4.3.10-9, eaccelerator 0.9.2a, debian , apache 2.0.53
http://www.mondespersistants.com/ (2005/01/07) an other game oriented french website with 6 000 000 pageloads monthly. http://guildes.mondespersistants.com is a full php5 oo development. theses websites are running under freebsd / apache 1.3 / php 5.0.3 / eaccelerator 0.9.2
http://www.moviemaze.de/ (2005/12/09) markus ostertag - movie maze is a large german online-magazine with trailer, wallpaper, reviews, news and much more. currently we use three servers (suse & debian with apache 2, php4) with eaccelerator and provide more than 3tb data to ~1 mio. users each month.
http://www.rtvslo.si (2005/01/04) the slovenian national rtv station and its news/misc portal with forums. over 3500 users and more than 37000 forum messages in a year. two round-robin servers for the masses, and an administrator server. 6 000 000 pageloads monthly.
http://www.shroomery.org/ (2006/03/28) a site about mushrooms and mycology, serving 20,000,000 pages per month. web and database server are identical dual 64-bit xeons with 4gb and scsi raid5 running gentoo. eaccelerator help keep our page generation time under .1 second!

http://www.sourceforge.net/ (2005/04/25) sourceforge.net is the world's largest open source software development web site, hosting more than 100,000 projects and over 1,000,000 registered users with a centralized resource for managing projects, issues, communications, and code. sourceforge.net has the largest repository of open source code and applications available on the internet, and hosts more open source development products than any other site or network worldwide. sourceforge.net provides a wide variety of services to projects we host, and to the open source community. eaccelerator is used on the webserver cluster for their frontpage.
companies offering hosting with eaccelerator enabled ?

http://lylix.net/ (2006/04/29) offering webhosting w/ apache/2.0.55, php 5.0.5, and eaccelerator 0.9.5 beta1 on gentoo linux servers. also a provider of quality virtual private server (vps) hosting, including 32 and 64-bit platforms. most vps images have a pre-installed lamp environment w/ eaccelerator installed and configured.
http://www.ulyssis.org a student organisation which provides shell and internet services for students at very cheap prices.