Skip to content

Commit 322b1b2

Browse files
snicollsnicoll
committed
Merge pull request #5158 from shakuzen/session-autoconfig-enhance
* gh-5158: Polish spring session auto-configuration Polish session auto-configuration Spring Session auto-configuration expansion
2 parents c3e8cc2 + bf89c8e commit 322b1b2

19 files changed

+1005
-94
lines changed

‎spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/session/HashMapSessionConfiguration.java

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
/*
2+
* Copyright 2012-2016 the original author or authors.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package org.springframework.boot.autoconfigure.session;
18+
19+
import org.springframework.context.annotation.Bean;
20+
import org.springframework.context.annotation.Conditional;
21+
import org.springframework.context.annotation.Configuration;
22+
import org.springframework.session.ExpiringSession;
23+
import org.springframework.session.MapSessionRepository;
24+
import org.springframework.session.SessionRepository;
25+
import org.springframework.session.config.annotation.web.http.EnableSpringHttpSession;
26+
27+
/**
28+
* HashMap based session configuration, intended as a fallback.
29+
*
30+
* @author Tommy Ludwig
31+
* @author Stephane Nicoll
32+
*/
33+
@Configuration
34+
@EnableSpringHttpSession
35+
@Conditional(SessionCondition.class)
36+
class HashMapSessionConfiguration {
37+
38+
@Bean
39+
public SessionRepository<ExpiringSession> sessionRepository(SessionProperties sessionProperties) {
40+
MapSessionRepository sessionRepository = new MapSessionRepository();
41+
Integer timeout = sessionProperties.getTimeout();
42+
if (timeout != null) {
43+
sessionRepository.setDefaultMaxInactiveInterval(timeout);
44+
}
45+
return sessionRepository;
46+
}
47+
48+
}

‎spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/session/HazelcastSessionConfiguration.java

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
/*
2+
* Copyright 2012-2016 the original author or authors.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package org.springframework.boot.autoconfigure.session;
18+
19+
import com.hazelcast.core.HazelcastInstance;
20+
21+
import org.springframework.beans.factory.annotation.Autowired;
22+
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
23+
import org.springframework.context.annotation.Conditional;
24+
import org.springframework.context.annotation.Configuration;
25+
import org.springframework.session.hazelcast.config.annotation.web.http.HazelcastHttpSessionConfiguration;
26+
27+
/**
28+
* Hazelcast backed session configuration.
29+
*
30+
* @author Tommy Ludwig
31+
* @author Eddú Meléndez
32+
* @author Stephane Nicoll
33+
*/
34+
@Configuration
35+
@ConditionalOnBean(HazelcastInstance.class)
36+
@Conditional(SessionCondition.class)
37+
class HazelcastSessionConfiguration {
38+
39+
@Configuration
40+
public static class SprigBootHazelcastHttpSessionConfiguration
41+
extends HazelcastHttpSessionConfiguration {
42+
43+
@Autowired
44+
public void customize(SessionProperties sessionProperties) {
45+
Integer timeout = sessionProperties.getTimeout();
46+
if (timeout != null) {
47+
setMaxInactiveIntervalInSeconds(timeout);
48+
}
49+
setSessionMapName(sessionProperties.getHazelcast().getMapName());
50+
}
51+
52+
}
53+
}

‎spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/session/JdbcSessionConfiguration.java

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
/*
2+
* Copyright 2012-2016 the original author or authors.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package org.springframework.boot.autoconfigure.session;
18+
19+
import javax.sql.DataSource;
20+
21+
import org.springframework.beans.factory.annotation.Autowired;
22+
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
23+
import org.springframework.context.annotation.Conditional;
24+
import org.springframework.context.annotation.Configuration;
25+
import org.springframework.session.jdbc.config.annotation.web.http.JdbcHttpSessionConfiguration;
26+
27+
/**
28+
* JDBC backed session configuration.
29+
*
30+
* @author Eddú Meléndez
31+
* @author Stephane Nicoll
32+
*/
33+
@Configuration
34+
@ConditionalOnBean(DataSource.class)
35+
@Conditional(SessionCondition.class)
36+
class JdbcSessionConfiguration {
37+
38+
@Configuration
39+
public static class SpringBootJdbcHttpSessionConfiguration
40+
extends JdbcHttpSessionConfiguration {
41+
42+
@Autowired
43+
public void customize(SessionProperties sessionProperties) {
44+
Integer timeout = sessionProperties.getTimeout();
45+
if (timeout != null) {
46+
setMaxInactiveIntervalInSeconds(timeout);
47+
}
48+
setTableName(sessionProperties.getJdbc().getTableName());
49+
}
50+
51+
}
52+
53+
}

