查看: 429|回复: 0

[Java代码] 详解SpringBoot中Session超时原理说明

发表于 2017-10-5 09:51:00
尚学堂AD

一:前言:

最近支付后台登录一段时间后如果没有任何操作,总是需要重新登录才可以继续访问页面,出现这个问题的原因就是session超时,debug代码后发现session的超时时间是1800s。也就是说当1800秒内没有任何操作,session就会出现超时现象。那这个超时时间是如何设置的呢?然后该如何重新设置此超时时间呢?系统又如何判断session超时的呢?接下来就一一进行解答。

二:系统session超时时间如何默认的?

说明:获取session超时时间的方法为”request.getSession().getMaxInactiveInterval()",但是tomcat中设置超时时间的参数为“sessionTimeout”,那么他们是怎么联系起来的呢?

第一步:加载sessionTimeout参数。

1、项目运行初始化通过“@ConfigurationProperties”注解加载“org.springframework.boot.autoconfigure.web.ServerProperties”类。

  1. //springBoot中默认的配置文件为"application.yml"或者"application.perties"文件,也就是说server是其中的一个配置参数。
  2. @ConfigurationProperties(prefix = "server", ignoreUnknownFields = true)
  3. public class ServerProperties
  4. implements EmbeddedServletContainerCustomizer, EnvironmentAware, Ordered {
  5. //代码
  6. }
复制代码

2、上面类中“ServerProperties”继承自“EmbeddedServletContainerCustomizer”接口。重写customize方法,之后在此方法中“向上推”,即可找到“AbstractConfigurableEmbeddedServletContainer ”类。

  1. @Override
  2. public void customize(ConfigurableEmbeddedServletContainer container) {
  3. //多个参数判断,如果在application中没配置的情况下都是null
  4. if (getPort() != null) {
  5. container.setPort(getPort());
  6. }
  7. ...//n多个参数判断,
  8. //以下的代码就是重点,因为是tomcat容器,所以以下条件为“真”,经过一系列的查找父类或者实现接口即可找到抽象类“AbstractConfigurableEmbeddedServletContainer”
  9. //public class TomcatEmbeddedServletContainerFactory extends AbstractEmbeddedServletContainerFactory implements ResourceLoaderAware
  10. //public abstract class AbstractEmbeddedServletContainerFactory extends AbstractConfigurableEmbeddedServletContainer implements EmbeddedServletContainerFactory
  11. if (container instanceof TomcatEmbeddedServletContainerFactory) {
  12. getTomcat().customizeTomcat(this,
  13. (TomcatEmbeddedServletContainerFactory) container);
  14. }
  15. //以上代码执行完成之后,实际上已经有对应的session所有的默认参数,之后通过下面方法,将所有参数放入对应的容器中。第3、4步就是设置过程
  16. container.addInitializers(new SessionConfiguringInitializer(this.session));
  17. }
复制代码

3、在“AbstractConfigurableEmbeddedServletContainer”类中终于可以找到“超时时间”的相关设置

  1. //重要代码
  2. //45行
  3. private static final int DEFAULT_SESSION_TIMEOUT = (int) TimeUnit.MINUTES
  4. .toSeconds(30);
  5. //66行
  6. private int sessionTimeout = DEFAULT_SESSION_TIMEOUT;
  7. @Override
  8. public void setSessionTimeout(int sessionTimeout) {
  9. this.sessionTimeout = sessionTimeout;
  10. }
  11. //171-188行
  12. @Override
  13. public void setSessionTimeout(int sessionTimeout, TimeUnit timeUnit) {
  14. Assert.notNull(timeUnit, "TimeUnit must not be null");
  15. this.sessionTimeout = (int) timeUnit.toSeconds(sessionTimeout);
  16. }
  17. /**
  18. * Return the session timeout in seconds.
  19. * @return the timeout in seconds
  20. */
  21. public int getSessionTimeout() {
  22. return this.sessionTimeout;
  23. }
复制代码

