# xxl-job-plus

**Repository Path**: stepwen2/xxl-job-plus

## Basic Information

- **Project Name**: xxl-job-plus
- **Description**: 对xxl-job注解进行增强，无需上调度中心配置
- **Primary Language**: Java
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 2
- **Created**: 2024-07-22
- **Last Updated**: 2024-07-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# xxl-job-plus

## 功能

对 `xxl-job-core` 进行增强，增加自动注册执行器与任务功能

## 快速开始

### 引入jar包

```xml
<dependencies>

    <!-- 自行编译 -->
    <dependency>
        <groupId>cn.nn200433</groupId>
        <artifactId>xxl-job-plus-core</artifactId>
        <version>${最新版本}</version>
    </dependency>

</dependencies>
```

### 配置

```yaml
server:
  port: 18080
xxl:
  job:
    enable: true
    is-sync-modify-remote: false
    access-token: xxxxxxxx
    admin:
      addresses: http://127.0.0.1:8080/xxl-job-admin
      account: admin
      password: 123456
    executor:
      address: ''
      appname: xxl-job-plus
      ip: 127.0.0.1
      port: 9999
      logpath: ../logs/api
      logretentiondays: 30
```

详细说明请参考文件 [XxlJobProperties.java](xxl-job-plus-core/src/main/java/cn/nn200433/job/config/XxlJobProperties.java)

### 注解说明

#### @XxlJobPlus

说明：标识在方法上

参数：

* value：任务方法名称
* cron：cron 表达式
* init：初始化处理程序，在 JobThread 初始化时调用
* destroy：销毁处理程序，当 JobThread 销毁时调用
* desc：任务描述（默认值：默认调度任务）
* author：作者（默认值：系统管理员）
* status：触发状态，枚举类 [Trigger.java](xxl-job-plus-core/src/main/java/cn/nn200433/job/enums/Trigger.java)（默认值：启用）

示例：

```java
/**
 * 演示服务实现
 *
 * @author nn200433
 * @date 2024-06-14 01:18:00
 */
@Slf4j
@Component
public class DemoServiceImpl {

    @XxlJobPlus(value = "test", cron = "0/30 * * * * ?", desc = "xxlJobPlus 任务")
    public void execute1() {
        log.info("测试 xxlJobPlus 任务。。。");
    }

    @XxlJob(value = "test1")
    public void execute2() {
        log.info("测试 xxlJob 任务。。。");
    }

}
```

#### @XxlJob

兼容，具体用例参考[官方文档](https://www.xuxueli.com/xxl-job/#%E6%AD%A5%E9%AA%A4%E4%B8%80%EF%BC%9A%E6%89%A7%E8%A1%8C%E5%99%A8%E9%A1%B9%E7%9B%AE%E4%B8%AD%EF%BC%8C%E5%BC%80%E5%8F%91Job%E7%B1%BB%EF%BC%9A)

## 特别鸣谢

> 感谢以下的项目,排名不分先后

* [Hutool](https://hutool.cn) Hutool是一个Java工具包，让Java语言也可以“甜甜的”。
* [XXL-JOB](https://www.xuxueli.com/xxl-job/) XXL-JOB是一个分布式任务调度平台，其核心设计目标是开发迅速、学习简单、轻量级、易扩展。现已开放源代码并接入多家公司线上产品线，开箱即用。