ユーザー登録時のメール認証機能の実装方法

はじめに

webサービスを作成した際に実装したメール認証機能の流れを紹介します。
必要な操作はDB登録と重複のチェックくらいで以外とシンプルです。
ただ、当初は実装方法のイメージを持つまで時間がかかってしまったので、
実装の流れを中心に紹介していきたいと思います。

全体の流れ：
1. (ユーザー)メールアドレスとパスワードを入力
2. (システム)UUIDを生成してユーザー情報と一緒に一時テーブルに保存
3. (システム)ユーザーに認証URLを送付
4. (ユーザー)メールアドレスから認証URLをクッリク
5. (システム)UUIDに該当する一時テーブルのユーザーを、正式にユーザー登録

1.メールアドレスとパスワードを入力

AjaxでもPostでも好きな方法でユーザー情報をサーバーサイドに渡してください。

2.3.ユーザー情報を一時テーブルに保存 & ユーザーに認証URLを送付

以下のような流れで処理していきます。

1. 入力されたユーザー情報を受け取る
2. 入力されたメールアドレスがすでに登録されていないか確認
3. 確認が取れた場合、UUIDと一緒に一時テーブルにユーザーを保存
4. 認証URLを生成してユーザーにメール送付します。認証URLは/validate/id=UUIDとしています。

ユーザーがURLをクリックしたことを識別するには、
URLに一時テーブルに保存したユーザーと紐づく情報を追加しておく必要があります。
バッティングしたり予測できてしまうと、他人の一時ユーザーを認証できてしまうので、
UUIDを使用します。

RegisterUserController

boolean isMember = memberRepository.existsByUsername(user);


            if(!isMember){
            String vali = UuidUtil.generateUUID();
            BCryptPasswordEncoder passEncoder = new BCryptPasswordEncoder();




            try {
                TmpMember tmpMember = new TmpMember(user, passEncoder.encode(pass), displyname, vali);
                tmpMemberRepository.saveAndFlush(tmpMember);
            } catch (Exception e) {
                e.printStackTrace();
                //status = "エラー：DB保存失敗";
                return status;
            }

            String IPadnPort = myIP.getYourIP();
            String from = "送信元のメールアドレス";
            String title = "Tobidemo アカウント確認のお願い";
            String content = displyname + "さん" + "\n" + "\n" + "以下のリンクにアクセスしてアカウントを認証してください" + "\n"
                    +"http://" + IPadnPort
                    + "/validate"+ "?id=" + vali ;

            try {
                SimpleMailMessage msg = new SimpleMailMessage();

                msg.setFrom(from);
                msg.setTo(user);
                msg.setSubject(title);// タイトルの設定
                msg.setText(content); // 本文の設定
                mailSender.send(msg);
            } catch (Exception e) {
                e.printStackTrace();
                //status = "エラー：メール送付失敗";
                return status;
            }

            status = "ok";
            }
            return status; //ng

        }
        ;
        return status; //ng

    }

4.メールアドレスから認証URLをクッリク

以下のようなメールがユーザーに送付されます。

5.UUIDに該当する一時テーブルのユーザーを正式にユーザー登録

ユーザーがURLをクリックしてアクセスした場合、id= のUUIDを受け取ります。
受け取ったUUIDが一時テーブルに保存されているか確認します。
確認が取れた場合、認証済みのユーザー情報を保管するテーブルに、
登録し直します。
その後、サービスのログインページにリダイレクトしています。

ValidateUserController.java

@CrossOrigin
    @RequestMapping(value = "/validate", method = RequestMethod.GET)
    public String validate(RedirectAttributes redirectAttributes,ModelAndView mav, @RequestParam("id") String id) throws Exception {

        String isRegisterd = "false";
        boolean isExist = tmpMemberRepository.existsByValidation(id);


        //System.out.println(isExist);

        if (isExist) {
            try {
                TmpMember tmp = tmpMemberRepository.findByValidation(id);
                String username = tmp.getUsername();
                String displyname = tmp.getDisplyname();
                String password = tmp.getPassword();


                Member member = new Member();
                member.setDisplyname(displyname);
                member.setPassword(password);
                member.setUsername(username);

                memberRepository.saveAndFlush(member);

                isRegisterd = "true";

            } catch (Exception e) {
                // TODO 自動生成された catch ブロック
                e.printStackTrace();
                 isRegisterd = "false";
            }


        }
        redirectAttributes.addFlashAttribute("isRegisterd", isRegisterd);
         return "redirect:/edit/begin";
    }

まとめ

最低限の機能ですが、意外と簡単にメール認証を実装することができました。
自前のメール認証ロジックなので、おかしなところがあるのかもしれないのですが、個人開発なので動くこと重視です！