Spring Security 6 & JWT Authentication · レッスン

カスタムUserDetailsServiceの実装

カスタム`UserDetailsService`を作成し、認証のためにアプリケーションのデータストアからユーザー固有のデータを読み込みます。

「カスタムUserDetailsServiceの実装」はCoddyKit上の無料Spring Security 6 & JWT Authenticationレッスンです。これはレッスン1/4です。下記で完全なレッスンを無料で読むことができます。その後、ブラウザ内の組み込みコードエディタと24時間対応のAIチューターでハンズオン演習できます。これはSpring Security 6 & JWT Authentication学習パスの一部であり、ウェブとCoddyKitアプリ全体で進捗が同期されます。 Spring Security 6 & JWT Authenticationコースには全4レッスンが含まれています。

このレッスンの一部はまだ翻訳されておらず、英語で表示されています。

Beyond In-Memory Users

In previous lessons, you might have used in-memory users for simple authentication. This means usernames and passwords are hardcoded directly in your application's configuration.

While easy for testing, real-world applications need to load user data from a persistent source like a database, LDAP, or another service. This is where a custom UserDetailsService comes in!

The UserDetailsService Interface

Spring Security uses the UserDetailsService interface to retrieve user-specific data during authentication. It has just one method you need to implement:

UserDetails loadUserByUsername(String username)

This method is crucial. When a user tries to log in, Spring Security calls this method, passing the username provided by the user.

What is UserDetails?

The loadUserByUsername method must return a UserDetails object. This interface represents the authenticated user's information, including:

Username
Password
Authorities (roles/permissions)
Account status (e.g., enabled, locked, expired)

Spring Security provides a default implementation called org.springframework.security.core.userdetails.User that you'll often use.

Creating Your Custom Service

To create a custom user service, you simply create a class that implements UserDetailsService. Inside, you'll override the loadUserByUsername method.

This method is where you'll write the logic to fetch user data from your chosen data store. For now, we'll use some hardcoded examples.

Implementing loadUserByUsername

Inside loadUserByUsername, you'll perform these steps:

Receive the username.
Look up the user in your data source.
If found, create a UserDetails object with their details (username, password, roles).
If not found, throw a UsernameNotFoundException.

Remember, password encoding is vital for security, but we'll cover that in a later lesson. For now, we'll use a plain text password prefix: {noop}.

Code: Basic UserDetailsService

Let's see a simple implementation. This example hardcodes users, simulating fetching from a data source. Run it to see how it works!

import org.springframework.security.core.userdetails.User;
import org.springframework.security.core.userdetails.UserDetails;
import org.springframework.security.core.userdetails.UserDetailsService;
import org.springframework.security.core.userdetails.UsernameNotFoundException;
import java.util.Arrays;
import java.util.Collections;

class MyUserDetailsService implements UserDetailsService {
    @Override
    public UserDetails loadUserByUsername(String username) throws UsernameNotFoundException {
        // In a real app, you'd fetch user from a database
        if ("user".equals(username)) {
            return User.withUsername("user")
                       .password("{noop}password") // {noop} for plain text
                       .roles("USER")
                       .build();
        }
        if ("admin".equals(username)) {
            return User.withUsername("admin")
                       .password("{noop}adminpass")
                       .roles("ADMIN", "USER")
                       .build();
        }
        throw new UsernameNotFoundException("User not found: " + username);
    }
}

