Redditアプリでのログインから登録を切り離す

投稿日: 2019-10-19 2022-10-15
タグ: REST, Spring

1. 概要

このチュートリアル– RedditがサポートするOAuth2認証プロセスを、よりシンプルなフォームベースのログインに置き換えます。

ログイン後もRedditをアプリケーションに接続することはできますが、メインのログインフローを駆動するためにRedditを使用することはありません。

2. 基本的なユーザー登録

まず、古い認証フローを置き換えましょう。

**2.1. ユーザーエンティティ**

Userエンティティにいくつかの変更を加えます。usernameを一意にし、 password フィールドを追加します（一時的）：

@Entity
public class User {
    ...

    @Column(nullable = false, unique = true)
    private String username;

    private String password;

    ...
}

2.2. 新規ユーザーの登録

次へ–バックエンドに新しいユーザーを登録する方法を見てみましょう。

@Controller
@RequestMapping(value = "/user")
public class UserController {

    @Autowired
    private UserService service;

    @RequestMapping(value = "/register", method = RequestMethod.POST)
    @ResponseStatus(HttpStatus.OK)
    public void register(
      @RequestParam("username") String username, 
      @RequestParam("email") String email,
      @RequestParam("password") String password) 
    {
        service.registerNewUser(username, email, password);
    }
}

明らかに、これはユーザーにとって基本的な作成操作であり、ベルやホイッスルはありません。

これがサービスレイヤーでの実際の実装です。

@Service
public class UserService {
    @Autowired
    private UserRepository userRepository;

    @Autowired
    private PreferenceRepository preferenceReopsitory;

    @Autowired
    private PasswordEncoder passwordEncoder;

    @Override
    public void registerNewUser(String username, String email, String password) {
        User existingUser = userRepository.findByUsername(username);
        if (existingUser != null) {
            throw new UsernameAlreadyExistsException("Username already exists");
        }
        
        User user = new User();
        user.setUsername(username);
        user.setPassword(passwordEncoder.encode(password));
        Preference pref = new Preference();
        pref.setTimezone(TimeZone.getDefault().getID());
        pref.setEmail(email);
        preferenceReopsitory.save(pref);
        user.setPreference(pref);
        userRepository.save(user);
    }
}

2.3. 例外への対処

そして、単純な UserAlreadyExistsException ：

public class UsernameAlreadyExistsException extends RuntimeException {

    public UsernameAlreadyExistsException(String message) {
        super(message);
    }
    public UsernameAlreadyExistsException(String message, Throwable cause) {
        super(message, cause);
    }
}

例外は、アプリケーションのメイン例外ハンドラーでで処理されます。

@ExceptionHandler({ UsernameAlreadyExistsException.class })
public ResponseEntity<Object> 
  handleUsernameAlreadyExists(RuntimeException ex, WebRequest request) {
    logger.error("400 Status Code", ex);
    String bodyOfResponse = ex.getLocalizedMessage();
    return new 
      ResponseEntity<Object>(bodyOfResponse, new HttpHeaders(), HttpStatus.BAD_REQUEST);
}

2.4. 簡単な登録ページ

最後に–シンプルなフロントエンド signup.html ：

<form>
    <input  id="username"/>
    <input  id="email"/>
    <input type="password" id="password" />
    <button onclick="register()">Sign up</button>
</form>

<script>
function register(){
    $.post("user/register", {username: $("#username").val(),
      email: $("#email").val(), password: $("#password").val()}, 
      function (data){
        window.location.href= "./";
    }).fail(function(error){
        alert("Error: "+ error.responseText);
    }); 
}
</script>

これは完全に成熟した登録プロセスではなく、非常に迅速なフローであることに再度言及する価値があります。完全な登録フローについては、ここBaeldungでメイン登録シリーズをチェックしてください。

3. 新しいログインページ

新しくてシンプルなログインページは次のとおりです。

<div th:if="${param.containsKey('error')}">
Invalid username or password
</div>
<form method="post" action="j_spring_security_check">
    <input name="username" />
    <input type="password" name="password"/>  
    <button type="submit" >Login</button>
</form>
<a href="signup">Sign up</a>

4. セキュリティ構成

それでは、新しいセキュリティ構成を見てみましょう。

@Configuration
@EnableWebSecurity
@ComponentScan({ "org.baeldung.security" })
public class SecurityConfig extends WebSecurityConfigurerAdapter {

