In-depth analysis of Laravel pipeline (code)

The content shared with you in this article is an in-depth analysis (code) of Laravel pipeline. It has certain reference value. Friends in need can refer to it.

Basically, you can use laravel pipelines to pass objects into multiple classes to perform any type of tasks based on chain operations, and return the final results in one go after all "tasks" are completed.

The most common example of how management works is its use within the components of the framework itself. What I’m talking about here is “middleware”.

Middleware provides a convenient mechanism to filter HTTP requests sent to the application...

Here is a basic middleware example:

<?php

namespace App\Http\Middleware;

use Closure;

class TestMiddleware
{
    /**
     * 处理请求
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \Closure  $next
     * @return mixed
     */
    public function handle($request, Closure $next)
    {
        // 在这里加入你的代码

        return $next($request);
    }
}

These " "Middleware" is actually a pipeline that handles the tasks required for execution by accepting incoming requests. Here you can detect whether the currently accepted request is an HTTP request, a JSON request or any user authentication etc.

If you take a quick look at the Illuminate\Foundation\Http\Kernel class, you will see how the middleware is executed in the Pipeline object.

/**
  * 将请求传入到指定的 中间件/路由。

  * @param  \Illuminate\Http\Request  $request
  * @return \Illuminate\Http\Response
  */
protected function sendRequestThroughRouter($request)
{
    $this->app->instance('request', $request);
    Facade::clearResolvedInstance('request');
    $this->bootstrap();
    return (new Pipeline($this->app))
                    ->send($request)
                    ->through($this->app->shouldSkipMiddleware() ? [] : $this->middleware)
    ->then($this->dispatchToRouter());
}

You can see from this code: the pipeline instance sends the request to a set of middleware and distributes it to the router.

Don’t worry if this code is a bit confusing to you. I will illustrate its related concepts with some examples.

Running multiple tasks in a class (Working on a class that requires to run multiple tasks)

Consider this scenario. We need to create a forum system that allows users to create topics and leave messages. But the client requires you to automatically delete tags when they are created or edited.

Here's what you need to do:

1. Replace the link tag in the text.

2. Use "*" to replace sensitive words.

3. Remove script tags from text.

Maybe eventually you will build related classes to handle these "tasks".

$pipes = [
    RemoveBadWords::class
    ReplaceLinkTags::clas
    RemoveScriptTags::class
];

What we have to do is to pass our "content" to each task in turn, and then pass the processing results of the previous task to the next task. We can use pipes to handle this task.

public function create(Request $request)
{
    $pipes = [
        RemoveBadWords::class,
        ReplaceLinkTags::class,
        RemoveScriptTags::class
    ];

    $post = app(Pipeline::class)
    ->send($request)
    ->through($pipes)
    ->then(function ($content) {
        return Post::create(['content' => $content]);
    });

    // 返回响应
}

Each "task" class needs to define a "handle" method to handle the function. Maybe programming by implementing an interface is a good idea:

<?php

namespace App;

use Closure;

interface Pipe
{
    public function handle($content, Closure $next);
}

• Naming is so hard ¯_(ツ)_/¯*

<?php

namespace App;

use Closure;

class RemoveBadWords implements Pipe
{
    public function handle($content, Closure $next)
    {
        // 在这里处理任务，返回待更新的 **$content** 给到下一个管道任务。
        return  $next($content);
    }
}

The method used to handle the task receives two parameters, the first is a passable object and the second is the closure to which the object will be redirected after running the last pipeline.

You can also customize the method name to replace the "handle" method name. Then you need to specify the method name to be used by the pipeline, like this:

app(Pipeline::class)
 ->send($content)
 ->through($pipes)
 ->via('customMethodName') // <---- 就是这个 :)
 ->then(function ($content) {
     return Post::create(['content' => $content]);
 });

What happens at the end? What should happen here is that the submitted content will Will be modified by each

, and the final returned content will be saved.

$post = app(Pipeline::class)
    ->send($request->all())
    ->through($pipes)
    ->then(function ($content) {
        return Post::create(['content' => $content]);
    });

Remember, there are many ways to deal with this type of problem. How you choose is up to you. But be happy to have the knowledge of this new weapon in your knowledge base already built in when you need it.

I hope this example can give you a deeper understanding of "Laravel Pipelines" and know how to use them.

You can also check out the laravel api documentation if you want to know more about how it works

Related recommendations:

The above is the detailed content of In-depth analysis of Laravel pipeline (code). For more information, please follow other related articles on the PHP Chinese website!