update document
This commit is contained in:
parent
9fed7b9c60
commit
c07d366aad
|
@ -1,58 +0,0 @@
|
||||||
package com.xxl.job.executor.service.jobhandler;
|
|
||||||
|
|
||||||
import com.xxl.job.core.biz.model.ReturnT;
|
|
||||||
import com.xxl.job.core.handler.IJobHandler;
|
|
||||||
import com.xxl.job.core.handler.annotation.JobHandler;
|
|
||||||
import com.xxl.job.core.log.XxlJobLogger;
|
|
||||||
import org.springframework.stereotype.Component;
|
|
||||||
|
|
||||||
import java.io.BufferedInputStream;
|
|
||||||
import java.io.BufferedReader;
|
|
||||||
import java.io.InputStreamReader;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* 命令行任务
|
|
||||||
*
|
|
||||||
* @author xuxueli 2018-09-16 03:48:34
|
|
||||||
*/
|
|
||||||
@JobHandler(value="commandJobHandler")
|
|
||||||
@Component
|
|
||||||
public class CommandJobHandler extends IJobHandler {
|
|
||||||
|
|
||||||
@Override
|
|
||||||
public ReturnT<String> execute(String param) throws Exception {
|
|
||||||
String command = param;
|
|
||||||
int exitValue = -1;
|
|
||||||
|
|
||||||
BufferedReader bufferedReader = null;
|
|
||||||
try {
|
|
||||||
// command process
|
|
||||||
Process process = Runtime.getRuntime().exec(command);
|
|
||||||
BufferedInputStream bufferedInputStream = new BufferedInputStream(process.getInputStream());
|
|
||||||
bufferedReader = new BufferedReader(new InputStreamReader(bufferedInputStream));
|
|
||||||
|
|
||||||
// command log
|
|
||||||
String line;
|
|
||||||
while ((line = bufferedReader.readLine()) != null) {
|
|
||||||
XxlJobLogger.log(line);
|
|
||||||
}
|
|
||||||
|
|
||||||
// command exit
|
|
||||||
process.waitFor();
|
|
||||||
exitValue = process.exitValue();
|
|
||||||
} catch (Exception e) {
|
|
||||||
XxlJobLogger.log(e);
|
|
||||||
} finally {
|
|
||||||
if (bufferedReader != null) {
|
|
||||||
bufferedReader.close();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if (exitValue == 0) {
|
|
||||||
return IJobHandler.SUCCESS;
|
|
||||||
} else {
|
|
||||||
return new ReturnT<String>(IJobHandler.FAIL.getCode(), "command exit value("+exitValue+") is failed");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
|
@ -1,38 +0,0 @@
|
||||||
package com.xxl.job.executor.service.jobhandler;
|
|
||||||
|
|
||||||
import com.xxl.job.core.biz.model.ReturnT;
|
|
||||||
import com.xxl.job.core.handler.IJobHandler;
|
|
||||||
import com.xxl.job.core.handler.annotation.JobHandler;
|
|
||||||
import com.xxl.job.core.log.XxlJobLogger;
|
|
||||||
import org.springframework.stereotype.Component;
|
|
||||||
|
|
||||||
import java.util.concurrent.TimeUnit;
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
* 任务Handler示例(Bean模式)
|
|
||||||
*
|
|
||||||
* 开发步骤:
|
|
||||||
* 1、继承"IJobHandler":“com.xxl.job.core.handler.IJobHandler”;
|
|
||||||
* 2、注册到Spring容器:添加“@Component”注解,被Spring容器扫描为Bean实例;
|
|
||||||
* 3、注册到执行器工厂:添加“@JobHandler(value="自定义jobhandler名称")”注解,注解value值对应的是调度中心新建任务的JobHandler属性的值。
|
|
||||||
* 4、执行日志:需要通过 "XxlJobLogger.log" 打印执行日志;
|
|
||||||
*
|
|
||||||
* @author xuxueli 2015-12-19 19:43:36
|
|
||||||
*/
|
|
||||||
@JobHandler(value="demoJobHandler")
|
|
||||||
@Component
|
|
||||||
public class DemoJobHandler extends IJobHandler {
|
|
||||||
|
|
||||||
@Override
|
|
||||||
public ReturnT<String> execute(String param) throws Exception {
|
|
||||||
XxlJobLogger.log("XXL-JOB, Hello World.");
|
|
||||||
|
|
||||||
for (int i = 0; i < 5; i++) {
|
|
||||||
XxlJobLogger.log("beat at:" + i);
|
|
||||||
TimeUnit.SECONDS.sleep(2);
|
|
||||||
}
|
|
||||||
return SUCCESS;
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
|
@ -1,85 +0,0 @@
|
||||||
package com.xxl.job.executor.service.jobhandler;
|
|
||||||
|
|
||||||
import com.xxl.job.core.biz.model.ReturnT;
|
|
||||||
import com.xxl.job.core.handler.IJobHandler;
|
|
||||||
import com.xxl.job.core.handler.annotation.JobHandler;
|
|
||||||
import com.xxl.job.core.log.XxlJobLogger;
|
|
||||||
import org.springframework.stereotype.Component;
|
|
||||||
|
|
||||||
import java.io.BufferedReader;
|
|
||||||
import java.io.InputStreamReader;
|
|
||||||
import java.net.HttpURLConnection;
|
|
||||||
import java.net.URL;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* 跨平台Http任务
|
|
||||||
*
|
|
||||||
* @author xuxueli 2018-09-16 03:48:34
|
|
||||||
*/
|
|
||||||
@JobHandler(value = "httpJobHandler")
|
|
||||||
@Component
|
|
||||||
public class HttpJobHandler extends IJobHandler {
|
|
||||||
|
|
||||||
@Override
|
|
||||||
public ReturnT<String> execute(String param) throws Exception {
|
|
||||||
|
|
||||||
// request
|
|
||||||
HttpURLConnection connection = null;
|
|
||||||
BufferedReader bufferedReader = null;
|
|
||||||
try {
|
|
||||||
// connection
|
|
||||||
URL realUrl = new URL(param);
|
|
||||||
connection = (HttpURLConnection) realUrl.openConnection();
|
|
||||||
|
|
||||||
// connection setting
|
|
||||||
connection.setRequestMethod("GET");
|
|
||||||
connection.setDoOutput(true);
|
|
||||||
connection.setDoInput(true);
|
|
||||||
connection.setUseCaches(false);
|
|
||||||
connection.setReadTimeout(5 * 1000);
|
|
||||||
connection.setConnectTimeout(3 * 1000);
|
|
||||||
connection.setRequestProperty("connection", "Keep-Alive");
|
|
||||||
connection.setRequestProperty("Content-Type", "application/json;charset=UTF-8");
|
|
||||||
connection.setRequestProperty("Accept-Charset", "application/json;charset=UTF-8");
|
|
||||||
|
|
||||||
// do connection
|
|
||||||
connection.connect();
|
|
||||||
|
|
||||||
//Map<String, List<String>> map = connection.getHeaderFields();
|
|
||||||
|
|
||||||
// valid StatusCode
|
|
||||||
int statusCode = connection.getResponseCode();
|
|
||||||
if (statusCode != 200) {
|
|
||||||
throw new RuntimeException("Http Request StatusCode(" + statusCode + ") Invalid.");
|
|
||||||
}
|
|
||||||
|
|
||||||
// result
|
|
||||||
bufferedReader = new BufferedReader(new InputStreamReader(connection.getInputStream(), "UTF-8"));
|
|
||||||
StringBuilder result = new StringBuilder();
|
|
||||||
String line;
|
|
||||||
while ((line = bufferedReader.readLine()) != null) {
|
|
||||||
result.append(line);
|
|
||||||
}
|
|
||||||
String responseMsg = result.toString();
|
|
||||||
|
|
||||||
XxlJobLogger.log(responseMsg);
|
|
||||||
return SUCCESS;
|
|
||||||
} catch (Exception e) {
|
|
||||||
XxlJobLogger.log(e);
|
|
||||||
return FAIL;
|
|
||||||
} finally {
|
|
||||||
try {
|
|
||||||
if (bufferedReader != null) {
|
|
||||||
bufferedReader.close();
|
|
||||||
}
|
|
||||||
if (connection != null) {
|
|
||||||
connection.disconnect();
|
|
||||||
}
|
|
||||||
} catch (Exception e2) {
|
|
||||||
XxlJobLogger.log(e2);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
|
@ -0,0 +1,193 @@
|
||||||
|
package com.xxl.job.executor.service.jobhandler;
|
||||||
|
|
||||||
|
import com.xxl.job.core.biz.model.ReturnT;
|
||||||
|
import com.xxl.job.core.handler.IJobHandler;
|
||||||
|
import com.xxl.job.core.handler.annotation.XxlJob;
|
||||||
|
import com.xxl.job.core.log.XxlJobLogger;
|
||||||
|
import com.xxl.job.core.util.ShardingUtil;
|
||||||
|
import org.slf4j.Logger;
|
||||||
|
import org.slf4j.LoggerFactory;
|
||||||
|
import org.springframework.stereotype.Component;
|
||||||
|
|
||||||
|
import java.io.BufferedInputStream;
|
||||||
|
import java.io.BufferedReader;
|
||||||
|
import java.io.InputStreamReader;
|
||||||
|
import java.net.HttpURLConnection;
|
||||||
|
import java.net.URL;
|
||||||
|
import java.util.concurrent.TimeUnit;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* XxlJob开发示例(Bean模式)
|
||||||
|
*
|
||||||
|
* 开发步骤:
|
||||||
|
* 1、在Spring Bean实例中,开发Job方法,方式格式要求为 "public ReturnT<String> execute(String param)"
|
||||||
|
* 2、为Job方法添加注解 "@XxlJob(value="自定义jobhandler名称", init = "JobHandler初始化方法", destroy = "JobHandler销毁方法")",注解value值对应的是调度中心新建任务的JobHandler属性的值。
|
||||||
|
* 3、执行日志:需要通过 "XxlJobLogger.log" 打印执行日志;
|
||||||
|
*
|
||||||
|
* @author xuxueli 2019-12-11 21:52:51
|
||||||
|
*/
|
||||||
|
@Component
|
||||||
|
public class SampleXxlJob {
|
||||||
|
private static Logger logger = LoggerFactory.getLogger(SampleXxlJob.class);
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 1、简单任务示例(Bean模式)
|
||||||
|
*/
|
||||||
|
@XxlJob("demoJobHandler")
|
||||||
|
public ReturnT<String> demoJobHandler(String param) throws Exception {
|
||||||
|
XxlJobLogger.log("XXL-JOB, Hello World.");
|
||||||
|
|
||||||
|
for (int i = 0; i < 5; i++) {
|
||||||
|
XxlJobLogger.log("beat at:" + i);
|
||||||
|
TimeUnit.SECONDS.sleep(2);
|
||||||
|
}
|
||||||
|
return ReturnT.SUCCESS;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 2、分片广播任务
|
||||||
|
*/
|
||||||
|
@XxlJob("shardingJobHandler")
|
||||||
|
public ReturnT<String> shardingJobHandler(String param) throws Exception {
|
||||||
|
|
||||||
|
// 分片参数
|
||||||
|
ShardingUtil.ShardingVO shardingVO = ShardingUtil.getShardingVo();
|
||||||
|
XxlJobLogger.log("分片参数:当前分片序号 = {}, 总分片数 = {}", shardingVO.getIndex(), shardingVO.getTotal());
|
||||||
|
|
||||||
|
// 业务逻辑
|
||||||
|
for (int i = 0; i < shardingVO.getTotal(); i++) {
|
||||||
|
if (i == shardingVO.getIndex()) {
|
||||||
|
XxlJobLogger.log("第 {} 片, 命中分片开始处理", i);
|
||||||
|
} else {
|
||||||
|
XxlJobLogger.log("第 {} 片, 忽略", i);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return ReturnT.SUCCESS;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 3、命令行任务
|
||||||
|
*/
|
||||||
|
@XxlJob("commandJobHandler")
|
||||||
|
public ReturnT<String> commandJobHandler(String param) throws Exception {
|
||||||
|
String command = param;
|
||||||
|
int exitValue = -1;
|
||||||
|
|
||||||
|
BufferedReader bufferedReader = null;
|
||||||
|
try {
|
||||||
|
// command process
|
||||||
|
Process process = Runtime.getRuntime().exec(command);
|
||||||
|
BufferedInputStream bufferedInputStream = new BufferedInputStream(process.getInputStream());
|
||||||
|
bufferedReader = new BufferedReader(new InputStreamReader(bufferedInputStream));
|
||||||
|
|
||||||
|
// command log
|
||||||
|
String line;
|
||||||
|
while ((line = bufferedReader.readLine()) != null) {
|
||||||
|
XxlJobLogger.log(line);
|
||||||
|
}
|
||||||
|
|
||||||
|
// command exit
|
||||||
|
process.waitFor();
|
||||||
|
exitValue = process.exitValue();
|
||||||
|
} catch (Exception e) {
|
||||||
|
XxlJobLogger.log(e);
|
||||||
|
} finally {
|
||||||
|
if (bufferedReader != null) {
|
||||||
|
bufferedReader.close();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (exitValue == 0) {
|
||||||
|
return IJobHandler.SUCCESS;
|
||||||
|
} else {
|
||||||
|
return new ReturnT<String>(IJobHandler.FAIL.getCode(), "command exit value("+exitValue+") is failed");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 4、跨平台Http任务
|
||||||
|
*/
|
||||||
|
@XxlJob("httpJobHandler")
|
||||||
|
public ReturnT<String> httpJobHandler(String param) throws Exception {
|
||||||
|
|
||||||
|
// request
|
||||||
|
HttpURLConnection connection = null;
|
||||||
|
BufferedReader bufferedReader = null;
|
||||||
|
try {
|
||||||
|
// connection
|
||||||
|
URL realUrl = new URL(param);
|
||||||
|
connection = (HttpURLConnection) realUrl.openConnection();
|
||||||
|
|
||||||
|
// connection setting
|
||||||
|
connection.setRequestMethod("GET");
|
||||||
|
connection.setDoOutput(true);
|
||||||
|
connection.setDoInput(true);
|
||||||
|
connection.setUseCaches(false);
|
||||||
|
connection.setReadTimeout(5 * 1000);
|
||||||
|
connection.setConnectTimeout(3 * 1000);
|
||||||
|
connection.setRequestProperty("connection", "Keep-Alive");
|
||||||
|
connection.setRequestProperty("Content-Type", "application/json;charset=UTF-8");
|
||||||
|
connection.setRequestProperty("Accept-Charset", "application/json;charset=UTF-8");
|
||||||
|
|
||||||
|
// do connection
|
||||||
|
connection.connect();
|
||||||
|
|
||||||
|
//Map<String, List<String>> map = connection.getHeaderFields();
|
||||||
|
|
||||||
|
// valid StatusCode
|
||||||
|
int statusCode = connection.getResponseCode();
|
||||||
|
if (statusCode != 200) {
|
||||||
|
throw new RuntimeException("Http Request StatusCode(" + statusCode + ") Invalid.");
|
||||||
|
}
|
||||||
|
|
||||||
|
// result
|
||||||
|
bufferedReader = new BufferedReader(new InputStreamReader(connection.getInputStream(), "UTF-8"));
|
||||||
|
StringBuilder result = new StringBuilder();
|
||||||
|
String line;
|
||||||
|
while ((line = bufferedReader.readLine()) != null) {
|
||||||
|
result.append(line);
|
||||||
|
}
|
||||||
|
String responseMsg = result.toString();
|
||||||
|
|
||||||
|
XxlJobLogger.log(responseMsg);
|
||||||
|
return ReturnT.SUCCESS;
|
||||||
|
} catch (Exception e) {
|
||||||
|
XxlJobLogger.log(e);
|
||||||
|
return ReturnT.FAIL;
|
||||||
|
} finally {
|
||||||
|
try {
|
||||||
|
if (bufferedReader != null) {
|
||||||
|
bufferedReader.close();
|
||||||
|
}
|
||||||
|
if (connection != null) {
|
||||||
|
connection.disconnect();
|
||||||
|
}
|
||||||
|
} catch (Exception e2) {
|
||||||
|
XxlJobLogger.log(e2);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 5、生命周期任务示例:任务初始化与销毁时,支持自定义相关逻辑;
|
||||||
|
*/
|
||||||
|
@XxlJob(value = "demoJobHandler2", init = "init", destroy = "destroy")
|
||||||
|
public ReturnT<String> demoJobHandler2(String param) throws Exception {
|
||||||
|
XxlJobLogger.log("XXL-JOB, Hello World.");
|
||||||
|
return ReturnT.SUCCESS;
|
||||||
|
}
|
||||||
|
public void init(){
|
||||||
|
logger.info("init");
|
||||||
|
}
|
||||||
|
public void destroy(){
|
||||||
|
logger.info("destory");
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
}
|
|
@ -1,38 +0,0 @@
|
||||||
package com.xxl.job.executor.service.jobhandler;
|
|
||||||
|
|
||||||
import com.xxl.job.core.biz.model.ReturnT;
|
|
||||||
import com.xxl.job.core.handler.IJobHandler;
|
|
||||||
import com.xxl.job.core.handler.annotation.JobHandler;
|
|
||||||
import com.xxl.job.core.log.XxlJobLogger;
|
|
||||||
import com.xxl.job.core.util.ShardingUtil;
|
|
||||||
import org.springframework.stereotype.Service;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* 分片广播任务
|
|
||||||
*
|
|
||||||
* @author xuxueli 2017-07-25 20:56:50
|
|
||||||
*/
|
|
||||||
@JobHandler(value="shardingJobHandler")
|
|
||||||
@Service
|
|
||||||
public class ShardingJobHandler extends IJobHandler {
|
|
||||||
|
|
||||||
@Override
|
|
||||||
public ReturnT<String> execute(String param) throws Exception {
|
|
||||||
|
|
||||||
// 分片参数
|
|
||||||
ShardingUtil.ShardingVO shardingVO = ShardingUtil.getShardingVo();
|
|
||||||
XxlJobLogger.log("分片参数:当前分片序号 = {}, 总分片数 = {}", shardingVO.getIndex(), shardingVO.getTotal());
|
|
||||||
|
|
||||||
// 业务逻辑
|
|
||||||
for (int i = 0; i < shardingVO.getTotal(); i++) {
|
|
||||||
if (i == shardingVO.getIndex()) {
|
|
||||||
XxlJobLogger.log("第 {} 片, 命中分片开始处理", i);
|
|
||||||
} else {
|
|
||||||
XxlJobLogger.log("第 {} 片, 忽略", i);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return SUCCESS;
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
Loading…
Reference in New Issue