碼上快樂

相關內容    簡體    繁體

SpringBoot使用token簡單鑒權

本文轉載自   查看原文   2019-11-02 17:31   5473    SpringBoot/ redis

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

image

1.簡介

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

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

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

2.具體實現

2.1 工程結構

本文工程結構如下：

image

其中：

  • config：用於配置攔截器
  • controller：這里只編寫了LoginController（用於登錄和注銷）和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，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.測試

可以使用如下步驟進行簡單測試：

  1. 首先在瀏覽器訪問：http://localhost:8888/test，可以看到提示

用戶未登錄，請登錄后操作！

  1. 在使用錯誤密碼瀏覽器訪問：http://localhost:8888/login?username=dalaoyang&password=1，看到提示

用戶名或密碼錯誤，登錄失敗！

  1. 在瀏覽器使用用戶名密碼訪問：http://localhost:8888/login?username=dalaoyang&password=123，看到提示

用戶：dalaoyang登錄成功，token是：02fdd2bd-1669-48b9-b51b-1e724f97688f

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

dosomething

4.擴展點

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

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

5.源碼

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


免責聲明！

本站轉載的文章為個人學習借鑒使用，本站對版權不負任何法律責任。如果侵犯了您的隱私權益，請聯系本站郵箱yoyou2525@163.com刪除。



猜您在找 SpringBoot使用token簡單鑒權的具體實現方法 springboot實現token鑒權 如何在SpringBoot中集成JWT(JSON Web Token)鑒權 sa-token 鑒權框架（springboot集成） 使用token機制做登錄鑒權（threadlocal+redis） 接口測試中的cookie鑒權和token鑒權 SpringBoot中使用Shiro和JWT做認證和鑒權 springboot中通過stomp方式來處理websocket及token權限鑒權相關 關於防范csrf攻擊基於token鑒權 基於jwt token機制鑒權架構
 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM