YII2中添加自定义模块

时间:2021-07-08 10:37:44

有些时候系统功能过于复杂,这时我们需要通过模块把一些功能区分开来,便于管理与维护。

我用的是Yii2的基本应用程序模板,程序其实已经给我们提供了一个模块,就是app本身。YII2中是可以无限嵌套模块的。不过一般不要超过2层。

我们在app下创建一个modules的目录,并创建一个api子目录,子目录下创建Api.php文件。

Api.php代码如下:

<?php

namespace app\modules\api;

use yii\base\Module;

//注意模块必须继承自yii\base\Module
class Api extends Module
{ }

在api子目录下,我们分别创建controllers,views,models目录,你会发现,这里的目录结构跟app的很像,其实app就是一个模块,不过它是顶层模块。

YII2中添加自定义模块

然后我们在controllers里创建一个IndexController.php,在views下创建index目录,并创建index.php

IndexController.php代码如下:

<?php

//注意这里的命名空间,要跟你的目录对应
namespace app\modules\api\controllers; use yii\web\Controller; class IndexController extends Controller
{ public function actionIndex()
{
return $this->render('index', ['data' => 'hello world']);
}
}

index.php代码如下:

<?php echo $data; ?>

最后我们还需要在config/web.php中配置一个我们的模块,就可以访问了。

'modules' => [
'api' => [
'class' => 'app\modules\api\Api',
],
],

通过api/index/index来访问,如果没有配置URL美化,通过?r=api/index/index来访问

YII2中添加自定义模块

这样我们的api模块就创建好了,当然api模块下我们还可以创建modules目录来创建子模块,不过最好不要超过2层。

不过YII2中的GII已经帮我们做好了生成模块的操作,不需要像上面那样那么麻烦自已配置。

通过访问/gii,或者?r=gii,来使用GII。

YII2中添加自定义模块

我们选择Module Generator,点击start。

YII2中添加自定义模块

点击preview,查看文件和路径是否正确,点击Generate进行生成。

YII2中添加自定义模块

这样,一个模块就创建好了。是不是很方便。

YII2中添加自定义模块