Shulou(Shulou.com)06/02 Report--

This article will explain in detail what Laravel modularization is, and the content of the article is of high quality, so the editor will share it for you as a reference. I hope you will have a certain understanding of the relevant knowledge after reading this article.

Recently, the project wants to use the Laravel framework for development, but considering that with the growth of the project, the increase of code, and the complexity and diversification of requirements, it is undoubtedly a big problem to write all the code together, which will lead to too complex code, and some written function points want to be reused, which is too difficult to find. So taking into account the use of modular development similar to other frameworks, but the laravel framework does not have a clear modular division, so I want to see if there are other third-party modular (Module) development packages to use, after all, the laravel community is so hot and powerful, and finally found the modular development package, but also relatively easy to use, so summarize it and share it.

The third-party image package used here is nwidart/laravel-modules,laravel 's module manager. It's easy to use. Git address: https://github.com/nWidart/laravel-modules

Next, let's talk about the use:

Installation:

Use the composer Quick install:

Composer require nwidart/laravel-modules

Of course, this step is based on the fact that you have already installed composer locally. Do not install composer can check the official instructions, address: https://getcomposer.org/download/

Add a service provider:

Next, add the following service provider to config / app.php.

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

Add aliases to an array of aliases in the same file.

The above two steps are to register the service, which must be added, but it can run without adding after the laravel5.5 version, thanks to the automatic package discovery mechanism provided by laravel5.5.

Next, release the configuration of the package by running the following:

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

After executing the above command, a modules.php file will be generated in the config folder, which is the configuration file for module development, where you can configure it.

Add autoload:

By default, module classes are not loaded automatically. You can use psr-4 to load the module automatically.

Modify file: composer.json

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

Tip: don't forget to run the composer dump-autoload command.

Generation module

Next, generate the required modules, using the following command:

Php artisan module:make module-name

If you need to generate more than one module at a time, you can use the following command:

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

File structure

Execute the above generation module command to generate the following file structure:

Such as executing the command: 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

At this point, the installation and use of the image package has been completed, and you can use it normally.

Let's talk about the changes in use.

Module location modification

Since the module of the directory structure generated above is in the same level as app, I want to put it under the app directory to make it look better (personal habit, but you don't have to modify it).

Method: modify the configuration file config/modules.php file

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

Now execute the generate module command, and the generated Modules module will be under the app directory.

Route modification

The routing file installed using the nwidart/laravel-modules image package is under Blog/Http/routes.php by default, while using routing is loaded by the start.php file generated by the module. I want to extract it and put it under a separate folder, just like the routing of laravel (personal habits, but no need to modify it).

Method: modify the configuration file config/modules.php file

① removes the configuration about start from the configuration file

'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'],]

Next, remove the start.php generated under Blog/module.json.

{"files": [],}

The above two steps are to avoid reporting errors during program execution, so they must be performed.

② modifies the route file generation path

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

Now execute the generate module command, and the generated route file will be under the Blog/Routes/route.php module.

③ then modifies the routing service provider to register the route

Execute the command:

Php artisan module:route-provider Blog

Generates the given route for the specified module.

After executing this command, a RouteServiceProvider.php file is generated under the Blog/Providers directory, which is the routed service provider.

Next, modify the RouteServiceProvider.php file

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

Add method:

Protected function mapWebRoutes () {/ / method 1: / / Route::group ([/ / 'middleware' = >' web', / / 'namespace' = > $this- > namespace, / /], function ($router) {/ / require module_path (' Admin'). Method 2: Route::middleware ('web')-> namespace ($this- > rootUrlNamespace)-> group (module_path (' Blog'). '/ Routes/routes.php');}

The RouteServiceProvider.php file has been modified here.

Next, modify the Blog/Providers/BlogServiceProvider.php file as follows:

Public function register () {/ / Register service provider $this- > app- > register (RouteServiceProvider::class);}

At this point, using the third-party image package, the development of laravel modularization project has been described, I hope it will be useful to you.

About what Laravel modularization is to share here, I hope the above content can be of some help to you, can learn more knowledge. If you think the article is good, you can share it for more people to see.

Welcome to subscribe "Shulou Technology Information " to get latest news, interesting things and hot topics in the IT industry, and controls the hottest and latest Internet news, technology news and IT industry trends.