SpringBoot+MyBatis如何设置API超时并终止超时SQL查询？

针对你的SpringBoot+MyBatis项目，要实现超时后终止SQL查询，有以下几种直接可行的实现方式：

1. MyBatis语句级超时配置（最直接） #

可以直接在Mapper的XML查询语句或接口方法上单独设置超时时间，单位为秒。

方式1：在XML映射文件中添加timeout属性 #

修改你的getExportJobDetailById查询标签，新增timeout属性：

<select id="getExportJobDetailById" resultMap="BaseResultMap" timeout="10">
    SELECT * FROM
    export_job_detail
    where export_job_id = #{id}
    order by containers desc
</select>

这里timeout="10"表示超时时间为10秒，超过后MyBatis会抛出SQLTimeoutException，你可以在业务层捕获该异常并返回对应错误提示。

方式2：在Mapper接口方法上使用@Options注解 #

如果不想修改XML，也可以直接在接口方法上添加@Options注解配置超时：

@Mapper
public interface ExportJobDetailRepository {
    @Options(timeout = 10)
    List<RegularExportDetail> getExportJobDetailById(@Param("id") String id);
}

该配置和XML方式效果一致，且接口注解的优先级会覆盖XML中的设置。

2. 数据库连接池全局超时配置 #

如果需要给所有SQL查询设置统一的超时时间，可以在连接池配置中全局定义，以常用的HikariCP为例，在application.yml中添加：

spring:
  datasource:
    hikari:
      # 连接超时（毫秒）
      connection-timeout: 30000
      # 全局查询超时（秒）
      query-timeout: 10
      idle-timeout: 600000
      max-lifetime: 1800000

这个配置会对所有通过该连接池执行的SQL生效，适合全局统一管控超时的场景。

3. Spring MVC接口级总超时（结合异步处理） #

如果需要控制整个API接口的总耗时（包括SQL查询+业务处理），可以用Spring的异步支持实现：

第一步：开启异步支持 #

在SpringBoot启动类上添加@EnableAsync注解：

@SpringBootApplication
@EnableAsync
public class YourApplication {
    public static void main(String[] args) {
        SpringApplication.run(YourApplication.class, args);
    }
}

第二步：实现异步方法并设置超时 #

将Mapper调用逻辑封装为异步方法，在Controller中设置总超时：

// 业务层
@Service
public class ExportJobDetailService {
    @Autowired
    private ExportJobDetailRepository repository;

    @Async
    public Future<List<RegularExportDetail>> getExportJobDetailByIdAsync(String id) {
        return new AsyncResult<>(repository.getExportJobDetailById(id));
    }
}

// Controller层
@RestController
@RequestMapping("/export")
public class ExportJobDetailController {
    @Autowired
    private ExportJobDetailService service;

    @GetMapping("/detail/{id}")
    public ResponseEntity<?> getDetail(@PathVariable String id) {
        try {
            Future<List<RegularExportDetail>> future = service.getExportJobDetailByIdAsync(id);
            // 设置总超时时间为10秒
            List<RegularExportDetail> result = future.get(10, TimeUnit.SECONDS);
            return ResponseEntity.ok(result);
        } catch (TimeoutException e) {
            return ResponseEntity.status(HttpStatus.REQUEST_TIMEOUT).body("请求超时，请稍后重试");
        } catch (Exception e) {
            return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body("查询失败");
        }
    }
}

4. 手动用Callable控制超时 #

如果不想依赖Spring异步，也可以手动通过Callable和ExecutorService实现超时控制：

// 业务层方法示例
public List<RegularExportDetail> getExportJobDetailWithTimeout(String id, long timeoutSeconds) throws Exception {
    ExecutorService executor = Executors.newSingleThreadExecutor();
    Callable<List<RegularExportDetail>> task = () -> repository.getExportJobDetailById(id);
    Future<List<RegularExportDetail>> future = executor.submit(task);
    
    try {
        return future.get(timeoutSeconds, TimeUnit.SECONDS);
    } catch (TimeoutException e) {
        // 超时后主动取消任务
        future.cancel(true);
        throw new RuntimeException("查询超时，请稍后重试");
    } finally {
        executor.shutdown();
    }
}

内容的提问来源于stack exchange，提问作者Nghi Hoàng Đức