4、执行第2步的”Container.addInitializers(new SessionConfiguringInitializer(this.session))“加载所有的配置参数。

  1. public static class Session {
  2. /**
  3. * Session timeout in seconds.
  4. */
  5. private Integer timeout;
  6. public Integer getTimeout() {
  7. return this.timeout;
  8. }
  9. //将session超时时间设置进来
  10. public void setTimeout(Integer sessionTimeout) {
  11. this.timeout = sessionTimeout;
  12. }
复制代码

第二步:将上面的超时时间赋值给“MaxInactiveInterval”参数。

说明:既然上面tomcat需要的参数都已经加载完成,那么接下来就会运行tomcat,此处不做细讲,直接进入tomcat启动和加载参数说明。在“TomcatEmbeddedServletContainerFactory”类中的方法调用流程如下:

getEmbeddedServletContainer--》prepareContext--》configureContext--》configureSession--》getSessionTimeoutInMinutes。

1、调用configureSession设置tomcat的Session配置参数。

  1. //以下代码
  2. private void configureSession(Context context) {
  3. long sessionTimeout = getSessionTimeoutInMinutes();
  4. context.setSessionTimeout((int) sessionTimeout);
  5. Manager manager = context.getManager();
  6. if (manager == null) {
  7. manager = new StandardManager();
  8. //此处即为设置相应的参数的位置。之后会调用StandardContext类的setManger(Manager)方法,在setManger中会调用"manager.setContext(this)"
  9. context.setManager(manager);
  10. }
  11. }
  12. //计算超时时间为分钟(注意:此处会将之前的1800秒,转换为30分钟)。可以看出最终的时间结果是个整数的分钟类型,也就是说如果设置的超时时间(单位为秒)不是60的倍数,也会最终转换为60的倍数,并且最小超时时间设置的是60秒。
  13. private long getSessionTimeoutInMinutes() {
  14. long sessionTimeout = getSessionTimeout();
  15. if (sessionTimeout > 0) {
  16. sessionTimeout = Math.max(TimeUnit.SECONDS.toMinutes(sessionTimeout), 1L);
  17. }
  18. return sessionTimeout;
  19. }
复制代码

2、最终将SessionTimeout赋值给MaxInactiveInterval。终于完成session超时时间设置。

  1. //以下代码
  2. @Override
  3. public void setContext(Context context) {
  4. //省略其余设置代码,直接重新设置Session超时时间,此时又将上面的分钟单位转为秒。此时终于给Sesseion设置了默认超时时间。
  5. if (this.context != null) {
  6. setMaxInactiveInterval(this.context.getSessionTimeout() * 60);
  7. this.context.addPropertyChangeListener(this);
  8. }
  9. }
复制代码

三:如果自定义超时时间呢?

其实从上面的流程,已经不难看出,只需要在“org.springframework.boot.autoconfigure.web.ServerProperties”类中找到对应的Session参数,初始化让其加载上来即可完成设置。

  1. /**
  2. * Get the session timeout.
  3. * @return the session timeout
  4. * @deprecated since 1.3.0 in favor of {[url=home.php?mod=space&uid=24691]@code[/url] session.timeout}.
  5. */
  6. @Deprecated
  7. @DeprecatedConfigurationProperty(replacement = "server.session.timeout")
  8. public Integer getSessionTimeout() {
  9. return this.session.getTimeout();
  10. }
复制代码

所以在application中配置“server.session.timeout“即可,参数类型为long类型,单位为”秒“。

四:运行程序是如何判断session超时的?

其实很简单:只需要在每次本次同一个sessionequest请求的时间,和之前的请求时间进行比较,发现两个值的差已经大于MaxInactiveInterval的值即可。

  1. //判断是否超时
  2. @Override
  3. public boolean isValid() {
  4. //省略多个条件判断
  5. if (maxInactiveInterval > 0) {
  6. //判断此session空闲时间是否比maxInactiveInterval大,如果大的情况下,session就超时
  7. int timeIdle = (int) (getIdleTimeInternal() / 1000L);
  8. if (timeIdle >= maxInactiveInterval) {
  9. expire(true);
  10. }
  11. }
  12. return this.isValid;
  13. }
  14. //将上次访问时间和当前时间比较,拿到空闲时间值
  15. @Override
  16. public long getIdleTimeInternal() {
  17. long timeNow = System.currentTimeMillis();
  18. long timeIdle;
  19. if (LAST_ACCESS_AT_START) {
  20. timeIdle = timeNow - lastAccessedTime;
  21. } else {
  22. timeIdle = timeNow - thisAccessedTime;
  23. }
  24. return timeIdle;
  25. }
复制代码

说明:

所以为了保证session超时时间长点,可以在application配置文件中配置“server.session.timeout”参数即可,参数单位为“秒”,如果参数不是60的整数倍,会转换成60的整数倍(见二:系统如何设置超时时间、步骤二中的“1”中算法)。如不满一分钟,会转换为60秒。

扩展:

实际上也可以直接重写EmbeddedServletContainerCustomizer的customize方法进行赋值。

  1. @Bean
  2. public EmbeddedServletContainerCustomizer containerCustomizer(){
  3. return new EmbeddedServletContainerCustomizer() {
  4. @Override
  5. public void customize(ConfigurableEmbeddedServletContainer container) {
  6. container.setSessionTimeout(600);//单位为S
  7. }
  8. };
  9. }
复制代码

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持程序员之家。



回复

使用道具 举报