‎spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/session/MongoSessionConfiguration.java

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
/*
2+
* Copyright 2012-2016 the original author or authors.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package org.springframework.boot.autoconfigure.session;
18+
19+
import org.springframework.beans.factory.annotation.Autowired;
20+
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
21+
import org.springframework.context.annotation.Conditional;
22+
import org.springframework.context.annotation.Configuration;
23+
import org.springframework.data.mongodb.core.MongoOperations;
24+
import org.springframework.session.data.mongo.config.annotation.web.http.MongoHttpSessionConfiguration;
25+
26+
/**
27+
* Mongo backed session configuration.
28+
*
29+
* @author Eddú Meléndez
30+
* @author Stephane Nicoll
31+
*/
32+
@Configuration
33+
@ConditionalOnBean(MongoOperations.class)
34+
@Conditional(SessionCondition.class)
35+
class MongoSessionConfiguration {
36+
37+
@Configuration
38+
public static class SpringBootMongoHttpSessionConfiguration
39+
extends MongoHttpSessionConfiguration {
40+
41+
@Autowired
42+
public void customize(SessionProperties sessionProperties) {
43+
Integer timeout = sessionProperties.getTimeout();
44+
if (timeout != null) {
45+
setMaxInactiveIntervalInSeconds(timeout);
46+
}
47+
setCollectionName(sessionProperties.getMongo().getCollectionName());
48+
}
49+
50+
}
51+
52+
}

‎spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/session/NoOpSessionConfiguration.java

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
/*
2+
* Copyright 2012-2016 the original author or authors.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package org.springframework.boot.autoconfigure.session;
18+
19+
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
20+
import org.springframework.context.annotation.Conditional;
21+
import org.springframework.context.annotation.Configuration;
22+
import org.springframework.session.SessionRepository;
23+
24+
/**
25+
* No-op session configuration used to disable Spring Session using the environment.
26+
*
27+
* @author Tommy Ludwig
28+
*/
29+
@Configuration
30+
@ConditionalOnMissingBean(SessionRepository.class)
31+
@Conditional(SessionCondition.class)
32+
class NoOpSessionConfiguration {
33+
}

‎spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/session/RedisSessionConfiguration.java

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
/*
2+
* Copyright 2012-2016 the original author or authors.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package org.springframework.boot.autoconfigure.session;
18+
19+
import org.springframework.beans.factory.annotation.Autowired;
20+
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
21+
import org.springframework.context.annotation.Conditional;
22+
import org.springframework.context.annotation.Configuration;
23+
import org.springframework.data.redis.connection.RedisConnectionFactory;
24+
import org.springframework.data.redis.core.RedisTemplate;
25+
import org.springframework.session.data.redis.config.annotation.web.http.RedisHttpSessionConfiguration;
26+
27+
/**
28+
* Redis backed session configuration.
29+
*
30+
* @author Andy Wilkinson
31+
* @author Tommy Ludwig
32+
* @author Eddú Meléndez
33+
* @author Stephane Nicoll
34+
*/
35+
@Configuration
36+
@ConditionalOnBean({ RedisTemplate.class, RedisConnectionFactory.class })
37+
@Conditional(SessionCondition.class)
38+
class RedisSessionConfiguration {
39+
40+
@Configuration
41+
public static class SpringBootRedisHttpSessionConfiguration
42+
extends RedisHttpSessionConfiguration {
43+
44+
@Autowired
45+
public void customize(SessionProperties sessionProperties) {
46+
Integer timeout = sessionProperties.getTimeout();
47+
if (timeout != null) {
48+
setMaxInactiveIntervalInSeconds(timeout);
49+
}
50+
SessionProperties.Redis redis = sessionProperties.getRedis();
51+
setRedisNamespace(redis.getNamespace());
52+
setRedisFlushMode(redis.getFlushMode());
53+
}
54+
55+
}
56+
57+
}

‎spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/session/SessionAutoConfiguration.java

