JConsul is a builder style Java client for Consul, using async-http-client and Netty for http request and will have limited dependencies of 3rd libs.
JConsul will have a recipes module contains some utils such as Spring bean auto reload support when configuration or service registration change.
JConsul support consul 0.5.x now.
JConsul need jdk 1.7+ to build
git checkout v0.3.0
mvn clean install -Dmaven.test.skip=true
Maven:
<dependencies>
<dependency>
<groupId>com.loukou.jconsul</groupId>
<artifactId>jconsul-client</artifactId>
<version>0.3.0</version>
</dependency>
<dependency>
<groupId>com.loukou.jconsul</groupId>
<artifactId>jconsul-spring</artifactId>
<version>0.3.0</version>
</dependency>
</dependencies>Note: Only JConsul instance is thread safe, all the other instances have no thread safe guarantee
Agent:
JConsul jconsul=new JConsul();
Agent agent=jconsul.agent().self();
Map<String, Service> services = jconsul.agent().services();
Map<String, HealthCheck> checks = jconsul.agent().checks();
List<Member> list = jconsul.agent().members();
//check register
RegisterStatus checkStatus = jconsul.agent().registerCheck("test").id("test-check").notes("test").ttl(10);
checkStatus.pass();
checkStatus.fail("fail reason");
checkStatus.deregister();
//service register
RegisterStatus serviceStatus = jconsul.agent().registerService("test-service").port(1234).tags("test","example").ttl(10);
serviceStatus.pass();
serviceStatus.fail("reason");
serviceStatus.deregister();Key Value:
//get
JConsulResponse<Value> response = jconsul.keyValue().get("testKey").poll(1, 1)
.consistency(ConsistencyMode.STALE).response();
Optional<Value> valueOptional = jconsul.keyValue().get("testKey").value();
Optional<String> rawValue = jconsul.keyValue().get("testKey").raw().value();
jconsul.keyValue().get("testKey").poll(1, index).async(new JConsulResponseCallback<Value>() {
@Override
public void onFailure(Throwable throwable) {
LOGGER.warn(throwable.getMessage(),throwable);
}
@Override
public void onComplete(JConsulResponse<Value> consulResponse) {
//do something
//async call again
jconsul.keyValue().get(key).poll(1, consulResponse.getIndex()).async(this);
});
//keys
JConsulResponse<List<String>> response = jconsul.keyValue().get("test").keys().response();
//put
boolean success=jconsul.keyValue().put("test/key").flags(123).value("test value");
//delete
boolean result=jconsul.keyValue().delete("test/abc").cas(index).execute();Catalog:
JConsulResponse<List<Node>> nodeListResponse = jconsul.catalog().nodes().response();
Optional<CatalogNode> nodeOptional = jconsul.catalog().node("nodename").value();
jconsul.catalog().register("testNode", "127.0.0.1").service("testServiceId", "testService").port(8080).check("testServiceCheckId", "testServiceCheck")
.forService("testNode", "testServiceId").status("passing").execute();
Health:
List<HealthCheck> list = jconsul.health().node("testNode").value().get();
List<HealthCheck> list = jconsul.health().checks("serviceName").value().get();
List<HealthService> list = jconsul.health().service("serviceName").value().get();
List<HealthCheck> list=jconsul.health().status("passing").value().get();Session:
Optional<Session> sessionOpional = jconsul.session().info(sessionId).value();
SessionStatus session = jconsul.session().create().name("testSession").behavior("delete").lockDelay(1000).ttl(20).node(nodename).execute();
Session s=session.renew();
session.destroy();
List<Session> sessionList = jconsul.session().list().value();
List<Session> nodeSessions = jconsul.session().node(nodename).value();
Status
String leader=jconsul.status().leader();
List<String> peers=jconsul.status().peers();ServiceRegisterLifecycle
ServiceRegisterLifecycle will register your application to consul via http agent api and deregister it when shutdown
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:jconsul="http://www.loukou.com/schema/jconsul"
xsi:schemaLocation="
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.loukou.com/schema/jconsul http://www.loukou.com/schema/jconsul/jconsul.xsd
">
<!-- either of the following ways is ok -->
<jconsul:registration name="jconsul-spring-lifecycle-unittest" tag="tag1,tag2" />
<bean class="com.loukou.jconsul.spring.ServiceRegisterLifecycle">
<property name="serviceName" value="jconsul-spring-lifecycle-unittest" />
<property name="serviceTags">
<array>
<value>tag1</value>
<value>tag2</value>
</array>
</property>
<property name="servicePort" value="8080"/>
<property name="serviceCheckTtl" value="10"/>
<property name="serviceCheckPassPeriod" value="3"/>
</bean>
JConsulPropertyPlaceholderConfigurer
JConsulPropertyPlaceholderConfigurer extends org.springframework.beans.factory.config.PropertyPlaceholderConfigurer, you can use it like PropertyPlaceholderConfigurer in your Spring based project.
JConsulPropertyPlaceholderConfigurer will resolve the placeholder from consul key values. When your project is not running in a consul environment, set fallbackToFileWhenNotExists true to fallback to the locations properties files. All the other properties are extends from PropertyPlaceholderConfigurer
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:jconsul="http://www.loukou.com/schema/jconsul"
xsi:schemaLocation="
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.loukou.com/schema/jconsul http://www.loukou.com/schema/jconsul/jconsul.xsd
">
<!-- either of the following ways is ok -->
<jconsul:property-placeholder
fallbackToFileWhenNotExists="true" location="classpath:test.properties" />
<bean id="servicePlaceholderConfig"
class="com.loukou.jconsul.spring.JConsulPropertyPlaceholderConfigurer">
<property name="location" value="classpath:test.properties" />
<property name="fallbackToFileWhenNotExists" value="true" />
</bean>JConsulConfiguration
This class is a helper for Spring EL use to access consul service addresses. Futher, this will help to implement auto reloadable beans suppport.
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:jconsul="http://www.loukou.com/schema/jconsul"
xsi:schemaLocation="
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.loukou.com/schema/jconsul http://www.loukou.com/schema/jconsul/jconsul.xsd
">
<jconsul:configuration />
<jconsul:property-placeholder
fallbackToFileWhenNotExists="true" location="classpath:test.properties" />
<bean class="com.loukou.jconsul.spring.PlaceholderTestBean">
<property name="desc"
value="${__unittest/com.loukou.jconsul.spring.PlaceholderTestBean/desc}" />
<property name="kv"
value="#{jconsulConfig.config('__unittest/com.loukou.jconsul.spring.PlaceholderTestBean/desc')}"></property>
<property name="randomAddress" value="#{jconsulConfig.randomAddress('config_unittest')}"></property>
</bean>