当前位置： 首页 > news >正文

用户模块——redis工具类

news 来源：原创 2025/5/1 21:01:27

1. Redis工具类与基础配置

1.1 什么是Redis，为什么使用它？

        Redis（Remote Dictionary Server）是一个开源的高性能键值对存储数据库，通常用于缓存数据、存储会话信息等场景。它的主要优点是速度快，支持多种数据结构（如字符串、哈希、列表、集合等）。在开发中，我们经常使用Redis来加速数据读取，减轻数据库压力，提升应用性能。

1.2 为什么要使用Redis工具类？

        在实际开发中，我们通常会遇到频繁操作Redis的情况（例如存取数据、设置过期时间等）。如果每次都直接使用StringRedisTemplate进行操作，代码会变得冗长和重复。为了解决这个问题，我们可以封装一个Redis工具类，将常用的Redis操作封装成简单的方法，方便代码复用，同时也让我们的代码更加简洁。

1.3 配置Redis数据源

        首先，我们需要在Spring Boot项目中配置Redis数据源，确保我们的应用可以连接到Redis数据库。通常，我们会在application.properties或者application.yml文件中配置Redis的连接信息。以下是一个简单的配置示例：

# application.properties文件
spring.redis.host=localhost      # Redis服务器地址
spring.redis.port=6379           # Redis服务器端口
spring.redis.password=yourpassword  # Redis密码（如果有的话）
spring.redis.timeout=2000ms      # Redis连接超时时间

1.4 创建Redis工具类

        现在，我们来创建一个简单的Redis工具类RedisUtils。该工具类主要使用Spring提供的StringRedisTemplate来操作Redis。为了简化操作，我们将一些常见的方法封装成静态方法。

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.StringRedisTemplate;
import org.springframework.stereotype.Component;

@Component
public class RedisUtils {

    @Autowired
    private StringRedisTemplate stringRedisTemplate;

    // 设置键值对
    public static void set(String key, String value) {
        stringRedisTemplate.opsForValue().set(key, value);
    }

    // 获取值
    public static String get(String key) {
        return stringRedisTemplate.opsForValue().get(key);
    }

    // 删除键值对
    public static void delete(String key) {
        stringRedisTemplate.delete(key);
    }
    
    // 设置带过期时间的键值对
    public static void setWithExpiration(String key, String value, long timeout) {
        stringRedisTemplate.opsForValue().set(key, value, timeout);
    }
}

代码说明：

  • set(String key, String value)：将一个键值对存入Redis。
  • get(String key)：根据键从Redis中获取值。
  • delete(String key)：删除指定的键。
  • setWithExpiration(String key, String value, long timeout)：将键值对存入Redis，并设置一个过期时间（单位为秒）。

1.5 使用Redis工具类

        接下来，我们可以在项目中的其他部分通过调用这些工具方法来进行Redis操作。例如，在控制器中获取和存储数据：

@RestController
@RequestMapping("/redis")
public class RedisController {

    @Autowired
    private RedisUtils redisUtils;

    @GetMapping("/set")
    public String setValue() {
        redisUtils.set("name", "Redis Tutorial");
        return "Data has been saved to Redis!";
    }

    @GetMapping("/get")
    public String getValue() {
        String value = redisUtils.get("name");
        return value != null ? "Retrieved value: " + value : "No value found!";
    }
}

代码说明：

  • setValue()：通过调用redisUtils.set()方法将数据存入Redis。
  • getValue()：通过调用redisUtils.get()方法从Redis中获取数据。

1.6 小结

        通过封装Redis工具类，我们能够简化对Redis的操作，让代码更加简洁和可维护。我们不再需要每次都手动操作StringRedisTemplate，而是通过工具类提供的方法直接进行存取操作。

        在后面的部分，我们将进一步扩展功能，例如如何使用Redisson实现分布式锁，如何使用Redis进行JWT认证等。但无论做什么，掌握好基本的Redis操作都是至关重要的第一步。

2. 分布式锁与Redisson

2.1 什么是分布式锁？

        在分布式系统中，多个应用或服务器可能会同时访问同一资源（例如数据库、缓存等），这就可能导致并发冲突和数据不一致的情况。分布式锁是一种用于保证同一时刻只有一个客户端能访问共享资源的机制，确保资源在并发访问时的一致性。

        举个简单例子，假设有一个购物车系统，多个用户同时抢购限量商品，如果不加锁，可能会导致商品数量减不下来，甚至超卖。这时，就需要用到分布式锁来控制同时只有一个用户能成功购买。

2.2 为什么需要Redisson？

        在Redis中，我们可以利用setnx命令来模拟加锁和解锁操作，但是这种方式有很多不足之处，像锁超时、并发问题等都需要额外的处理。为了简化这一过程，Redisson是一个优秀的工具，它提供了简单易用的分布式锁实现，避免了低级错误。

Redisson是基于Redis的客户端，它封装了很多复杂的操作，例如分布式锁、消息队列、分布式集合等。通过Redisson，开发者可以轻松实现分布式锁，并且避免了很多底层细节。

2.3 如何使用Redisson实现分布式锁？

        在Spring Boot项目中，使用Redisson非常简单。我们只需要先引入相关的依赖，然后配置Redisson客户端，最后通过Redisson提供的API来加锁和解锁。

2.3.1 引入Redisson依赖

首先，在pom.xml中添加Redisson的依赖：

<dependency>
    <groupId>org.redisson</groupId>
    <artifactId>redisson</artifactId>
    <version>3.16.3</version>
</dependency>

2.3.2 配置Redisson

接下来，我们需要配置Redisson的客户端，连接到Redis。你可以在application.properties中添加Redis的连接配置。

spring.redis.host=localhost
spring.redis.port=6379
spring.redis.password=yourpassword  # 可选
spring.redis.timeout=2000ms

然后，我们在配置类中创建Redisson客户端实例：

import org.redisson.api.RedissonClient;
import org.redisson.client.RedisClient;
import org.redisson.config.Config;
import org.redisson.spring.starter.RedissonAutoConfiguration;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class RedissonConfig {

    @Bean
    public RedissonClient redissonClient() {
        Config config = new Config();
        config.useSingleServer().setAddress("redis://localhost:6379");  // 配置Redis服务器地址
        return Redisson.create(config);
    }
}

2.3.3 使用Redisson分布式锁

        接下来，我们就可以在业务逻辑中使用Redisson提供的分布式锁了。Redisson提供的锁是RLock类型，类似于ReentrantLock。

import org.redisson.api.RLock;
import org.redisson.api.RedissonClient;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
public class OrderService {

    @Autowired
    private RedissonClient redissonClient;

    // 模拟创建订单的操作
    public void createOrder(String orderId) {
        RLock lock = redissonClient.getLock("order-lock:" + orderId);  // 使用订单ID作为锁的标识

        try {
            // 尝试获取锁，最多等待10秒，锁定后最多保持5秒
            if (lock.tryLock(10, 5, TimeUnit.SECONDS)) {
                // 如果成功获取锁，则执行下列业务逻辑
                System.out.println("锁定成功，开始处理订单：" + orderId);
                // 模拟处理订单的操作
                Thread.sleep(2000);  // 假装正在处理订单
                System.out.println("订单处理完成：" + orderId);
            } else {
                System.out.println("获取锁失败，订单正在处理：" + orderId);
            }
        } catch (InterruptedException e) {
            e.printStackTrace();
        } finally {
            // 确保锁被释放
            if (lock.isHeldByCurrentThread()) {
                lock.unlock();
                System.out.println("锁已释放");
            }
        }
    }
}

代码说明：

  • redissonClient.getLock("order-lock:" + orderId)：这里我们使用order-lock:{orderId}作为锁的唯一标识，每个订单使用独立的锁，避免多个用户并发抢购同一订单时发生冲突。
  • lock.tryLock(10, 5, TimeUnit.SECONDS)：尝试在10秒内获取锁，获取锁后，最多保持5秒。超时后，自动释放锁。
  • lock.unlock()：释放锁，确保其他线程能够获取锁。

