Laravel 框架如何进行模块化开发

作者:包包大人   时间:2018-04-28 15:05:33   来源:原创   阅读:75   评论:0  

最近项目想用Laravel框架做开发,但考虑到随着项目的增大,代码的增多,需求变的复杂多样化,将所有代码写在一起,无疑是一个很大的问题,这将导致代码过于复杂,一些写过的功能点想要重新使用,查找起来太过费劲;所以考虑到使用和其他框架类似的模块化开发,但是laravel框架没有明确的模块化划分,所以就想找一下看是否有其他第三方模块化(Module)开发包来使用,毕竟laravel社区这么火热和强大,最终找到了模块化开发包,还比较好用,所以总结一下,分享出来。
感慨一下:站在巨人的肩膀上写东西就是好!!!
这里使用的第三方镜像包是:nwidart/laravel-modules,laravel的模块管理器。用起来很方便,git地址:https://github.com/nWidart/laravel-modules
接下来就说一下使用的情况:
安装:
使用composer快捷安装:

composer require nwidart/laravel-modules

当然这一步是要建立在你本地已经安装了composer的情况下。不会安装composer可以查看官方说明,地址:https://getcomposer.org/download/
添加服务提供者:
接下来在config / app.php中添加以下服务提供者。


'providers' => [
Nwidart\Modules\LaravelModulesServiceProvider::class,
],

添加别名到同一文件的别名数组中。

'aliases' => [
'Module' => Nwidart\Modules\Facades\Module::class,
],

以上两步是进行服务注册,必须要进行添加,不过在laravel5.5版本之后可以不添加也能运行,这得益于laravel5.5提供的包自动发现机制。
接下来发布软件包的配置,通过运行以下方式:

php artisan vendor:publish --provider="Nwidart\Modules\LaravelModulesServiceProvider"

执行完上面这条命令之后,在config文件夹下会生成一个modules.php文件,这个是模块开发的配置文件,你可以在这里面进行配置。
添加自动加载:
默认情况下,模块类不会自动加载。 您可以使用psr-4自动加载模块。
修改文件:composer.json

{
"autoload": {
"psr-4": {
"App\\": "app/",
"Modules\\": "Modules/"
}
}
}

提示:不要忘记运行 composer dump-autoload 命令。
生成模块
接下来生成需要的模块,使用以下命令:

php artisan module:make module-name

如果需要一次生成多个模块,可以使用以下命令:

php artisan module:make module-name1 module-name2 module-name3

文件结构
执行上面的生成模块命令,会生成如下文件结构:
如执行命令:

php artisan module:make Blog
app/
bootstrap/
vendor/
Modules/
├── Blog/
├── Assets/
├── Config/
├── Console/
├── Database/
├── Migrations/
├── Seeders/
├── Entities/
├── Http/
├── Controllers/
├── Middleware/
├── Requests/
├── routes.php
├── Providers/
├── BlogServiceProvider.php
├── Resources/
├── lang/
├── views/
├── Repositories/
├── Tests/
├── composer.json
├── module.json
├── start.php

至此,镜像包安装和使用已经完成,可以正常使用了。
下面说一下有关使用中的修改

模块位置修改
由于以上生成的目录结构的模块是在和app同级的目录下,我想把他放到app目录下面,这样看起来会好一点(个人习惯,可不必修改)。
方法:修改配置文件config/modules.php文件

'namespace' => 'App\Modules',

'paths' => [
'modules' => base_path('App\Modules'),
]

现在执行生成模块命令,生成的Modules模块会在app目录下面。
路由修改
使用nwidart/laravel-modules镜像包安装的路由文件默认是在Blog/Http/routes.php下面,而使用路由是由模块生成的start.php文件加载的。我想把他提取出来,放到单独的文件夹下面,像laravel的路由一样(个人习惯,可不必修改)。
方法:修改配置文件config/modules.php文件
①将配置文件中有关start的配置去掉

'stubs' => [
'enabled' => false,
'path' => base_path() . '/vendor/nwidart/laravel-modules/src/Commands/stubs',
'files' => [
// 'start' => 'start.php',
'routes' => 'Http/routes.php',
],
'replacements' => [
// 'start' => ['LOWER_NAME'],
],
],

接下来再将Blog/module.json下面生成的start.php去掉

{
"files": [],
}

以上两步是为了避免程序执行期间报错,所以必须执行。
②修改路由文件生成路径

'stubs' => [
'files' => [
// 'start' => 'start.php',
'routes' => 'Routes/routes.php',
],

现在执行生成模块命令,生成的路由文件会在Blog/Routes/route.php模块下面。
③接下来修改路由服务提供者,注册路由
执行命令:

php artisan module:route-provider Blog

为指定的模块生成给定的路由。
执行完此命令之后,会在Blog/Providers目录下面生成一个RouteServiceProvider.php文件,此文件就是路由的服务提供者。
接下来修改RouteServiceProvider.php文件

public function map(Router $router)
{
// if (!app()->routesAreCached()) {
//    require __DIR__ . '/Http/routes.php';
// }
if (! app()->routesAreCached()) {
$this->mapWebRoutes();
}
}

增加方法:

protected function mapWebRoutes()
{
//方法一:
//Route::group([
//'middleware' => 'web',
//'namespace'  => $this->namespace,
//], function ($router) {
//require module_path('Admin') . '/Routes/routes.php';
//});
//方法二:
Route::middleware('web')
->namespace($this->rootUrlNamespace)
->group(module_path('Blog') . '/Routes/routes.php');
}

在此RouteServiceProvider.php文件已经修改完毕。
接下来修改Blog/Providers/BlogServiceProvider.php文件,修改如下:

public function register()
{
//注册服务提供者
$this->app->register(RouteServiceProvider::class);
}

到此使用第三方镜像包,开发laravel模块化项目已经说明完毕,希望对大家有用。

  • 点赞
  • 收藏
  • 分享

评论 (0人参与

最新评论
暂无评论
写博客