tutorial-performance-tuning.md 9.6 KB
Newer Older
1 2 3
Performance Tuning
==================

4
> Note: This section is under development.
Qiang Xue committed
5

Larry Ullman committed
6
The performance of your web application is based upon two parts. First is the framework performance
7 8 9 10 11
and the second is the application itself. Yii has a pretty low performance impact
on your application out of the box and can be fine-tuned further for production
environment. As for the application, we'll provide some of the best practices
along with examples on how to apply them to Yii.

12 13 14 15 16
Preparing environment
---------------------

A well configured environment to run PHP application really matters. In order to get maximum performance:

17
- Always use the latest stable PHP version. Each major release brings significant performance improvements and reduced
18 19 20 21
  memory usage.
- Use [APC](http://ru2.php.net/apc) for PHP 5.4 and less or [Opcache](http://php.net/opcache) for PHP 5.5 and more. It
  gives a very good performance boost.

22 23 24 25 26 27 28
Preparing framework for production
----------------------------------

### Disabling Debug Mode

First thing you should do before deploying your application to production environment
is to disable debug mode. A Yii application runs in debug mode if the constant
29 30
`YII_DEBUG` is defined as `true` in `index.php`.
So, in order to disable debug mode, the following should be in your `index.php`:
31 32

```php
33
defined('YII_DEBUG') or define('YII_DEBUG', false);
34 35 36 37 38
```

Debug mode is very useful during development stage, but it would impact performance
because some components cause extra burden in debug mode. For example, the message
logger may record additional debug information for every message being logged.
39 40 41 42

### Enabling PHP opcode cache

Enabling the PHP opcode cache improves any PHP application performance and lowers
43 44 45
memory usage significantly. Yii is no exception. It was tested with both
[PHP 5.5 OPcache](http://php.net/manual/en/book.opcache.php) and
[APC PHP extension](http://php.net/manual/en/book.apc.php). Both cache
46
optimize PHP intermediate code and avoid the time spent in parsing PHP
47 48 49 50 51 52 53
scripts for every incoming request.

### Turning on ActiveRecord database schema caching

If the application is using Active Record, we should turn on the schema caching
to save the time of parsing database schema. This can be done by setting the
`Connection::enableSchemaCache` property to be `true` via application configuration
54
`config/web.php`:
55 56

```php
Alexander Makarov committed
57
return [
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77
    // ...
    'components' => [
        // ...
        'db' => [
            'class' => 'yii\db\Connection',
            'dsn' => 'mysql:host=localhost;dbname=mydatabase',
            'username' => 'root',
            'password' => '',
            'enableSchemaCache' => true,

            // Duration of schema cache.
            // 'schemaCacheDuration' => 3600,

            // Name of the cache component used. Default is 'cache'.
            //'schemaCache' => 'cache',
        ],
        'cache' => [
            'class' => 'yii\caching\FileCache',
        ],
    ],
Alexander Makarov committed
78
];
79 80
```

81
Note that the `cache` [application component](structure-application-components.md) should be configured.
82

83 84
### Combining and Minimizing Assets

85 86 87
It is possible to combine and minimize assets, typically JavaScript and CSS, in order to slightly improve page load
time and therefore deliver better experience for end user of your application.

Klimov Paul committed
88
In order to learn how it can be achieved, refer to [assets](structure-assets.md) guide section.
89 90 91

### Using better storage for sessions

92
By default PHP uses files to handle sessions. It is OK for development and
93
small projects. But when it comes to handling concurrent requests, it's better to
94
switch to another storage such as database. You can do so by configuring your
95
application via `config/web.php`:
96 97

```php
Alexander Makarov committed
98
return [
99 100 101 102 103
    // ...
    'components' => [
        'session' => [
            'class' => 'yii\web\DbSession',

104
            // Set the following if you want to use DB component other than
105 106 107
            // default 'db'.
            // 'db' => 'mydb',

108
            // To override default session table, set the following
109 110 111
            // 'sessionTable' => 'my_session',
        ],
    ],
Alexander Makarov committed
112
];
113 114
```

115
You can use `CacheSession` to store sessions using cache. Note that some
116
cache storage such as memcached has no guarantee that session data will not
117
be lost, and it would lead to unexpected logouts.
118

119 120
If you have [Redis](http://redis.io/) on your server, it's highly recommended as session storage.

121 122 123
Improving application
---------------------

124
### Using Serverside Caching Techniques
125 126 127 128 129 130 131 132 133 134

As described in the Caching section, Yii provides several caching solutions that
may improve the performance of a Web application significantly. If the generation
of some data takes long time, we can use the data caching approach to reduce the
data generation frequency; If a portion of page remains relatively static, we
can use the fragment caching approach to reduce its rendering frequency;
If a whole page remains relative static, we can use the page caching approach to
save the rendering cost for the whole page.


135
### Leveraging HTTP caching to save processing time and bandwidth
136

137 138 139 140 141
Leveraging HTTP caching saves both processing time, bandwidth and resources significantly. It can be implemented by
sending either `ETag` or `Last-Modified` header in your application response. If browser is implemented according to
HTTP specification (most browsers are), content will be fetched only if it is different from what it was prevously.

Forming proper headers is time consuming task so Yii provides a shortcut in form of controller filter
142
[[yii\filters\HttpCache]]. Using it is very easy. In a controller you need to implement `behaviors` method like
143 144 145 146 147
the following:

```php
public function behaviors()
{
148 149
    return [
        'httpCache' => [
150
            'class' => \yii\filters\HttpCache::className(),
151 152 153 154 155 156 157 158 159 160
            'only' => ['list'],
            'lastModified' => function ($action, $params) {
                $q = new Query();
                return strtotime($q->from('users')->max('updated_timestamp'));
            },
            // 'etagSeed' => function ($action, $params) {
                // return // generate etag seed here
            //}
        ],
    ];
161 162 163 164 165 166 167 168
}
```

In the code above one can use either `etagSeed` or `lastModified`. Implementing both isn't necessary. The goal is to
determine if content was modified in a way that is cheaper than fetching and rendering that content. `lastModified`
should return unix timestamp of the last content modification while `etagSeed` should return a string that is then
used to generate `ETag` header value.

169

170 171 172
### Database Optimization

Fetching data from database is often the main performance bottleneck in
173 174
a Web application.
Although using [caching](caching.md#Query-Caching) may alleviate the performance hit,
175 176 177 178 179 180 181 182 183 184
it does not fully solve the problem. When the database contains enormous data
and the cached data is invalid, fetching the latest data could be prohibitively
expensive without proper database and query design.

Design index wisely in a database. Indexing can make SELECT queries much faster,
but it may slow down INSERT, UPDATE or DELETE queries.

For complex queries, it is recommended to create a database view for it instead
of issuing the queries inside the PHP code and asking DBMS to parse them repetitively.

185
Do not overuse Active Record. Although Active Record is good at modeling data
186 187 188 189 190
in an OOP fashion, it actually degrades performance due to the fact that it needs
to create one or several objects to represent each row of query result. For data
intensive applications, using DAO or database APIs at lower level could be
a better choice.

191
Last but not least, use `LIMIT` in your `SELECT` queries. This avoids fetching
192 193 194 195
overwhelming data from database and exhausting the memory allocated to PHP.

### Using asArray

196 197 198 199
A good way to save memory and processing time on read-only pages is to use
ActiveRecord's `asArray` method.

```php
200 201
class PostController extends Controller
{
202 203 204 205 206
    public function actionIndex()
    {
        $posts = Post::find()->orderBy('id DESC')->limit(100)->asArray()->all();
        return $this->render('index', ['posts' => $posts]);
    }
207
}
208 209
```

210
In the view you should access fields of each individual record from `$posts` as array:
211 212

```php
resurtm committed
213
foreach ($posts as $post) {
214
    echo $post['title'] . "<br>";
215 216 217 218 219
}
```

Note that you can use array notation even if `asArray` wasn't specified and you're
working with AR objects.
220

221 222 223 224 225
### Processing data in background

In order to respond to user requests faster you can process heavy parts of the
request later if there's no need for immediate response.

226
There are two common ways to achieve it: cron job processing and specialized queues.
227

228
In the first case we need to save the data that we want to process later to a persistent storage
229 230 231 232
such as database. A [console command](tutorial-console.md) that is run regularly via cron job queries
database and processes data if there's any.

The solution is OK for most cases but has one significant drawback. We aren't aware if there's data to
233
process before we query database, so we're either querying database quite often or have a slight delay
234 235 236 237 238 239
between each data processing.

This issue could be solved by queue and job servers such RabbitMQ, ActiveMQ, Amazon SQS and more.
In this case instead of writing data to persistent storage you're queueing it via APIs provided
by queue or job server. Processing is often put into job handler class. Job from the queue is executed
right after all jobs before it are done.
240 241 242 243 244 245

### If nothing helps

If nothing helps, never assume what may fix performance problem. Always profile your code instead before changing
anything. The following tools may be helpful:

246
- [Yii debug toolbar and debugger](tool-debugger.md)
247 248
- [XDebug profiler](http://xdebug.org/docs/profiler)
- [XHProf](http://www.php.net/manual/en/book.xhprof.php)