SpringBoot使用token簡單鑒權的具體實現方法

更新時間：2019年11月05日 10:04:50 作者：dalaoyang

這篇文章主要介紹了SpringBoot使用token簡單鑒權的具體實現方法，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧

本文使用SpringBoot結合Redis進行簡單的token鑒權。

1.簡介

剛剛換了公司，所以最近有些忙碌，所以一直沒有什么產出，最近朋友問我登錄相關的，所以這里先寫一篇簡單使用token鑒權的文章，后續(xù)會補充一些高階的，所以如果感覺這篇文章簡單，可以直接繞行，言歸正傳，現在一般系統(tǒng)都進行了前后端分離，為了保證一定的安全性，現在很流行使用token來進行會話的驗證，一般流程如下：

用戶登錄請求登錄接口時，驗證用戶名密碼等，驗證成功會返回給前端一個token，這個token就是之后鑒權的唯一憑證。
后臺可能將token存儲在redis或者數據庫中。
之后前端的請求，需要在header中攜帶token，后端取出token去redis或者數據庫中進行驗證，如果驗證通過則放行，如果不通過則拒絕操作。

當然，如上的說法只是簡單的實現，實質上還有很多需要優(yōu)化的地方。

2.具體實現

2.1 工程結構

本文工程結構如下：

其中：

config：用于配置攔截器
controller：這里只編寫了LoginController（用于登錄和注銷）和TestController（用于測試未登錄效果）
interceptor：編寫攔截器代碼
service：只寫了操作redis的代碼和登錄相關的代碼

2.2 代碼實現

本文使用redis存儲token信息，用戶只是創(chuàng)建了一個固定的用戶，在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，RedisService內容如下：

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);
  }
}

LoginService只是進行登錄和注銷操作，其中登錄就是先判斷用戶名密碼是否正確，如果正確，那么會生成一個字符串做為token（本文中使用uuid），并且做為返回值，密碼錯誤則提示錯誤。注銷實質就是刪除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 "注銷成功！";
  }
}

LoginController內容很簡單，只是對LoginService的簡單調用，如下：

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，看到提示
用戶名或密碼錯誤，登錄失?。?/p>

在瀏覽器使用用戶名密碼訪問：http://localhost:8888/login?username=dalaoyang&password=123，看到提示
用戶：dalaoyang登錄成功，token是：02fdd2bd-1669-48b9-b51b-1e724f97688f

使用http工具，如postman等，將token放入header中，請求：http://localhost:8888/test，看到提示，請求成功。
dosomething

4.擴展點

本文只是簡單對token使用做了一個樣例，并不適用于生產環(huán)境，有很多地方是可以擴展的，比如：

本文redis值存儲的只是username，而且并沒有利用，實際情況可以存儲用戶信息等。
可以擴展使用jwt進行token管理。
可以放行幾個固定的token用作內部接口調用等。
注意token的生成規(guī)則，不要有規(guī)律讓別人利用。

5.源碼

源碼地址：https://gitee.com/dalaoyang/springboot_learn/tree/master/springboot2_redis_login

以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章:

關于RestTemplate中的Get請求
這篇文章主要介紹了關于RestTemplate中的Get請求，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教
2023-07-07
Springboot中@scheduled注解解析
這篇文章主要介紹了Springboot中@scheduled注解解析,定時任務就是在指定時間執(zhí)行程序,或周期性執(zhí)行計劃任務,Java中實現定時任務的方法有很多,本文從從JDK自帶的一些方法來實現定時任務的需求,需要的朋友可以參考下
2023-09-09
Java導入、導出excel用法步驟保姆級教程(附封裝好的工具類)
這篇文章主要介紹了Java導入、導出excel的相關資料,講解了使用Java和ApachePOI庫將數據導出為Excel文件,包括創(chuàng)建工作簿、工作表、行和單元格,設置樣式和字體,合并單元格,添加公式和下拉選擇等功能,需要的朋友可以參考下
2025-03-03
CentOS 7系統(tǒng)下配置自定義JDK的教程
這篇文章主要給大家介紹了在CentOS 7系統(tǒng)下配置自定義JDK的教程，文中將配置的方法教程介紹的非常詳細，對大家具有一定的參考學習價值，需要的朋友們下面來一起看看吧。
2017-06-06
Java實現添加條形碼到PDF表格的方法詳解
條碼的應用已深入生活和工作的方方面面。本文以操作PDF文件為例，介紹如何利用Java語言在編輯表格時，向單元格中添加條形碼，感興趣的可以學習一下
2022-06-06
Java設計模式之責任鏈模式詳解
這篇文章主要介紹了Java設計模式之責任鏈模式詳解,文中有非常詳細的代碼示例,對正在學習java的小伙伴們有非常好的幫助,需要的朋友可以參考下
2021-04-04
SpringBoot結合SpringSecurity實現圖形驗證碼功能
這篇文章主要介紹了SpringBoot + SpringSecurity 實現圖形驗證碼功能，小編覺得挺不錯的，現在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧
2018-05-05
Spring自定義注解實現數據脫敏
在當今數據安全越來越受到重視的背景下,許多企業(yè)都對敏感數據的保護有著嚴格的要求,本文就來深入探討一下如何自定義注解來實現對敏感數據的脫敏處理吧
2024-11-11
淺析Java編程中類和對象的定義
下面小編就為大家?guī)硪黄獪\析Java編程中類和對象的定義。小編覺得挺不錯的，現在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧，祝大家游戲愉快哦
2016-05-05
淺談SpringMVC的執(zhí)行流程
下面小編就為大家?guī)硪黄獪\談SpringMVC的執(zhí)行流程。小編覺得挺不錯的，現在就分享給大家，也給大家做個參考。一起跟隨小編過來看看吧
2017-09-09