Laravel Türkiye Discord Kanalı Forumda kod paylaşılırken dikkat edilmesi gerekenler!Birlikte proje geliştirmek ister misiniz?

Kod iyileştirme

MehmetCanYUMUTUTAN

Merhabalar. Aşağıdaki gibi bir çok metot oluşturacağım. Bu konuda, daha az kod yazacak, daha anlaşılır ve daha hızlı geliştirme yapılabilir bir düzenleme yapmak istiyorum.

Bir Libraries/Helpers gibi bir yapı içinde bir metot oluşturup, o metodu diğer metotlar içinde çağırmak faydalı olur mu?
Buna alternatif nasıl bir yol izleyebilirim.

function detail(Request $request)
{

    try {
        $client = new Client();
        $params = ["lang" => env("APP_DEFAULT_LANG"), "token" => $request->token];
        $query = http_build_query($params);
        $response = $client->request('GET', env("REST_API_ADDR") . "user/detail?{$query}");

        $body = $response->getBody()->getContents();

        $data = json_decode($body, true);

    } catch (ClientException  $exception) {
        $response = $exception->getResponse();
        $data = $response->getBody()->getContents();
        $data = json_decode($data, true);

        abort($response->getStatusCode(), $data['error']);
    }

    return view('user.details', [
        "mydata" => $data['data']
    ]);
}

deathisonitsway

Bunu controller icinde yapıyorsan kesinlikle hatalı.Bu guzzle kütüphanesi kesinlikle adapter pattern ile farklı bir sınıftan çağırılmalı.Yani bir http sınıfı oluşturmalısın.

MehmetCanYUMUTUTAN

Teşekkür ederim. Adapter pattern'i araşırayım.

Farklı tavsiyesi olan ya da örnek paylaşabilecek olan varsa incelemek isterim.

sineld

Bu kodu birçok yerde, sadece parametreleri değiştirip kullanacaksanız Trait'e dönüştürmenizi öneririm.

https://www.php.net/manual/tr/language.oop5.traits.php

MehmetCanYUMUTUTAN

Teşekkür ederim, inceleyeceğim.

mgsmus

Request kullandığınızda Http katmanına giriş yapmış olursunuz. Eğer yazacağınız servisler Request kullanırsa bu bu servisleri komutlarda, arka plan işlerinde vs kullanamazsınız (ya da new Request şeklinde yüklemeniz gerekecek). Yani servisleri mümkün olduğunca katman-bağımsız yazmaya çalışın.

Kabaca önce bir TokenManager'a ihtiyacınız olacak. Token çekme, yenileme, önbelleğe alma gibi işlemleri yapacak. Sonra bir tane HttpClient'a ihtiyacınız olacak. Bu da Guzzle yükleyecek. Daha sonra ise bu TokenManager ve HttpClient'ı enjekte edeceğiniz temel bir API Wrapper yazacaksınız. İçerisinde API ile temel haberleşmeleri barındıran yöntemler olabilir. Artık API varlıklarını kontrol edecek sınıflara geldi, örneğin UserService. API Wrapper sınıfı da UserService içerisine enjekte edip bununla örneğinizdeki detail yöntemini geliştireceksiniz. Son olarak da bu UserService sınıfını Controller, Command, Job, Event vs... kullanmak istediğiniz yerlere enjekte edip kullanabileceksiniz.

TokenManager → HttpClient → APIWrapper → UserService → UserController

İşiniz bittiğinde şuna ulaşmış olacaksınız:

// UserController::show()
public function show()
{
    $details = $this->userService->details();

    return view('user.details', compact('details'));
}

TokenManager kendi içerisinde CacheAdapter kullanabilir: Cache, Session, Flysystem.
HttpClient kendi içerisinde ClientAdapter kullanabilir: Guzzle, cUrl

Biliyorum, biraz aşağıdaki gibi oldu ama:

İnsan bunları araştırırken öğrenir.

MehmetCanYUMUTUTAN

Teşekkür ederim.

