当前位置：首页 > news >正文

SpringTask 引起的错误

news 来源：原创 2025/6/12 16:17:26

SpringTask 引起的错误

1. 场景

在使用 SpringBoot 编写后台程序时，当在浏览器页面中发起请求时，MP 自动填充来完成一些字段的填充，例如创建时间、创建人、更新时间、更新人等。但是当编写微信小程序时，由于一些字段无法进行自动填充，例如创建人、更新人等，这时需要进行处理，来区分是否为微信端的请求

private final HttpServletRequest request;

// 是否排除路径，排除微信端的路径，不自动填充用户id
private boolean isExclude() {
  String path = request.getRequestURI();
  return !path.startsWith("/member");
}

// 插入数据时自动填充
@Override
public void insertFill(MetaObject metaObject) {
  if (isExclude()) {
    this.strictInsertFill(metaObject, "createBy", String.class, String.valueOf(getLoginUserId()));
  }
  this.strictInsertFill(metaObject, "createTime", Date.class, DateUtils.getNowDate());
}

// 修改数据时自动填充
@Override
public void updateFill(MetaObject metaObject) {
  if (isExclude()) {
    this.setFieldValByName("updateBy", String.valueOf(getLoginUserId()), metaObject);
  }
  this.setFieldValByName("updateTime", DateUtils.getNowDate(), metaObject);
}

但是此时，就会产生一个问题：当在浏览器端（后台管理端）使用定时任务时（这里以 SpringTask 举例），就会出现异常

提示 “当前请求并未为 Web 请求”，后来经过层层排查，发现是自动填充处使用了 HttpServletRequest 来获取当前请求详情。

在场景中，isExclude 方法依赖于 HttpServletRequest 对象来获取请求路径。然而，定时任务并不属于 Web 请求的一部分，因此在定时任务执行时，HttpServletRequest 对象不可用，这会导致遇到的 IllegalStateException 异常。

2. 解决方案

为了解决这个问题，可以考虑以下几种方法：

检查请求是否存在：在 isExclude 方法中添加一个检查，判断 HttpServletRequest 是否为空，如果为空则直接返回 true 或 false，具体根据你的业务需求来决定。但这只是避免了异常，并没有真正解决问题，因为定时任务确实不需要根据请求路径来判断是否填充用户信息。
使用不同的条件来判断是否排除：如果定时任务和微信端请求可以通过其他方式区分开来（比如特定的线程池、特定的任务标识等），你可以考虑使用这些方式来判断，而不是依赖请求路径。
将用户ID作为参数传递：对于定时任务，你可以在任务触发时直接传递用户ID，而不是在任务内部去获取。这样可以避免对 HttpServletRequest 的依赖。
使用不同的 MetaObjectHandler 实现：为定时任务创建一个独立的 MetaObjectHandler 实现，这个实现不需要考虑 HttpServletRequest，也不需要调用 isExclude 方法。
修改定时任务逻辑：在定时任务中，手动填充创建人或更新人字段，而不是依赖 MetaObjectHandler 来自动填充。这样可以确保定时任务在执行时不会调用 isExclude 方法。
基于任务类型进行判断：在 MetaObjectHandler 类中增加一个字段，用于标识当前操作的类型（比如是定时任务还是 Web 请求），在 insertFill 和 updateFill 方法中根据这个字段来决定是否执行 isExclude 方法的判断。

3. 修改

这里使用一种很简单的方法，使用 RequestContextHolder.getRequestAttributes() 方法来判断当前线程是否绑定了一个 Web 请求的上下文，这是一种常见的方法来区分 Web 请求和其他非 Web 请求（例如定时任务）的线程上下文。这种方法在 Spring 框架中被广泛用于获取当前请求的相关信息，而不会抛出 No thread-bound request found 这样的异常。

具体来说，在的 isExclude 方法中，通过检查 RequestContextHolder.getRequestAttributes() 返回的结果是否为 null，可以判断当前线程是否在一个 Web 请求的上下文中。如果返回的是 null，说明当前线程不是在一个 Web 请求中，因此可以决定不执行某些依赖于 Web 请求的操作，比如填充 createBy 和 updateBy 字段。

private boolean isExclude() {
  // 校验是否为 Web 请求，避免非 Web 请求导致 IllegalStateException 异常
  ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
  if (attributes != null) {
    HttpServletRequest request = attributes.getRequest();
    String path = request.getRequestURI();
    return !path.startsWith("/member");
  }
  return false;
}

以下是一些关键点，帮助更好地理解这种方法：

RequestContextHolder: 这个类提供了对当前请求的访问。通过 getRequestAttributes() 方法，可以获取到当前线程的请求属性。
ServletRequestAttributes: 这是 RequestContextHolder.getRequestAttributes() 返回的对象类型之一，包含了当前请求的相关信息。
判断是否为 web 请求: 通过检查 RequestContextHolder.getRequestAttributes() 是否返回 null，可以判断当前线程是否在一个 web 请求的上下文中。如果不是 null，则可以安全地获取 HttpServletRequest 并进行相关操作。
ThreadLocal 使用: 尽管在 MyMetaObjectHandler 中没有直接使用 ThreadLocal 来判断是否为 web 请求，但 Spring 框架本身在处理 web 请求时会使用 ThreadLocal 来存储请求的上下文信息。因此，RequestContextHolder.getRequestAttributes() 能够正确地识别当前线程是否为 web 请求线程。

这种方法不仅能够有效地区分 Web 请求和其他请求，还能避免出现 No thread-bound request found 的异常，是一个比较优雅的解决方案。如果有其他特定的需求或场景，也可以考虑自定义 ThreadLocal 变量来标识不同的请求类型，但通常情况下，使用 Spring 提供的 RequestContextHolder 就可以满足大多数需求。