【未完成】springboot项目实现扫码登录相关逻辑

准备工作

配置redis

引入redis依赖

<dependencies><!-- Spring Data Redis 依赖 --><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-data-redis</artifactId></dependency><!-- Jedis 依赖 --><dependency><groupId>redis.clients</groupId><artifactId>jedis</artifactId></dependency>
</dependencies>

在application.yml中配置redis

spring:redis:host: 127.0.0.1port: 6379database: 0password: 

配置 Jedis 连接池

@Component
@ConfigurationProperties(prefix = "spring.redis")
public class RedisConfigInfo {private String host;private Integer port;private Integer database;private String password;// 省略getter、setter方法
}

@Configuration
public class JedisConfig {@Autowiredprivate RedisConfigInfo redisConfigInfo;@Beanpublic JedisConnectionFactory jedisConnectionFactory() {RedisStandaloneConfiguration redisStandaloneConfiguration = new RedisStandaloneConfiguration();redisStandaloneConfiguration.setHostName(redisConfigInfo.getHost());redisStandaloneConfiguration.setPort(redisConfigInfo.getPort());String password = redisConfigInfo.getPassword();// 将字符串类型的密码转换为 RedisPassword 类型if (password != null && !password.isEmpty()) {redisStandaloneConfiguration.setPassword(RedisPassword.of(password));} else {redisStandaloneConfiguration.setPassword(RedisPassword.none());}redisStandaloneConfiguration.setDatabase(redisConfigInfo.getDatabase());return new JedisConnectionFactory(redisStandaloneConfiguration);}@Beanpublic RedisTemplate<String, Object> redisTemplate() {RedisTemplate<String, Object> template = new RedisTemplate<>();template.setConnectionFactory(jedisConnectionFactory());// 设置键的序列化器为 StringRedisSerializertemplate.setKeySerializer(new StringRedisSerializer());// 设置哈希键的序列化器为 StringRedisSerializertemplate.setHashKeySerializer(new StringRedisSerializer());// 设置值的序列化器为 GenericJackson2JsonRedisSerializer，用于处理 JSON 数据template.setValueSerializer(new GenericJackson2JsonRedisSerializer());// 设置哈希值的序列化器为 GenericJackson2JsonRedisSerializertemplate.setHashValueSerializer(new GenericJackson2JsonRedisSerializer());return template;}
}

QrCodeController

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;import java.util.HashMap;
import java.util.Map;
import java.util.UUID;
import java.util.concurrent.TimeUnit;@RestController
@RequestMapping("/qr-code")
public class QrCodeController {@Autowiredprivate RedisTemplate<String, Object> redisTemplate;// 生成二维码的接口@GetMapping(value = "/generate", produces = MediaType.APPLICATION_JSON_VALUE)public ResponseEntity<Map<String, String>> generateQrCode() {// 生成一个唯一的登录请求标识符String token = UUID.randomUUID().toString();// 存储 token 到 Redis 并设置 5 分钟有效期redisTemplate.opsForValue().set(token, "valid", 5, TimeUnit.MINUTES);// 封装返回的 JSON 数据Map<String, String> response = new HashMap<>();response.put("token", token);return ResponseEntity.ok(response);}// APP 扫描二维码后调用的接口@PostMapping("/scan")public String scanQrCode(@RequestBody ScanRequestInfo scanRequestInfo) {String token = request.getToken();String userId = request.getUserId();Map<String, String> response = new HashMap<>();if ("valid".equal(redisTemplate.opsForValue().get(token))) {// 将查询到用户信息（主要是token）放入缓存redisTemplate.opsForValue().set(token, userId, 1, TimeUnit.MINUTES);response.put("code", 0);} else {response.put("code", -1);}return ResponseEntity.ok(response);}@GetMapping("/checkLoginStatus")public String checkLoginStatus(@RequestParam String token) {// 使用 RedisTemplate 从 Redis 中获取登录状态String userId = (Boolean) redisTemplate.opsForValue().get(token);Map<String, String> response = new HashMap<>();if (userId != null && "valid".equal(userId)) {   // 根据userId查询用户信息并返回UserInfo userInfo = new UserInfo();response.put("code", 0);response.put("userInfo", userInfo);} else {response.put("code", -1);}return ResponseEntity.ok(response);}
}

UserInfo

@Data
public class UserInfo{private String userId;private String userName;private String token;
}

ScanRequestInfo

@Data
public class ScanRequestInfo{private String token;private String userId;
}

引入lombok依赖

<dependencies><!-- 引入 Lombok 依赖 --><dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><!-- 可以根据需要调整版本号 --><version>1.18.26</version><!-- 对于编译和测试范围使用，运行时不需要 --><scope>compile</scope></dependency>
</dependencies>

知识点

Jedis 和 Lettuce

Jedis：是 Redis 官方推荐的 Java 客户端之一，出现时间较早。其提供了非常全面且直观的 API，和 Redis 命令的对应关系十分清晰，开发人员可以方便地使用这些 API 来直接操作 Redis。
Lettuce：是基于 Netty 框架实现的高性能 Redis 客户端，Netty 是一个异步事件驱动的网络应用程序框架，使得 Lettuce 具有非阻塞和异步的特性。它被广泛应用于 Spring Boot 2.x 默认的 Redis 客户端。

小技巧

区分本地运行配置和测试环境运行配置

可以在application.properties和application.yml文件中分别配置：

application.properties（本地，不提交到git）

server.port=8080
spring.redis.host=127.0.0.1
spring.redis.port=6379
spring.redis.password=
spring.redis.database=0

application.yml（提交到git）

spring:redis:host: 127.0.0.1port: 6379database: 0password:
server:port: 8080