2.4 小结

        使用Redisson可以简化分布式锁的实现，它封装了很多底层细节，帮助我们轻松实现分布式环境下的锁机制，确保资源在并发情况下的一致性。在高并发场景中，分布式锁能够有效防止数据竞态问题，提高系统的可靠性。

        通过Redisson提供的简单API，我们可以轻松地将分布式锁引入到项目中，确保同一资源只能被一个线程访问，避免了并发冲突。

3. JWT认证与Token管理

3.1 什么是JWT？

        JWT（JSON Web Token）是一种用于在网络应用环境中传递声明的方式，主要用于身份认证和信息交换。它是一个由三部分组成的字符串，用于安全地在各方之间传递信息。

JWT的结构如下：

header.payload.signature
  • Header（头部）：通常包含令牌的类型（JWT）和加密算法（如HMAC SHA256或RSA）。
  • Payload（负载）：包含声明（claims），也就是传递的信息，比如用户的ID、角色等。这些信息是编码的，但不加密，所以不要在payload中存储敏感信息。
  • Signature（签名）：通过Header和Payload使用秘钥加密生成，用于验证JWT是否被篡改。

3.2 JWT认证的流程

JWT认证常用于无状态的认证系统。JWT认证流程通常如下：

  1. 用户登录：用户通过用户名和密码登录系统。
  2. 生成JWT Token：系统验证用户身份，如果验证成功，服务器生成一个JWT Token，并将其返回给客户端。此Token中包含用户的相关信息（例如用户ID、角色等）。
  3. Token存储：客户端将JWT Token存储在本地，通常保存在浏览器的localStorage或sessionStorage中。
  4. 携带Token请求接口：当用户请求受保护的接口时，客户端会将JWT Token放入HTTP请求头中，发送给服务器。
  5. 服务器验证Token：服务器收到请求后，会检查请求头中的JWT Token是否合法。如果合法，服务器允许访问相应的资源；如果不合法，返回401 Unauthorized错误。

3.3 如何使用JWT生成Token？

在Spring Boot中，我们可以通过使用jjwt库来生成JWT Token。首先，需要在pom.xml文件中引入jjwt依赖：

<dependency>
    <groupId>io.jsonwebtoken</groupId>
    <artifactId>jjwt</artifactId>
    <version>0.11.5</version>
</dependency>

3.3.1 创建JWT工具类

接下来，我们创建一个JwtUtils类，负责生成和解析JWT Token：

import io.jsonwebtoken.Jwts;
import io.jsonwebtoken.SignatureAlgorithm;
import java.util.Date;

public class JwtUtils {

    private static final String SECRET_KEY = "your-secret-key"; // 请使用更安全的秘钥

    // 生成JWT Token
    public static String generateToken(String userId) {
        return Jwts.builder()
                .setSubject(userId)  // 设置JWT的主体
                .setIssuedAt(new Date())  // 设置Token的发行时间
                .setExpiration(new Date(System.currentTimeMillis() + 3600000))  // 设置过期时间1小时
                .signWith(SignatureAlgorithm.HS256, SECRET_KEY)  // 使用HS256算法和秘钥签名
                .compact();  // 构建JWT
    }

    // 解析JWT Token
    public static String parseToken(String token) {
        return Jwts.parser()
                .setSigningKey(SECRET_KEY)  // 使用秘钥验证Token
                .parseClaimsJws(token)  // 解析Token
                .getBody()
                .getSubject();  // 获取Token中的用户ID
    }
}

代码解释：

  • generateToken(String userId)：生成JWT Token，包含用户ID（userId），设置有效期为1小时，并使用HS256算法进行签名。
  • parseToken(String token)：解析JWT Token，验证签名，并从Token中获取用户ID。

3.4 使用JWT Token进行认证

        接下来，我们可以在Spring Boot的登录功能中使用JWT来管理Token。在用户登录时，服务器验证用户信息，生成并返回JWT Token：

