Download the PHP package sametsahindogan/laravel-jwtredis without Composer

laravel-jwtredis

This package allows JWT-authenticated users to be stored and management in Redis with their roles, permissions, statuses and anything you want.

Also this package have an observer for listening and updating to your user model on Redis. This observer is triggered when you assign roles & permissions to user, or update and delete to your user model.

Requirements

This package work with together tymondesigns/jwt-auth and spatie/laravel-permission package under the hood.

!Make sure to install and configure these dependencies. You must publish, migrate etc. all packages.!

• If your PHP setup does not have the Redis extension or Laravel's Redis driver is not selected as phpredis, you must install nrk/predis >= 1.1 (Recommended 1.1)
• PHP >= 7.2.5
• Laravel >= 6.0
• tymondesigns/jwt-auth >= 1.0 (Recommended 1.0.2)
• spatie/laravel-permission >= 4.0 (Recommended 4.0.0)
• sametsahindogan/response-object-creator >= 1.0 (Recommended 1.0.2)

Installation

Once this has finished, you will need to add&change these values in .env file:

Next, you will need to change the guards and providers arrays in your config/auth.php config as follows:

This package uses auto-discovery to register the service provider but if you'd rather do it manually, the service provider is: add to providers array in your config/app.php config as follows:

You will want to publish the config using the following command:

Configurations

When everything is done, don't forget to add this Trait to your user model.

You need to add $routeMiddleware array in app/Http/Kernel.php

Usage

You do not have any instructions for use. This package only affects the background, functions in an almost identical way to Laravel session authentication, with a few exceptions. All you have to do is change your middleware.(I mention this below) You can use Laravel's Auth facade, Tymon's JWTAuth facade and all spatie/laravel-permission package methods as usual.

• For user authentication by token;
  ( Use this middleware if the user's identity is not important. This middleware only checks if Token is valid. Doesn't send to any query to any database.)

• To check user authorization, you need to this one of these middlewares;
  ( Use this middleware if the user's identity is important. This middlewares fetch user from Redis and mark as authorized to Laravel's Request object. And you will reach all default Auth facade's methods you want. Just call Laravel's Auth facades.)

• To refresh the token, you can add the refreshable middleware to the required route. You don't need to take any action on the controller of this route;
  ( Also this middleware can refreshes user from Redis if necessary. )

If you want to do different things, you can override those mentioned middlewares.

After using it as above, every authorization you made in your application, such as Auth::user() or $user->can('permission'), is always checked from Redis, not from the database.

Options

You can customize some options in that package. Check config/jwtredis.php file.

• User Model

• Observer

• Events Queue

• Cache Time

• Cache Prefix

• Serialization

• Banned User Check

• Relation Caching

• Customize Exceptions

Example Project

Here is an example using laravel-jwtredis. You can examine in detail.

Performance Improvements Tips

You may install the PhpRedis PHP extension via PECL. The extension is more complex to install but may yield better performance for applications that make heavy use of Redis. Predis is the alternative for PhpRedis on pure PHP and does not require any additional C extension by default.

"PhpRedis is faster about x6 times. Using igbinary serializer reduces stored data size about 3x times. If Redis installed on separate machines, reducing network traffic is a very significant speedup."

In my opinion, using PhpRedis and serializer as igbinary ( Laravel does not support igbinary serialization on Redis. However, this package provides igbinary serialization support for Laravel. Please check config/jwtredis.php file. ) in production environment gives a great performance.

You can review this article for performance comparison PhpRedis vs. Predis.

Integrate with Laravel Swoole Package

This package fully compatible with Laravel Swoole package. If you want to use it together, all you have to do is change the instances and providers arrays in your config/swoole_http.php config as follows:

License

MIT © Samet Sahindogan