Exception Handling di Laravel

Indonesian (Bahasa Indonesia) translation by Sap (you can also view the original English article)

Dalam artikel ini, kita akan menjelajahi salah satu fitur yang paling penting dan paling sedikit dibahas dari Laravel web framework— exception handling. Laravel dilengkapi dengan built-in exception handler yang memungkinkan Anda untuk melaporkan dan membuat pengecualian dengan mudah dan ramah.

Di babak pertama artikel, kita akan menjelajahi pengaturan default disediakan oleh exception handler. Pada kenyataannya, kita akan pergi melalui default Handler class di tempat pertama untuk memahami bagaimana Laravel menangani exceptions.

Di babak kedua artikel, kita akan melanjutkan dan melihat bagaimana Anda bisa membuat custom exception handler yang memungkinkan Anda untuk mengerti custom exceptions.

Menyiapkan prasyarat

Sebelum kita melanjutkan dan menyelam ke Handler class lebih jauh, mari kita lihat beberapa parameter konfigurasi penting yang berkaitan dengan exceptions.

Silahkan membuka config/app.php file. Mari kita melihat dari dekat potongan berikut.

1	...
2	...
3	/*
4	\|--------------------------------------------------------------------------
5	\| Application Debug Mode
6	\|--------------------------------------------------------------------------
7	\|
8	\| When your application is in debug mode, detailed error messages with
9	\| stack traces will be shown on every error that occurs within your
10	\| application. If disabled, a simple generic error page is shown.
11	\|
12	*/
13
14	'debug' => env('APP_DEBUG', false),
15	...
16	...

Seperti namanya, jika sudah diatur ke TRUE, ini akan membantu Anda untuk men-debug kesalahan yang dihasilkan oleh aplikasi. Nilai default dari variabel ini diatur ke nilai variabel APP_DEBUG environment dalam .env file.

Dalam development environment, Anda harus mengatur ke TRUE sehingga Anda dapat dengan mudah melacak kesalahan dan memperbaikinya. Di sisi lain, Anda harus mematikannya saat production environment, dan akan menampilkan halaman kesalahan umum dalam hal ini.

Selain menampilkan kesalahan, Laravel memungkinkan Anda untuk log errors dalam log file. Mari kita lihat pilihan yang tersedia bagi logging. Sekali lagi, mari kita beralih ke config/app.php file dan telah melihat dari dekat potongan berikut.

...
...
'log' => env('APP_LOG', 'single'),

'log_level' => env('APP_LOG_LEVEL', 'debug'),
...
...

Laravel menggunakan Monolog PHP library untuk logging, Anda harus mengatur opsi di atas dalam konteks library nya.

File log standar terletak di storage/logs/laravel.log, dan cukup dalam kebanyakan kasus. Di sisi lain, APP_LOG_LEVEL diatur ke nilai yang menunjukkan tingkat keparahan kesalahan yang akan didata.

Jadi itu pengenalan dasar pilihan konfigurasi yang tersedia untuk exceptions dan logging.

Selanjutnya, kita akan melihat default Handler class yang datang dengan default aplikasi Laravel. Lanjutkan dan buka app/Exceptions/Handler.php file.

<?php

namespace App\Exceptions;

use Exception;
use Illuminate\Auth\AuthenticationException;
use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler;

class Handler extends ExceptionHandler
{
    /**
     * A list of the exception types that should not be reported.
     *
     * @var array
     */
    protected $dontReport = [
        \Illuminate\Auth\AuthenticationException::class,
        \Illuminate\Auth\Access\AuthorizationException::class,
        \Symfony\Component\HttpKernel\Exception\HttpException::class,
        \Illuminate\Database\Eloquent\ModelNotFoundException::class,
        \Illuminate\Session\TokenMismatchException::class,
        \Illuminate\Validation\ValidationException::class,
    ];

    /**
     * Report or log an exception.
     *
     * This is a great spot to send exceptions to Sentry, Bugsnag, etc.
     *
     * @param  \Exception  $exception
     * @return void
     */
    public function report(Exception $exception)
    {
        parent::report($exception);
    }

    /**
     * Render an exception into an HTTP response.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \Exception  $exception
     * @return \Illuminate\Http\Response
     */
    public function render($request, Exception $exception)
    {
        return parent::render($request, $exception);
    }

    /**
     * Convert an authentication exception into an unauthenticated response.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \Illuminate\Auth\AuthenticationException  $exception
     * @return \Illuminate\Http\Response
     */
    protected function unauthenticated($request, AuthenticationException $exception)
    {
        if ($request->expectsJson()) {
            return response()->json(['error' => 'Unauthenticated.'], 401);
        }

        return redirect()->guest(route('login'));
    }
}

Ada dua fungsi penting yang handler class bertanggung jawab untuk — pelaporan dan rendering semua errors.

Mari kita telah melihat dari dekat report method.

/**
 * Report or log an exception.
 *
 * This is a great spot to send exceptions to Sentry, Bugsnag, etc.
 *
 * @param  \Exception  $exception
 * @return void
 */
public function report(Exception $exception)
{
    parent::report($exception);
}

Report method digunakan untuk log errors ke log file. Pada saat yang sama, hal ini juga penting untuk dicatat dontReport property, yang berisi daftar semua jenis pengecualian yang tidak boleh login.