import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class AuthController {

    @PostMapping("/login")
    public String login(@RequestBody LoginRequest loginRequest) {
        // 假设用户名和密码已经验证通过
        String userId = loginRequest.getUsername();  // 获取用户ID（这里简化）
        
        // 生成JWT Token
        String token = JwtUtils.generateToken(userId);
        
        // 返回生成的Token
        return "Bearer " + token;  // 返回格式为 "Bearer <Token>"
    }
}
代码解释：
  • 用户通过POST请求传递用户名和密码，服务器验证用户身份后，生成JWT Token。
  • 登录成功后，返回JWT Token。客户端可以将此Token保存在本地。

3.5 Token验证与使用

客户端每次请求时，都需要将JWT Token放入HTTP请求头中：

Authorization: Bearer <JWT Token>

服务器收到请求后，解析Token，验证其合法性，并根据Token中的信息执行相关操作。

在Spring Boot中，可以通过过滤器来验证Token：

import org.springframework.web.filter.OncePerRequestFilter;
import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebFilter;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

@WebFilter("/protected/*")
public class JwtFilter extends OncePerRequestFilter {

    @Override
    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {
        String token = request.getHeader("Authorization");

        if (token != null && token.startsWith("Bearer ")) {
            token = token.substring(7);  // 去掉Bearer前缀
            try {
                String userId = JwtUtils.parseToken(token);  // 解析Token
                request.setAttribute("userId", userId);  // 将用户ID添加到请求中
            } catch (Exception e) {
                response.setStatus(HttpServletResponse.SC_UNAUTHORIZED);  // Token无效，返回401
                return;
            }
        }

        filterChain.doFilter(request, response);  // 放行请求
    }
}

3.6 小结

        JWT是一种简洁且高效的身份验证方式，它通过将用户身份信息封装在Token中，避免了频繁查询数据库验证用户身份。我们可以利用JWT进行无状态的认证，实现安全、便捷的API访问。

        在这部分，我们介绍了JWT的基本原理、如何生成和解析Token，以及如何在Spring Boot项目中使用JWT来管理用户的认证信息。通过这种方式，我们可以轻松地实现一个安全的认证系统，避免了传统的Session机制带来的许多问题。

4. 综合应用：实现用户登录与分布式锁

        在这一部分，我们将结合之前讲到的JWT认证和Redisson分布式锁，创建一个简单的用户登录系统，并在用户登录时使用分布式锁来防止多个请求同时登录，确保系统的并发安全。

4.1 用户登录的流程

用户登录流程通常包含以下步骤：

  1. 用户提交用户名和密码。
  2. 服务器验证用户名和密码是否正确。
  3. 如果验证成功，生成JWT Token并返回给用户。
  4. 用户使用JWT Token进行后续的API请求认证。

4.2 为什么需要分布式锁？

        在高并发场景下，如果多个请求同时试图登录同一个用户，会导致数据的不一致性。例如，多个请求同时向数据库写入用户登录信息，可能会出现覆盖或重复记录的情况。

为了解决这个问题，我们使用分布式锁来确保同一时刻只有一个请求能进行登录操作，其他请求需要等待锁释放后才能继续执行。这样就可以防止出现并发问题。

4.3 使用Redisson实现分布式锁

        Redisson是基于Redis的分布式锁实现，它可以帮助我们确保分布式系统中的不同节点在执行某个操作时能够同步，避免多个线程同时执行某个资源的操作。

首先，我们需要在pom.xml文件中引入Redisson的依赖：

<dependency>
    <groupId>org.redisson</groupId>
    <artifactId>redisson</artifactId>
    <version>3.16.2</version>
</dependency>

4.3.1 配置Redisson

我们使用Spring Boot配置Redisson的数据源。可以在application.properties中添加以下配置：

spring.redis.host=127.0.0.1
spring.redis.port=6379

然后，创建一个RedissonConfig类来配置Redisson客户端：

