xxl-job restful api

简介: xxl-job restful api

昨天对接了xxl-jobrestful api,发现其没有提供查询job信息的api,于是自己拓展

在原先com.xxl.job.admin.controller.JobApiController#api添加

/**
 * api
 *
 * @param uri
 * @param data
 * @return
 */
@RequestMapping("/{uri}")
@ResponseBody
@PermissionLimit(limit=false)
public ReturnT<?> api(HttpServletRequest request, @PathVariable("uri") String uri, @RequestBody(required = false) String data) {

    // valid
    if (!"POST".equalsIgnoreCase(request.getMethod())) {
        return new ReturnT<String>(ReturnT.FAIL_CODE, "invalid request, HttpMethod not support.");
    }
    if (uri==null || uri.trim().length()==0) {
        return new ReturnT<String>(ReturnT.FAIL_CODE, "invalid request, uri-mapping empty.");
    }
    if (XxlJobAdminConfig.getAdminConfig().getAccessToken()!=null
            && XxlJobAdminConfig.getAdminConfig().getAccessToken().trim().length()>0
            && !XxlJobAdminConfig.getAdminConfig().getAccessToken().equals(request.getHeader(XxlJobRemotingUtil.XXL_JOB_ACCESS_TOKEN))) {
        return new ReturnT<String>(ReturnT.FAIL_CODE, "The access token is wrong.");
    }

    // services mapping
    if ("callback".equals(uri)) {
        List<HandleCallbackParam> callbackParamList = GsonTool.fromJson(data, List.class, HandleCallbackParam.class);
        return adminBiz.callback(callbackParamList);
    } else if ("registry".equals(uri)) {
        RegistryParam registryParam = GsonTool.fromJson(data, RegistryParam.class);
        return adminBiz.registry(registryParam);
    } else if ("registryRemove".equals(uri)) {
        RegistryParam registryParam = GsonTool.fromJson(data, RegistryParam.class);
        return adminBiz.registryRemove(registryParam);
    } else if ("pageList".equals(uri)) {
        ReturnT<Map<String, Object>> success = new ReturnT<>();
        JobQuery jobQuery = GsonTool.fromJson(data, JobQuery.class);
        Map<String, Object> pageList = xxlJobService.pageList(
                jobQuery.getStart(),
                jobQuery.getLength(),
                jobQuery.getJobGroup(),
                jobQuery.getTriggerStatus(),
                jobQuery.getJobDesc(),
                jobQuery.getExecutorHandler(),
                jobQuery.getAuthor());
        success.setContent(pageList);
        return success;
    } else {
        return new ReturnT<String>(ReturnT.FAIL_CODE, "invalid request, uri-mapping("+ uri +") not found.");
    }

}

这里参数

public class JobQuery {
        private Integer start;
        private Integer length;
        private Integer jobGroup;
        private Integer triggerStatus;
        private String jobDesc;
        private String executorHandler;
        private String author;

        public Integer getStart() {
            return start;
        }

        public void setStart(Integer start) {
            this.start = start;
        }

        public Integer getLength() {
            return length;
        }

        public void setLength(Integer length) {
            this.length = length;
        }

        public Integer getJobGroup() {
            return jobGroup;
        }

        public void setJobGroup(Integer jobGroup) {
            this.jobGroup = jobGroup;
        }

        public Integer getTriggerStatus() {
            return triggerStatus;
        }

        public void setTriggerStatus(Integer triggerStatus) {
            this.triggerStatus = triggerStatus;
        }

        public String getJobDesc() {
            return jobDesc;
        }

        public void setJobDesc(String jobDesc) {
            this.jobDesc = jobDesc;
        }

        public String getExecutorHandler() {
            return executorHandler;
        }

        public void setExecutorHandler(String executorHandler) {
            this.executorHandler = executorHandler;
        }

        public String getAuthor() {
            return author;
        }

        public void setAuthor(String author) {
            this.author = author;
        }
    }

然后是修改对应的serviceimpl的签名

com.xxl.job.admin.service.XxlJobService#pageList

public Map<String, Object> pageList(Integer start, Integer length, Integer jobGroup, Integer triggerStatus, String jobDesc, String executorHandler, String author);

com.xxl.job.admin.service.impl.XxlJobServiceImpl#pageList

