SpringCloud 2020.0.4 系列之 JWT用户鉴权

2024-05-31 23:58
文章标签 java spring 系列 用户 springcloud jwt 鉴权 2020.0

本文主要是介绍SpringCloud 2020.0.4 系列之 JWT用户鉴权，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

目录

1. 概述

2. 开发 授权鉴权服务接口层 my-auth-api

3. 开发 授权鉴权服务 my-auth-service

4. 在网关层（Gateway工程）添加鉴权过滤器

5. 综述

6. 个人公众号

1. 概述

老话说的好：善待他人就是善待自己，虽然可能有所付出，但也能得到应有的收获。

言归正传，之前我们聊了 Gateway 组件，今天来聊一下如何使用 JWT 技术给用户授权，以及如果在 Gateway 工程使用自定义 filter 验证用户权限。

闲话不多说，直接上代码。

2. 开发 授权鉴权服务接口层 my-auth-api

2.1 主要依赖

    <artifactId>my-auth-api</artifactId><dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-openfeign</artifactId></dependency></dependencies>

2.2 实体类

/*** 账户实体类*/
@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
public class Account implements java.io.Serializable {// 用户名private String userName;// tokenprivate String token;// 刷新tokenprivate String refreshToken;
}

/*** 响应实体类*/
@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class AuthResponse implements java.io.Serializable {// 账户private Account account;// 响应码private Integer code;
}

2.3 授权鉴权 Service 接口

/***  授权鉴权 Service 接口*/
@FeignClient("my-auth-service")
public interface AuthService {/*** 登录接口* @param userName  用户名* @param password  密码* @return*/@PostMapping("/login")AuthResponse login(@RequestParam("userName") String userName,@RequestParam("password") String password);/*** 校验token* @param token     token* @param userName  用户名* @return*/@GetMapping("/verify")AuthResponse verify(@RequestParam("token") String token,@RequestParam("userName") String userName);/*** 刷新token* @param refreshToken   刷新token*/@PostMapping("/refresh")AuthResponse refresh(@RequestParam("refreshToken") String refreshToken);
}

3. 开发 授权鉴权服务 my-auth-service

3.1 主要依赖

        <dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-netflix-eureka-client</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-actuator</artifactId></dependency><!-- redis --><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-data-redis</artifactId></dependency><!-- jwt --><dependency><groupId>com.auth0</groupId><artifactId>java-jwt</artifactId><version>3.18.2</version></dependency><dependency><groupId>cn.zhuifengren</groupId><artifactId>my-auth-api</artifactId><version>${project.version}</version></dependency>

3.2 主要配置

server:port: 45000
spring:application:name: my-auth-serviceredis:database: 0host: 192.168.1.22port: 6379password: zhuifengreneureka:client:service-url:defaultZone: http://zhuifengren1:35000/eureka/,http://zhuifengren2:35001/eureka/    # Eureka Server的地址

3.3 启动类添加注解

@SpringBootApplication
@EnableDiscoveryClient

3.4 JWT 核心Service方法

