# aTask
**Repository Path**: jonzhang-3/a-task
## Basic Information
- **Project Name**: aTask
- **Description**: 一个简单的多用途异步任务执行框架
- **Primary Language**: Java
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 38
- **Forks**: 14
- **Created**: 2020-10-01
- **Last Updated**: 2022-02-18
## Categories & Tags
**Categories**: task-schedule
**Tags**: None
## README
[](https://www.codacy.com/gh/JonZhang3/aTask/dashboard?utm_source=github.com&utm_medium=referral&utm_content=JonZhang3/aTask&utm_campaign=Badge_Grade)
# ATask
> 一个简单的多用途异步任务执行框架
### 主要特性
1. 操作简便，采用链式调用
2. 多种任务类型：可设置回调的任务，可获取返回结果的任务，任务组
3. 可自定义任务的类型，超时时间等参数
4. 灵活，可阻塞当前线程，亦可设置回调方法
5. 实时获取正在运行任务状态，对已完成任务进行自定义处理
6. 可实时监控任务执行情况
### 使用说明
#### 引入
Maven
```xml
com.github.jonzhang3
aTask
1.1.0
```
#### 示例
##### 首先创建任务执行的引擎（线程池）
```java
TaskEngine engine = new TaskEngine.Builder()
.corePoolSize(3)// 设置核心线程池大小，默认为系统 CPU 核数
.maxPoolSize(100)// 设置线程池的最大大小，默认为 Integer.MAX_VALUE
.keepAliveSeconds(1000)// 设置线程的最大空闲时间，默认为 60 秒
// 设置任务等待队列的大小，默认为 Integer.MAX_VALUE
// 如果设置的为负数，则采用 SynchronousQueue，否则采用 LinkedBlockingQueue
.queueCapacity(20)
// 设置线程池的任务拒绝策略
.rejectedExecutionHandler(RejectedExecutionHandler)
.completedTaskHandler(handler)// 设置对已完成任务的处理回调
.build();
// 可通过 getRunningTasks() 方法获取当前正在执行的任务
```
##### 1. 使用回调处理执行结果的任务的使用
```java
Task task = engine.buildTask(ctx -> {
ctx.onProgress(100);// 设置进度值，将调用进度回调函数
ctx.onSuccess("1", "2", "3");// 设置任务执行成功，将调用结果回调函数
ctx.onError(Exception);// 设置任务执行失败，将调用结果回调函数
// 如果 onSuccess 和 onError 都调用了，则第首先执行的方法将会调用成功
})
.type("type")// 设置任务的类型
.progress(progress -> {})// 设置任务的进度回调
// 设置任务的结果回调
// 如果任务执行失败，error 则不为 null；如果任务执行成功，error 则为 null
.end((ctx, error) -> {
if(error != null) {// 执行成功
ctx.getResult();// 获取 onSuccess 设置的数据
} else {// 执行失败
log.error(error);// 打印错误
}
})
.build();
engine.go(task);// 最后调用 TaskEngine 的 go 方法执行该任务
task.await(); // 该方法会阻塞当前线程，如果你需要等待任务执行完成再继续执行，则调用该方法
```
##### 2. 具有返回结果的任务的使用
```java
ResultTask resultTask = engine.buildResultTask(ctx -> {
ctx.onProgress(200);
return "success";// 返回结果数据
})
.type("type")
.progress(i -> {})
.build();
engine.go(resultTask);
// 获取返回结果
// 该方法会阻塞当前线程
String result = resultTask.get();
```
##### 3. 任务组的使用
```java
TaskGroup group = engine.prepareGroup();// 创建一个任务组
// 添加并执行一个任务
group.go(group.buildItem(ctx -> {
ctx.group().incrementCounter();// 计数器 +1（线程安全）
ctx.group().addData("data");// 设置数据，方便后续使用
}).build());
group.await();// 等待线程组中所有的任务执行完成
group.getCounter();// 获取计数器的结果
Data data = group.getData();// 获取组中任务执行时设置的数据（线程安全）
```
##### 4. 监控页面的使用
##### 第一种方式：
注册一个 ServletRegistrationBean 类
```java
@Bean
public ServletRegistrationBean druidStatViewServlet() {
TaskEngine engine = new TaskEngine.Builder()
.build();
engine.prepareGroup("test");
// 设置 TaskEngine
TaskStatService.setTaskEngine(engine);
// 注册 StatViewServlet，并为其设置路径
ServletRegistrationBean registrationBean =
new ServletRegistrationBean<>(new StatViewServlet(), "/atask/*");
registrationBean.addInitParameter("username", "root");// 设置登录用户名
registrationBean.addInitParameter("password", "1234");// 设置登录密码
return registrationBean;
}
```
##### 第二种方式：
首先新建一个 `TaskEngine`, 然后将其设置到 `TaskStatService`
```java
// 也可以采用其他方式
static TaskEngine engine;
static {
engine = new TaskEngine.Builder()
.build();
TaskStatService.setTaskEngine(engine);
}
```
然后新建一个 `Servlet` 类，并添加 `@WebServlet` 注解
```java
@WebServlet(
urlPatterns = "/atask/*",
initParams = {
@WebInitParam(name = "username", value = "admin"),
@WebInitParam(name = "password", value = "123456"),
}
)
public class ATaskStatServlet extends StatViewServlet {
}
```
不要忘了在启动类上添加 `@ServletComponentScan` 注解
```java
@SpringBootApplication
@ServletComponentScan
public class DemoApplication {
}
```
监控页面：
