YII Framework的filter过滤器用法分析

什么是filter过滤器?

YII Framework中的filter过滤器是一个非常实用的功能。通过使用filters，我们可以拦截控制器的操作，并对请求或相应进行处理。这个过程有点像middleware，它可以用来执行许多有用的操作，比如数据验证、数据过滤、数据和响应编码，甚至是权限验证等。

如何使用filter过滤器?

使用filters分两步走: 第一步，你需要创建一个类，称之为filter，这个类需要实现IActionFilter接口。第二步，将所创建的filter类关联到你所需要它拦截的控制器或者控制器的某个操作上。

以下代码提供了一个示例，让我们了解如何一步一步实现这个过程。

在下面的代码中，我们将创建一个名为AdminFilter的filter，它将应用于SiteController类的所有操作中。这个filter将验证我们是否已经登录进入了管理后台，如果没有，就会重定向到登录页面。

1. 创建AdminFilter类和IActionFilter接口的实现函数

class AdminFilter implements IActionFilter
{
    public function beforeAction($action){
        if (!Yii::$app->user->isGuest && Yii::$app->user->identity->isAdmin) {
            return true;
        }else{
            Yii::$app->response->redirect(Yii::$app->homeUrl);
            return false;
        }
    }

    public function afterAction($action, $result){
        return $result;
    }
}

在上面的代码中，我们定义了beforeAction方法，如果用户已经登录，并且是系统管理员，则返回true，允许进入SiteController执行相应的操作。否则，将用户重定向到主页，并返回false，终止程序的其他执行过程。

• beforeAction方法：被过滤的操作在运行之前调用。

• afterAction方法：被过滤的操作在运行之后调用（在本例中，并没有对其进行操作，所以只返回结果）。

• 将AdminFilter关联到SiteController上

class SiteController extends Controller
{
    public function behaviors()
    {
        return [
            'access' => [
                'class' => AdminFilter::className(),
            ],
        ];
    }

    public function actionIndex()
    {
        // 添加action内容
    }

    public function actionView($id)
    {
        // 添加action内容
    }

    public function actionCreate()
    {
        // 添加action内容
    }

    // 其他action方法
}

在上面的代码中，我们将AdminFilter与SiteController关联起来，使得 beforeAction方法可以应用给SiteController的每个操作。通过在behaviors函数中添加'access' => ['class' => AdminFilter::className()]，我们使得过滤器可以工作，如此我们就达到了想要的效果。

这是一个非常强大的功能，在开发的过程中，可以使用它来增强应用的安全性。下面我们将通过一个更复杂的示例来展示filter的强大之处。

示例: 限制用户对文章的编辑权限

假设我们正在开发一个博客网站，现在需要限制用户对他人文章的编辑权限，只允许文章的所有者进行编辑。这个需求非常重要，否则如果小心不当，一些敏感信息将会泄露出去。

在以下代码中，我们将展示如何使用filter完成这个功能。

1. 创建EditArticleFilter类和IActionFilter接口的实现函数

class EditArticleFilter implements IActionFilter
{
    public function beforeAction($action){
        $articleId = Yii::$app->request->get('id');
        $article = Article::findOne($articleId);
        if($article->user_id != Yii::$app->user->identity->id){
            throw new NotFoundHttpException('This article doesn\'t belong to you.');
        }
        return true;
    }

    public function afterAction($action, $result){
        return $result;
    }
}

在上面的代码中，beforeAction方法首先获取被编辑文章的id，然后再从数据库中查找相应的记录。接下来，我们检查该文章是否属于当前用户，如果不是，则抛出NotFoundHttpException异常，告知用户操作失败。

1. 将EditArticleFilter关联到ArticleController上

class ArticleController extends Controller
{
    public function behaviors()
    {
        return [
            'access' => [
                'class' => EditArticleFilter::className(),
                'only' => ['update'], // edit
            ],
        ];
    }

    /**
     * Updates an existing Article model.
     */
    public function actionUpdate($id)
    {
        $model = $this->findModel($id);

        if ($model->load(Yii::$app->request->post()) && $model->save()) {
            return $this->redirect(['view', 'id' => $model->id]);
        } else {
            return $this->render('update', [
                'model' => $model,
            ]);
        }
    }

    // 其他action方法
}

在以上代码中，我们将EditArticleFilter与ArticleController关联起来，并配置其只应用于'update'操作。如果用户试图编辑他人的文章，将会抛出NotFoundHttpException异常，防止用户非法操作。

到目前为止，你应该已经大致明白了如何使用filters来有效的对控制器操作进行监管。filter是Yii Framework强大的功能之一，可以方便的完成诸如数据过滤、权限控制等功能，如果你想加强安全性，请务必使用它。