postman调用xxljob
时间: 2025-05-12 07:18:47 浏览: 40
### 使用 Postman 调用 XxlJob API 或执行任务
XxlJob 提供了一个基于 Web 的管理界面用于任务调度和配置,同时也暴露了一些 RESTful 风格的接口以便外部程序调用。以下是关于如何通过 Postman 调用这些接口的具体说明。
#### 1. 登录接口
为了能够操作 XxlJob 的相关功能,首先需要登录获取会话令牌(Session Token)。可以通过 `POST` 请求发送用户名和密码来完成登录:
- **URL**: `{XXL_JOB_ADMIN_URL}/login`
- **Method**: POST
- **Body (Form Data)**:
- `username`: 管理员账号,默认为 `admin`
- `password`: 密码,默认为 `123456`
成功返回的数据结构类似于以下内容[^2]:
```json
{
"code": 200,
"msg": null,
"content": {
"id": 1,
"username": "admin",
...
}
}
```
注意保存响应中的 Cookie 值,在后续请求中需携带该 Cookie 进行身份验证。
#### 2. 添加或更新任务组
如果需要新增或者修改任务分组,则可以利用相应的接口实现此目的。例如创建一个新的任务分组可通过下面的方式达成:
- **URL**: `{XXL_JOB_ADMIN_URL}/jobgroup/add`
- **Method**: POST
- **Headers**:
- `Cookie`: 上一步获得的 Session Cookie
- **Body (JSON)**:
```json
{
"appname":"testApp",
"title":"Test Group"
}
```
上述过程涉及到数据库查询逻辑可参考 DAO 层定义如下的 SQL 映射语句[^3]:
```sql
SELECT <include refid="Base_Column_List"/>
FROM xxl_job_group AS t
WHERE t.app_name = #{appName}
```
#### 3. 执行任务实例
当已经存在某个具体的任务时,可以直接触发它的运行状态改变。假设目标 Job ID 是已知的情况下,发起如下 HTTP 请求即可立即执行指定作业项:
- **URL**: `{XXL_JOB_ADMIN_URL}/jobinfo/trigger`
- **Method**: GET or POST(depending on version)
- **Parameters**:
- `jobId`: 对应的目标任务编号
- 可选参数依据实际需求补充
典型 URL 示例可能形似这样:`http://localhost:8080/jobinfo/trigger?jobId=1`.
另外值得注意的是新版移除了传统意义上的输入输出形式改用了辅助工具类来进行交互处理[^1],因此在构建自定义处理器的时候应该遵循新的规范模式.
```java
@XxlJob("sayHelloHandler")
public void execute() {
String param = XxlJobHelper.getJobParam();
userService.sayHelloToUser(param);
// Set success result
XxlJobHelper.handleSuccess("Task completed successfully.");
}
```
以上即为借助 Postman 工具远程操控 XXL-Job 平台主要步骤概述。
阅读全文
相关推荐