import org.redisson.api.RedissonClient;
import org.redisson.client.RedisClient;
import org.redisson.config.Config;
import org.redisson.Redisson;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class RedissonConfig {

    @Bean
    public RedissonClient redissonClient() {
        Config config = new Config();
        config.useSingleServer()
              .setAddress("redis://127.0.0.1:6379"); // 连接到本地Redis

        return Redisson.create(config);
    }
}

4.3.2 实现分布式锁

接下来，我们创建一个LoginService类，在登录操作中使用分布式锁来防止并发问题：

import org.redisson.api.RLock;
import org.redisson.api.RedissonClient;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
public class LoginService {

    @Autowired
    private RedissonClient redissonClient;

    // 用于模拟用户登录
    public String login(String username, String password) {
        // 锁的名字是"loginLock"
        RLock lock = redissonClient.getLock("loginLock");

        try {
            // 尝试加锁，最多等待10秒，锁住后最多持有30秒
            if (lock.tryLock(10, 30, java.util.concurrent.TimeUnit.SECONDS)) {
                try {
                    // 模拟用户验证（实际情况中可以验证用户名密码）
                    if ("user".equals(username) && "password".equals(password)) {
                        // 登录成功，生成JWT Token
                        String token = JwtUtils.generateToken(username);
                        return "Login successful! Token: " + token;
                    } else {
                        return "Invalid username or password!";
                    }
                } finally {
                    // 确保释放锁
                    lock.unlock();
                }
            } else {
                return "Please try again later. The system is busy.";
            }
        } catch (InterruptedException e) {
            Thread.currentThread().interrupt();
            return "An error occurred. Please try again.";
        }
    }
}

代码解释：

  • redissonClient.getLock("loginLock")：通过Redisson客户端获取名为loginLock的锁。如果多个请求同时进入这段代码，只有一个请求能够成功获得锁，其他请求会等待。
  • lock.tryLock(10, 30, TimeUnit.SECONDS)：尝试加锁，如果10秒内无法获取锁，就返回false；如果加锁成功，锁会持有30秒，之后会自动释放。
  • lock.unlock()：在完成登录操作后释放锁，以便其他请求可以继续处理。

4.3.3 调用登录接口

在AuthController中，我们调用LoginService来处理登录请求：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class AuthController {

    @Autowired
    private LoginService loginService;

    @PostMapping("/login")
    public String login(@RequestBody LoginRequest loginRequest) {
        return loginService.login(loginRequest.getUsername(), loginRequest.getPassword());
    }
}

代码解释：

  • 用户通过POST请求传递用户名和密码，AuthController接收请求并将其交给LoginService处理。
  • LoginService使用分布式锁确保同一时刻只有一个请求能执行登录操作，从而防止并发问题。

4.4 总结

        在这一部分，我们结合了JWT认证和Redisson分布式锁，创建了一个简单的用户登录系统。在登录时，我们通过分布式锁保证同一时刻只有一个请求可以进行登录操作，避免并发冲突。

  1. JWT认证：用于生成和管理用户的认证Token。
  2. Redisson分布式锁：通过分布式锁确保并发情况下的线程安全，避免多个请求同时修改数据。

        通过这种方式，我们可以在分布式系统中有效地管理用户登录，同时确保系统的高并发环境下的数据一致性和安全性。

5. 总结：实现用户登录与分布式锁

        在本文中，我们详细讲解了如何实现一个带有JWT认证和分布式锁的用户登录系统。通过结合这两者的技术，我们能够在高并发的情况下保证系统的安全性和稳定性。

5.1 主要技术点回顾

  1. JWT认证：

    • JWT（JSON Web Token） 是一种轻量级的认证机制，用于在客户端和服务端之间传递身份信息。
    • 在用户登录成功后，我们生成一个JWT Token，并将其返回给用户，用户后续的每个请求都可以带上这个Token，服务器用它来验证用户身份。
    • JWT中包含了用户信息和过期时间等，保证了传输过程中的安全性和有效性。

  2. Redisson分布式锁：

    • 在多线程或分布式系统中，Redisson分布式锁确保在同一时刻，只有一个请求能执行关键操作，其他请求需等待。
    • 通过在关键操作前后加锁与解锁，避免了多个请求同时操作同一资源导致数据不一致的问题。
    • Redisson通过Redis提供强大的分布式支持，能够在多个实例之间进行锁的协调，保证操作的原子性。