@Override
public Map<String, Object> pageList(Integer start, Integer length, Integer jobGroup, Integer triggerStatus, String jobDesc, String executorHandler, String author) {

  start = Optional.ofNullable(start).orElse(0);
  length = Optional.ofNullable(length).orElse(10);
  // page list
  List<XxlJobInfo> list = xxlJobInfoDao.pageList(start, length, jobGroup, triggerStatus, jobDesc, executorHandler, author);
  int list_count = xxlJobInfoDao.pageListCount(start, length, jobGroup, triggerStatus, jobDesc, executorHandler, author);

  // package result
  Map<String, Object> maps = new HashMap<String, Object>();
    maps.put("recordsTotal", list_count);   // 总记录数
    maps.put("recordsFiltered", list_count);  // 过滤后的总记录数
    maps.put("data", list);           // 分页列表
  return maps;
}

com.xxl.job.admin.dao.XxlJobInfoDao

public List<XxlJobInfo> pageList(@Param("offset") Integer offset,
                 @Param("pagesize") Integer pagesize,
                 @Param("jobGroup") Integer jobGroup,
                 @Param("triggerStatus") Integer triggerStatus,
                 @Param("jobDesc") String jobDesc,
                 @Param("executorHandler") String executorHandler,
                 @Param("author") String author);

public int pageListCount(@Param("offset") Integer offset,
             @Param("pagesize") Integer pagesize,
             @Param("jobGroup") Integer jobGroup,
             @Param("triggerStatus") Integer triggerStatus,
             @Param("jobDesc") String jobDesc,
             @Param("executorHandler") String executorHandler,
             @Param("author") String author);

以及XxlJobInfoMapper.xml

