# task-message

**Repository Path**: superxcy/task-message

## Basic Information

- **Project Name**: task-message
- **Description**: 任务消息组件
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-03-06
- **Last Updated**: 2026-03-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: 任务消息

## README

# task-message 框架

## 项目简介

`task-message` 是一个基于 Spring 事件机制的任务消息处理框架，提供了简洁的任务消息发布和处理能力。该框架通过 Spring 的事件系统实现任务消息的异步处理，支持任务消息的发布、监听和处理。

## 功能特性

- **自动配置**：基于 Spring Boot 自动配置，无需手动配置
- **异步处理**：使用 `@Async` 注解实现任务消息的异步处理
- **事件驱动**：基于 Spring 事件机制，解耦消息发布和处理
- **简单易用**：提供简洁的 API 接口，方便集成和使用

## 目录结构

```
task-message/
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   └── com/sky/task/
│   │   │       ├── config/            # 配置类
│   │   │       ├── entity/            # 实体类
│   │   │       ├── handler/           # 处理器接口
│   │   │       ├── listener/          # 事件监听器
│   │   │       └── service/           # 服务接口
│   │   └── resources/
│   │       └── META-INF/
│   │           └── spring.factories   # Spring 自动配置
│   └── test/                          # 测试代码
├── .gitignore
├── pom.xml                            # Maven 依赖
└── ReadMe.md                          # 项目说明
```

## 核心组件

### 1. 实体类

- **TaskMessage**：任务消息实体，包含任务 ID 和任务名称
- **SpringTaskMessageEvent**：Spring 事件包装类，用于包装 TaskMessage

### 2. 配置类

- **TaskMessageAutoConfig**：自动配置类，启用异步和调度功能

### 3. 接口

- **TaskMessageHandler**：任务消息处理接口，用于自定义任务消息处理逻辑
- **TaskMessageEventPublisher**：任务消息发布接口，用于发布任务消息事件

### 4. 监听器

- **TaskMessageEventListener**：事件监听器，异步处理任务消息事件

## 快速开始

### 1. 依赖引入

在 Maven 项目中引入 `task-message` 依赖：

```xml
<dependency>
    <groupId>com.sky.task</groupId>
    <artifactId>task-message</artifactId>
    <version>1.0.0</version>
</dependency>
```

### 2. 配置启用

该框架基于 Spring Boot 自动配置，无需额外配置，只需确保项目中启用了 `@EnableAsync` 和 `@EnableScheduling` 注解（框架已自动配置）。

### 3. 使用示例

#### 3.1 发布任务消息

```java
@Resource
private TaskMessageEventPublisher publisher;

public void publishTask() {
    TaskMessage taskMessage = new TaskMessage();
    taskMessage.setTaskId("100001");
    taskMessage.setTaskName("测试任务");
    publisher.publishEvent(taskMessage);
}
```

#### 3.2 自定义任务消息处理

实现 `TaskMessageHandler` 接口：

```java
@Component
public class CustomTaskMessageHandler implements TaskMessageHandler {
    @Override
    public void handleTaskMessage(TaskMessage taskMessage) {
        // 自定义处理逻辑
        System.out.println("处理任务消息：" + taskMessage);
    }
}
```

## 依赖说明

- **Spring Boot**：2.0+ 版本
- **Lombok**：用于简化代码

## 注意事项

1. 确保项目中启用了异步处理功能（框架已通过 `@EnableAsync` 自动配置）
2. 自定义 `TaskMessageHandler` 实现时，需要使用 `@Component` 注解使其被 Spring 管理
3. 任务消息处理可能会在异步线程中执行，注意线程安全问题
4. 可以通过扩展 `TaskMessage` 类添加更多字段，以满足业务需求

## 测试

项目包含测试代码，可通过以下命令运行测试：

```bash
mvn test
```

## 版本历史

- 1.0.0：初始版本，实现基本的任务消息发布和处理功能

## 许可证

MIT License