SpringBoot tokenを使って簡単に認証できる具体的な実現方法


本論文ではSpring Bootを用いてRedisと結合して簡単なtoken認証を行う。
1.概要
会社が変わったばかりなので、最近はちょっと忙しいです。だから、友達から登録についての質問がありました。ここではまず簡単にtoken鑑権を使う文章を書きます。後で高次の文章を補充します。だから、この文章が簡単だと感じたら、直接回り道ができます。一定の安全性を保証するために、tokenを使った会話の検証が流行しています。一般的な流れは以下の通りです。
  • ユーザがログイン要求インターフェースを登録すると、ユーザ名パスワードなどを検証し、認証に成功したらフロントエンドのtokenに戻ります。このtokenは後認証の唯一の証明です。
  • バックグラウンドは、tokenをredisまたはデータベースに格納することができる。
  • の後、フロントエンドの要求は、headerにtokenを携帯し、バックエンドはtokenを取り出してRedisまたはデータベースに検証を行う必要があり、検証が通れば、実行し、もし通らなければ動作を拒否する。
  • もちろん、上のような言い方は簡単に実現するだけで、実質的には最適化するべきところがたくさんあります。
    2.具体的な実現
    2.1工事構造
    本論文の工程構造は以下の通りである。

    その中:
  • config:スクリーンセーバを構成するための
  • controller:ここでは、Login Controller(ログインとログアウトのための)とTestController(未登録の効果をテストするための)
  • だけが作成されています。
  • interceptor:ブロックコードを作成する
  • service:操作redisのコードと登録に関するコードのみを書き込みました。
    2.2コード実現
    本論文では、redisを使用してtoken情報を記憶し、ユーザーは固定ユーザーを作成しただけで、pomに関連する依存性を追加し、完全な内容は以下の通りである。
    
    <?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
     <parent>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-parent</artifactId>
     <version>2.2.0.RELEASE</version>
     <relativePath/> <!-- lookup parent from repository -->
     </parent>
     <groupId>com.dalaoyang</groupId>
     <artifactId>springboot2_redis_login</artifactId>
     <version>0.0.1-SNAPSHOT</version>
     <name>springboot2_redis_login</name>
     <description>springboot2_redis_login</description>
    
     <properties>
     <java.version>1.8</java.version>
     </properties>
    
     <dependencies>
     <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-data-redis</artifactId>
     </dependency>
     <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-web</artifactId>
     </dependency>
     <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-devtools</artifactId>
      <scope>runtime</scope>
      <optional>true</optional>
     </dependency>
     <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-test</artifactId>
      <scope>test</scope>
      <exclusions>
      <exclusion>
       <groupId>org.junit.vintage</groupId>
       <artifactId>junit-vintage-engine</artifactId>
      </exclusion>
      </exclusions>
     </dependency>
     </dependencies>
    
     <build>
     <plugins>
      <plugin>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-maven-plugin</artifactId>
      </plugin>
     </plugins>
     </build>
    
    </project>
    設定ファイルに対応するRedis情報を設定します。
    
    server.port=8888
    ##redis  
    spring.redis.host=localhost
    spring.redis.port=6379
    
    次にredis関連の操作を作成します。ここではget、set、deleteまでの操作が必要です。RedisTemplateを簡単に使用します。Redis Serviceの内容は以下の通りです。
    
    package com.dalaoyang.service;
    
    import org.springframework.data.redis.core.RedisTemplate;
    import org.springframework.data.redis.core.ValueOperations;
    import org.springframework.data.redis.serializer.RedisSerializer;
    import org.springframework.data.redis.serializer.StringRedisSerializer;
    import org.springframework.stereotype.Service;
    
    import javax.annotation.Resource;
    
    @Service
    public class RedisService {
      @Resource
      private RedisTemplate<String,Object> redisTemplate;
    
      public void set(String key, Object value) {
        //   redis    key    
        RedisSerializer redisSerializer =new StringRedisSerializer();
        redisTemplate.setKeySerializer(redisSerializer);
        ValueOperations<String,Object> vo = redisTemplate.opsForValue();
        vo.set(key, value);
      }
    
      public Object get(String key) {
        ValueOperations<String,Object> vo = redisTemplate.opsForValue();
        return vo.get(key);
      }
    
      public Boolean delete(String key) {
        return redisTemplate.delete(key);
      }
    }
    LoginnServiceはログインとログアウトだけを行います。ログインはユーザ名のパスワードが正しいかどうかを先に判断します。正しい場合、tokenとして文字列を生成します。また、リターン値としてパスワードが間違っていたらエラーを提示します。ログアウトの実質はredisのtokenのキャッシュを削除することです。完全な内容は以下の通りです。
    
    package com.dalaoyang.service;
    
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.stereotype.Service;
    
    import javax.servlet.http.HttpServletRequest;
    import java.util.Objects;
    import java.util.UUID;
    
    @Service
    public class LoginService {
    
      @Autowired
      private RedisService redisService;
    
      public String login(String username, String password) {
        if (Objects.equals("dalaoyang", username) &&
            Objects.equals("123", password)) {
          String token = UUID.randomUUID().toString();
          redisService.set(token, username);
          return "  :" + username + "    ,token :" + token;
        } else {
          return "        ,    !";
        }
      }
    
      public String logout(HttpServletRequest request) {
        String token = request.getHeader("token");
        Boolean delete = redisService.delete(token);
        if (!delete) {
          return "    ,       !";
        }
        return "    !";
      }
    }
    
    
    Login Controllerの内容は簡単で、LoginnServiceの簡単な呼び出しだけです。以下の通りです。
    
    package com.dalaoyang.controller;
    
    
    import com.dalaoyang.service.LoginService;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    import javax.servlet.http.HttpServletRequest;
    
    @RestController
    @RequestMapping("/login")
    public class LoginController {
    
      @Autowired
      private LoginService loginService;
    
      @GetMapping({"/", ""})
      public String login(String username, String password) {
        return loginService.login(username, password);
      }
    
      @GetMapping("/logout")
      public String logout(HttpServletRequest request) {
        return loginService.logout(request);
      }
    }
    
    
    TestControllerには文字列を単純に返すインターフェースだけが書かれています。以下の通りです。
    
    package com.dalaoyang.controller;
    
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    @RestController
    @RequestMapping("/test")
    public class TestController {
    
      @GetMapping({"/", ""})
      public String dosomething() {
        return "dosomething";
      }
    }
    
    
    続いてスクリーンセーバーです。スクリーンセーバーの中からheaderのtokenを取り出して、redisに行って判断します。もしあるなら、操作が許可されたら、ヒント情報に戻ります。内容は以下の通りです。
    
    package com.dalaoyang.interceptor;
    
    import com.dalaoyang.service.RedisService;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.util.StringUtils;
    import org.springframework.web.servlet.HandlerInterceptor;
    import org.springframework.web.servlet.ModelAndView;
    
    import javax.servlet.http.HttpServletRequest;
    import javax.servlet.http.HttpServletResponse;
    import java.util.Objects;
    
    public class AuthInterceptor implements HandlerInterceptor {
    
      @Autowired
      private RedisService redisService;
    
      @Override
      public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        response.setCharacterEncoding("UTF-8");
        response.setContentType("text/html;charset=utf-8");
        String token = request.getHeader("token");
        if (StringUtils.isEmpty(token)) {
          response.getWriter().print("     ,      !");
          return false;
        }
        Object loginStatus = redisService.get(token);
        if( Objects.isNull(loginStatus)){
          response.getWriter().print("token  ,   !");
          return false;
        }
        return true;
      }
    
      @Override
      public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
    
      }
    
      @Override
      public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
    
      }
    }
    
    
    最後にスクリーンショットを配置します。スクリーンショットにはRedisServiceが使われていますので、ここでは以下のようにスクリーンに注入する必要があります。
    
    package com.dalaoyang.config;
    
    import com.dalaoyang.interceptor.AuthInterceptor;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
    import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
    
    @Configuration
    public class AuthConfig implements WebMvcConfigurer {
    
      @Bean
      public AuthInterceptor initAuthInterceptor(){
        return new AuthInterceptor();
      }
    
      @Override
      public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(initAuthInterceptor()).addPathPatterns("/test/**").excludePathPatterns("/login/**");
      }
    
    }
    
    
    内容はここで完成しました。
    3.テスト
    以下の手順で簡単なテストができます。
    まずブラウザからアクセス:http://localhost:8888/testを選択します。ヒントが見えます。
    ユーザはログインしていません。ログインしてから操作してください。
    エラーパスワードブラウザでアクセス:http://localhost:8888/login?username=dalaoyang&password=1が表示されます
    ログインに失敗しました。
    ブラウザでユーザ名パスワードでアクセス:http://localhost:8888/login?username=dalaoyang&password=123が表示されます
    ユーザ:dalaoyang登録に成功しました。tokenは:02 fdd 2 bd-1669-48 b 9-b 51 b-1 e 724 f 97688 fです。
    httpツールを使って、postmanなど、tokenをheaderに入れて、要求:http://localhost:8888/testヒントを見て、成功を願う。
    dosomething
    4.拡張点
    本論文は単にtokenを使用してサンプルを作っただけで、生産環境には適用されません。
  • ここでredis値が格納されているのは、usernameだけであり、利用されていないので、実際にはユーザ情報などを記憶することができる。
  • は、jwtを用いてtoken管理を拡張することができる。
  • は、いくつかの固定されたtokenを内部インターフェース呼び出しなどとして利用することができる。
  • tokenの生成規則に注意して、規則があって他の人に利用させないでください。
  • 5.ソースコード
    ソースアドレス:https://gitee.com/dalaoyang/springboot_learn/tree/master/sprigboot 2_redis_ロゴ
    以上が本文の全部です。皆さんの勉強に役に立つように、私たちを応援してください。