<select id="pageList" parameterType="java.util.HashMap" resultMap="XxlJobInfo">
  SELECT <include refid="Base_Column_List" />
  FROM xxl_job_info AS t
  <trim prefix="WHERE" prefixOverrides="AND | OR" >
    <if test="jobGroup != null and jobGroup gt 0">
      AND t.job_group = #{jobGroup}
    </if>
           <if test="triggerStatus != null and triggerStatus gte 0">
               AND t.trigger_status = #{triggerStatus}
           </if>
    <if test="jobDesc != null and jobDesc != ''">
      AND t.job_desc like CONCAT(CONCAT('%', #{jobDesc}), '%')
    </if>
    <if test="executorHandler != null and executorHandler != ''">
      AND t.executor_handler like CONCAT(CONCAT('%', #{executorHandler}), '%')
    </if>
    <if test="author != null and author != ''">
      AND t.author like CONCAT(CONCAT('%', #{author}), '%')
    </if>
  </trim>
  ORDER BY id DESC
  LIMIT #{offset}, #{pagesize}
</select>

<select id="pageListCount" parameterType="java.util.HashMap" resultType="int">
  SELECT count(1)
  FROM xxl_job_info AS t
  <trim prefix="WHERE" prefixOverrides="AND | OR" >
    <if test="jobGroup != null and jobGroup gt 0">
      AND t.job_group = #{jobGroup}
    </if>
    <if test="triggerStatus != null and triggerStatus gte 0">
               AND t.trigger_status = #{triggerStatus}
           </if>
    <if test="jobDesc != null and jobDesc != ''">
      AND t.job_desc like CONCAT(CONCAT('%', #{jobDesc}), '%')
    </if>
    <if test="executorHandler != null and executorHandler != ''">
      AND t.executor_handler like CONCAT(CONCAT('%', #{executorHandler}), '%')
    </if>
    <if test="author != null and author != ''">
      AND t.author like CONCAT(CONCAT('%', #{author}), '%')
    </if>
  </trim>
</select>

至此,终于可以通过请求

http://localhost:8080/xxl-job-admin/api/pageList

查询到job列表了,别忘了在header里携带token

XXL-JOB-ACCESS-TOKEN:{xxl.job.accessToken}
相关文章
|
2天前
|
XML JSON API
【PHP开发专栏】PHP RESTful API设计与开发
随着互联网技术的发展,前后端分离成为Web开发的主流模式。本文介绍RESTful API的基本概念、设计原则及在PHP中的实现方法。RESTful API是一种轻量级、无状态的接口设计风格,通过HTTP方法(GET、POST、PUT、DELETE)操作资源,使用JSON或XML格式传输数据。在PHP中,通过定义路由、创建控制器、处理HTTP请求和响应等步骤实现RESTful API,并强调了安全性的重要性。
8 2
|
4天前
|
存储 安全 API
深入理解RESTful API设计原则
本文旨在探讨RESTful API设计的基本原则和最佳实践,帮助开发者构建高效、可维护的Web服务。通过分析REST架构的核心概念,如资源、统一接口、无状态通信等,本文将指导读者如何设计符合REST原则的API,以及如何处理常见的设计挑战,如版本控制、错误处理和安全性问题。
|
6天前
|
存储 缓存 API
深入理解RESTful API设计原则
【10月更文挑战第28天】 在现代软件开发中,RESTful API已经成为了前后端分离架构下不可或缺的一部分。本文将探讨RESTful API的核心设计原则,包括资源导向、无状态性、统一的接口以及可缓存性等关键概念,并通过实例解析如何在实际应用中遵循这些原则来设计高效、可扩展的API。我们将深入了解REST架构风格的理论基础,并讨论其对提升系统互操作性和简化客户端实现的重要性。
31 3
|
7天前
|
JavaScript 中间件 API
Node.js进阶:Koa框架下的RESTful API设计与实现
【10月更文挑战第28天】本文介绍了如何在Koa框架下设计与实现RESTful API。首先概述了Koa框架的特点,接着讲解了RESTful API的设计原则,包括无状态和统一接口。最后,通过一个简单的博客系统示例,详细展示了如何使用Koa和koa-router实现常见的CRUD操作,包括获取、创建、更新和删除文章。
26 3
|
8天前
|
前端开发 关系型数据库 API
深入浅出后端开发——从零到一构建RESTful API
本文旨在为初学者提供一个关于后端开发的全面指南,特别是如何从零开始构建一个RESTful API。我们将探讨后端开发的基本概念、所需技术栈、以及通过实际案例展示如何设计和实现一个简单的RESTful API。无论你是完全的新手还是有一定编程基础的开发者,这篇文章都将为你提供实用的知识和技巧,帮助你在后端开发的道路上迈出坚实的一步。
|
8天前
|
XML API 网络架构
深入理解RESTful API设计原则与实践
【10月更文挑战第26天】在数字化浪潮中,API(应用程序编程接口)成为连接不同软件组件的桥梁。本文将深入浅出地探讨如何根据REST(Representational State Transfer)原则设计高效、易于维护和扩展的API,同时分享一些实用的代码示例,帮助开发者构建更加健壮和用户友好的服务。
|
10天前
|
JSON API 数据格式
如何使用Python和Flask构建一个简单的RESTful API。Flask是一个轻量级的Web框架
本文介绍了如何使用Python和Flask构建一个简单的RESTful API。Flask是一个轻量级的Web框架,适合小型项目和微服务。文章从环境准备、创建基本Flask应用、定义资源和路由、请求和响应处理、错误处理等方面进行了详细说明,并提供了示例代码。通过这些步骤,读者可以快速上手构建自己的RESTful API。
22 2
|
10天前
|
API 数据安全/隐私保护 开发者
探索RESTful API设计的最佳实践
【10月更文挑战第25天】在数字时代的浪潮中,API成为了连接不同软件组件的桥梁。本文将深入探讨如何设计高效的RESTful API,通过实际代码示例揭示背后的逻辑和结构之美。我们将从基础原则出发,逐步展开到高级概念,旨在为读者提供一套完整的设计蓝图。
|
14天前
|
SQL API 数据安全/隐私保护
打造现代化后端服务:从零到一实现RESTful API
【10月更文挑战第20天】在数字化时代的浪潮中,构建一个高效、可靠的后端服务是每个软件工程师的必备技能。本文将引导你理解RESTful API的设计哲学,并通过实际的代码示例,展示如何从无到有地实现一个现代化的后端服务。无论你是初学者还是有经验的开发者,这篇文章都将为你提供宝贵的知识和启发。
|
14天前
|
存储 XML API
探索后端开发中的RESTful API设计哲学
【10月更文挑战第21天】在数字化时代,后端开发是构建强大、可靠和可扩展应用程序的基石。本文将深入探讨RESTful API的设计原则,并展示如何通过这些原则来提升API的质量和性能。我们将从基础概念出发,逐步深入到实际案例分析,揭示高效API设计的秘诀。无论你是初学者还是有经验的开发者,这篇文章都将为你提供宝贵的见解和实用的技巧,帮助你在后端开发的道路上更进一步。

热门文章

最新文章