# xxl-job-spring-boot-starter

**Repository Path**: asurplus/xxl-job-spring-boot-starter

## Basic Information

- **Project Name**: xxl-job-spring-boot-starter
- **Description**: 自定义封装的 xxl-job-spring-boot-starter
- **Primary Language**: Java
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 1
- **Created**: 2022-04-29
- **Last Updated**: 2022-10-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# xxl-job-spring-boot-starter

#### 介绍

封装xxl-job-spring-boot-starter

#### 版本说明

1. SpringBoot: 2.5.3
2. xxl-job-core：2.3.0

### 使用说明

使用 maven 打包
```
mvn clean install
```

在 target 目录得到 xxl-job-spring-boot-starter-2.3.0.jar 文件，将文件放在项目的 /resources/lib/ 目录下，在项目中引入
```
<!-- xxl-job-spring-boot-starter：https://gitee.com/asurplus/xxl-job-spring-boot-starter -->
<dependency>
    <groupId>com.asurplus</groupId>
    <artifactId>xxl-job-spring-boot-starter</artifactId>
    <version>2.3.0</version>
    <systemPath>${project.basedir}/src/main/resources/lib/xxl-job-spring-boot-starter-2.3.0.jar</systemPath>
</dependency>
```

配置信息：
```
# xxl-job配置信息
xxl-job:
  admin:
    # 调度中心部署跟地址 [选填]：如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调"；为空则关闭自动注册
    addresses: http://127.0.0.1:8080/xxl-job-admin
   # 执行器通讯TOKEN [选填]：非空时启用
  accessToken:
  executor:
    # 执行器AppName [选填]：执行器心跳注册分组依据；为空则关闭自动注册
    appname: xxl-job-executor-sample
    # 执行器注册 [选填]：优先使用该配置作为注册地址，为空时使用内嵌服务 ”IP:PORT“ 作为注册地址。从而更灵活的支持容器类型执行器动态IP和动态映射端口问题
    address:
    # 执行器IP [选填]：默认为空表示自动获取IP，多网卡时可手动设置指定IP，该IP不会绑定Host仅作为通讯实用；地址信息用于 "执行器注册" 和 "调度中心请求并触发任务"
    ip: 127.0.0.1
    # 执行器端口号 [选填]：小于等于0则自动获取；默认端口为9999，单机部署多个执行器时，注意要配置不同执行器端口
    port: 9999
    # 执行器运行日志文件存储磁盘路径 [选填] ：需要对该路径拥有读写权限；为空则使用默认路径
    logpath:
    # 执行器日志文件保存天数 [选填] ： 过期日志自动清理, 限制值大于等于3时生效; 否则, 如-1, 关闭自动清理功能
    logretentiondays: 30
```