Selanjutnya, mari kita membawa dalam render method.

/**
 * Render an exception into an HTTP response.
 *
 * @param  \Illuminate\Http\Request  $request
 * @param  \Exception  $exception
 * @return \Illuminate\Http\Response
 */
public function render($request, Exception $exception)
{
    return parent::render($request, $exception);
}

Jika report method yang digunakan untuk log atau report errors, render method ini digunakan untuk membuat errors pada layar. Pada kenyataannya, method ini menangani apa yang akan ditampilkan kepada users ketika exception terjadi.

render method juga memungkinkan Anda untuk menyesuaikan response untuk berbagai jenis exceptions, sebagaimana kita lihat dalam bagian berikutnya.

Akhirnya, method unauthenticated menangani AuthenticationException exception yang memungkinkan Anda untuk memutuskan apakah akan ditampilkan kepada users dalam kasus mereka sedang tidak terauthentikasi untuk mengakses halaman yang mereka cari.

Custom Excepiton Class

Pada bagian ini, kita akan membuat custom exception class yang menangani exceptions dari jenis CustomException. Ide di balik menciptakan kelas kustom pengecualian adalah untuk mudah mengelola custom exceptions dan membuat custom responses pada waktu yang sama.

Lanjutkan dan buat file app/Exceptions/CustomException.php dengan isi sebagai berikut.

<?php

namespace App\Exceptions;

use Exception;

class CustomException extends Exception
{
    /**
     * Report the exception.
     *
     * @return void
     */
    public function report()
    {
    }

    /**
     * Render the exception into an HTTP response.
     *
     * @param  \Illuminate\Http\Request
     * @return \Illuminate\Http\Response
     */
    public function render($request)
    {
        return response()->view(
                'errors.custom',
                array(
                    'exception' => $this
                )
        );
    }
}

Hal yang penting untuk dicatat di sini adalah bahwa CustomException class harus memberikan inti Exception class. Untuk keperluan demonstrasi, kita hanya akan membahas render method, tapi tentu saja Anda juga dapat menyesuaikan report method.

Seperti yang Anda lihat, kami akan mengarahkan pengguna ke halaman kesalahan errors.custom dalam kasus kami. Cara itu, Anda dapat menerapkan halaman custom error untuk jenis exceptions tertentu.

Tentu saja, kita perlu membuat file view terkait di resources/views/errors/custom.blade.php.

1	Exception details: <b>{{ $exception->getMessage() }}</b>

Itu cukup sederhana Lihat file yang menampilkan pesan error, tapi tentu saja Anda bisa desain seperti yang Anda inginkan.

Kita juga perlu untuk membuat perubahan dalam render method app/Exceptions/Handler.php file sehingga custom exception class kami dapat dipanggil. Mari kita mengganti render method dengan isi sebagai berikut di app/Exceptions/Handler.php file.

...
...
/**
 * Render an exception into an HTTP response.
 *
 * @param  \Illuminate\Http\Request  $request
 * @param  \Exception  $exception
 * @return \Illuminate\Http\Response
 */
public function render($request, Exception $exception)
{
    if ($exception instanceof \App\Exceptions\CustomException)  {
        return $exception->render($request);
    }

    return parent::render($request, $exception);
}
...
...

Seperti yang Anda lihat, kita memeriksa jenis exception dalam render method di tempat pertama. Jika jenis exception \App\Exceptions\CustomException, kita memanggil render method dari class itu.

Jadi semuanya di tempat sekarang. Selanjutnya, mari kita lanjutkan dan buat controller file di app/Http/Controllers/ExceptionController.php sehingga kita dapat menguji custom exception class.

<?php
namespace App\Http\Controllers;

use App\Http\Controllers\Controller;

class ExceptionController extends Controller
{
    public function index()
    {
        // something went wrong and you want to throw CustomException
        throw new \App\Exceptions\CustomException('Something Went Wrong.');
    }
}

Tentu saja, Anda perlu menambahkan route yang terkait di routes/web.php seperti yang ditunjukkan dalam potongan berikut.

1	// Exception routes
2	Route::get('exception/index', 'ExceptionController@index');

Dan dengan itu, Anda dapat menjalankan URL http://your-laravel-site.com/exception/index untuk melihat apakah ia bekerja seperti yang diharapkan. Ini harus menampilkan errors.custom sesuai konfigurasi kami.

Jadi itulah bagaimana Anda seharusnya menangani custom exceptions dalam Laravel. Dan itu membawa kita ke akhir artikel ini-saya harap Anda telah menikmati itu!

Kesimpulan

Hari ini, kita melewati exception handling fitur di Laravel. Di awal artikel, kami mengeksplorasi konfigurasi dasar yang disediakan oleh Laravel untuk render dan report exceptions. Lebih lanjut, kita melihat singkat standar exception handler class.

Di babak kedua artikel, kami menyiapkan custom exception handler class yang menunjukkan bagaimana Anda bisa menangani custom exceptions dalam aplikasi Anda.

Bagi Anda yang baru mulai dengan Laravel atau mencari untuk memperluas pengetahuan Anda, situs, atau aplikasi dengan ekstensi, kami memiliki berbagai hal yang Anda dapat belajar di Envato Market.

Saya akan senang mendengar dari Anda dalam bentuk pertanyaan dan saran!