Fix Hazelcast Cache auto-configuration ordering
Spring Boot supports the automatic configuration of an additional HazelcastInstance if one already exists and an explicit property has been set to use a different configuration for caching. So three cases are supported really: no `HazelcastInstance` exists so we need to create one anyway or an `HazelcastInstance` already exists; in that latter case, we should either reuse it or create a new one. Unfortunately, the conditions that checked those three use cases were not ordered consistently and we could easily get in a situation where both conditions were evaluated. This commit makes sure that we first check if an `HazelcastInstance` exists and then (and only then) we create the missing `HazelcastInstance` used for caching. The tests have also been improved to validate the proper `HazelcastInstance` is used for caching. Closes gh-5181pull/5190/head
Stephane Nicoll
9 years ago
parent
14a5feacea
commit
094f7aa20e
@ -0,0 +1,120 @@
|
||||
/*
|
||||
* Copyright 2012-2016 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.springframework.boot.autoconfigure.cache;
|
||||
|
||||
import java.io.Closeable;
|
||||
import java.io.IOException;
|
||||
|
||||
import com.hazelcast.core.Hazelcast;
|
||||
import com.hazelcast.core.HazelcastInstance;
|
||||
import com.hazelcast.spring.cache.HazelcastCacheManager;
|
||||
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
|
||||
import org.springframework.boot.autoconfigure.condition.ConditionalOnSingleCandidate;
|
||||
import org.springframework.boot.autoconfigure.hazelcast.HazelcastConfigResourceCondition;
|
||||
import org.springframework.boot.autoconfigure.hazelcast.HazelcastInstanceFactory;
|
||||
import org.springframework.context.annotation.Bean;
|
||||
import org.springframework.context.annotation.Conditional;
|
||||
import org.springframework.context.annotation.Configuration;
|
||||
import org.springframework.core.io.Resource;
|
||||
|
||||
/**
|
||||
* Actual {@link HazelcastInstance} configurations imported by
|
||||
* {@link HazelcastCacheConfiguration}.
|
||||
*
|
||||
* @author Stephane Nicoll
|
||||
*/
|
||||
abstract class HazelcastInstanceConfiguration {
|
||||
|
||||
@Configuration
|
||||
@ConditionalOnSingleCandidate(HazelcastInstance.class)
|
||||
static class Existing {
|
||||
|
||||
@Autowired
|
||||
private CacheProperties cacheProperties;
|
||||
|
||||
@Bean
|
||||
public HazelcastCacheManager cacheManager(
|
||||
HazelcastInstance existingHazelcastInstance) throws IOException {
|
||||
Resource config = this.cacheProperties.getHazelcast().getConfig();
|
||||
Resource location = this.cacheProperties.resolveConfigLocation(config);
|
||||
if (location != null) {
|
||||
HazelcastInstance cacheHazelcastInstance = new HazelcastInstanceFactory(
|
||||
location).getHazelcastInstance();
|
||||
return new CloseableHazelcastCacheManager(cacheHazelcastInstance);
|
||||
}
|
||||
return new HazelcastCacheManager(existingHazelcastInstance);
|
||||
}
|
||||
}
|
||||
|
||||
@Configuration
|
||||
@ConditionalOnMissingBean(HazelcastInstance.class)
|
||||
@Conditional(ConfigAvailableCondition.class)
|
||||
static class Specific {
|
||||
|
||||
@Autowired
|
||||
private CacheProperties cacheProperties;
|
||||
|
||||
@Bean
|
||||
public HazelcastInstance hazelcastInstance() throws IOException {
|
||||
Resource config = this.cacheProperties.getHazelcast().getConfig();
|
||||
Resource location = this.cacheProperties.resolveConfigLocation(config);
|
||||
if (location != null) {
|
||||
return new HazelcastInstanceFactory(location).getHazelcastInstance();
|
||||
}
|
||||
return Hazelcast.newHazelcastInstance();
|
||||
}
|
||||
|
||||
@Bean
|
||||
public HazelcastCacheManager cacheManager() throws IOException {
|
||||
return new HazelcastCacheManager(hazelcastInstance());
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* {@link HazelcastConfigResourceCondition} that checks if the
|
||||
* {@code spring.cache.hazelcast.config} configuration key is defined.
|
||||
*/
|
||||
static class ConfigAvailableCondition extends HazelcastConfigResourceCondition {
|
||||
|
||||
ConfigAvailableCondition() {
|
||||
super("spring.cache.hazelcast", "config");
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
private static class CloseableHazelcastCacheManager extends HazelcastCacheManager
|
||||
implements Closeable {
|
||||
|
||||
private final HazelcastInstance hazelcastInstance;
|
||||
|
||||
CloseableHazelcastCacheManager(HazelcastInstance hazelcastInstance) {
|
||||
super(hazelcastInstance);
|
||||
this.hazelcastInstance = hazelcastInstance;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void close() throws IOException {
|
||||
this.hazelcastInstance.shutdown();
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
Loading…
Reference in New Issue