类 yii\filters\HttpCache
HttpCache 通过利用 Last-Modified
和 ETag
HTTP 头来实现客户端缓存。
它是一个动作过滤器,可以添加到控制器中,并处理 beforeAction
事件。
要使用 HttpCache,请在控制器类的 behaviors()
方法中声明它。在以下示例中,过滤器将应用于 index
动作,并且 Last-Modified 头将包含数据库中用户表上次更新的日期。
public function behaviors()
{
return [
[
'class' => 'yii\filters\HttpCache',
'only' => ['index'],
'lastModified' => function ($action, $params) {
$q = new \yii\db\Query();
return $q->from('user')->max('updated_at');
},
// 'etagSeed' => function ($action, $params) {
// return // generate ETag seed here
// }
],
];
}
公共属性
属性 | 类型 | 描述 | 定义于 |
---|---|---|---|
$cacheControlHeader | string|null | Cache-Control HTTP 头的值。 |
yii\filters\HttpCache |
$enabled | boolean | 一个值,指示此过滤器是否应启用。 | yii\filters\HttpCache |
$etagSeed | callable | 一个 PHP 回调函数,用于生成 ETag 种子字符串。 | yii\filters\HttpCache |
$except | array | 此过滤器不应应用于的操作 ID 列表。 | yii\base\ActionFilter |
$lastModified | callable | 一个 PHP 回调函数,返回上次修改时间的时间戳。 | yii\filters\HttpCache |
$only | array | 此过滤器应应用于的操作 ID 列表。 | yii\base\ActionFilter |
$owner | yii\base\Component|null | 此行为的所有者 | yii\base\Behavior |
$params | mixed | 应传递给 $lastModified 和 $etagSeed 回调函数的其他参数。 | yii\filters\HttpCache |
$sessionCacheLimiter | string|null | 调用 session_cache_limiter() 时要设置的缓存限制器的名称。 | yii\filters\HttpCache |
$weakEtag | boolean | 是否生成弱 ETags。 | yii\filters\HttpCache |
公共方法
方法 | 描述 | 定义于 |
---|---|---|
__call() | 调用不是类方法的命名方法。 | yii\base\BaseObject |
__construct() | 构造函数。 | yii\base\BaseObject |
__get() | 返回对象属性的值。 | yii\base\BaseObject |
__isset() | 检查属性是否已设置,即已定义且不为 null。 | yii\base\BaseObject |
__set() | 设置对象属性的值。 | yii\base\BaseObject |
__unset() | 将对象属性设置为 null。 | yii\base\BaseObject |
afterAction() | 此方法在执行操作后立即调用。 | yii\base\ActionFilter |
afterFilter() | yii\base\ActionFilter | |
attach() | 将行为对象附加到组件。 | yii\base\ActionFilter |
beforeAction() | 此方法在要执行操作之前立即调用(在所有可能的过滤器之后)。您可以覆盖此方法以对操作进行最后一分钟的准备。 | yii\filters\HttpCache |
beforeFilter() | yii\base\ActionFilter | |
canGetProperty() | 返回一个值,指示是否可以读取属性。 | yii\base\BaseObject |
canSetProperty() | 返回一个值,指示是否可以设置属性。 | yii\base\BaseObject |
className() | 返回此类的完全限定名称。 | yii\base\BaseObject |
detach() | 从组件分离行为对象。 | yii\base\ActionFilter |
events() | 声明 $owner 事件的事件处理程序。 | yii\base\Behavior |
hasMethod() | 返回一个值,指示方法是否已定义。 | yii\base\BaseObject |
hasProperty() | 返回一个值,指示属性是否已定义。 | yii\base\BaseObject |
init() | 初始化对象。 | yii\base\BaseObject |
受保护的方法
方法 | 描述 | 定义于 |
---|---|---|
generateEtag() | 根据给定的种子字符串生成 ETag。 | yii\filters\HttpCache |
getActionId() | 通过将 yii\base\Action::$uniqueId 转换为相对于模块的 ID 来返回操作 ID。 | yii\base\ActionFilter |
isActive() | 返回一个值,指示过滤器对于给定操作是否处于活动状态。 | yii\base\ActionFilter |
sendCacheControlHeader() | 将缓存控制头发送到客户端。 | yii\filters\HttpCache |
validateCache() | 验证 HTTP 缓存是否包含有效内容。 | yii\filters\HttpCache |
属性详情
Cache-Control
HTTP 头的值。如果为 null,则不会发送该头。
另请参阅 https://datatracker.ietf.org/doc/html/rfc2616#section-14.9。
一个 PHP 回调函数,用于生成 ETag 种子字符串。回调函数的签名应为
function ($action, $params)
其中 $action
是此过滤器当前正在处理的 yii\base\Action 对象;$params
获取 $params 的值。回调函数应返回一个用作生成 ETag 种子的字符串。
一个 PHP 回调函数,返回上次修改时间的时间戳。回调函数的签名应为
function ($action, $params)
其中$action
是当前此过滤器正在处理的 yii\base\Action 对象;$params
获取 $params 的值。回调函数应返回一个 Unix 时间戳。
另请参阅 https://datatracker.ietf.org/doc/html/rfc7232#section-2.2。
当调用 session_cache_limiter() 时,要设置的缓存限制器的名称。默认值为一个空字符串,表示完全关闭自动发送缓存头。您可以将此属性设置为 public
、private
、private_no_expire
和 nocache
。有关这些值的详细说明,请参阅 session_cache_limiter()。
如果此属性为 null
,则不会调用 session_cache_limiter()
。因此,PHP 将根据 session.cache_limiter
PHP ini 设置发送标头。
是否生成弱 ETags。
如果内容应被视为语义上等效但字节上不等效,则应使用弱 ETag。
另请参阅 https://datatracker.ietf.org/doc/html/rfc7232#section-2.3。
方法详情
public mixed __call ( $name, $params ) | ||
$name | string |
方法名称 |
$params | array |
方法参数 |
返回值 | mixed |
方法返回值 |
---|---|---|
抛出 | yii\base\UnknownMethodException |
调用未知方法时 |
public function __call($name, $params)
{
throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}
定义于: yii\base\BaseObject::__construct()
构造函数。
默认实现执行两件事
- 使用给定的配置
$config
初始化对象。 - 调用 init()。
如果此方法在子类中被重写,建议
- 构造函数的最后一个参数是一个配置数组,如这里的
$config
。 - 在构造函数的末尾调用父实现。
public void __construct ( $config = [] ) | ||
$config | array |
将用于初始化对象属性的名称-值对 |
public function __construct($config = [])
{
if (!empty($config)) {
Yii::configure($this, $config);
}
$this->init();
}
定义于: yii\base\BaseObject::__get()
返回对象属性的值。
不要直接调用此方法,因为它是一个 PHP 魔术方法,当执行 $value = $object->property;
时会隐式调用。
另请参阅 __set()。
public mixed __get ( $name ) | ||
$name | string |
属性名称 |
返回值 | mixed |
属性值 |
---|---|---|
抛出 | yii\base\UnknownPropertyException |
如果未定义属性 |
抛出 | yii\base\InvalidCallException |
如果属性是只写属性 |
public function __get($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
return $this->$getter();
} elseif (method_exists($this, 'set' . $name)) {
throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
}
throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}
定义于: yii\base\BaseObject::__isset()
检查属性是否已设置,即已定义且不为 null。
不要直接调用此方法,因为它是一个 PHP 魔术方法,当执行 isset($object->property)
时会隐式调用。
请注意,如果未定义属性,则将返回 false。
public boolean __isset ( $name ) | ||
$name | string |
属性名称或事件名称 |
返回值 | boolean |
命名的属性是否已设置(非 null)。 |
---|
public function __isset($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
return $this->$getter() !== null;
}
return false;
}
定义于: yii\base\BaseObject::__set()
设置对象属性的值。
不要直接调用此方法,因为它是一个 PHP 魔术方法,当执行 $object->property = $value;
时会隐式调用。
另请参阅 __get()。
public void __set ( $name, $value ) | ||
$name | string |
属性名称或事件名称 |
$value | mixed |
属性值 |
抛出 | yii\base\UnknownPropertyException |
如果未定义属性 |
---|---|---|
抛出 | yii\base\InvalidCallException |
如果属性是只读属性 |
public function __set($name, $value)
{
$setter = 'set' . $name;
if (method_exists($this, $setter)) {
$this->$setter($value);
} elseif (method_exists($this, 'get' . $name)) {
throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
} else {
throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}
}
定义于: yii\base\BaseObject::__unset()
将对象属性设置为 null。
不要直接调用此方法,因为它是一个 PHP 魔术方法,当执行 unset($object->property)
时会隐式调用。
请注意,如果未定义属性,则此方法将不执行任何操作。如果属性是只读属性,则会抛出异常。
public void __unset ( $name ) | ||
$name | string |
属性名称 |
抛出 | yii\base\InvalidCallException |
如果属性是只读属性。 |
---|
public function __unset($name)
{
$setter = 'set' . $name;
if (method_exists($this, $setter)) {
$this->$setter(null);
} elseif (method_exists($this, 'get' . $name)) {
throw new InvalidCallException('Unsetting read-only property: ' . get_class($this) . '::' . $name);
}
}
public mixed afterAction ( $action, $result ) | ||
$action | yii\base\Action |
刚刚执行的操作。 |
$result | mixed |
操作执行结果 |
返回值 | mixed |
已处理的操作结果。 |
---|
public function afterAction($action, $result)
{
return $result;
}
public void afterFilter ( $event ) | ||
$event | yii\base\ActionEvent |
public function afterFilter($event)
{
$event->result = $this->afterAction($event->action, $event->result);
$this->owner->off(Controller::EVENT_AFTER_ACTION, [$this, 'afterFilter']);
}
定义于: yii\base\ActionFilter::attach()
将行为对象附加到组件。
默认实现将设置 $owner 属性并根据 events() 中的声明附加事件处理程序。如果您重写此方法,请确保调用父实现。
public void attach ( $owner ) | ||
$owner | yii\base\Component |
要附加此行为的组件。 |
public function attach($owner)
{
$this->owner = $owner;
$owner->on(Controller::EVENT_BEFORE_ACTION, [$this, 'beforeFilter']);
}
此方法在要执行操作之前立即调用(在所有可能的过滤器之后)。您可以覆盖此方法以对操作进行最后一分钟的准备。
public boolean beforeAction ( $action ) | ||
$action | yii\base\Action |
要执行的操作。 |
返回值 | boolean |
操作是否应继续执行。 |
---|
public function beforeAction($action)
{
if (!$this->enabled) {
return true;
}
$verb = Yii::$app->getRequest()->getMethod();
if ($verb !== 'GET' && $verb !== 'HEAD' || $this->lastModified === null && $this->etagSeed === null) {
return true;
}
$lastModified = $etag = null;
if ($this->lastModified !== null) {
$lastModified = call_user_func($this->lastModified, $action, $this->params);
}
if ($this->etagSeed !== null) {
$seed = call_user_func($this->etagSeed, $action, $this->params);
if ($seed !== null) {
$etag = $this->generateEtag($seed);
}
}
$this->sendCacheControlHeader();
$response = Yii::$app->getResponse();
if ($etag !== null) {
$response->getHeaders()->set('Etag', $etag);
}
$cacheValid = $this->validateCache($lastModified, $etag);
// https://tools.ietf.org/html/rfc7232#section-4.1
if ($lastModified !== null && (!$cacheValid || ($cacheValid && $etag === null))) {
$response->getHeaders()->set('Last-Modified', gmdate('D, d M Y H:i:s', $lastModified) . ' GMT');
}
if ($cacheValid) {
$response->setStatusCode(304);
return false;
}
return true;
}
public void beforeFilter ( $event ) | ||
$event | yii\base\ActionEvent |
public function beforeFilter($event)
{
if (!$this->isActive($event->action)) {
return;
}
$event->isValid = $this->beforeAction($event->action);
if ($event->isValid) {
// call afterFilter only if beforeFilter succeeds
// beforeFilter and afterFilter should be properly nested
$this->owner->on(Controller::EVENT_AFTER_ACTION, [$this, 'afterFilter'], null, false);
} else {
$event->handled = true;
}
}
定义于: yii\base\BaseObject::canGetProperty()
返回一个值,指示是否可以读取属性。
如果属性可读,则
- 类具有与指定名称关联的 getter 方法(在这种情况下,属性名称不区分大小写);
- 类具有与指定名称相同的成员变量(当
$checkVars
为 true 时);
另请参阅 canSetProperty()。
public boolean canGetProperty ( $name, $checkVars = true ) | ||
$name | string |
属性名称 |
$checkVars | boolean |
是否将成员变量视为属性 |
返回值 | boolean |
属性是否可读 |
---|
public function canGetProperty($name, $checkVars = true)
{
return method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name);
}
定义于: yii\base\BaseObject::canSetProperty()
返回一个值,指示是否可以设置属性。
如果属性可写,则
- 类具有与指定名称关联的 setter 方法(在这种情况下,属性名称不区分大小写);
- 类具有与指定名称相同的成员变量(当
$checkVars
为 true 时);
另请参阅 canGetProperty()。
public boolean canSetProperty ( $name, $checkVars = true ) | ||
$name | string |
属性名称 |
$checkVars | boolean |
是否将成员变量视为属性 |
返回值 | boolean |
属性是否可写 |
---|
public function canSetProperty($name, $checkVars = true)
{
return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
}
::class
。
定义于: yii\base\BaseObject::className()
返回此类的完全限定名称。
public static string className ( ) | ||
返回值 | string |
此类的完全限定名称。 |
---|
public static function className()
{
return get_called_class();
}
定义于: yii\base\ActionFilter::detach()
从组件分离行为对象。
默认实现将取消设置 $owner 属性并分离 events() 中声明的事件处理程序。如果您重写此方法,请确保调用父实现。
public void detach ( ) |
public function detach()
{
if ($this->owner) {
$this->owner->off(Controller::EVENT_BEFORE_ACTION, [$this, 'beforeFilter']);
$this->owner->off(Controller::EVENT_AFTER_ACTION, [$this, 'afterFilter']);
$this->owner = null;
}
}
定义于: yii\base\Behavior::events()
声明 $owner 事件的事件处理程序。
子类可以重写此方法以声明应将哪些 PHP 回调附加到 $owner 组件的事件。
当行为附加到所有者时,回调将附加到 $owner 的事件;当行为从组件分离时,它们将从事件中分离。
回调可以是以下任何一种
- 此行为中的方法:
'handleClick'
,相当于[$this, 'handleClick']
- 对象方法:
[$object, 'handleClick']
- 静态方法:
['Page', 'handleClick']
- 匿名函数:
function ($event) { ... }
以下是一个示例
[
Model::EVENT_BEFORE_VALIDATE => 'myBeforeValidate',
Model::EVENT_AFTER_VALIDATE => 'myAfterValidate',
]
public array events ( ) | ||
返回值 | array |
事件(数组键)和相应的事件处理程序方法(数组值)。 |
---|
public function events()
{
return [];
}
根据给定的种子字符串生成 ETag。
protected string generateEtag ( $seed ) | ||
$seed | string |
ETag 的种子 |
返回值 | string |
生成的 ETag |
---|
protected function generateEtag($seed)
{
$etag = '"' . rtrim(base64_encode(sha1($seed, true)), '=') . '"';
return $this->weakEtag ? 'W/' . $etag : $etag;
}
定义于: yii\base\ActionFilter::getActionId()
通过将 yii\base\Action::$uniqueId 转换为相对于模块的 ID 来返回操作 ID。
protected string getActionId ( $action ) | ||
$action | yii\base\Action |
protected function getActionId($action)
{
if ($this->owner instanceof Module) {
$mid = $this->owner->getUniqueId();
$id = $action->getUniqueId();
if ($mid !== '' && strpos($id, $mid) === 0) {
$id = substr($id, strlen($mid) + 1);
}
} else {
$id = $action->id;
}
return $id;
}
定义于: yii\base\BaseObject::hasMethod()
返回一个值,指示方法是否已定义。
默认实现是对 php 函数 method_exists()
的调用。当您实现 php 魔术方法 __call()
时,您可以重写此方法。
public boolean hasMethod ( $name ) | ||
$name | string |
方法名称 |
返回值 | boolean |
方法是否已定义 |
---|
public function hasMethod($name)
{
return method_exists($this, $name);
}
定义于: yii\base\BaseObject::hasProperty()
返回一个值,指示属性是否已定义。
如果满足以下条件,则属性被定义为已定义:
- 类具有与指定名称关联的 getter 或 setter 方法(在这种情况下,属性名称不区分大小写);
- 类具有与指定名称相同的成员变量(当
$checkVars
为 true 时);
另请参阅
public boolean hasProperty ( $name, $checkVars = true ) | ||
$name | string |
属性名称 |
$checkVars | boolean |
是否将成员变量视为属性 |
返回值 | boolean |
属性是否已定义 |
---|
public function hasProperty($name, $checkVars = true)
{
return $this->canGetProperty($name, $checkVars) || $this->canSetProperty($name, false);
}
public void init ( ) |
public function init()
{
}
定义于: yii\base\ActionFilter::isActive()
返回一个值,指示过滤器对于给定操作是否处于活动状态。
protected boolean isActive ( $action ) | ||
$action | yii\base\Action |
正在过滤的操作 |
返回值 | boolean |
过滤器对于给定操作是否处于活动状态。 |
---|
protected function isActive($action)
{
$id = $this->getActionId($action);
if (empty($this->only)) {
$onlyMatch = true;
} else {
$onlyMatch = false;
foreach ($this->only as $pattern) {
if (StringHelper::matchWildcard($pattern, $id)) {
$onlyMatch = true;
break;
}
}
}
$exceptMatch = false;
foreach ($this->except as $pattern) {
if (StringHelper::matchWildcard($pattern, $id)) {
$exceptMatch = true;
break;
}
}
return !$exceptMatch && $onlyMatch;
}
将缓存控制头发送到客户端。
另请参阅 $cacheControlHeader。
protected void sendCacheControlHeader ( ) |
protected function sendCacheControlHeader()
{
if ($this->sessionCacheLimiter !== null) {
if ($this->sessionCacheLimiter === '' && !headers_sent() && Yii::$app->getSession()->getIsActive()) {
header_remove('Expires');
header_remove('Cache-Control');
header_remove('Last-Modified');
header_remove('Pragma');
}
Yii::$app->getSession()->setCacheLimiter($this->sessionCacheLimiter);
}
$headers = Yii::$app->getResponse()->getHeaders();
if ($this->cacheControlHeader !== null) {
$headers->set('Cache-Control', $this->cacheControlHeader);
}
}
验证 HTTP 缓存是否包含有效内容。
如果 Last-Modified 和 ETag 均为 null,则返回 false。
protected boolean validateCache ( $lastModified, $etag ) | ||
$lastModified | integer|null |
以 UNIX 时间戳形式计算的 Last-Modified 值。如果为 null,则不会验证 Last-Modified 标头。 |
$etag | string|null |
计算的 ETag 值。如果为 null,则不会验证 ETag 标头。 |
返回值 | boolean |
HTTP 缓存是否仍然有效。 |
---|
protected function validateCache($lastModified, $etag)
{
if (Yii::$app->request->headers->has('If-None-Match')) {
// HTTP_IF_NONE_MATCH takes precedence over HTTP_IF_MODIFIED_SINCE
// https://datatracker.ietf.org/doc/html/rfc7232#section-3.3
return $etag !== null && in_array($etag, Yii::$app->request->getETags(), true);
} elseif (Yii::$app->request->headers->has('If-Modified-Since')) {
return $lastModified !== null && @strtotime(Yii::$app->request->headers->get('If-Modified-Since')) >= $lastModified;
}
return false;
}
注册 或 登录 以发表评论。