public class Main {
    public static void main(String[] args) {
        MyUserDetailsService service = new MyUserDetailsService();

        System.out.println("Attempting to load 'user'...");
        try {
            UserDetails user = service.loadUserByUsername("user");
            System.out.println("Loaded User: " + user.getUsername());
            System.out.println("Authorities: " + user.getAuthorities());
        } catch (UsernameNotFoundException e) {
            System.out.println(e.getMessage());
        }

        System.out.println("\nAttempting to load 'admin'...");
        try {
            UserDetails admin = service.loadUserByUsername("admin");
            System.out.println("Loaded Admin: " + admin.getUsername());
            System.out.println("Authorities: " + admin.getAuthorities());
        } catch (UsernameNotFoundException e) {
            System.out.println(e.getMessage());
        }

        System.out.println("\nAttempting to load 'unknown'...");
        try {
            service.loadUserByUsername("unknown");
        } catch (UsernameNotFoundException e) {
            System.out.println(e.getMessage());
        }
    }
}

Adding Roles and Authorities

Notice in the example, we used .roles("USER") and .roles("ADMIN", "USER").

Roles are high-level permissions, like 'ADMIN' or 'USER'.
These roles are converted into GrantedAuthority objects by Spring Security.
When building the UserDetails object, you specify the roles/authorities the user possesses.

These authorities are later used by Spring Security for authorization (determining what a user can access).

Registering Your Service

Once you've created your custom UserDetailsService, Spring Security needs to know about it. In a Spring Boot application, you typically register it as a Spring bean.

By simply defining your custom service as a @Bean, Spring Security's auto-configuration will usually pick it up and use it for authentication.

The Custom Authentication Flow

Here's how custom authentication typically works with your service:

User submits login credentials (username, password).
Spring Security receives the request.
It calls your custom UserDetailsService's loadUserByUsername() method with the provided username.
Your method fetches user data and returns a UserDetails object.
Spring Security then compares the provided password with the password from UserDetails (after encoding/decoding).
If they match, authentication succeeds!

Check Your Understanding

Consider the core purpose and components of implementing a custom UserDetailsService.

Recap: Custom UserDetailsService

You've learned how to implement a custom UserDetailsService, a fundamental component for advanced user authentication in Spring Security:

It allows loading user data from any source.
You implement the loadUserByUsername method.
This method returns a UserDetails object, containing user credentials and authorities.
It's essential for moving beyond in-memory user management.

Next, we'll dive into securing those passwords with proper encoding!

よくある質問

「カスタムUserDetailsServiceの実装」レッスンは無料ですか？

はい。「カスタムUserDetailsServiceの実装」の完全なテキストはこのウェブで無料で読めます。インタラクティブに演習し（組み込みコードエディタと24時間対応のAIチューター）、Spring Security 6 & JWT Authenticationコースの残りをアンロックするには、CoddyKit PROにアップグレードしてください。 Spring Security 6 & JWT Authenticationコースには全4レッスンが含まれています。

「カスタムUserDetailsServiceの実装」で何を学びますか？

カスタム`UserDetailsService`を作成し、認証のためにアプリケーションのデータストアからユーザー固有のデータを読み込みます。ブラウザで直接実行するハンズオンコードでSpring Security 6 & JWT Authenticationを演習し、24時間対応のAIチューターがレッスンを進める中での質問に答えます。

Spring Security 6 & JWT Authenticationを始めるのに経験は必要ですか？

事前経験は必要ありません。CoddyKitのSpring Security 6 & JWT Authenticationは初級者から上級者向けに構成されているため、ここから始めるか最初から始めて、自分のペースで進むことができます。これはレッスン1/4です。

「カスタムUserDetailsServiceの実装」レッスンにはどのくらい時間がかかりますか？

ほとんどのCoddyKitレッスンは約5～10分かかります。各レッスンはコンパクトでインタラクティブなので、着実に進歩し、ウェブとアプリ全体で正確に前回の場所から再開できます。

このSpring Security 6 & JWT Authenticationレッスンでコードを書いて実行できますか？

はい。すべてのSpring Security 6 & JWT Authenticationレッスンに組み込みコードエディタが含まれているため、ブラウザでリアルコードを書いて実行し、即座のAIフィードバックを取得できます。ローカル設定は不要です。

このコースのすべてのレッスン

← Spring Security 6 & JWT Authenticationに戻る