5.2 如何避免并发问题

        在实际开发中，很多时候我们需要处理高并发的情况。以用户登录为例，当多个请求同时尝试登录同一个用户时，如果不加以控制，可能会导致以下问题：

  • 多个请求同时更新数据库，可能导致用户信息的覆盖或数据丢失。
  • 同时发放多个Token，可能造成安全隐患。

        通过引入分布式锁，我们能够在请求进入登录操作时，确保只有一个请求能执行登录逻辑，其他请求会等待锁释放。这样就能有效避免并发冲突。

5.3 结合JWT和Redisson锁的好处

  1. 安全性：JWT通过加密保证了Token的安全性，避免了Token被篡改的风险。
  2. 高并发支持：通过Redisson的分布式锁机制，我们在高并发情况下也能保证操作的顺序性和数据的一致性。
  3. 简化管理：JWT使得我们能够在不同系统间轻松传递身份信息，而Redisson则让我们能够在分布式环境下管理锁，避免了传统分布式系统中的复杂问题。

5.4 最后的一些注意事项

  • 在实际生产环境中，使用JWT时需要注意Token的过期时间和更新机制，确保Token不被长期滥用。
  • 在Redisson分布式锁的使用中，需要避免锁的“死锁”情况，确保在操作完成后及时释放锁。
  • 使用分布式锁时要保证锁粒度尽可能小，避免长时间持有锁，影响其他请求的响应速度。

5.5 小结

        今天我们学习了如何结合JWT认证和Redisson分布式锁来实现一个安全且高效的用户登录系统。通过JWT，我们可以确保用户身份的验证和信息的安全性；通过Redisson分布式锁，我们可以解决并发问题，确保系统在高并发环境下的稳定性。

        随着分布式系统和微服务的普及，这些技术的应用变得越来越重要。希望通过这篇文章，你能够理解JWT和Redisson分布式锁的基本原理，并能够在实际项目中运用这些技术来解决问题。

相关文章：

  • 04 | 初始化 fastgo 项目仓库
  • tcp/ip协议中网络层协议的主要特点，tcp/ip协议中网络层都有哪些协议？
  • c# 2025/3/12 周三
  • MyBatis 的核心配置文件是干什么的？ 它的结构是怎样的？ 哪些是必须配置的，哪些是可选的？
  • AI重构SEO关键词布局
  • TA学习之路——1.4 MVP矩阵运算
  • 安全左移动赋能：灵脉IAST交互式应用安全测试平台
  • Python的日志
  • HarmonyOS学习第19天:感知世界的 “超能力”，HarmonyOS 传感器揭秘
  • ChātGPT开发“SolidWorks工具箱”，可建海量3D模型库，能一键画图、批量赋属性、自动出图，效率提高10倍
  • 浅拷贝和深拷贝AI
  • 复试数据库原理总结
  • Unity3D网格简化与LOD技术详解
  • Linux 内核文件读取与内存映射管理机制的理解心得
  • 「 机器人 」扑翼飞行器通过总气动力控制四自由度运动方法
  • LLM：了解大语言模型
  • Cadence 学习笔记(1)
  • 《解锁Flutter：跨平台开发的未来之光》
  • 【NLP 36、CRF条件随机场 —— 源码解读】
  • 告别复杂日志解析 用bin2sql轻松实现MySQL数据闪回
  • 长三角铁路今日预计发送旅客420万人次，有望创单日客发量新高
  • 海南机场拟超23亿元收购美兰空港控股权，进一步聚焦机场主业
  • 经营业绩持续稳中向好，国铁集团2024年度和2025年一季度财务决算公布
  • 过去24小时中美是否就关税问题进行过接触？外交部：没有
  • 上海国际咖啡文化节开幕，北外滩集结了超350个展位
  • 欢迎回家！神十九返回舱成功着陆