SpringCloud微服务架构分布式组件如何共享session对象

电玩女神 2022-11-29 03:04 423阅读 0赞

参考文章: [https://www.cnblogs.com/fengli9998/p/7881331.html][https_www.cnblogs.com_fengli9998_p_7881331.html]

[https://blog.csdn.net/dsen726/article/details/80880458][https_blog.csdn.net_dsen726_article_details_80880458]

**一.简单做一个背景说明**  
1.为说明问题，本文简单微服务架构示例如下

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p1c3RscGY_size_16_color_FFFFFF_t_70][]

2.组件说明  
分布式架构，每个组件都是集群或者主备。具体说明如下：  
**zuul service**:网关，API调用都走zuul service。  
**micro service1 & micro service2**:业务功能实现，数据库增删改查。  
**eureka**:组件注册，zuul service,micro service等组件都注册到eureka，管理组件调用地址。  
**db-master & db-slave**:数据库集群，一主两从。  
**redis master & redis slave**:redis集群，缓存。这里主要存储session对象。

3.组件之间API调用  
①：网关zuul接收到的API请求，路由至业务实现组件。  
②：网关zuul以及业务组件将session对象存储到redis、或从redis获取session对象。  
③：业务组件实现数据增删改查。  
④：业务组件之间通过springCloud feign组件进行调用。  
⑤：网关zuul以及micro service组件注册到eureka组件，或从eureka获取组件调用地址。

**二.存在问题**  
基于如上微服务的分布式架构如果按照传统方式，将session对象存储在内存中。在zuul网关将路由请求至不同的micro service1或者micro service2时，内存中的session对象将不能被共享，无法判断用户的登陆状态，也无法获取session对象存储的全局数据。

**三.解决方案**  
1.Spring管理session对象  
通过EnableRedisHttpSession注解支持基于Redis存储session，全局共享session对象。

2.微服务架构下共享session对象实现说明  
1)客户端API请求到zuul，zuul基于spring管理session将session对象存储到redis，并将生成的sessionId返回给客户端。  
2)zuul将请求路由到micro service，将sessionId通过cookie头带给micro service。  
3)micro service通过sessionId从redis获取到已经生成的session对象。  
4)micro servcie1调用micro service2时，将sessionId也通过cookie头带给micro service2，micro service2通过sessionId从redis中获取session对象。  
5)客户端再次调用时将a)步返回的sessionId增加到cookie头，在redis中存储的session失效之前zuul和micro service一直共享这个session。

5.具体实现  
1)**通过springframework的EnableRedisHttpSession注解管理session，zuul和micro service组件实现这个类以存储、获取redis中存储的session对象。**

1.  `import org.springframework.session.data.redis.config.annotation.web.http.EnableRedisHttpSession;`
2.   
3.  `@Configuration`
4.  `@EnableRedisHttpSession(maxInactiveIntervalInSeconds = GlobalConstants.SESSION_TIMOUT,`
5.  `redisFlushMode = RedisFlushMode.IMMEDIATE)`
6.  `public class SessionConfig {`
7.   
8.  `}`

**EnableRedisHttpSession注解参数说明：  
maxInactiveIntervalInSeconds**：session过期时间配置。  
**redisFlushMode**：redis session刷新模式。配置为RedisFlushMode.IMMEDIATE，可以确保zuul存储到redis的session对象在请求到micro service中能立即被获取。**在实际开发过程中出现由于没有这个配置值，有时候zuul将session对象存储到了redis，但是micro service无法立即获取。**

2)在zuul过滤器方法中调用addZuulRequestHeader增加请求头，将sessionId通过cookie头路由到micro service。

1.  `public class AccessFilter extends ZuulFilter {`
2.  `@Autowired`
3.  `HttpServletRequest httpServletRequest;`
4.  `@Autowired`
5.  `HttpServletResponse httpServletResponse;`
6.   
7.  `@Override`
8.  `public Object run() {`
9.  `RequestContext ctx = RequestContext.getCurrentContext();`
10. `String sessionId = httpServletRequest.getSession().getId();`
11. `ctx.addZuulRequestHeader("Cookie", "SESSION=" + sessionId);`
12. `ctx.setSendZuulResponse(true);// 对该请求进行路由`
13. `ctx.setResponseStatusCode(200); // 返回200正确响应`
14. `}`
15. `}`

3)micro service1通过feign调用micro service2时，实现RequestInterceptor接口。通过增加cookie头，将sessionId带到micro service2。

1.  `@Configuration`
2.  `public class MyRequestInterceptor implements RequestInterceptor {`
3.  `@Autowired`
4.  `HttpServletRequest request;`
5.   
6.  `@Override`
7.  `public void apply(RequestTemplate requestTemplate) {`
8.  `logger.info("MyRequestInterceptor apply begin.");`
9.  `try {`
10. `String sessionId = RequestContextHolder.currentRequestAttributes().getSessionId();`
11. `if (null != sessionId) {`
12. `requestTemplate.header("Cookie", "SESSION=" + sessionId);`
13. `}`
14. `} catch (Exception e) {`
15. `logger.error("MyRequestInterceptor exception: ", e);`
16. `}`
17. `}`
18. `}`

**6.验证**

1)通过postman请求zuul服务地址，调用登陆接口。

![70][]

**2)查看各组件sessionId**

zuul sessionId：

![70 1][]

micro service1 sessionId:

![70 2][]

micro service1调用micro service2 sessionId:

![70 3][]

**结论：可以看到zuul和micro service中sessionId都是相同的，都是586b\*c9a4，通过这种方式实现了API调用过程中的session对象共享。**

**注意:**springcloud项目中经过网关zuul转发请求后发生session失效问题，这是由于zuul默认会丢弃原来的session并生成新的session，解决方法网关配置文件application.yml 中添加 sensitiveHeaders: “\*”

转自：[https://blog.csdn.net/justlpf/article/details/80350943][https_blog.csdn.net_justlpf_article_details_80350943]

[https_www.cnblogs.com_fengli9998_p_7881331.html]: https://www.cnblogs.com/fengli9998/p/7881331.html
[https_blog.csdn.net_dsen726_article_details_80880458]: https://blog.csdn.net/dsen726/article/details/80880458
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p1c3RscGY_size_16_color_FFFFFF_t_70]: /images/20221124/a49e1852c03549518138a9f18f1a66ca.png
[70]: /images/20221124/1b5b233f7ae54417afc05095b32f6c64.png
[70 1]: /images/20221124/73338fb126624fb38110b1788432aada.png
[70 2]: /images/20221124/a4d00b52a7254dab82e6ebc2a48ffe28.png
[70 3]: /images/20221124/00f85e61a44a4b7088b001dd70947972.png
[https_blog.csdn.net_justlpf_article_details_80350943]: https://blog.csdn.net/justlpf/article/details/80350943