Lines changed: 29 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -21,66 +21,51 @@
2121
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
2222
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
2323
import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
24-
import org.springframework.boot.autoconfigure.condition.SearchStrategy;
2524
import org.springframework.boot.autoconfigure.data.redis.RedisAutoConfiguration;
26-
import org.springframework.boot.autoconfigure.web.ServerProperties;
25+
import org.springframework.boot.autoconfigure.hazelcast.HazelcastAutoConfiguration;
26+
import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;
27+
import org.springframework.boot.autoconfigure.mongo.MongoAutoConfiguration;
28+
import org.springframework.boot.autoconfigure.session.SessionAutoConfiguration.SessionConfigurationImportSelector;
2729
import org.springframework.boot.context.properties.EnableConfigurationProperties;
28-
import org.springframework.context.annotation.Bean;
2930
import org.springframework.context.annotation.Configuration;
30-
import org.springframework.data.redis.connection.RedisConnectionFactory;
31+
import org.springframework.context.annotation.Import;
32+
import org.springframework.context.annotation.ImportSelector;
33+
import org.springframework.core.type.AnnotationMetadata;
3134
import org.springframework.session.Session;
32-
import org.springframework.session.data.redis.RedisOperationsSessionRepository;
33-
import org.springframework.session.data.redis.config.annotation.web.http.EnableRedisHttpSession;
34-
import org.springframework.session.data.redis.config.annotation.web.http.RedisHttpSessionConfiguration;
35+
import org.springframework.session.SessionRepository;
3536

3637
/**
3738
* {@link EnableAutoConfiguration Auto-configuration} for Spring Session.
3839
*
3940
* @author Andy Wilkinson
40-
* @since 1.3.0
41+
* @author Tommy Ludwig
42+
* @author Eddú Meléndez
43+
* @author Stephane Nicoll
44+
* @since 1.4.0
4145
*/
4246
@Configuration
4347
@ConditionalOnClass(Session.class)
44-
@AutoConfigureAfter(RedisAutoConfiguration.class)
48+
@ConditionalOnWebApplication
49+
@ConditionalOnMissingBean(SessionRepository.class)
50+
@EnableConfigurationProperties(SessionProperties.class)
51+
@AutoConfigureAfter({ DataSourceAutoConfiguration.class, HazelcastAutoConfiguration.class,
52+
MongoAutoConfiguration.class, RedisAutoConfiguration.class })
53+
@Import(SessionConfigurationImportSelector.class)
4554
public class SessionAutoConfiguration {
4655

47-
@EnableConfigurationProperties
48-
@ConditionalOnClass(RedisConnectionFactory.class)
49-
@ConditionalOnWebApplication
50-
@ConditionalOnMissingBean(RedisHttpSessionConfiguration.class)
51-
@EnableRedisHttpSession
52-
@Configuration
53-
public static class SessionRedisHttpConfiguration {
56+
/**
57+
* {@link ImportSelector} to add {@link StoreType} configuration classes.
58+
*/
59+
static class SessionConfigurationImportSelector implements ImportSelector {
5460

55-
private final ServerProperties serverProperties;
56-
57-
private final RedisOperationsSessionRepository sessionRepository;
58-
59-
public SessionRedisHttpConfiguration(ServerProperties serverProperties,
60-
RedisOperationsSessionRepository sessionRepository) {
61-
this.serverProperties = serverProperties;
62-
this.sessionRepository = sessionRepository;
63-
applyConfigurationProperties();
64-
}
65-
66-
private void applyConfigurationProperties() {
67-
Integer timeout = this.serverProperties.getSession().getTimeout();
68-
if (timeout != null) {
69-
this.sessionRepository.setDefaultMaxInactiveInterval(timeout);
61+
@Override
62+
public String[] selectImports(AnnotationMetadata importingClassMetadata) {
63+
StoreType[] types = StoreType.values();
64+
String[] imports = new String[types.length];
65+
for (int i = 0; i < types.length; i++) {
66+
imports[i] = SessionStoreMappings.getConfigurationClass(types[i]);
7067
}
71-
}
72-
73-
@Configuration
74-
@ConditionalOnMissingBean(value = ServerProperties.class, search = SearchStrategy.CURRENT)
75-
// Just in case user switches off ServerPropertiesAutoConfiguration
76-
public static class ServerPropertiesConfiguration {
77-
78-
@Bean
79-
// Use the same bean name as the default one for any old webapp
80-
public ServerProperties serverProperties() {
81-
return new ServerProperties();
82-
}
83-
68+
return imports;
8469
}
8570

8671
}

0 commit comments

Comments
 (0)