1.需求说明
乘客在选定完起始地点和终点之后,即可呼叫代驾,生成代驾订单,保存订单数据。保存好订单之后搜索附近可接单的代驾司机。
2.生成订单
OrderInfoController
@Tag(name = "订单API接口管理")
@RestController
@RequestMapping(value="/order/info")
@SuppressWarnings({"unchecked", "rawtypes"})
public class OrderInfoController {
@Autowired
private OrderInfoService orderInfoService;
@Operation(summary = "保存订单信息")
@PostMapping("/saveOrderInfo")
public Result<Long> saveOrderInfo(@RequestBody OrderInfoForm orderInfoForm) {
return Result.ok(orderInfoService.saveOrderInfo(orderInfoForm));
}
}
OrderInfoServiceImpl
@Service
@SuppressWarnings({"unchecked", "rawtypes"})
public class OrderInfoServiceImpl extends ServiceImpl<OrderInfoMapper, OrderInfo> implements OrderInfoService {
@Autowired
private OrderInfoMapper orderInfoMapper;
@Autowired
private OrderStatusLogMapper orderStatusLogMapper;
//乘客下单
@Override
public Long saveOrderInfo(OrderInfoForm orderInfoForm) {
//order_info添加订单数据
OrderInfo orderInfo = new OrderInfo();
BeanUtils.copyProperties(orderInfoForm,orderInfo);
//订单号
String orderNo = UUID.randomUUID().toString().replaceAll("-","");
orderInfo.setOrderNo(orderNo);
//订单状态
orderInfo.setStatus(OrderStatus.WAITING_ACCEPT.getStatus());
orderInfoMapper.insert(orderInfo);
//记录日志
this.log(orderInfo.getId(),orderInfo.getStatus());
return orderInfo.getId();
}
public void log(Long orderId, Integer status) {
OrderStatusLog orderStatusLog = new OrderStatusLog();
orderStatusLog.setOrderId(orderId);
orderStatusLog.setOrderStatus(status);
orderStatusLog.setOperateTime(new Date());
orderStatusLogMapper.insert(orderStatusLog);
}
}
OrderInfoFeignClient
@FeignClient(value = "service-order")
public interface OrderInfoFeignClient {
/**
* 保存订单信息
* @param orderInfoForm
* @return
*/
@PostMapping("/order/info/saveOrderInfo")
Result<Long> saveOrderInfo(@RequestBody OrderInfoForm orderInfoForm);
}
web-controller中
OrderController
@Operation(summary = "乘客下单")
@GuiguLogin
@PostMapping("/submitOrder")
public Result<Long> submitOrder(@RequestBody SubmitOrderForm submitOrderForm) {
submitOrderForm.setCustomerId(AuthContextHolder.getUserId());
return Result.ok(orderService.submitOrder(submitOrderForm));
}
3.查询订单状态
乘客下完单后,订单状态为1等待接单,乘客端小程序会轮询订单状态,如果有司机接单,订单状态变化为2已接单,那么页面进行跳转,进行下一步操作。
- 根据订单id查询订单状态
OrderInfoController
@Operation(summary = "根据订单id获取订单状态")
@GetMapping("/getOrderStatus/{orderId}")
public Result<Integer> getOrderStatus(@PathVariable Long orderId) {
return Result.ok(orderInfoService.getOrderStatus(orderId));
}
OrderInfoServiceImpl
//根据订单id获取订单状态
@Override
public Integer getOrderStatus(Long orderId) {
//sql语句: select status from order_info where id=?
LambdaQueryWrapper<OrderInfo> wrapper = new LambdaQueryWrapper<>();
wrapper.eq(OrderInfo::getId,orderId);
wrapper.select(OrderInfo::getStatus);
//调用mapper方法
OrderInfo orderInfo = orderInfoMapper.selectOne(wrapper);
//订单不存在
if(orderInfo == null) {
return OrderStatus.NULL_ORDER.getStatus();
}
return orderInfo.getStatus();
}
OrderInfoFeignClient
/**
* 根据订单id获取订单状态
* @param orderId
* @return
*/
@GetMapping("/order/info/getOrderStatus/{orderId}")
Result<Integer> getOrderStatus(@PathVariable("orderId") Long orderId);
- 乘客端远程调用
web-customer
OrderController
@Operation(summary = "查询订单状态")
@GuiGuLogin
@GetMapping("/getOrderStatus/{orderId}")
public Result<Integer> getOrderStatus(@PathVariable Long orderId) {
return Result.ok(orderService.getOrderStatus(orderId));
}
OrderServiceImpl
//查询订单状态
@Override
public Integer getOrderStatus(Long orderId) {
Result<Integer> integerResult = orderInfoFeignClient.getOrderStatus(orderId);
return integerResult.getData();
}
- 司机端远程调用
web-driver
OrderController
@Operation(summary = "查询订单状态")
@GuiGuLogin
@GetMapping("/getOrderStatus/{orderId}")
public Result<Integer> getOrderStatus(@PathVariable Long orderId) {
return Result.ok(orderService.getOrderStatus(orderId));
}
OrderServiceImpl
@Override
public Integer getOrderStatus(Long orderId) {
return orderInfoFeignClient.getOrderStatus(orderId).getData();
}
4.搜索附近可接单司机
通过redis中的GEO可以实现搜索附近可接单的司机。
4.1 实时更新司机的位置信息
- 司机开启接单服务之后,司机端小程序实时把司机的当前位置上传到Redis里面的GEO,让Redis计算代驾起点周围几公里以内的司机
- 更新司机位置信息
- 删除司机位置信息
service-map
LocationController
@Autowired
private LocationService locationService;
//司机开启接单,更新司机位置信息
@Operation(summary = "开启接单服务:更新司机经纬度位置")
@PostMapping("/updateDriverLocation")
public Result<Boolean> updateDriverLocation(@RequestBody
UpdateDriverLocationForm updateDriverLocationForm) {
Boolean flag = locationService.updateDriverLocation(updateDriverLocationForm);
return Result.ok(flag);
}
//司机关闭接单,删除司机位置信息
@Operation(summary = "关闭接单服务:删除司机经纬度位置")
@DeleteMapping("/removeDriverLocation/{driverId}")
public Result<Boolean> removeDriverLocation(@PathVariable Long driverId) {
return Result.ok(locationService.removeDriverLocation(driverId));
}
LocationServiceImpl
//更新司机位置信息
@Override
public Boolean updateDriverLocation(UpdateDriverLocationForm updateDriverLocationForm) {
//把司机位置信息添加redis里面geo
Point point = new Point(updateDriverLocationForm.getLongitude().doubleValue(),
updateDriverLocationForm.getLatitude().doubleValue());
//添加到redis里面
redisTemplate.opsForGeo().add(RedisConstant.DRIVER_GEO_LOCATION,
point,
updateDriverLocationForm.getDriverId().toString());
return true;
}
//删除司机位置信息
@Override
public Boolean removeDriverLocation(Long driverId) {
redisTemplate.opsForGeo().remove(RedisConstant.DRIVER_GEO_LOCATION,driverId.toString());
return true;
}
service-map-client 远程调用
LocationFeignClient
/**
* 开启接单服务:更新司机经纬度位置
* @param updateDriverLocationForm
* @return
*/
@PostMapping("/map/location/updateDriverLocation")
Result<Boolean> updateDriverLocation(@RequestBody UpdateDriverLocationForm updateDriverLocationForm);
/**
* 关闭接单服务:删除司机经纬度位置
* @param driverId
* @return
*/
@DeleteMapping("/map/location/removeDriverLocation/{driverId}")
Result<Boolean> removeDriverLocation(@PathVariable("driverId") Long driverId);
司机端 web-driver
LocationController
@Autowired
private LocationService locationService;
@Operation(summary = "开启接单服务:更新司机经纬度位置")
@GuiGuLogin
@PostMapping("/updateDriverLocation")
public Result<Boolean> updateDriverLocation(@RequestBody UpdateDriverLocationForm updateDriverLocationForm) {
Long driverId = AuthContextHolder.getUserId();//司机id
updateDriverLocationForm.setDriverId(driverId);
return Result.ok(locationService.updateDriverLocation(updateDriverLocationForm));
}
LocationServiceImpl
@Autowired
private LocationFeignClient locationFeignClient;
//更新司机位置
@Override
public Boolean updateDriverLocation(UpdateDriverLocationForm updateDriverLocationForm) {
Result<Boolean> booleanResult = locationFeignClient.updateDriverLocation(updateDriverLocationForm);
return booleanResult.getData();
}
4.2 获取司机个性化设置消息
司机针对接单,有一些个性化设置,只有满足了这些条件,才可以接单,如:“实时更新司机位置信息”,只有开启了接单服务,接口才可以更新数据。
daijia_driver数据库里面driver_set表
说明:
service_status:服务状态,司机开启了接单,才能进行接单后的一些列操作;
order_distance:订单里程设置,如:order_distance=0(不限制);order_distance=50(只接代驾里程在50公里范围内的订单);
accept_distance:接单里程设置,司机起始点距离司机的位置,如:accept_distance=3(只接收3公里范围内的订单);
is_auto_accept:是否自动接单,开启后,系统自动抢单,不需要手动点接单按钮;
service-driver
DriverInfoController
@Operation(summary = "获取司机设置信息")
@GetMapping("/getDriverSet/{driverId}")
public Result<DriverSet> getDriverSet(@PathVariable Long driverId) {
return Result.ok(driverInfoService.getDriverSet(driverId));
}
DriverInfoServiceImpl
//获取司机设置信息
@Override
public DriverSet getDriverSet(Long driverId) {
LambdaQueryWrapper<DriverSet> wrapper = new LambdaQueryWrapper<>();
wrapper.eq(DriverSet::getDriverId,driverId);
DriverSet driverSet = driverSetMapper.selectOne(wrapper);
return driverSet;
}
远程调用定义 service-driver-client
DriverInfoFeignClient
/**
* 获取司机设置信息
* @param driverId
* @return
*/
@GetMapping("/driver/info/getDriverSet/{driverId}")
Result<DriverSet> getDriverSet(@PathVariable("driverId") Long driverId);
修改司机web端,判断司机当前状态是否接单
LocationServiceImpl
//更新司机位置
@Override
public Boolean updateDriverLocation(UpdateDriverLocationForm updateDriverLocationForm) {
//根据司机id获取司机个性化设置信息
Long driverId = updateDriverLocationForm.getDriverId();
Result<DriverSet> driverSetResult = driverInfoFeignClient.getDriverSet(driverId);
DriverSet driverSet = driverSetResult.getData();
//判断:如果司机开始接单,更新位置信息
if(driverSet.getServiceStatus() == 1) {
Result<Boolean> booleanResult = locationFeignClient.updateDriverLocation(updateDriverLocationForm);
return booleanResult.getData();
} else {
//没有接单
throw new GuiguException(ResultCodeEnum.NO_START_SERVICE);
}
}
4.3 搜索附近适合接单的司机
司机端的小程序开启接单服务后,开始实时上传司机的定位信息到redis的GEO缓存,前面乘客已经下单,现在我们要查找附近适合接单的司机,比如搜索附近3公里以内的接单司机,如果有对应的司机,那么就给司机发送新订单消息。
service-map
LocationController
@Operation(summary = "搜索附近满足条件的司机")
@PostMapping("/searchNearByDriver")
public Result<List<NearByDriverVo>> searchNearByDriver(@RequestBody
SearchNearByDriverForm searchNearByDriverForm) {
return Result.ok(locationService.searchNearByDriver(searchNearByDriverForm));
}
LocationServiceImpl
//搜索附近满足条件的司机
@Override
public List<NearByDriverVo> searchNearByDriver(SearchNearByDriverForm searchNearByDriverForm) {
//搜索经纬度位置5公里以内的司机
//1 操作redis里面geo
//创建point,经纬度位置
Point point = new Point(searchNearByDriverForm.getLongitude().doubleValue(),
searchNearByDriverForm.getLatitude().doubleValue());
//定义距离,5公里
Distance distance = new Distance(SystemConstant.NEARBY_DRIVER_RADIUS,
RedisGeoCommands.DistanceUnit.KILOMETERS);
//创建circle对象,point distance
Circle circle = new Circle(point,distance);
//定义GEO参数,设置返回结果包含内容
RedisGeoCommands.GeoRadiusCommandArgs args =
RedisGeoCommands.GeoRadiusCommandArgs.newGeoRadiusArgs()
.includeDistance() //包含距离
.includeCoordinates() //包含坐标
.sortAscending(); //升序
GeoResults<RedisGeoCommands.GeoLocation<String>> result =
redisTemplate.opsForGeo().radius(RedisConstant.DRIVER_GEO_LOCATION, circle, args);
//2 查询redis最终返回list集合
List<GeoResult<RedisGeoCommands.GeoLocation<String>>> content = result.getContent();
//3 对查询list集合进行处理
// 遍历list集合,得到每个司机信息
// 根据每个司机个性化设置信息判断
List<NearByDriverVo> list = new ArrayList<>();
if(!CollectionUtils.isEmpty(content)) {
Iterator<GeoResult<RedisGeoCommands.GeoLocation<String>>> iterator = content.iterator();
while(iterator.hasNext()) {
GeoResult<RedisGeoCommands.GeoLocation<String>> item = iterator.next();
//获取司机id
Long driverId = Long.parseLong(item.getContent().getName());
//远程调用,根据司机id个性化设置信息
Result<DriverSet> driverSetResult = driverInfoFeignClient.getDriverSet(driverId);
DriverSet driverSet = driverSetResult.getData();
//判断订单里程order_distance
BigDecimal orderDistance = driverSet.getOrderDistance();
//orderDistance==0,司机没有限制的
//如果不等于0 ,比如30,接单30公里代驾订单。
//接单距离 - 当前单子距离 < 0,不复合条件
// 30 35
if(orderDistance.doubleValue() != 0
&& orderDistance.subtract(searchNearByDriverForm.getMileageDistance()).doubleValue()<0) {
continue;
}
//判断接单里程 accept_distance
//当前接单距离
BigDecimal currentDistance =
new BigDecimal(item.getDistance().getValue()).setScale(2, RoundingMode.HALF_UP);
BigDecimal acceptDistance = driverSet.getAcceptDistance();
if(acceptDistance.doubleValue() !=0
&& acceptDistance.subtract(currentDistance).doubleValue()<0) {
continue;
}
//封装复合条件数据
NearByDriverVo nearByDriverVo = new NearByDriverVo();
nearByDriverVo.setDriverId(driverId);
nearByDriverVo.setDistance(currentDistance);
list.add(nearByDriverVo);
}
}
return list;
}
service-map-client
LocationFeignClient
/**
* 搜索附近满足条件的司机
* @param searchNearByDriverForm
* @return
*/
@PostMapping("/map/location/searchNearByDriver")
Result<List<NearByDriverVo>> searchNearByDriver(@RequestBody SearchNearByDriverForm searchNearByDriverForm);
4.4 接口测试
- 启动相关服务
- 采用Swagger进行测试
测试更新司机经纬度
{
"driverId": 1,
"longitude": 116.417876,
"latitude": 39.915411
}
在redis里面可以查看到添加的信息
搜索附近满足条件的司机
如果这里添加了多个司机位置,要注意查看数据库中是否有对应的司机id,如果不存在会报空指针。
{
"longitude": 116.4000,
"latitude": 39.9000,
"mileageDistance": 15
}
4.5 乘客下单添加任务调度
4.5.1 集成XXL-JOB
我们使用单独的一个微服务模块service-dispatch集成XXL-JOB执行器
service-dispatch引入依赖
<dependencies>
<dependency>
<groupId>com.xuxueli</groupId>
<artifactId>xxl-job-core</artifactId>
</dependency>
</dependencies>
执行器配置
项目nacos配置中心里面配置进行修改
修改service-dispatch里的properties中的地址
创建xxl-job配置类
package com.atguigu.daijia.dispatch.xxl.config;
import com.xxl.job.core.executor.impl.XxlJobSpringExecutor;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class XxlJobConfig {
private Logger logger = LoggerFactory.getLogger(XxlJobConfig.class);
@Value("${xxl.job.admin.addresses}")
private String adminAddresses;
@Value("${xxl.job.accessToken}")
private String accessToken;
@Value("${xxl.job.executor.appname}")
private String appname;
@Value("${xxl.job.executor.address}")
private String address;
@Value("${xxl.job.executor.ip}")
private String ip;
@Value("${xxl.job.executor.port}")
private int port;
@Value("${xxl.job.executor.logpath}")
private String logPath;
@Value("${xxl.job.executor.logretentiondays}")
private int logRetentionDays;
@Bean
public XxlJobSpringExecutor xxlJobExecutor() {
logger.info(">>>>>>>>>>> xxl-job config init.");
XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor();
xxlJobSpringExecutor.setAdminAddresses(adminAddresses);
xxlJobSpringExecutor.setAppname(appname);
xxlJobSpringExecutor.setAddress(address);
xxlJobSpringExecutor.setIp(ip);
xxlJobSpringExecutor.setPort(port);
xxlJobSpringExecutor.setAccessToken(accessToken);
xxlJobSpringExecutor.setLogPath(logPath);
xxlJobSpringExecutor.setLogRetentionDays(logRetentionDays);
return xxlJobSpringExecutor;
}
}
4.5.2 测试
创建类,编写任务job方法
@Component
public class DispatchJobHandler {
@XxlJob("firstJobHandler")
public void testJobHandler() {
System.out.println("xxl-job项目集成测试");
}
}
进行测试
第一步 启动相关服务
- 启动调度中心
- 启动执行器项目服务
第二步 在调度中心创建任务
如果调度失败,可以查看token是否保持一致,我这里是报错了msg:The access token is wrong.
nacos和xxl-job项目里的token保持一致
4.5.3 封装XXL-JOB客户端
- 乘客下单之后,开启任务调度,搜索附近满足条件可以接单司机
- 因为任务调度是灵活过程,需要封装相关方法,通过方法实现添加并启动任务
调度中心创建任务方法xxl-job-admin
说明:排除登录校验(@PermissionLimit(limit = false))
//自定义任务操作的方法
//添加任务
@RequestMapping("/addJob")
@ResponseBody
@PermissionLimit(limit = false)
public ReturnT<String> addJobInfo(@RequestBody XxlJobInfo jobInfo) {
return xxlJobService.add(jobInfo);
}
//删除任务
@RequestMapping("/removeJob")
@ResponseBody
@PermissionLimit(limit = false)
public ReturnT<String> removeJob(@RequestBody XxlJobInfo jobInfo) {
return xxlJobService.remove(jobInfo.getId());
}
//修改任务
@RequestMapping("/updateJob")
@ResponseBody
@PermissionLimit(limit = false)
public ReturnT<String> updateJob(@RequestBody XxlJobInfo jobInfo) {
return xxlJobService.update(jobInfo);
}
//停止任务
@RequestMapping("/stopJob")
@ResponseBody
@PermissionLimit(limit = false)
public ReturnT<String> pauseJob(@RequestBody XxlJobInfo jobInfo) {
return xxlJobService.stop(jobInfo.getId());
}
//启动任务
@RequestMapping("/startJob")
@ResponseBody
@PermissionLimit(limit = false)
public ReturnT<String> startJob(@RequestBody XxlJobInfo jobInfo) {
return xxlJobService.start(jobInfo.getId());
}
//添加并启动任务
@RequestMapping("/addAndStartJob")
@ResponseBody
@PermissionLimit(limit = false)
public ReturnT<String> addAndStartJob(@RequestBody XxlJobInfo jobInfo) {
ReturnT<String> result = xxlJobService.add(jobInfo);
String content = result.getContent();
int id = Integer.parseInt(content);
xxlJobService.start(id);
//立即执行一次
JobTriggerPoolHelper.trigger(id, TriggerTypeEnum.MANUAL, -1, null, jobInfo.getExecutorParam(), "");
return result;
}
service-dispatch配置文件添加任务方法
-
到nacos里面找到配置文件 service-dispatch-dev.yaml
service-dispatch添加相关配置类 -
创建配置类,读取配置文件里面调用的调度中心任务操作的方法
@Data
@Component
@ConfigurationProperties(prefix = "xxl.job.client")
public class XxlJobClientConfig {
private Integer jobGroupId;
private String addUrl;
private String removeUrl;
private String startJobUrl;
private String stopJobUrl;
private String addAndStartUrl;
}
- 创建客户端类,编写调用调度中心里面的方法
package com.atguigu.daijia.dispatch.xxl.client;
import com.alibaba.fastjson.JSONObject;
import com.atguigu.daijia.common.execption.GuiguException;
import com.atguigu.daijia.common.result.ResultCodeEnum;
import com.atguigu.daijia.dispatch.xxl.config.XxlJobClientConfig;
import com.atguigu.daijia.model.entity.dispatch.XxlJobInfo;
import lombok.SneakyThrows;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpEntity;
import org.springframework.http.HttpHeaders;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Component;
import org.springframework.web.client.RestTemplate;
@Slf4j
@Component
public class XxlJobClient {
@Autowired
private XxlJobClientConfig xxlJobClientConfig;
//客户端调用服务端里面的方法
@Autowired
private RestTemplate restTemplate;
@SneakyThrows
public Long addJob(String executorHandler, String param, String corn, String desc){
XxlJobInfo xxlJobInfo = new XxlJobInfo();
xxlJobInfo.setJobGroup(xxlJobClientConfig.getJobGroupId());
xxlJobInfo.setJobDesc(desc);
xxlJobInfo.setAuthor("qy");
xxlJobInfo.setScheduleType("CRON");
xxlJobInfo.setScheduleConf(corn);
xxlJobInfo.setGlueType("BEAN");
xxlJobInfo.setExecutorHandler(executorHandler);
xxlJobInfo.setExecutorParam(param);
xxlJobInfo.setExecutorRouteStrategy("FIRST");
xxlJobInfo.setExecutorBlockStrategy("SERIAL_EXECUTION");
xxlJobInfo.setMisfireStrategy("FIRE_ONCE_NOW");
xxlJobInfo.setExecutorTimeout(0);
xxlJobInfo.setExecutorFailRetryCount(0);
HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON);
HttpEntity<XxlJobInfo> request = new HttpEntity<>(xxlJobInfo, headers);
String url = xxlJobClientConfig.getAddUrl();
ResponseEntity<JSONObject> response =
restTemplate.postForEntity(url, request, JSONObject.class);
if(response.getStatusCode().value() == 200 && response.getBody().getIntValue("code") == 200) {
log.info("增加xxl执行任务成功,返回信息:{}", response.getBody().toJSONString());
//content为任务id
return response.getBody().getLong("content");
}
log.info("调用xxl增加执行任务失败:{}", response.getBody().toJSONString());
throw new GuiguException(ResultCodeEnum.DATA_ERROR);
}
public Boolean startJob(Long jobId) {
XxlJobInfo xxlJobInfo = new XxlJobInfo();
xxlJobInfo.setId(jobId.intValue());
HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON);
HttpEntity<XxlJobInfo> request = new HttpEntity<>(xxlJobInfo, headers);
String url = xxlJobClientConfig.getStartJobUrl();
ResponseEntity<JSONObject> response = restTemplate.postForEntity(url, request, JSONObject.class);
if(response.getStatusCode().value() == 200 && response.getBody().getIntValue("code") == 200) {
log.info("启动xxl执行任务成功:{},返回信息:{}", jobId, response.getBody().toJSONString());
return true;
}
log.info("启动xxl执行任务失败:{},返回信息:{}", jobId, response.getBody().toJSONString());
throw new GuiguException(ResultCodeEnum.DATA_ERROR);
}
public Boolean stopJob(Long jobId) {
XxlJobInfo xxlJobInfo = new XxlJobInfo();
xxlJobInfo.setId(jobId.intValue());
HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON);
HttpEntity<XxlJobInfo> request = new HttpEntity<>(xxlJobInfo, headers);
String url = xxlJobClientConfig.getStopJobUrl();
ResponseEntity<JSONObject> response = restTemplate.postForEntity(url, request, JSONObject.class);
if(response.getStatusCode().value() == 200 && response.getBody().getIntValue("code") == 200) {
log.info("停止xxl执行任务成功:{},返回信息:{}", jobId, response.getBody().toJSONString());
return true;
}
log.info("停止xxl执行任务失败:{},返回信息:{}", jobId, response.getBody().toJSONString());
throw new GuiguException(ResultCodeEnum.DATA_ERROR);
}
public Boolean removeJob(Long jobId) {
XxlJobInfo xxlJobInfo = new XxlJobInfo();
xxlJobInfo.setId(jobId.intValue());
HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON);
HttpEntity<XxlJobInfo> request = new HttpEntity<>(xxlJobInfo, headers);
String url = xxlJobClientConfig.getRemoveUrl();
ResponseEntity<JSONObject> response = restTemplate.postForEntity(url, request, JSONObject.class);
if(response.getStatusCode().value() == 200 && response.getBody().getIntValue("code") == 200) {
log.info("删除xxl执行任务成功:{},返回信息:{}", jobId, response.getBody().toJSONString());
return true;
}
log.info("删除xxl执行任务失败:{},返回信息:{}", jobId, response.getBody().toJSONString());
throw new GuiguException(ResultCodeEnum.DATA_ERROR);
}
//添加并启动任务
public Long addAndStart(String executorHandler, String param, String corn, String desc) {
XxlJobInfo xxlJobInfo = new XxlJobInfo();
xxlJobInfo.setJobGroup(xxlJobClientConfig.getJobGroupId());
xxlJobInfo.setJobDesc(desc);
xxlJobInfo.setAuthor("qy");
xxlJobInfo.setScheduleType("CRON");
xxlJobInfo.setScheduleConf(corn);
xxlJobInfo.setGlueType("BEAN");
xxlJobInfo.setExecutorHandler(executorHandler);
xxlJobInfo.setExecutorParam(param);
xxlJobInfo.setExecutorRouteStrategy("FIRST");
xxlJobInfo.setExecutorBlockStrategy("SERIAL_EXECUTION");
xxlJobInfo.setMisfireStrategy("FIRE_ONCE_NOW");
xxlJobInfo.setExecutorTimeout(0);
xxlJobInfo.setExecutorFailRetryCount(0);
HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON);
HttpEntity<XxlJobInfo> request = new HttpEntity<>(xxlJobInfo, headers);
//获取调度中心请求路径
String url = xxlJobClientConfig.getAddAndStartUrl();
//restTemplate
ResponseEntity<JSONObject> response = restTemplate.postForEntity(url, request, JSONObject.class);
if(response.getStatusCode().value() == 200 && response.getBody().getIntValue("code") == 200) {
log.info("增加并开始执行xxl任务成功,返回信息:{}", response.getBody().toJSONString());
//content为任务id
return response.getBody().getLong("content");
}
log.info("增加并开始执行xxl任务失败:{}", response.getBody().toJSONString());
throw new GuiguException(ResultCodeEnum.DATA_ERROR);
}
}
启动类配置RestTemplate
@Bean
public RestTemplate restTemplate() {
return new RestTemplate();
}
4.5.4 创建并启动任务接口
service-dispatch
NewOrderController
@Autowired
private NewOrderService newOrderService;
@Operation(summary = "添加并开始新订单任务调度")
@PostMapping("/addAndStartTask")
public Result<Long> addAndStartTask(@RequestBody NewOrderTaskVo newOrderTaskVo) {
return Result.ok(newOrderService.addAndStartTask(newOrderTaskVo));
}
NewOrderServiceImpl
@Service
@SuppressWarnings({"unchecked", "rawtypes"})
public class NewOrderServiceImpl implements NewOrderService {
@Autowired
private OrderJobMapper orderJobMapper;
@Autowired
private XxlJobClient xxlJobClient;
//创建并启动任务调度方法
@Override
public Long addAndStartTask(NewOrderTaskVo newOrderTaskVo) {
//1 判断当前订单是否启动任务调度
//根据订单id查询
LambdaQueryWrapper<OrderJob> wrapper = new LambdaQueryWrapper<>();
wrapper.eq(OrderJob::getOrderId,newOrderTaskVo.getOrderId());
OrderJob orderJob = orderJobMapper.selectOne(wrapper);
//2 没有启动,进行操作
if(orderJob == null) {
//创建并启动任务调度
//String executorHandler 执行任务job方法
// String param
// String corn 执行cron表达式
// String desc 描述信息
Long jobId = xxlJobClient.addAndStart("newOrderTaskHandler", "",
"0 0/1 * * * ?",
"新创建订单任务调度:" + newOrderTaskVo.getOrderId());
//记录任务调度信息
orderJob = new OrderJob();
orderJob.setOrderId(newOrderTaskVo.getOrderId());
orderJob.setJobId(jobId);
orderJob.setParameter(JSONObject.toJSONString(newOrderTaskVo));
orderJobMapper.insert(orderJob);
}
return orderJob.getJobId();
}
}
远程调用定义 service-disptach-client
NewOrderFeignClient
/**
* 添加新订单任务
* @param newOrderDispatchVo
* @return
*/
@PostMapping("/dispatch/newOrder/addAndStartTask")
Result<Long> addAndStartTask(@RequestBody NewOrderTaskVo newOrderDispatchVo);
service-dispatch下的xxl.job创建JobHandler 类
@Component
public class JobHandler {
@Autowired
private XxlJobLogMapper xxlJobLogMapper;
@Autowired
private NewOrderService newOrderService;
@XxlJob("newOrderTaskHandler")
public void newOrderTaskHandler() {
//记录任务调度日志
XxlJobLog xxlJobLog = new XxlJobLog();
xxlJobLog.setJobId(XxlJobHelper.getJobId());
long startTime = System.currentTimeMillis();
try {
//执行任务:搜索附近代驾司机
newOrderService.executeTask(XxlJobHelper.getJobId());
//成功状态
xxlJobLog.setStatus(1);
} catch (Exception e) {
//失败状态
xxlJobLog.setStatus(0);
xxlJobLog.setError(e.getMessage());
e.printStackTrace();
} finally {
long times = System.currentTimeMillis()- startTime;
//TODO 完善long
xxlJobLog.setTimes((int)times);
xxlJobLogMapper.insert(xxlJobLog);
}
}
}
NewOrderServiceImpl
//执行任务:搜索附近代驾司机
@Override
public void executeTask(long jobId) {
//1 根据jobid查询数据库,当前任务是否已经创建
//如果没有创建,不往下执行了
LambdaQueryWrapper<OrderJob> wrapper = new LambdaQueryWrapper<>();
wrapper.eq(OrderJob::getJobId,jobId);
OrderJob orderJob = orderJobMapper.selectOne(wrapper);
if(orderJob == null) {
//不往下执行了
return;
}
//2 查询订单状态,如果当前订单接单状态,继续执行。如果当前订单不是接单状态,停止任务调度
//获取OrderJob里面对象
String jsonString = orderJob.getParameter();
NewOrderTaskVo newOrderTaskVo = JSONObject.parseObject(jsonString, NewOrderTaskVo.class);
//获取orderId
Long orderId = newOrderTaskVo.getOrderId();
Integer status = orderInfoFeignClient.getOrderStatus(orderId).getData();
if(status.intValue() != OrderStatus.WAITING_ACCEPT.getStatus().intValue()) {
//停止任务调度
xxlJobClient.stopJob(jobId);
return;
}
//3 远程调用:搜索附近满足条件可以接单司机
//4 远程调用之后,获取满足可以接单司机集合
SearchNearByDriverForm searchNearByDriverForm = new SearchNearByDriverForm();
searchNearByDriverForm.setLongitude(newOrderTaskVo.getStartPointLongitude());
searchNearByDriverForm.setLatitude(newOrderTaskVo.getStartPointLatitude());
searchNearByDriverForm.setMileageDistance(newOrderTaskVo.getExpectDistance());
//远程调用
List<NearByDriverVo> nearByDriverVoList =
locationFeignClient.searchNearByDriver(searchNearByDriverForm).getData();
//5 遍历司机集合,得到每个司机,为每个司机创建临时队列,存储新订单信息
nearByDriverVoList.forEach(driver -> {
//使用Redis的set类型
//根据订单id生成key
String repeatKey =
RedisConstant.DRIVER_ORDER_REPEAT_LIST+newOrderTaskVo.getOrderId();
//记录司机id,防止重复推送
Boolean isMember = redisTemplate.opsForSet().isMember(repeatKey, driver.getDriverId());
if(!isMember) {
//把订单信息推送给满足条件多个司机
redisTemplate.opsForSet().add(repeatKey,driver.getDriverId());
//过期时间:15分钟,超过15分钟没有接单自动取消
redisTemplate.expire(repeatKey,
RedisConstant.DRIVER_ORDER_REPEAT_LIST_EXPIRES_TIME,
TimeUnit.MINUTES);
NewOrderDataVo newOrderDataVo = new NewOrderDataVo();
newOrderDataVo.setOrderId(newOrderTaskVo.getOrderId());
newOrderDataVo.setStartLocation(newOrderTaskVo.getStartLocation());
newOrderDataVo.setEndLocation(newOrderTaskVo.getEndLocation());
newOrderDataVo.setExpectAmount(newOrderTaskVo.getExpectAmount());
newOrderDataVo.setExpectDistance(newOrderTaskVo.getExpectDistance());
newOrderDataVo.setExpectTime(newOrderTaskVo.getExpectTime());
newOrderDataVo.setFavourFee(newOrderTaskVo.getFavourFee());
newOrderDataVo.setDistance(driver.getDistance());
newOrderDataVo.setCreateTime(newOrderTaskVo.getCreateTime());
//新订单保存司机的临时队列,Redis里面List集合
String key = RedisConstant.DRIVER_ORDER_TEMP_LIST+driver.getDriverId();
redisTemplate.opsForList().leftPush(key,JSONObject.toJSONString(newOrderDataVo));
//过期时间:1分钟
redisTemplate.expire(key,RedisConstant.DRIVER_ORDER_TEMP_LIST_EXPIRES_TIME, TimeUnit.MINUTES);
}
});
}
4.5.5 乘客下单添加任务调度
在web-customer下的OrderServiceImpl中
// //乘客下单
@Override
public Long submitOrder(SubmitOrderForm submitOrderForm) {
//1 重新计算驾驶线路
CalculateDrivingLineForm calculateDrivingLineForm = new CalculateDrivingLineForm();
BeanUtils.copyProperties(submitOrderForm,calculateDrivingLineForm );
Result<DrivingLineVo> drivingLineVoResult = mapFeignClient.calculateDrivingLine(calculateDrivingLineForm);
DrivingLineVo drivingLineVo = drivingLineVoResult.getData();
//2 重新订单费用
FeeRuleRequestForm calculateOrderFeeForm = new FeeRuleRequestForm();
calculateOrderFeeForm.setDistance(drivingLineVo.getDistance());
calculateOrderFeeForm.setStartTime(new Date());
calculateOrderFeeForm.setWaitMinute(0);
Result<FeeRuleResponseVo> feeRuleResponseVoResult = feeRuleFeignClient.calculateOrderFee(calculateOrderFeeForm);
FeeRuleResponseVo feeRuleResponseVo = feeRuleResponseVoResult.getData();
//封装数据
OrderInfoForm orderInfoForm = new OrderInfoForm();
BeanUtils.copyProperties(submitOrderForm,orderInfoForm);
orderInfoForm.setExpectDistance(drivingLineVo.getDistance());
orderInfoForm.setExpectAmount(feeRuleResponseVo.getTotalAmount());
Result<Long> orderInfoResult = orderInfoFeignClient.saveOrderInfo(orderInfoForm);
Long orderId = orderInfoResult.getData();
//任务调度:查询附近可以接单司机
NewOrderTaskVo newOrderDispatchVo = new NewOrderTaskVo();
newOrderDispatchVo.setOrderId(orderId);
newOrderDispatchVo.setStartLocation(orderInfoForm.getStartLocation());
newOrderDispatchVo.setStartPointLongitude(orderInfoForm.getStartPointLongitude());
newOrderDispatchVo.setStartPointLatitude(orderInfoForm.getStartPointLatitude());
newOrderDispatchVo.setEndLocation(orderInfoForm.getEndLocation());
newOrderDispatchVo.setEndPointLongitude(orderInfoForm.getEndPointLongitude());
newOrderDispatchVo.setEndPointLatitude(orderInfoForm.getEndPointLatitude());
newOrderDispatchVo.setExpectAmount(orderInfoForm.getExpectAmount());
newOrderDispatchVo.setExpectDistance(orderInfoForm.getExpectDistance());
newOrderDispatchVo.setExpectTime(drivingLineVo.getDuration());
newOrderDispatchVo.setFavourFee(orderInfoForm.getFavourFee());
newOrderDispatchVo.setCreateTime(new Date());
//远程调用
Long jobId = newOrderFeignClient.addAndStartTask(newOrderDispatchVo).getData();
//返回订单id
return orderId;
}
4.5.6司机获取最新订单数据
司机开启接单服务后,司机端小程序就会实时轮询新订单数据,如果临时队列有数据,就拉取数据进行实时语音播报。但是当司机接单成功后,就需要清空临时队列,释放系统空间,因此这两接口都提供了,清除不需要web接口。
①查询司机最新订单
②清空新订单队列数据
service-dispatch下的NewOrderController
@Operation(summary = "查询司机新订单数据")
@GetMapping("/findNewOrderQueueData/{driverId}")
public Result<List<NewOrderDataVo>> findNewOrderQueueData(@PathVariable Long driverId) {
return Result.ok(newOrderService.findNewOrderQueueData(driverId));
}
@Operation(summary = "清空新订单队列数据")
@GetMapping("/clearNewOrderQueueData/{driverId}")
public Result<Boolean> clearNewOrderQueueData(@PathVariable Long driverId) {
return Result.ok(newOrderService.clearNewOrderQueueData(driverId));
}
NewOrderServiceImpl
//获取最新订单
@Override
public List<NewOrderDataVo> findNewOrderQueueData(Long driverId) {
List<NewOrderDataVo> list = new ArrayList<>();
String key = RedisConstant.DRIVER_ORDER_TEMP_LIST + driverId;
Long size = redisTemplate.opsForList().size(key);
if(size > 0) {
for (int i = 0; i < size; i++) {
String content = (String)redisTemplate.opsForList().leftPop(key);
NewOrderDataVo newOrderDataVo = JSONObject.parseObject(content,NewOrderDataVo.class);
list.add(newOrderDataVo);
}
}
return list;
}
//清空队列数据
@Override
public Boolean clearNewOrderQueueData(Long driverId) {
String key = RedisConstant.DRIVER_ORDER_TEMP_LIST + driverId;
redisTemplate.delete(key);
return true;
}
远程调用定义 service-dispatch-client
NewOrderFeignClient
/**
* 查询司机新订单数据
*
* @param driverId
* @return
*/
@GetMapping("/dispatch/newOrder/findNewOrderQueueData/{driverId}")
Result<List<NewOrderDataVo>> findNewOrderQueueData(@PathVariable("driverId") Long driverId);
/**
* 清空新订单队列数据
* @param driverId
* @return
*/
@GetMapping("/dispatch/newOrder/clearNewOrderQueueData/{driverId}")
Result<Boolean> clearNewOrderQueueData(@PathVariable("driverId") Long driverId);
司机web端进行调用,只需要得到最新的订单数据,清空不需要写web端
OrderController
@Operation(summary = "查询司机新订单数据")
@GuiGuLogin
@GetMapping("/findNewOrderQueueData")
public Result<List<NewOrderDataVo>> findNewOrderQueueData() {
Long driverId = AuthContextHolder.getUserId();
return Result.ok(orderService.findNewOrderQueueData(driverId));
}
OrderService
// 查询司机新订单数据
List<NewOrderDataVo> findNewOrderQueueData(Long driverId);
OrderServiceImpl
@Autowired
private NewOrderFeignClient newOrderFeignClient;
@Override
public List<NewOrderDataVo> findNewOrderQueueData(Long driverId) {
return newOrderFeignClient.findNewOrderQueueData(driverId).getData();
}
4.5.7 功能测试
启动相关服务
点击呼叫代驾出现空指针异常
原因:老师在OrderServiceImpl里面的代码写错了,没有把需要的信息复制到calculateDrivingLineForm中
修改为如下所示代码,之后重启服务即可
BeanUtils.copyProperties(submitOrderForm,calculateDrivingLineForm);
5.定时任务调度框架
单机
- Timer:这是 java 自带的 java.util.Timer 类,这个类允许你调度一个 java.util.TimerTask 任务。使用这种方式可以让你的程序按照某一个频度执行,但不能在指定时间运行。一般用的较少。
- ScheduledExecutorService:也 jdk 自带的一个类;是基于线程池设计的定时任务类,每个调度任务都会分配到线程池中的一个线程去执行,也就是说,任务是并发执行,互不影响。
- Spring Task:Spring3.0 以后自带的 task,配置简单功能较多,如果系统使用单机的话可以优先考虑spring定时器。
分布式
- Quartz:Java事实上的定时任务标准。但Quartz关注点在于定时任务而非数据,并无一套根据数据处理而定制化的流程。虽然Quartz可以基于数据库实现作业的高可用,但缺少分布式并行调度的功能。
- TBSchedule:阿里早期开源的分布式任务调度系统。代码略陈旧,使用timer而非线程池执行任务调度。众所周知,timer在处理异常状况时是有缺陷的。而且TBSchedule作业类型较为单一,只能是获取/处理数据一种模式。还有就是文档缺失比较严重。
- elastic-job:当当开发的弹性分布式任务调度系统,功能丰富强大,采用zookeeper实现分布式协调,实现任务高可用以及分片,并且可以支持云开发。
- Saturn:是唯品会自主研发的分布式的定时任务的调度平台,基于当当的elastic-job 版本1开发,并且可以很好的部署到docker容器上。
- xxl-job: 是大众点评员工徐雪里于2015年发布的分布式任务调度平台,是一个轻量级分布式任务调度框架,其核心设计目标是开发迅速、学习简单、轻量级、易扩展,其在唯品会内部已经发部署350+个节点,每天任务调度4000多万次。同时,管理和统计也是它的亮点。使用案例 大众点评、易信(IM)、京东(电商系统)、360金融(金融系统)、易企秀、随行付(支付系统)、优信二手车。
我们项目选择:XXL-JOB
5.1 分布式任务调度平台XXL-JOB
官方文档:https://www.xuxueli.com/xxl-job/
5.1.1 概述
XXL-JOB是一个分布式任务调度平台,其核心设计目标是开发迅速、学习简单、轻量级、易扩展。现已开放源代码并接入多家公司线上产品线,开箱即用。
5.1.2 特性(仅了解)
- 1、简单:支持通过Web页面对任务进行CRUD操作,操作简单,一分钟上手;
- 2、动态:支持动态修改任务状态、启动/停止任务,以及终止运行中任务,即时生效;
- 3、调度中心HA(中心式):调度采用中心式设计,“调度中心”自研调度组件并支持集群部署,可保证调度中心HA;
- 4、执行器HA(分布式):任务分布式执行,任务”执行器”支持集群部署,可保证任务执行HA;
- 5、注册中心: 执行器会周期性自动注册任务, 调度中心将会自动发现注册的任务并触发执行。同时,也支持手动录入执行器地址;
- 6、弹性扩容缩容:一旦有新执行器机器上线或者下线,下次调度时将会重新分配任务;
- 7、触发策略:提供丰富的任务触发策略,包括:Cron触发、固定间隔触发、固定延时触发、API(事件)触发、人工触发、父子任务触发;
- 8、调度过期策略:调度中心错过调度时间的补偿处理策略,包括:忽略、立即补偿触发一次等;
- 9、阻塞处理策略:调度过于密集执行器来不及处理时的处理策略,策略包括:单机串行(默认)、丢弃后续调度、覆盖之前调度;
- 10、任务超时控制:支持自定义任务超时时间,任务运行超时将会主动中断任务;
- 11、任务失败重试:支持自定义任务失败重试次数,当任务失败时将会按照预设的失败重试次数主动进行重试;其中分片任务支持分片粒度的失败重试;
- 12、任务失败告警;默认提供邮件方式失败告警,同时预留扩展接口,可方便的扩展短信、钉钉等告警方式;
- 13、路由策略:执行器集群部署时提供丰富的路由策略,包括:第一个、最后一个、轮询、随机、一致性HASH、最不经常使用、最近最久未使用、故障转移、忙碌转移等;
- 14、分片广播任务:执行器集群部署时,任务路由策略选择”分片广播”情况下,一次任务调度将会广播触发集群中所有执行器执行一次任务,可根据分片参数开发分片任务;
- 15、动态分片:分片广播任务以执行器为维度进行分片,支持动态扩容执行器集群从而动态增加分片数量,协同进行业务处理;在进行大数据量业务操作时可显著提升任务处理能力和速度。
- 16、故障转移:任务路由策略选择”故障转移”情况下,如果执行器集群中某一台机器故障,将会自动Failover切换到一台正常的执行器发送调度请求。
- 17、任务进度监控:支持实时监控任务进度;
- 18、Rolling实时日志:支持在线查看调度结果,并且支持以Rolling方式实时查看执行器输出的完整的执行日志;
- 19、GLUE:提供Web IDE,支持在线开发任务逻辑代码,动态发布,实时编译生效,省略部署上线的过程。支持30个版本的历史版本回溯。
- 20、脚本任务:支持以GLUE模式开发和运行脚本任务,包括Shell、Python、NodeJS、PHP、PowerShell等类型脚本;
- 21、命令行任务:原生提供通用命令行任务Handler(Bean任务,”CommandJobHandler”);业务方只需要提供命令行即可;
- 22、任务依赖:支持配置子任务依赖,当父任务执行结束且执行成功后将会主动触发一次子任务的执行, 多个子任务用逗号分隔;
- 23、一致性:“调度中心”通过DB锁保证集群分布式调度的一致性, 一次任务调度只会触发一次执行;
- 24、自定义任务参数:支持在线配置调度任务入参,即时生效;
- 25、调度线程池:调度系统多线程触发调度运行,确保调度精确执行,不被堵塞;
- 26、数据加密:调度中心和执行器之间的通讯进行数据加密,提升调度信息安全性;
- 27、邮件报警:任务失败时支持邮件报警,支持配置多邮件地址群发报警邮件;
- 28、推送maven中央仓库: 将会把最新稳定版推送到maven中央仓库, 方便用户接入和使用;
- 29、运行报表:支持实时查看运行数据,如任务数量、调度次数、执行器数量等;以及调度报表,如调度日期分布图,调度成功分布图等;
- 30、全异步:任务调度流程全异步化设计实现,如异步调度、异步运行、异步回调等,有效对密集调度进行流量削峰,理论上支持任意时长任务的运行;
- 31、跨语言:调度中心与执行器提供语言无关的 RESTful API 服务,第三方任意语言可据此对接调度中心或者实现执行器。除此之外,还提供了 “多任务模式”和“httpJobHandler”等其他跨语言方案;
- 32、国际化:调度中心支持国际化设置,提供中文、英文两种可选语言,默认为中文;
- 33、容器化:提供官方docker镜像,并实时更新推送dockerhub,进一步实现产品开箱即用;
- 34、线程池隔离:调度线程池进行隔离拆分,慢任务自动降级进入”Slow”线程池,避免耗尽调度线程,提高系统稳定性;
- 35、用户管理:支持在线管理系统用户,存在管理员、普通用户两种角色;
- 36、权限控制:执行器维度进行权限控制,管理员拥有全量权限,普通用户需要分配执行器权限后才允许相关操作;
5.1.3 下载
文档地址
源码仓库地址
源码仓库地址 | Release Download |
---|---|
https://github.com/xuxueli/xxl-job | Download |
http://gitee.com/xuxueli0323/xxl-job | Download |
中央仓库地址
当前项目使用版本:2.4.1-SNAPSHOT
注:为了统一版本,已统一下载,在资料中获取:xxl-job-master.zip
<dependency>
<groupId>com.xuxueli</groupId>
<artifactId>xxl-job-core</artifactId>
<version>${最新稳定版本}</version>
</dependency>
5.2快速入门
5.2.1 导入项目到idea
解压:xxl-job-master.zip,导入idea,如图:
项目结构说明:
xxl-job-master:
xxl-job-admin:调度中心
xxl-job-core:公共依赖
xxl-job-executor-samples:执行器Sample示例(选择合适的版本执行器,可直接使用,也可以参考其并将现有项目改造成执行器)
xxl-job-executor-sample-springboot:Springboot版本,通过Springboot管理执行器,推荐这种方式;
xxl-job-executor-sample-frameless:无框架版本;
5.2.2 初始化“调度数据库”
获取 “调度数据库初始化SQL脚本” 并执行即可。
调度数据库初始化SQL脚本” 位置为:
/xxl-job-master/doc/db/tables_xxl_job.sql
5.1.3 部署”调度中心“
调度中心项目:xxl-job-admin
作用:统一管理任务调度平台上调度任务,负责触发调度执行,并且提供任务管理平台。
步骤一:修改数据库连接
### xxl-job, datasource
spring.datasource.url=jdbc:mysql://localhost:3306/xxl_job?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
步骤二:启动项目
调度中心访问地址:http://localhost:8080/xxl-job-admin
默认登录账号 “admin/123456”, 登录后运行界面如下图所示:
步骤三:调度中心集群部署(可选)
调度中心支持集群部署,提升调度系统容灾和可用性。
调度中心集群部署时,几点要求和建议:
- DB配置保持一致;
- 集群机器时钟保持一致(单机集群忽视);
- 建议:推荐通过nginx为调度中心集群做负载均衡,分配域名。调度中心访问、执行器回调配置、调用API服务等操作均通过该域名进行。
5.1.4 配置部署“执行器项目”
“执行器”项目:xxl-job-executor-sample-springboot (提供多种版本执行器供选择,现以 springboot 版本为例,可直接使用,也可以参考其并将现有项目改造成执行器)
作用:负责接收“调度中心”的调度并执行;可直接部署执行器,也可以将执行器集成到现有业务项目中。
步骤一:maven依赖
确认pom文件中引入了 “xxl-job-core” 的maven依赖;
<!-- xxl-job-core -->
<dependency>
<groupId>com.xuxueli</groupId>
<artifactId>xxl-job-core</artifactId>
<version>2.4.1-SNAPSHOT</version>
</dependency>
步骤二:执行器配置
执行器配置,配置内容说明:
### 调度中心部署根地址 [选填]:如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调";为空则关闭自动注册;
xxl.job.admin.addresses=http://127.0.0.1:8080/xxl-job-admin
### 执行器通讯TOKEN [选填]:非空时启用;
xxl.job.accessToken=
### 执行器AppName [选填]:执行器心跳注册分组依据;为空则关闭自动注册
xxl.job.executor.appname=xxl-job-executor-sample
### 执行器注册 [选填]:优先使用该配置作为注册地址,为空时使用内嵌服务 ”IP:PORT“ 作为注册地址。从而更灵活的支持容器类型执行器动态IP和动态映射端口问题。
xxl.job.executor.address=
### 执行器IP [选填]:默认为空表示自动获取IP,多网卡时可手动设置指定IP,该IP不会绑定Host仅作为通讯实用;地址信息用于 "执行器注册" 和 "调度中心请求并触发任务";
xxl.job.executor.ip=
### 执行器端口号 [选填]:小于等于0则自动获取;默认端口为9999,单机部署多个执行器时,注意要配置不同执行器端口;
xxl.job.executor.port=9999
### 执行器运行日志文件存储磁盘路径 [选填] :需要对该路径拥有读写权限;为空则使用默认路径;
xxl.job.executor.logpath=/data/applogs/xxl-job/jobhandler
### 执行器日志文件保存天数 [选填] : 过期日志自动清理, 限制值大于等于3时生效; 否则, 如-1, 关闭自动清理功能;
xxl.job.executor.logretentiondays=30
步骤三:执行器组件配置
执行器组件,配置内容说明:
package com.xxl.job.executor.core.config;
import com.xxl.job.core.executor.impl.XxlJobSpringExecutor;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
/**
* xxl-job config
*
* @author xuxueli 2017-04-28
*/
@Configuration
public class XxlJobConfig {
private Logger logger = LoggerFactory.getLogger(XxlJobConfig.class);
@Value("${xxl.job.admin.addresses}")
private String adminAddresses;
@Value("${xxl.job.accessToken}")
private String accessToken;
@Value("${xxl.job.executor.appname}")
private String appname;
@Value("${xxl.job.executor.address}")
private String address;
@Value("${xxl.job.executor.ip}")
private String ip;
@Value("${xxl.job.executor.port}")
private int port;
@Value("${xxl.job.executor.logpath}")
private String logPath;
@Value("${xxl.job.executor.logretentiondays}")
private int logRetentionDays;
@Bean
public XxlJobSpringExecutor xxlJobExecutor() {
logger.info(">>>>>>>>>>> xxl-job config init.");
XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor();
xxlJobSpringExecutor.setAdminAddresses(adminAddresses);
xxlJobSpringExecutor.setAppname(appname);
xxlJobSpringExecutor.setAddress(address);
xxlJobSpringExecutor.setIp(ip);
xxlJobSpringExecutor.setPort(port);
xxlJobSpringExecutor.setAccessToken(accessToken);
xxlJobSpringExecutor.setLogPath(logPath);
xxlJobSpringExecutor.setLogRetentionDays(logRetentionDays);
return xxlJobSpringExecutor;
}
/**
* 针对多网卡、容器内部署等情况,可借助 "spring-cloud-commons" 提供的 "InetUtils" 组件灵活定制注册IP;
*
* 1、引入依赖:
* <dependency>
* <groupId>org.springframework.cloud</groupId>
* <artifactId>spring-cloud-commons</artifactId>
* <version>${version}</version>
* </dependency>
*
* 2、配置文件,或者容器启动变量
* spring.cloud.inetutils.preferred-networks: 'xxx.xxx.xxx.'
*
* 3、获取IP
* String ip_ = inetUtils.findFirstNonLoopbackHostInfo().getIpAddress();
*/
}
步骤四:启动执行器项目:
启动:xxl-job-executor-sample-springboot
步骤五:执行器集群(可选):
执行器支持集群部署,提升调度系统可用性,同时提升任务处理能力。
执行器集群部署时,几点要求和建议:
- 执行器回调地址(xxl.job.admin.addresses)需要保持一致;执行器根据该配置进行执行器自动注册等操作。
- 同一个执行器集群内AppName(xxl.job.executor.appname)需要保持一致;调度中心根据该配置动态发现不同集群的在线执行器列表。
5.1.5 第一个任务调度
步骤一:配置执行器
上面我们启动了xxl-job-executor-sample-springboot 执行器项目,当前已注册上来,我们执行使用改执行器。
执行器属性说明:
AppName: 是每个执行器集群的唯一标示AppName, 执行器会周期性以AppName为对象进行自动注册。可通过该配置自动发现注册成功的执行器, 供任务调度时使用;
名称: 执行器的名称, 因为AppName限制字母数字等组成,可读性不强, 名称为了提高执行器的可读性;排序: 执行器的排序, 系统中需要执行器的地方,如任务新增, 将会按照该排序读取可用的执行器列表;
注册方式:调度中心获取执行器地址的方式;
自动注册:执行器自动进行执行器注册,调度中心通过底层注册表可以动态发现执行器机器地址;
手动录入:人工手动录入执行器的地址信息,多地址逗号分隔,供调度中心使用;
机器地址:"注册方式"为"手动录入"时有效,支持人工维护执行器的地址信息;
步骤二:新建任务:
登录调度中心:http://localhost:8080/xxl-job-admin
默认登录账号 “admin/123456”
任务管理 ==》 新增
添加成功,如图:
步骤三:执行器项目开发job方法
使用xxl-job-executor-sample-springboot项目job实例,与步骤二的JobHandler配置一致
/**
* 1、简单任务示例(Bean模式)
*/
@XxlJob("demoJobHandler")
public void demoJobHandler() throws Exception {
XxlJobHelper.log("XXL-JOB, Hello World.");
for (int i = 0; i < 5; i++) {
XxlJobHelper.log("beat at:" + i);
TimeUnit.SECONDS.sleep(2);
}
// default success
}
步骤四:启动任务
任务列表状态改变,如图:
设置断点,执行结果:
查看调度日志: