Úvod

V průběhu let, Vytvořil jsem mnoho aplikací SaaS založených na Laravelu.. Jeden z základní a společná vlastnost v téměř jakémkoli SaaS aplikace je na řídit spotřebu uživatelů, účty nebo týmy. Stránky cíl je zajistit, aby uživatelé nadměrně nevyužívali zdroje, ať už jde o volání API., limity pro zasílání zpráv nebo cokoli jiného, co vyžaduje kontrolu. Proto jsem vytvořil balíček Laravel, který přesně toto dělá --- Omezovač používání Laravelu.

Omezovač používání Laravelu vám pomůže sledovat a omezit, jak často mohou uživatelé používat nebo využívat určitou funkci v aplikaci po určitou dobu (např. omezit počet volání API na 100 za den). Definováním vlastních limitů můžete začít spravovat věci, jako jsou limity požadavků API, limity pro odesílání zpráv nebo jakékoli jiné funkce řízeného používání.

V tomto tutoriálu vás provedu instalací a použitím tohoto balíčku v aplikaci Laravel, přičemž vše bude velmi jednoduché. Pojďme se do toho ponořit!

Požadavek

Laravel verze 8.0 nebo vyšší.

Instalace

Pomocí správce balíčků Composer nainstalujte nástroj Laravel Usage Limiter:

composer require nabilhassen/laravel-usage-limiter

Dále byste měli publikovat konfigurační a migrační soubory omezovače použití Laravel pomocí příkazu vendor:publish Artisan.

php artisan vendor:publish --provider="NabilHassen\LaravelUsageLimiter\ServiceProvider"

Nakonec byste měli spustit příkaz migrate, abyste vytvořili potřebné tabulky.

php artisan migrate

Příklad použití

Předpokládejme tedy, že pracujeme na aplikaci elektronického obchodu poháněné systémem Laravel, kde mohou dodavatelé nabízet a prodávat své produkty. Naše aplikace má dva plány: Pro a Premium. Každý z těchto plánů má svá omezení, jak je popsáno níže.

• Pro: 20 produktů
• Premium: 50 produktů

Prvním krokem tedy bude použití HasLimits na modelu, který chceme sledovat, což je pravděpodobně uživatelský model.

use NabilHassen\LaravelUsageLimiter\Traits\HasLimits;
 
class User extends Authenticatable
{
    use HasLimits;
}

Dále definujme naše plány s jejich limity.

namespace Database\Seeders;
 
use Illuminate\Database\Seeder;
use NabilHassen\LaravelUsageLimiter\Models\Limit;
 
class PlanSeeder extends Seeder
{
    /**
     * Run the database seeds.
     */
    public function run(): void
    {
        // Pro plan can create 20 products
         Limit::create([
            'name' => 'products',
            'allowed_amount' => 20,
            'plan' => 'pro',
            'reset_frequency' => 'every month',
        ]);
 
        // Premium plan can create 50 products
         Limit::create([
            'name' => 'products',
            'allowed_amount' => 50,
            'plan' => 'premium',
            'reset_frequency' => 'every month',
        ]);
    }
}

Jakmile je náš seeder připraven, můžeme spustit php artisan db:seed PlanSeeder. Skvělé!

Ve vašem User po vytvoření uživatele byste k němu měli připojit limit.

namespace App\Http\Controllers;
 
class UserController
{
    public function store(Request $request) {
        $user = User::create($request->validated());
 
        $user->setLimit('products', 'pro');
    }
 
    public function destroy(User $user) {
        $user->unsetLimit('products', 'pro');
 
        $user->delete();
    }
}

Nyní v naší ProductController třída, kdykoli se dodavatel (tj. uživatel) pokusí vytvořit produkt, můžeme zkontrolovat jeho limity a rozhodnout, zda smí vytvořit více produktů, nebo ne, a mezitím sledovat jeho limity.

namespace App\Http\Controllers;
 
class ProductController
{
    public function store(Request $request) {
        abort_if(! auth()->user()->hasEnoughtLimit('products'), 403);
 
        Product::create($request->validated());
 
        auth()->user()->useLimit('products');
    }
 
    public function destroy(Product $product) {
        $product->delete();
 
        auth()->user()->unuseLimit('products');
    }
}

✅ Vše je připraveno! Vaše aplikace je nyní připravena sledovat a spravovat zdroje a spotřebu uživatelů.

Pojďme ještě o krok dál. Na začátku tohoto návodu, když jsme definovali naše plány a limity, jsme také nastavili frekvenci resetování pro každý z našich limitů jako every month.

Omezovač používání Laravelu obsahuje integrované nástroje příkazového řádku. Jeden z dostupných příkazů použijeme k automatickému obnovení limitů uživatelů na základě frekvence obnovování, kterou jsme nastavili dříve.

// app/Console/Kernel.php
protected function schedule(Schedule $schedule)
{
    ...
    // Laravel <= 11
    $schedule->command('limit:reset')->everyMinute();
 
    // Laravel >= 10
    $schedule->command('limit:reset')->everySecond();
    ...
}

👏👏 Vaše aplikace je připravena spravovat, sledovat, omezovat a automaticky resetovat limity uživatelů.

Další funkce

Co jsme implementovali do tohoto bodu pravidelné implementace Omezovač používání Laravelu balíček. Balíček nabízí i další funkce, které si můžete prohlédnout na stránkách Repozitář GitHub.

Závěr

Souhrnně lze říci, že Omezovač používání Laravelu je mocným nástrojem pro všechny vývojáře Laravelu, kteří chtějí zavést omezení používání ve svých aplikacích. Ať už vytváříte produkt SaaS nebo jednoduchou funkci, tento balíček vám umožní snadno sledovat a spravovat spotřebu uživatelů a zároveň vám poskytne flexibilitu při definování vlastních limitů. Podle kroků popsaných v tomto návodu můžete do své aplikace rychle integrovat sledování spotřeby a zajistit, aby uživatelé nepřekračovali stanovené meze.

Nezapomeňte si prohlédnout další funkce, které balíček nabízí v úložišti GitHub. Se správnou konfigurací budete na dobré cestě k vytvoření robustní aplikace, která bude mít správu zdrojů pod kontrolou.

💻 --- Šťastné kódování!