/*** 获得 token* @param account   账户实体* @return*/public String token(Account account) {log.info("获取token");Date now = new Date();// 指定算法，KEY是自定义的秘钥Algorithm algorithm = Algorithm.HMAC256(KEY);// 生成tokenString token = JWT.create().withIssuer(ISSUER) // 发行人，自定义.withIssuedAt(now).withExpiresAt(new Date(now.getTime() + TOKEN_EXPIRES)) // 设置token过期时间.withClaim("userName", account.getUserName())   // 自定义属性.sign(algorithm);log.info(account.getUserName() + " token 生成成功");return token;}/*** 验证token* @param token* @param userName* @return*/public boolean verify(String token, String userName) {log.info("验证token");try {// 指定算法，KEY是自定义的秘钥Algorithm algorithm = Algorithm.HMAC256(KEY);// 验证tokenJWTVerifier verifier = JWT.require(algorithm).withIssuer(ISSUER)     // 发行人，自定义.withClaim("userName", userName)   // 自定义属性.build();verifier.verify(token);return true;} catch (Exception ex) {log.error("验证失败", ex);return false;}}

3.5 授权鉴权业务Service

/*** 授权鉴权 Service*/
@RestController
@Slf4j
public class AuthServiceImpl implements AuthService {@Autowiredprivate JwtService jwtService;@Autowiredprivate RedisTemplate redisTemplate;/*** 登录* @param userName  用户名* @param password  密码* @return*/public AuthResponse login(@RequestParam("userName") String userName,@RequestParam("password") String password) {Account account = Account.builder().userName(userName).build();String token = jwtService.token(account);account.setToken(token);account.setRefreshToken(UUID.randomUUID().toString());redisTemplate.opsForValue().set(account.getRefreshToken(), account);return AuthResponse.builder().account(account).code(200)  // 200 代表成功.build();}/*** 刷新token* @param refreshToken   刷新token* @return*/public AuthResponse refresh(@RequestParam("refreshToken") String refreshToken) {Account account = (Account)redisTemplate.opsForValue().get(refreshToken);if(account == null) {return AuthResponse.builder().code(-1)       // -1 代表用户未找到.build();}String newToken = jwtService.token(account);account.setToken(newToken);account.setRefreshToken(UUID.randomUUID().toString());redisTemplate.delete(refreshToken);redisTemplate.opsForValue().set(account.getRefreshToken(), account);return AuthResponse.builder().account(account).code(200)  // 200 代表成功.build();}/*** 验证token* @param token     token* @param userName  用户名* @return*/public AuthResponse verify(@RequestParam("token") String token,@RequestParam("userName") String userName) {log.info("verify start");boolean isSuccess = jwtService.verify(token, userName);log.info("verify result：" + isSuccess);return AuthResponse.builder().code(isSuccess ? 200 : -2)     // -2 代表验证不通过.build();}
}

4. 在网关层（Gateway工程）添加鉴权过滤器

4.1 增加依赖

        <dependency><groupId>cn.zhuifengren</groupId><artifactId>my-auth-api</artifactId><version>${project.version}</version><exclusions><exclusion><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></exclusion></exclusions></dependency><dependency><groupId>org.apache.commons</groupId><artifactId>commons-lang3</artifactId></dependency>

4.2 启动类增加注解

@SpringBootApplication
@EnableDiscoveryClient
@EnableFeignClients(clients = AuthService.class)

4.3 鉴权过滤器

@Slf4j
@Component
public class AuthFilter implements GatewayFilter, Ordered {private static final String AUTH = "Authorization";private static final String USER_NAME = "userName";@Autowiredprivate AuthService authService;@Overridepublic Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {log.info("开始验证");// 从 header 中得到 token 和 用户名ServerHttpRequest request = exchange.getRequest();HttpHeaders headers = request.getHeaders();String token = headers.getFirst(AUTH);String userName= headers.getFirst(USER_NAME);ServerHttpResponse response = exchange.getResponse();if(StringUtils.isBlank(token)) {log.error("token没有找到");response.setStatusCode(HttpStatus.UNAUTHORIZED);return response.setComplete();}// 验证用户名log.info("执行验证方法");AuthResponse resp = authService.verify(token, userName);       log.info("执行验证方法完毕");if(resp == null || resp.getCode() != 200) {log.error("无效的token");response.setStatusCode(HttpStatus.FORBIDDEN);return response.setComplete();}return chain.filter(exchange);}@Overridepublic int getOrder() {return 0;}
}

4.4 在路由规则中配置鉴权过滤器

这里我们随便找一个接口实验

@Configuration
public class GatewayConfig {@Bean@Orderpublic RouteLocator myRoutes(RouteLocatorBuilder builder, AuthFilter authFilter) {return builder.routes().route(r -> r.path("/business/**").and().method(HttpMethod.GET).filters(f -> f.stripPrefix(1).filter(authFilter)).uri("lb://MY-EUREKA-CLIENT")).build();}
}

4.5 block()/blockFirst()/blockLast() are blocking, which is not supported in thread reactor-http-nio-3 错误解决

此时，启动 Gateway 工程，调用实验接口：

GET  http://Gateway IP:端口/business/eurekaClient/hello

此时 Gateway 工程会报如下错误：

java.lang.IllegalStateException: block()/blockFirst()/blockLast() are blocking, which is not supported in thread reactor-http-nio-3at reactor.core.publisher.BlockingSingleSubscriber.blockingGet(BlockingSingleSubscriber.java:83) ~[reactor-core-3.4.11.jar:3.4.11]Suppressed: reactor.core.publisher.FluxOnAssembly$OnAssemblyException: 
Error has been observed at the following site(s):*__checkpoint ⇢ org.springframework.cloud.gateway.filter.WeightCalculatorWebFilter [DefaultWebFilterChain]*__checkpoint ⇢ org.springframework.boot.actuate.metrics.web.reactive.server.MetricsWebFilter [DefaultWebFilterChain]*__checkpoint ⇢ HTTP GET "/business/eurekaClient/hello" [ExceptionHandlingWebHandler]

这是因为在自定义过滤器 AuthFilter 的 filter 方法中，不能同步的调用 Feign 接口，需要异步去调。

我们修改 AuthFilter 中的代码

将 AuthResponse resp = authService.verify(token, userName); 这行代码改为如下代码：

        CompletableFuture<AuthResponse> completableFuture = CompletableFuture.supplyAsync(()-> {return authService.verify(token, userName);});AuthResponse resp = null;try {resp = completableFuture.get();} catch (Exception ex) {log.error("调用验证接口错误", ex);}

4.6 feign.codec.DecodeException: No qualifying bean of type 'org.springframework.boot.autoconfigure.http.HttpMessageConverters' available 错误解决

我们重启 Gateway 服务，再次调用实验接口：

GET  http://Gateway IP:端口/business/eurekaClient/hello

此时 Feign 接口调通了，但 Gateway 工程报了如下错误：

Caused by: org.springframework.beans.factory.NoSuchBeanDefinitionException: No qualifying bean of type 'org.springframework.boot.autoconfigure.http.HttpMessageConverters' available: expected at least 1 bean which qualifies as autowire candidate. Dependency annotations: {@org.springframework.beans.factory.annotation.Autowired(required=true)}at org.springframework.beans.factory.support.DefaultListableBeanFactory.raiseNoMatchingBeanFound(DefaultListableBeanFactory.java:1790) ~[spring-beans-5.3.12.jar:5.3.12]at org.springframework.beans.factory.support.DefaultListableBeanFactory.doResolveDependency(DefaultListableBeanFactory.java:1346) ~[spring-beans-5.3.12.jar:5.3.12]at org.springframework.beans.factory.support.DefaultListableBeanFactory$DependencyObjectProvider.getObject(DefaultListableBeanFactory.java:1979) ~[spring-beans-5.3.12.jar:5.3.12]

似乎是 HttpMessageConverters 这个 Bean 没有找到，经查阅资料，我们在启动类中添加如下代码

    @Bean@ConditionalOnMissingBeanpublic HttpMessageConverters messageConverters(ObjectProvider<HttpMessageConverter<?>> converters) {return new HttpMessageConverters(converters.orderedStream().collect(Collectors.toList()));}

4.7 实验授权鉴权

1）再次重启 Gateway 工程

2）调用登录接口获取 token

POST http://Gateway IP:端口/my-auth-service/login?userName=zhangsan&password=12345

3）调用业务接口，将 token 和用户名放到 header 中，可以正常访问接口

5. 综述

今天聊了一下 JWT用户鉴权，希望可以对大家的工作有所帮助。

欢迎帮忙点赞、评论、转发、加关注 ：）

关注追风人聊Java，每天更新Java干货。

6. 个人公众号

追风人聊Java，欢迎大家关注

这篇关于SpringCloud 2020.0.4 系列之 JWT用户鉴权的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1019412。

相关文章

如何在 Spring Boot 中实现 FreeMarker 模板

如何在 Spring Boot 中实现 FreeMarker 模板

《如何在SpringBoot中实现FreeMarker模板》FreeMarker是一种功能强大、轻量级的模板引擎,用于在Java应用中生成动态文本输出（如HTML、XML、邮件内容等）,本文... 目录什么是 FreeMarker 模板？在 Spring Boot 中实现 FreeMarker 模板1. 环
阅读更多...
SpringMVC 通过ajax 前后端数据交互的实现方法

SpringMVC 通过ajax 前后端数据交互的实现方法

《SpringMVC通过ajax前后端数据交互的实现方法》：本文主要介绍SpringMVC通过ajax前后端数据交互的实现方法,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价... 在前端的开发过程中，经常在html页面通过AJAX进行前后端数据的交互，SpringMVC的controll
阅读更多...
Java中的工具类命名方法

Java中的工具类命名方法

《Java中的工具类命名方法》：本文主要介绍Java中的工具类究竟如何命名,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧... 目录Java中的工具类究竟如何命名？先来几个例子几种命名方式的比较到底如何命名 ？总结Java中的工具类究竟如何命名？先来几个例子JD
阅读更多...
Java Stream流使用案例深入详解

Java Stream流使用案例深入详解

《JavaStream流使用案例深入详解》：本文主要介绍JavaStream流使用案例详解,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧... 目录前言1. Lambda1.1 语法1.2 没参数只有一条语句或者多条语句1.3 一个参数只有一条语句或者多
阅读更多...
Spring Security自定义身份认证的实现方法

Spring Security自定义身份认证的实现方法

《SpringSecurity自定义身份认证的实现方法》：本文主要介绍SpringSecurity自定义身份认证的实现方法,下面对SpringSecurity的这三种自定义身份认证进行详细讲解,... 目录1.内存身份认证（1）创建配置类（2）验证内存身份认证2.JDBC身份认证（1）数据准备 （2）配置依
阅读更多...
SpringBoot整合OpenFeign的完整指南

SpringBoot整合OpenFeign的完整指南

《SpringBoot整合OpenFeign的完整指南》OpenFeign是由Netflix开发的一个声明式Web服务客户端,它使得编写HTTP客户端变得更加简单,本文为大家介绍了SpringBoot... 目录什么是OpenFeign环境准备创建 Spring Boot 项目添加依赖启用 OpenFeig
阅读更多...
Java Spring 中 @PostConstruct 注解使用原理及常见场景

Java Spring 中 @PostConstruct 注解使用原理及常见场景

《JavaSpring中@PostConstruct注解使用原理及常见场景》在JavaSpring中,@PostConstruct注解是一个非常实用的功能,它允许开发者在Spring容器完全初... 目录一、@PostConstruct 注解概述二、@PostConstruct 注解的基本使用2.1 基本代
阅读更多...
springboot使用Scheduling实现动态增删启停定时任务教程

springboot使用Scheduling实现动态增删启停定时任务教程

《springboot使用Scheduling实现动态增删启停定时任务教程》：本文主要介绍springboot使用Scheduling实现动态增删启停定时任务教程,具有很好的参考价值,希望对大家有... 目录1、配置定时任务需要的线程池2、创建ScheduledFuture的包装类3、注册定时任务，增加、删
阅读更多...
SpringBoot整合mybatisPlus实现批量插入并获取ID详解

SpringBoot整合mybatisPlus实现批量插入并获取ID详解

《SpringBoot整合mybatisPlus实现批量插入并获取ID详解》这篇文章主要为大家详细介绍了SpringBoot如何整合mybatisPlus实现批量插入并获取ID,文中的示例代码讲解详细... 目录【1】saveBATch(一万条数据总耗时：2478ms)【2】集合方式foreach(一万条数
阅读更多...
IntelliJ IDEA 中配置 Spring MVC 环境的详细步骤及问题解决

IntelliJ IDEA 中配置 Spring MVC 环境的详细步骤及问题解决

《IntelliJIDEA中配置SpringMVC环境的详细步骤及问题解决》：本文主要介绍IntelliJIDEA中配置SpringMVC环境的详细步骤及问题解决,本文分步骤结合实例给大... 目录步骤 1：创建 Maven Web 项目步骤 2：添加 Spring MVC 依赖1、保存后执行2、将新的依赖
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2