{"id":11050,"date":"2021-11-25T10:00:00","date_gmt":"2021-11-25T01:00:00","guid":{"rendered":"https:\/\/www.gigas-jp.com\/appnews\/?p=11050"},"modified":"2021-11-24T19:38:31","modified_gmt":"2021-11-24T10:38:31","slug":"cleaning-up-laravel-controllers","status":"publish","type":"post","link":"https:\/\/www.gigas-jp.com\/appnews\/archives\/11050","title":{"rendered":"Cleaning Up Laravel Controllers"},"content":{"rendered":"\n

Introduction<\/strong> <\/p>\n\n\n\n

Controllers play a huge role in any MVC<\/a> (model view controller) based project. They\u2019re effectively the \u201cglue\u201d that takes a user\u2019s request, performs some type of logic, and then returns a response. <\/p>\n\n\n\n

<\/p>\n\n\n\n

The Problem with Bloated Controllers<\/strong> <\/p>\n\n\n\n

<\/p>\n\n\n\n

Bloated controllers can cause several problems for developers. They can:<\/p>\n\n\n\n

1. Make it hard to track down a particular piece of code or functionality. <\/p>\n\n\n\n

2. Make it difficult to spot the exact location of a bug. <\/p>\n\n\n\n

3. Make it harder to write tests for more complex requests.<\/p>\n\n\n\n

<\/p>\n\n\n\n

The Bloated Controller<\/strong> <\/p>\n\n\n\n

For this blog, I am going to use an example UserController<\/code>: <\/p>\n\n\n\n

class UserController extends Controller\n{\n    public function store(Request $request): RedirectResponse\n    {\n        $this->authorize('create', User::class);        $request->validate([\n            'name'     => 'string|required|max:50',\n            'email'    => 'email|required|unique:users',\n            'password' => 'string|required|confirmed',\n        ]);        $user = User::create([\n            'name'     => $request->name,\n            'email'    => $request->email,\n            'password' => $request->password,\n        ]);        $user->generateAvatar();\n        $this->dispatch(RegisterUserToNewsletter::class);        return redirect(route('users.index'));\n    }    public function unsubscribe(User $user): RedirectResponse\n    {\n        $user->unsubscribeFromNewsletter();        return redirect(route('users.index'));\n    }\n}\n\n1. Lift Validation and Authorization into Form Requests\n\n<\/strong>\n\nOne of the first things that we can do with the controller is to lift any validation and authorization out of the controller and into a form request class.\n\nWe\u2019ll use the following Artisan command to create a new form request:\n\nphp artisan make:request StoreUserRequest<\/strong>\n\nThe above command will have created a new app\/Http\/Requests\/StoreUserRequest.php class that looks like this:\n\nclass StoreUserRequest extends FormRequest\n{\n    \/**\n     * Determine if the user is authorized to make this request.\n     *\n     * @return bool\n     *\/\n    public function authorize()\n    {\n        return false;\n    }\n    \/**\n     * Get the validation rules that apply to the request.\n     *\n     * @return array\n     *\/\n    public function rules()\n    {\n        return [\n            \/\/\n        ];\n    }\n}\n\n\nWe can use the authorize() method to determine if the user should be allowed to carry out the request. The method should return true if they can and false if they cannot. We can also use the rules() method to specify any validation rules that should be run on the request body. \n\nclass StoreUserRequest extends FormRequest\n{\n    \/**\n     * Determine if the user is authorized to make this request.\n     *\n     * @return bool\n     *\/\n    public function authorize(): bool\n    {\n        return Gate::allows('create', User::class);\n    }\n    \/**\n     * Get the validation rules that apply to the request.\n     *\n     * @return array\n     *\/\n    public function rules(): array\n    {\n        return [\n            'name'     => 'string|required|max:50',\n            'email'    => 'email|required|unique:users',\n            'password' => 'string|required|confirmed',\n        ];\n    }\n}\n\nOur controller should now also look like this:\n\nclass UserController extends Controller\n{\n    public function store(StoreUserRequest $request): RedirectResponse\n    {\n        $user = User::create([\n            'name'     => $request->name,\n            'email'    => $request->email,\n            'password' => $request->password,\n        ]);\n        $user->generateAvatar();\n        $this->dispatch(RegisterUserToNewsletter::class);\n        return redirect(route('users.index'));\n    }\n    public function unsubscribe(User $user): RedirectResponse\n    {\n        $user->unsubscribeFromNewsletter();\n        return redirect(route('users.index'));\n    }\n}\n\n2. Move Common Logic into Actions or Services<\/strong>\n\nAnother step that we could take to clean up the store() method could be to move out our \"business logic\" into a separate action or service class.\n\nclass StoreUserAction\n{\n    public function execute(Request $request): void\n    {\n        $user = User::create([\n            'name'     => $request->name,\n            'email'    => $request->email,\n            'password' => $request->password,\n        ]);\n        $user->generateAvatar();\n        $this->dispatch(RegisterUserToNewsletter::class);\n    }\n}\n\nNow we can update our controller to use the action:\n\nclass UserController extends Controller\n{\n    public function store(StoreUserRequest $request, StoreUserAction $storeUserAction): RedirectResponse\n    {\n        $storeUserAction->execute($request);\n        return redirect(route('users.index'));\n    }\n    public function unsubscribe(User $user): RedirectResponse\n    {\n        $user->unsubscribeFromNewsletter();\n        return redirect(route('users.index'));\n    }\n}\n\n3. Use Resource or Single-use Controllers<\/strong>\n\nA great way of keeping controllers clean is to ensure that they are either \u201c resource controllers<\/a>\u201d or \u201c single-use controllers\u201d. <\/a>\n\nA resource controller is a controller that provides functionality based around a particular resource. So, in our case, our resource is the User model and we want to be able to perform all CRUD (create, update, update, delete) operations on this model. A resource controller typically contains index(), create(), store(), show(), edit(), update() and destroy() methods.\n\nA single-use controller is a controller that only has one public __invoke() method. These are really useful if you have a controller that doesn't really fit into one of the RESTful methods that we have in our resource controllers.\n\nSo let\u2019s create a new controller using the following Artisan command:\n\n\nphp artisan make:controller UnsubscribeUserController -i<\/strong>\n\nNotice how we passed -i to the command so that the new controller will be an invokable, single-use controller. We should now have a controller that looks like this:\n\nclass UnsubscribeUserController extends Controller\n{\n    public function __invoke(Request $request)\n    {\n        \/\/\n    }\n}\n\nWe can now move our method\u2019s code over and delete the unsubscribe method from our old controller:\n\nclass UnsubscribeUserController extends Controller\n{\n    public function __invoke(Request $request): RedirectResponse\n    {\n        $user->unsubscribeFromNewsletter();\n        return redirect(route('users.index'));\n    }\n}\n\n\nConclusion<\/strong>\n\nHopefully this article has given you an insight into the different types of things you can do to clean up your controllers in your Laravel projects.\n\n\nTsuki<\/pre>\n
\n            
<\/g:plusone><\/div>\n            
 \"\u3053\u306e\u30a8\u30f3\u30c8\u30ea\u30fc\u3092\u306f\u3066\u306a\u30d6\u30c3\u30af\u30de\u30fc\u30af\u306b\u8ffd\u52a0\"<\/a>