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
识别这些API接口定义(http,https,api,RPC,webservice,Restful api ,OpenAPI)
本内容介绍了API相关的术语分类,包括传输协议(HTTP/HTTPS)、接口风格(RESTful、WebService、RPC)及开放程度(API、OpenAPI),帮助理解各类API的特点与应用场景。
|
4月前
|
缓存 安全 API
RESTful与GraphQL:电商API接口设计的技术细节与适用场景
本文对比了RESTful与GraphQL这两种主流电商API接口设计方案。RESTful通过资源与HTTP方法定义操作,简单直观但可能引发过度或欠获取数据问题;GraphQL允许客户端精确指定所需字段,提高灵活性和传输效率,但面临深度查询攻击等安全挑战。从性能、灵活性、安全性及适用场景多维度分析,RESTful适合资源导向场景,GraphQL则适用于复杂数据需求。实际开发中需根据业务特点选择合适方案,或结合两者优势,以优化用户体验与系统性能。
|
4月前
|
JSON 编解码 API
Go语言网络编程:使用 net/http 构建 RESTful API
本章介绍如何使用 Go 语言的 `net/http` 标准库构建 RESTful API。内容涵盖 RESTful API 的基本概念及规范,包括 GET、POST、PUT 和 DELETE 方法的实现。通过定义用户数据结构和模拟数据库,逐步实现获取用户列表、创建用户、更新用户、删除用户的 HTTP 路由处理函数。同时提供辅助函数用于路径参数解析,并展示如何设置路由器启动服务。最后通过 curl 或 Postman 测试接口功能。章节总结了路由分发、JSON 编解码、方法区分、并发安全管理和路径参数解析等关键点,为更复杂需求推荐第三方框架如 Gin、Echo 和 Chi。
|
3月前
|
缓存 边缘计算 前端开发
从业务需求到技术栈:电商API选型RESTful还是GraphQL?这5个维度帮你决策
在数字经济时代,电商平台的竞争已延伸至用户体验与系统效能。作为连接前后端及各类服务的核心,API接口的架构设计至关重要。本文对比RESTful与GraphQL两大主流方案,从电商场景出发,分析两者的技术特性、适用场景与选型逻辑,帮助开发者根据业务需求做出最优选择。
|
7月前
|
XML JSON API
Understanding RESTful API and Web Services: Key Differences and Use Cases
在现代软件开发中,RESTful API和Web服务均用于实现系统间通信,但各有特点。RESTful API遵循REST原则,主要使用HTTP/HTTPS协议,数据格式多为JSON或XML,适用于无状态通信;而Web服务包括SOAP和REST,常用于基于网络的API,采用标准化方法如WSDL或OpenAPI。理解两者区别有助于选择适合应用需求的解决方案,构建高效、可扩展的应用程序。
|
7月前
|
机器学习/深度学习 设计模式 API
Python 高级编程与实战:构建 RESTful API
本文深入探讨了使用 Python 构建 RESTful API 的方法,涵盖 Flask、Django REST Framework 和 FastAPI 三个主流框架。通过实战项目示例,详细讲解了如何处理 GET、POST 请求,并返回相应数据。学习这些技术将帮助你掌握构建高效、可靠的 Web API。
|
10月前
|
JSON JavaScript 前端开发
深入浅出Node.js:从零开始构建RESTful API
在数字化时代的浪潮中,后端开发作为连接用户与数据的桥梁,扮演着至关重要的角色。本文将引导您步入Node.js的奇妙世界,通过实践操作,掌握如何使用这一强大的JavaScript运行时环境构建高效、可扩展的RESTful API。我们将一同探索Express框架的使用,学习如何设计API端点,处理数据请求,并实现身份验证机制,最终部署我们的成果到云服务器上。无论您是初学者还是有一定基础的开发者,这篇文章都将为您打开一扇通往后端开发深层知识的大门。
201 12
|
11月前
|
XML JSON 缓存
深入理解RESTful API设计原则与实践
在现代软件开发中,构建高效、可扩展的应用程序接口(API)是至关重要的。本文旨在探讨RESTful API的核心设计理念,包括其基于HTTP协议的特性,以及如何在实际应用中遵循这些原则来优化API设计。我们将通过具体示例和最佳实践,展示如何创建易于理解、维护且性能优良的RESTful服务,从而提升前后端分离架构下的开发效率和用户体验。
|
11月前
|
JSON 缓存 测试技术
构建高效RESTful API的后端实践指南####
本文将深入探讨如何设计并实现一个高效、可扩展且易于维护的RESTful API。不同于传统的摘要概述,本节将直接以行动指南的形式,列出构建RESTful API时必须遵循的核心原则与最佳实践,旨在为开发者提供一套直接可行的实施框架,快速提升API设计与开发能力。 ####
|
11月前
|
JSON API 开发者
深入理解RESTful API设计原则
在数字化时代,API已成为连接不同软件应用的桥梁。本文旨在探讨RESTful API设计的基本原则和最佳实践,帮助开发者构建高效、可扩展的网络服务接口。通过解析REST架构风格的核心概念,我们将了解如何设计易于理解和使用的API,同时保证其性能和安全性。