Java SDK¶
WeEvent支持RESTful、JsonRPC、STOMP、MQTT等协议，方便各种语言的接入和适配。
同时为Java语言提供了独立的SDK。其他语言SDK在规划中，欢迎大家贡献代码，WeEvent代码仓库 。
集成SDK¶
- gradle依赖
implement 'com.webank.weevent:weevent-client:1.1.0'
- maven依赖
<dependency>
<groupId>com.webank.weevent</groupId>
<artifactId>weevent-client</artifactId>
<version>1.1.0</version>
</dependency>
API接口¶
public interface IWeEventClient {
/**
* Get the client handler of WeEvent's broker with default groupId and url, http://localhost:8080/weevent.
*
* @return IWeEventClient WeEventClient struct
* @throws BrokerException broker exception
*/
static IWeEventClient build() throws BrokerException {
return new WeEventClient();
}
/**
* Get the client handler of WeEvent's broker with custom url.
*
* @param brokerUrl WeEvent's broker url, like http://localhost:8080/weevent
* @return IWeEventClient WeEventClient struct
* @throws BrokerException broker exception
*/
static IWeEventClient build(String brokerUrl) throws BrokerException {
return new WeEventClient(brokerUrl);
}
/**
* Get the client handler of WeEvent's broker with custom groupId and url.
*
* @param brokerUrl WeEvent's broker url, like http://localhost:8080/weevent
* @param groupId groupId
* @return IWeEventClient WeEventClient struct
* @throws BrokerException broker exception
*/
static IWeEventClient build(String brokerUrl, String groupId) throws BrokerException {
return new WeEventClient(brokerUrl, groupId);
}
/**
* Get the client handler of WeEvent's broker custom url and account authorization.
*
* @param brokerUrl WeEvent's broker url, like http://localhost:8080/weevent
* @param groupId groupId
* @param userName account name
* @param password password
* @return IWeEventClient WeEventClient struct
* @throws BrokerException broker exception
*/
static IWeEventClient build(String brokerUrl, String groupId, String userName, String password) throws BrokerException {
return new WeEventClient(brokerUrl, groupId, userName, password);
}
/**
* Open a topic
*
* @param topic topic name
* @return true if success
* @throws BrokerException broker exception
*/
boolean open(String topic) throws BrokerException;
/**
* Close a topic.
*
* @param topic topic name
* @return true if success
* @throws BrokerException broker exception
*/
boolean close(String topic) throws BrokerException;
/**
* Check a topic is exist or not.
*
* @param topic topic name
* @return true if exist
* @throws BrokerException broker exception
*/
boolean exist(String topic) throws BrokerException;
/**
* Publish an event to topic.
*
* @param weEvent WeEvent(String topic, byte[] content, Map extensions)
* @return send result, SendResult.SUCCESS if success, and SendResult.eventId
* @throws BrokerException broker exception
*/
SendResult publish(WeEvent weEvent) throws BrokerException;
/**
* Interface for notify callback
*/
interface EventListener {
/**
* Called while new event arrived.
*
* @param event the event
*/
void onEvent(WeEvent event);
/**
* Called while raise exception.
*
* @param e the e
*/
void onException(Throwable e);
}
/**
* Subscribe events from topic.
*
* @param topic topic name
* @param offset from next event after this offset(an event id), WeEvent.OFFSET_FIRST if from head of queue, WeEvent.OFFSET_LAST if from tail of queue
* @param listener callback
* @return subscription Id
* @throws BrokerException invalid input param
*/
String subscribe(String topic, String offset, @NonNull EventListener listener) throws BrokerException;
/**
* Subscribe events from topic.
*
* @param topic topic name
* @param offset from next event after this offset(an event id), WeEvent.OFFSET_FIRST if from head of queue, WeEvent.OFFSET_LAST if from tail of queue
* @param subscriptionId keep last subscribe
* @param listener callback
* @return subscription Id
* @throws BrokerException invalid input param
*/
String subscribe(String topic, String offset, String subscriptionId, @NonNull EventListener listener) throws BrokerException;
/**
* Subscribe events from multiple topic.
*
* @param topics topic list
* @param offset from next event after this offset(an event id), WeEvent.OFFSET_FIRST if from head of queue, WeEvent.OFFSET_LAST if from tail of queue
* @param listener callback
* @return subscription Id
* @throws BrokerException invalid input param
*/
String subscribe(String[] topics, String offset, @NonNull EventListener listener) throws BrokerException;
/**
* Subscribe events from multiple topic.
*
* @param topics topic list
* @param offset from next event after this offset(an event id), WeEvent.OFFSET_FIRST if from head of queue, WeEvent.OFFSET_LAST if from tail of queue
* @param subscriptionId keep last subscribe
* @param listener callback
* @return subscription Id
* @throws BrokerException invalid input param
*/
String subscribe(String[] topics, String offset, String subscriptionId, @NonNull EventListener listener) throws BrokerException;
/**
* Unsubscribe an exist subscription subscribed by subscribe interface.
* The consumer will no longer receive messages from broker after this.
*
* @param subscriptionId invalid input
* @return success if true
* @throws BrokerException broker exception
*/
boolean unSubscribe(String subscriptionId) throws BrokerException;
/**
* List all topics in WeEvent's broker.
*
* @param pageIndex page index, from 0
* @param pageSize page size, [10, 100)
* @return topic list
* @throws BrokerException broker exception
*/
TopicPage list(Integer pageIndex, Integer pageSize) throws BrokerException;
/**
* Get a topic information.
*
* @param topic topic name
* @return topic information
* @throws BrokerException broker exception
*/
TopicInfo state(String topic) throws BrokerException;
/**
* Get an event information.
*
* @param eventId event id
* @return WeEvent
* @throws BrokerException broker exception
*/
WeEvent getEvent(String eventId) throws BrokerException;
}
代码样例¶
public static void main(String[] args) {
try {
IWeEventClient client = IWeEventClient.build("http://localhost:8080/weevent", WeEvent.DEFAULT_GROUP_ID);
String topicName = "com.weevent.test";
// open 一个"com.weevent.test"的主题
client.open(topicName);
// 发送hello WeEvent
WeEvent weEvent = new WeEvent(topicName,"hello WeEvent".getBytes());
SendResult sendResult = client.publish(weEvent);
System.out.println(sendResult);
} catch (BrokerException e) {
e.printStackTrace();
}
}
完整的代码请参见Java SDK代码样例 。