Add ConnectionDetail support to Redis auto-configuration
Update Redis auto-configuration so that `RedisConnectionDetails` beans may be optionally used to provide connection details. See gh-34657 Co-Authored-By: Mortitz Halbritter <mkammerer@vmware.com> Co-Authored-By: Phillip Webb <pwebb@vmware.com>pull/34759/head
Andy Wilkinson
2 years ago
parent
69f31cb6c0
commit
ac55caa463
@ -0,0 +1,127 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2012-2023 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
|
||||||
|
*
|
||||||
|
* https://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.data.redis;
|
||||||
|
|
||||||
|
import java.util.List;
|
||||||
|
|
||||||
|
import org.springframework.boot.autoconfigure.data.redis.RedisConnectionConfiguration.ConnectionInfo;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Adapts {@link RedisProperties} to {@link RedisConnectionDetails}.
|
||||||
|
*
|
||||||
|
* @author Moritz Halbritter
|
||||||
|
* @author Andy Wilkinson
|
||||||
|
* @author Phillip Webb
|
||||||
|
*/
|
||||||
|
class PropertiesRedisConnectionDetails implements RedisConnectionDetails {
|
||||||
|
|
||||||
|
private final RedisProperties properties;
|
||||||
|
|
||||||
|
PropertiesRedisConnectionDetails(RedisProperties properties) {
|
||||||
|
this.properties = properties;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public String getUsername() {
|
||||||
|
if (this.properties.getUrl() != null) {
|
||||||
|
ConnectionInfo connectionInfo = connectionInfo(this.properties.getUrl());
|
||||||
|
String userInfo = connectionInfo.getUri().getUserInfo();
|
||||||
|
int index = (userInfo != null) ? userInfo.indexOf(':') : -1;
|
||||||
|
if (index != -1) {
|
||||||
|
return userInfo.substring(0, index);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return this.properties.getUsername();
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public String getPassword() {
|
||||||
|
if (this.properties.getUrl() != null) {
|
||||||
|
ConnectionInfo connectionInfo = connectionInfo(this.properties.getUrl());
|
||||||
|
String userInfo = connectionInfo.getUri().getUserInfo();
|
||||||
|
int index = (userInfo != null) ? userInfo.indexOf(':') : -1;
|
||||||
|
if (index != -1) {
|
||||||
|
return userInfo.substring(index + 1);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return this.properties.getPassword();
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public Standalone getStandalone() {
|
||||||
|
if (this.properties.getUrl() != null) {
|
||||||
|
ConnectionInfo connectionInfo = connectionInfo(this.properties.getUrl());
|
||||||
|
return Standalone.of(connectionInfo.getUri().getHost(), connectionInfo.getUri().getPort(),
|
||||||
|
this.properties.getDatabase());
|
||||||
|
}
|
||||||
|
return Standalone.of(this.properties.getHost(), this.properties.getPort(), this.properties.getDatabase());
|
||||||
|
}
|
||||||
|
|
||||||
|
private ConnectionInfo connectionInfo(String url) {
|
||||||
|
return (url != null) ? RedisConnectionConfiguration.parseUrl(url) : null;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public Sentinel getSentinel() {
|
||||||
|
org.springframework.boot.autoconfigure.data.redis.RedisProperties.Sentinel sentinel = this.properties
|
||||||
|
.getSentinel();
|
||||||
|
if (sentinel == null) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
return new Sentinel() {
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public int getDatabase() {
|
||||||
|
return PropertiesRedisConnectionDetails.this.properties.getDatabase();
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public String getMaster() {
|
||||||
|
return sentinel.getMaster();
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public List<Node> getNodes() {
|
||||||
|
return sentinel.getNodes().stream().map(PropertiesRedisConnectionDetails.this::asNode).toList();
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public String getUsername() {
|
||||||
|
return sentinel.getUsername();
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public String getPassword() {
|
||||||
|
return sentinel.getPassword();
|
||||||
|
}
|
||||||
|
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public Cluster getCluster() {
|
||||||
|
RedisProperties.Cluster cluster = this.properties.getCluster();
|
||||||
|
List<Node> nodes = (cluster != null) ? cluster.getNodes().stream().map(this::asNode).toList() : null;
|
||||||
|
return (nodes != null) ? () -> nodes : null;
|
||||||
|
}
|
||||||
|
|
||||||
|
private Node asNode(String node) {
|
||||||
|
String[] components = node.split(":");
|
||||||
|
return new Node(components[0], Integer.parseInt(components[1]));
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
@ -0,0 +1,190 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2012-2023 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
|
||||||
|
*
|
||||||
|
* https://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.data.redis;
|
||||||
|
|
||||||
|
import java.util.List;
|
||||||
|
|
||||||
|
import org.springframework.boot.autoconfigure.service.connection.ConnectionDetails;
|
||||||
|
import org.springframework.util.Assert;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Details required to establish a connection to a Redis service.
|
||||||
|
*
|
||||||
|
* @author Moritz Halbritter
|
||||||
|
* @author Andy Wilkinson
|
||||||
|
* @since 3.1.0
|
||||||
|
*/
|
||||||
|
public interface RedisConnectionDetails extends ConnectionDetails {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Login username of the redis server.
|
||||||
|
* @return the login username of the redis server
|
||||||
|
*/
|
||||||
|
default String getUsername() {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Login password of the redis server.
|
||||||
|
* @return the login password of the redis server
|
||||||
|
*/
|
||||||
|
default String getPassword() {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Redis standalone configuration. Mutually exclusive with {@link #getSentinel()} and
|
||||||
|
* {@link #getCluster()}.
|
||||||
|
* @return the Redis standalone configuration
|
||||||
|
*/
|
||||||
|
default Standalone getStandalone() {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Redis sentinel configuration. Mutually exclusive with {@link #getStandalone()} and
|
||||||
|
* {@link #getCluster()}.
|
||||||
|
* @return the Redis sentinel configuration
|
||||||
|
*/
|
||||||
|
default Sentinel getSentinel() {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Redis cluster configuration. Mutually exclusive with {@link #getStandalone()} and
|
||||||
|
* {@link #getSentinel()}.
|
||||||
|
* @return the Redis cluster configuration
|
||||||
|
*/
|
||||||
|
default Cluster getCluster() {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Redis standalone configuration.
|
||||||
|
*/
|
||||||
|
interface Standalone {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Redis server host.
|
||||||
|
* @return the redis server host
|
||||||
|
*/
|
||||||
|
String getHost();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Redis server port.
|
||||||
|
* @return the redis server port
|
||||||
|
*/
|
||||||
|
int getPort();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Database index used by the connection factory.
|
||||||
|
* @return the database index used by the connection factory
|
||||||
|
*/
|
||||||
|
default int getDatabase() {
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
static Standalone of(String host, int port) {
|
||||||
|
return of(host, port, 0);
|
||||||
|
}
|
||||||
|
|
||||||
|
static Standalone of(String host, int port, int database) {
|
||||||
|
Assert.hasLength(host, "Host must not be empty");
|
||||||
|
return new Standalone() {
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public String getHost() {
|
||||||
|
return host;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public int getPort() {
|
||||||
|
return port;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public int getDatabase() {
|
||||||
|
return database;
|
||||||
|
}
|
||||||
|
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Redis sentinel configuration.
|
||||||
|
*/
|
||||||
|
interface Sentinel {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Database index used by the connection factory.
|
||||||
|
* @return the database index used by the connection factory
|
||||||
|
*/
|
||||||
|
int getDatabase();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Name of the Redis server.
|
||||||
|
* @return the name of the Redis server
|
||||||
|
*/
|
||||||
|
String getMaster();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* List of nodes.
|
||||||
|
* @return the list of nodes
|
||||||
|
*/
|
||||||
|
List<Node> getNodes();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Login username for authenticating with sentinel(s).
|
||||||
|
* @return the login username for authenticating with sentinel(s) or {@code null}
|
||||||
|
*/
|
||||||
|
String getUsername();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Password for authenticating with sentinel(s).
|
||||||
|
* @return the password for authenticating with sentinel(s) or {@code null}
|
||||||
|
*/
|
||||||
|
String getPassword();
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Redis cluster configuration.
|
||||||
|
*/
|
||||||
|
interface Cluster {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Nodes to bootstrap from. This represents an "initial" list of cluster nodes and
|
||||||
|
* is required to have at least one entry.
|
||||||
|
* @return nodes to bootstrap from
|
||||||
|
*/
|
||||||
|
List<Node> getNodes();
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A node in a sentinel or cluster configuration.
|
||||||
|
*
|
||||||
|
* @param host the hostname of the node
|
||||||
|
* @param port the port of the node
|
||||||
|
*/
|
||||||
|
record Node(String host, int port) {
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
Loading…
Reference in New Issue