TokenManger, HttpClient ve APIWrapper için birer tane App/Libraries içine kendi sınıflarımı mı yazıp, APIWrapper içine TokenManger ve HttpClient çağırıp. Sonrasında UserService kısmında şu linkteki (https://murattopuz.com.tr/php/laravel-service-containerlari-anlamak/) gibi service container mı kullanmalıyım?

Anlattığınız yöntemi uygulamış örnekler verebilecek arkadaşlar olursa incelemek isterim.

Fikirleriniz için tekrar teşekkürler.

mgsmus

MehmetCanYUMUTUTAN Evet, bir servis sağlayıcı içerisinde, register yönteminde bu sınıfları birbirine bağlayacaksınız (binding). Bağlama sırasında TokenManager içerisine kullanıcı adı, şifre, client_id, client_secret... gibi değeleri alacak. HttpClient bağlama sırasında base_uri, headers... gibi default değerleri alacak.

Mesela:

$this->app->bind(TokenManager::class, function($app) {
    $config = config('api_config');
    return new TokenManager($config);
});

$this->app->bind(HttpClient::class, function($app) {
    $token = $app->make(TokenManager::class)->getToken();
    
    $client = new Guzzle([
        'base_uri' => config('api_config.base_uri'),
        'headers' => [
            'Authorization' => 'Bearer '.$token,
            'Accept' => 'application/json'
        ]
    ]);
    
    return new HttpClient($client, $token);
});

$this->app->bind(APIWrapper::class, function($app) {
    $httpClient = $app->make(HttpClient::class);
    return new APIWrapper($httpClient);
});

class UserService
{
    protected $path = 'users';
    
    protected $api;

    public function __construct(APIWrapper $api)
    {
       $this->api = $api; 
    }

    public function details($id)
    {
        $details = $this->api->httpClient->get($this->path.'/'.$id);
        // ...
    }
}

MehmetCanYUMUTUTAN

mgsmus Teşekkür ederim. Şu videoyu da izledim, https://www.youtube.com/watch?v=_z9nzEUgro4
Burada da benzer yöntemleri kullandı. Uygulamayı güncelledikten sonra kaynak olması açısından nasıl yaptığımı da paylaşacağım inşallah.

MehmetCanYUMUTUTAN

Tekrar merhabalar. cevabınızdan beri uğraştım fakat bir türlü birbirlerine geçiremedim. Aşağıda kodlarımı paylaşıyorum.

Bu provider'ı config/app.php dosyasındaki providers dizisine ekledim.

<?php

namespace App\Providers;

use GuzzleHttp\Client;
use Illuminate\Support\ServiceProvider;

class RestProvider extends ServiceProvider
{
    /**
     * Register services.
     *
     * @return void
     */
    public function register()
    {

        $this->app->bind(TokenManager::class, function ($app) {
            $config = config('api_config');
            return new TokenManager($config);
        });

        $this->app->bind(HttpClient::class, function ($app) {
            $token = $app->make(TokenManager::class)->getToken();

            $client = new Client([

            ]);

            return new HttpClient($client, $token);
        });

        $this->app->bind(APIWrapper::class, function ($app) {
            $httpClient = $app->make(HttpClient::class);
            return new APIWrapper($httpClient);
        });
    }

    /**
     * Bootstrap services.
     *
     * @return void
     */
    public function boot()
    {
        //
    }
}

App/Libraries dizininde aşağıdaki sınıfları oluşturdum.

namespace App\Libraries;


class TokenManager
{

    public function getToken()
    {
        return "jkfsdjkdsfjklfsdkl";
    } 
}

namespace App\Libraries;


use GuzzleHttp\Client;

class HttpClient
{

    public $client;

    function __construct(Client $client)
    {
        $this->client = $client;
    }

    function get($path)
    {

        $this->client->request('GET', env("REST_API_ADDR") . $path);

    }
}

namespace App\Libraries;


class APIWrapper
{

    public $httpClient;

    function __construct(HttpClient $httpClient)
    {
        $this->httpClient = $httpClient;
    }

}

Şu da UserService sınıfım.

namespace App\Services;

use App\Libraries\APIWrapper;

class UserService
{
    protected $path = 'user';

    protected $api;

    public function __construct(APIWrapper $api)
    {
        $this->api = $api;
    }

    public function details($id)
    {
        $details = $this->api->httpClient->get($this->path . "/detail?userid=" . $id);
        dd($details);
    }
}

UserController içindeki ilgili metot ise şöyle:

    public function show(UserService $userService, $id)
    {
        $details = $userService->details($id);
        dd($details);
    }

Bu kodlar sonucunda REST Api'ye istek gittiğini ve bana vermesi gereken cevabı verdiğini görüyorum. Bu cevapta token göndermediğimi söylüyor.

GuzzleHttp \ Exception \ ClientException (401)
Client error: `GET http://......../detail?userid=803` resulted in a `401 Unauthorized` response: {"error":"Token not provided."}

RestProvider.php sınıfımda Client (guzzle) için varsayılan parametreler vs eklemeye çalışıyorum. Fakat başarısız oldum.

Sanıyorum ki bağımlılıkları birbirlerine geçirme işlemlerini doğru anlayamadım. Nasıl bir yol izleyebilirim? Alternatif önerileriniz ne olabilir?

Teşekkürler.

mgsmus

$this->app->bind(HttpClient::class, function ($app) {
    $token = $app->make(TokenManager::class)->getToken();

    $client = new Client([

    ]);

    return new HttpClient($client, $token);
});

Bu kısımda takılmışsınız. Ben token örneği verirken Bearer olarak header içerisinde kullanımını örnek vermiştim. Siz query parameter olarak yola ekliyorsunuz. Bu token'ı her istekte parametre olarak otomatik ekletmek için gerekli bilgi şurada:
http://docs.guzzlephp.org/en/stable/handlers-and-middleware.html

Sizin örnekte şöyle olacak mesela:
(Özellikle hangi objelerin kullandığını görmeniz için full namespace kullandım)

$this->app->bind(HttpClient::class, function ($app) {
    $token = $app->make(TokenManager::class)->getToken();

    $stack = new \GuzzleHttp\HandlerStack();
    $stack->setHandler(new \GuzzleHttp\Handler\CurlHandler);

    $middleware = GuzzleHttp\Middleware::mapRequest(
        function (Psr\Http\Message\RequestInterface $request) use ($token) {
            $uri = GuzzleHttp\Psr7\Uri::withQueryValue(
                $request->getUri(), 
                'token',  // Parametre adı 
                $token    // Parametre değeri
            );
            
            return $request->withUri($uri);
        }
    );

    $stack->push($middleware);

    $client = new \GuzzleHttp\Client([
        'handler' => $stack
        // Diğer base_uri, headers... gibi default ek ayarlar buraya
    ]);

    // Artık içeri $token göndermeye gerek yok.
    return new HttpClient($client);
});