Jesque 技术文档

1. 安装指南

环境要求

• Java 7 或更高版本
• Maven 3.x
• Redis 服务器

安装步骤

1. 下载源码： 你可以从 GitHub 下载 Jesque 的最新源码：

   git clone https://github.com/gresrun/jesque.git
   

2. 通过 Maven 安装： 如果你使用 Maven 管理项目，可以在 pom.xml 中添加以下依赖：

   <dependency>
     <groupId>net.greghaines</groupId>
     <artifactId>jesque</artifactId>
     <version>2.2.0</version>
   </dependency>
   

3. 配置 Redis： Jesque 依赖 Redis 作为后台存储。确保 Redis 服务器已启动并运行在默认端口 6379。

2. 项目的使用说明

快速开始

以下是一个简单的 Jesque 使用示例：

// 配置
final Config config = new ConfigBuilder().build();

// 添加一个任务到队列
final Job job = new Job("TestAction", new Object[]{ 1, 2.3, true, "test", Arrays.asList("inner", 4.5)});
final Client client = new ClientImpl(config);
client.enqueue("foo", job);
client.end();

// 启动一个工作线程来运行队列中的任务
final Worker worker = new WorkerImpl(config, Arrays.asList("foo"), new MapBasedJobFactory(map(entry("TestAction", TestAction.class))));
final Thread workerThread = new Thread(worker);
workerThread.start();

// 关闭工作线程
worker.end(true);
try { workerThread.join(); } catch (Exception e){ e.printStackTrace(); }

延迟任务

延迟任务可以在未来的某个时间点执行：

final long delay = 10; // 延迟时间（秒）
final long future = System.currentTimeMillis() + (delay * 1000); // 时间戳

client.delayedEnqueue("fooDelay", job, future);

周期性任务

周期性任务可以在特定时间开始，并按指定间隔执行：

final long delay = 10; // 延迟时间（秒）
final long future = System.currentTimeMillis() + (delay * 1000); // 时间戳
final long frequency = 60; // 间隔时间（秒）

client.recurringEnqueue("fooRecur", job, future, (frequency * 1000));

取消任务

可以取消延迟任务和周期性任务：

client.removeDelayedEnqueue("fooDelay", job);
client.removeRecurringEnqueue("fooRecur", job);

使用 ClientPool

在多线程应用中，可以使用 ClientPool：

final Client jesqueClientPool = new ClientPoolImpl(config, PoolUtils.createJedisPool(config));
jesqueClientPool.enqueue("foo", job);

监听器

可以在特定的工作线程事件上执行自定义回调：

int myVar = 0;
worker.getWorkerEventEmitter().addListener(new WorkerListener(){
   public void onEvent(WorkerEvent event, Worker worker, String queue, Job job, 
					   Object runner, Object result, Throwable t) {
    if (runner instanceof TestAction) {
        ((TestAction) runner).setSomeVariable(myVar);
    }
  }
}, WorkerEvent.JOB_EXECUTE);

3. 项目API使用文档

主要类和接口

• Config：配置类，用于设置 Jesque 的配置参数。
• Client：客户端接口，用于将任务添加到队列。
• Worker：工作线程接口，用于从队列中取出任务并执行。
• Job：任务类，表示一个具体的任务。

常用方法

• Client.enqueue(String queue, Job job)：将任务添加到指定队列。
• Client.delayedEnqueue(String queue, Job job, long future)：将延迟任务添加到指定队列。
• Client.recurringEnqueue(String queue, Job job, long future, long frequency)：将周期性任务添加到指定队列。
• Worker.start()：启动工作线程。
• Worker.end(boolean waitForJobsToFinish)：停止工作线程。

4. 项目安装方式

通过 Maven 安装

在 pom.xml 中添加以下依赖：

<dependency>
  <groupId>net.greghaines</groupId>
  <artifactId>jesque</artifactId>
  <version>2.2.0</version>
</dependency>

手动安装

1. 下载 Jesque 的源码。
2. 使用 Maven 编译并安装到本地仓库：

   mvn clean install
   

通过以上步骤，你可以在项目中使用 Jesque 来管理和执行任务。