    @Autowired
    private MyUserDetailsService userDetailsService;

    @Override
    protected void configure(AuthenticationManagerBuilder auth) throws Exception {
        auth.userDetailsService(userDetailsService).passwordEncoder(encoder());
    }

    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http
            ...
            .formLogin()
            .loginPage("/")
            .loginProcessingUrl("/j_spring_security_check")
            .defaultSuccessUrl("/home")
            .failureUrl("/?error=true")
            .usernameParameter("username")
            .passwordParameter("password")
            ...
    }

    @Bean
    public PasswordEncoder encoder() { 
        return new BCryptPasswordEncoder(11); 
    }
}

ほとんどのことは非常に簡単なので、ここでは詳しく説明しません。

そして、これがカスタムUserDetailsServiceです。

@Service
public class MyUserDetailsService implements UserDetailsService {

    @Autowired
    private UserRepository userRepository;

    @Override
    public UserDetails loadUserByUsername(String username) {
        User user = userRepository.findByUsername(username); 
        if (user == null) { 
            throw new UsernameNotFoundException(username);
        } 
        return new UserPrincipal(user);
    }
}

そして、これがUserDetailsを実装するカスタムPrincipal「UserPrincipal」です。

public class UserPrincipal implements UserDetails {

    private User user;

    public UserPrincipal(User user) {
        super();
        this.user = user;
    }

    @Override
    public String getUsername() {
        return user.getUsername();
    }

    @Override
    public String getPassword() {
        return user.getPassword();
    }

    @Override
    public Collection<? extends GrantedAuthority> getAuthorities() {
        return Arrays.asList(new SimpleGrantedAuthority("ROLE_USER"));
    }

    @Override
    public boolean isAccountNonExpired() {
        return true;
    }

    @Override
    public boolean isAccountNonLocked() {
        return true;
    }

    @Override
    public boolean isCredentialsNonExpired() {
        return true;
    }

    @Override
    public boolean isEnabled() {
        return true;
    }
}

注：SpringSecurityのデフォルトのUser の代わりに、カスタム Principal “ UserPrincipal”を使用しました。

5. Redditを認証する

認証フローをRedditに依存しなくなったので、ユーザーがログインした後、ユーザーが自分のアカウントをRedditに接続できるようにする必要があります。

まず、古いRedditログインロジックを変更する必要があります。

@RequestMapping("/redditLogin")
public String redditLogin() {
    OAuth2AccessToken token = redditTemplate.getAccessToken();
    service.connectReddit(redditTemplate.needsCaptcha(), token);
    return "redirect:home";
}

そして実際の実装– connectReddit（）メソッド：

@Override
public void connectReddit(boolean needsCaptcha, OAuth2AccessToken token) {
    UserPrincipal userPrincipal = (UserPrincipal) 
      SecurityContextHolder.getContext().getAuthentication().getPrincipal();
    User currentUser = userPrincipal.getUser();
    currentUser.setNeedCaptcha(needsCaptcha);
    currentUser.setAccessToken(token.getValue());
    currentUser.setRefreshToken(token.getRefreshToken().getValue());
    currentUser.setTokenExpiration(token.getExpiration());
    userRepository.save(currentUser);
}

redditLogin（）ロジックを使用して、ユーザーの AccessToken を取得することにより、システム内のユーザーのアカウントをRedditアカウントに接続する方法に注意してください。

フロントエンドに関しては–それは非常に簡単です：

<h1>Welcome, 
<a href="profile" sec:authentication="principal.username">Bob</a></small>
</h1>
<a th:if="${#authentication.principal.user.accessToken == null}" href="redditLogin" >
    Connect your Account to Reddit
</a>

また、投稿を送信する前に、ユーザーが自分のアカウントをRedditに接続していることを確認する必要があります。

@RequestMapping("/post")
public String showSubmissionForm(Model model) {
    if (getCurrentUser().getAccessToken() == null) {
        model.addAttribute("msg", "Sorry, You did not connect your account to Reddit yet");
        return "submissionResponse";
    }
    ...
}

6. 結論

小さなredditアプリは間違いなく前進しています。

Redditによって完全にサポートされている古い認証フローは、いくつかの問題を引き起こしていました。これで、クリーンでシンプルなフォームベースのログインが可能になりましたが、バックエンドでRedditAPIに接続することもできます。

いい物。

getdocs

13036