Laravel development: How to use Laravel Socialite to implement Github login?

In today's Internet era, user login has become something that most web applications must consider. This also means that web applications need to provide users with optional multiple login methods to reduce user login difficulty and optimize user experience.

As one of the most popular PHP frameworks currently, Laravel provides some very convenient ways to implement user authentication. Laravel Socialite is a very powerful user authentication solution that allows applications to use Third-party platforms act as authentication providers.

In this article, we will introduce how to use Laravel Socialite to implement the Github login function. Let's take a step-by-step approach to achieving this goal.

Step 1: Create a Github application

Before starting this article, you first need to register and create a Github account, and create an OAuth application in Github. The process of creating an application is relatively simple, just follow the following steps:

1. Log in to your Github account and create a new OAuth App in the Github Settings -> Developer settings -> OAuth Apps page

2. Fill in the App name, Homepage URL and Callback URL in the first part

   Callback URL is the website address returned after successful login and needs to be defined in the Laravel website background

3. The client_id and client_secret of the Github application will be displayed on the page returned after submitting the form. client_id will be used to configure Laravel Socialite's Github driver.

Step 2: Install Laravel Socialite

Installing Laravel Socialite can be easily done through Composer. Just enter the following instructions in the command line in the project directory:

composer require laravel/socialite

Step 3: Configure the service provider and Facade Reference

Open the config/app.php configuration file and find providers Arrays and aliases array, add the Socialite service provider and Facade references to the corresponding arrays.

'providers' => [
    // Other service providers...

    LaravelSocialiteSocialiteServiceProvider::class,
],

'aliases' => [
    // Other aliases...

    'Socialite' => LaravelSocialiteFacadesSocialite::class,
],

Step 4: Define Github driver configuration

Add the following configuration in the config/services.php configuration file:

'github' => [
    'client_id' => env('GITHUB_CLIENT_ID'),
    'client_secret' => env('GITHUB_CLIENT_SECRET'),
    'redirect' => env('GITHUB_REDIRECT'),
],

Step 5: Define Github login link

Open the blade template file of the login page and add the following code:

<a href="{{ url('auth/github') }}" class="btn btn-github"><i class="fa fa-github"></i> Github 登录</a>

This will create a link that will jump to the Github login page by accessing /auth/github.

Step 6: Define the Github callback function

Open the Callback URL page when we registered in Github and get the code parameter in the link, and add the following code in the Laravel route:

Route::get('auth/github/callback', function () {
    $user = Socialite::driver('github')->user();

    // 如果在本地没有找到该用户，则创建新用户
    $existingUser = User::where('email', $user->getEmail())->first();
    if ($existingUser) {
        auth()->login($existingUser, true);
    } else {
        $newUser                  = new User;
        $newUser->name            = $user->getNickname();
        $newUser->email           = $user->getEmail();
        $newUser->github_id       = $user->getId();
        $newUser->avatar          = $user->getAvatar();
        $newUser->provider        = 'github';
        $newUser->save();
        auth()->login($newUser, true);
    }

    return redirect()->to('/home');
});

What needs to be noted here is that we need to save github_id in the database for login verification when needed, and also save the user's nickname and avatar for easy display.

Step 7: Create the .env file

Open the .env file in the project root directory and add the following Github related configuration:

GITHUB_CLIENT_ID=your-github-client-id-here
GITHUB_CLIENT_SECRET=your-github-client-secret-here
GITHUB_REDIRECT=http://localhost:8000/auth/github/callback

In the above configuration, you need to # Replace ##your-github-client-id-here and your-github-client-secret-here with the client_id and client_secret you obtained from Github. The value of GITHUB_REDIRECT should be the redirect URI parameter when registering the application on Github.

Okay, now you can try logging in with Github to test your application. When you visit /auth/github, you should be redirected to Github's login page. After entering your Github account, you should be redirected back to the address you specified via the Callback URI.

Using Laravel Socialite is indeed a fast and easy way to implement authentication. It also supports many other account authentication service providers, such as Facebook, Twitter, Google, etc. Comfortable and efficient third-party login methods can greatly improve user experience, and adding multiple login methods to web applications has gradually become a necessity. Compared with implementing an authentication system independently, using Laravel Socialite can make use of existing excellent authentication service providers to simplify the implementation of identity authentication solutions.

The above is the detailed content of Laravel development: How to use Laravel Socialite to implement Github login?. For more information, please follow other related articles on the PHP Chinese website!