讲师中心 微信公众号

工具推荐

视频效率加速
SoundView
SoundView

字幕擦除翻译、配音口型同步

AniShort
AniShort

AI短剧协同制作平台

updream

一键生成高质量推广成片

Laper
Laper

剧本策划到成片协作

Spring Boot REST接口开发怎么实现条件筛选

风涛酱_3492

风涛酱_3492

发布时间:2026-11-17 11:08:17

|

544人浏览过

|

来源于php中文网

原创

在 spring boot 中实现 rest 接口的条件筛选,最直接且符合规范的做法是使用 @requestparam 接收前端传递的查询参数,并在 service 层通过 specification 或 jpacriteriabuilder 动态构建查询条件。如果传入的参数为空,则忽略该条件以返回全量数据;如果存在值,则将其加入 where 子句进行过滤。这种方式避免了硬编码 sql,同时保证了接口的灵活性和安全性。

Spring Boot REST接口开发怎么实现条件筛选

如何定义支持多条件的 Controller 接口

Controller 层负责暴露 HTTP 端点并接收请求参数。我们需要定义一个 GET 请求方法,使用 @GetMapping 注解指定路径,并使用 @RequestParam 标注各个筛选字段。为了处理可选参数,可以为 @RequestParam 设置 required = false 并提供默认值(如空字符串)。这样当客户端不传参时,后端能正常接收 null 或空值,进而由后续逻辑决定是跳过筛选还是执行特定匹配。

Spring Boot REST接口开发怎么实现条件筛选

package com.example.demo.controller;

import com.example.demo.model.User;
import com.example.demo.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.PageRequest;
import org.springframework.data.domain.Sort;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

import java.util.List;

@RestController
@RequestMapping("/api/users")
public class UserController {

    @Autowired
    private UserService userService;

    @GetMapping
    public Page<User> getUsers(
            @RequestParam(required = false) String name,
            @RequestParam(required = false) Integer age,
            @RequestParam(defaultValue = "0") int page,
            @RequestParam(defaultValue = "10") int size) {
        
        // 调用 Service 层进行动态查询
        return userService.findUsers(name, age, PageRequest.of(page, size));
    }
}

上述代码定义了一个 /api/users 接口。name 和 age 是可选的筛选条件。page 和 size 用于分页,默认值为第 0 页,每页 10 条。当用户访问 /api/users?name=John&age=30 时,控制器将这两个值传递给服务层。如果只访问 /api/users,则 name 和 age 为 null,服务层应返回所有用户。这种设计确保了接口既能做精确筛选,也能做全量获取。

Spring Boot Actuator Analyzer
Spring Boot Actuator Analyzer

分析Spring Boot Actuator端点的安全性、健康检查、指标暴露及生产配置——审计信息、健康状态和自定义端点。

下载

Service 层如何实现动态 JPA Specification 查询

Service 层的核心逻辑在于根据传入的参数构建 Specification。我们使用 JPA 的 Specification 接口,它允许我们在运行时动态组装 WHERE 子句。通过创建一个内部类或静态方法来实现 toPredicate 方法,检查每个参数是否为 null 或空字符串。如果不为空,则添加对应的 CriteriaQuery 谓词;如果为空,则返回 null 表示该条件不参与过滤。最终将这些谓词组合成 AND 关系。

Spring Boot REST接口开发怎么实现条件筛选

package com.example.demo.service;

import com.example.demo.model.User;
import com.example.demo.repository.UserRepository;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.jpa.domain.Specification;
import org.springframework.stereotype.Service;
import org.springframework.util.StringUtils;

import javax.persistence.criteria.CriteriaBuilder;
import javax.persistence.criteria.CriteriaQuery;
import javax.persistence.criteria.Predicate;
import javax.persistence.criteria.Root;
import java.util.ArrayList;
import java.util.List;

@Service
public class UserService {

    private final UserRepository userRepository;

    public UserService(UserRepository userRepository) {
        this.userRepository = userRepository;
    }

    public Page<User> findUsers(String name, Integer age, Pageable pageable) {
        Specification<User> spec = buildSpecification(name, age);
        return userRepository.findAll(spec, pageable);
    }

    private Specification<User> buildSpecification(String name, Integer age) {
        return (Root<User> root, CriteriaQuery<?> query, CriteriaBuilder cb) -> {
            List<pre class="brush:php;toolbar:false;"dicate> predicates = new ArrayList<>();
            
            if (StringUtils.hasText(name)) {
                predicates.add(cb.like(root.get("name"), "%" + name + "%"));
            }
            
            if (age != null) {
                predicates.add(cb.equal(root.get("age"), age));
            }
            
            return cb.and(predicates.toArray(new Predicate[0]));
        };
    }
}

这段代码展示了 buildSpecification 方法的实现。它首先创建一个空的 Predicate 列表。然后检查 name 是否包含文本,如果包含,则使用 cb.like 添加模糊匹配条件。接着检查 age 是否为 null,如果不为 null,则使用 cb.equal 添加精确匹配条件。最后,使用 cb.and 将所有谓词组合起来。如果两个参数都为空,返回的谓词数组为空,JPA 会生成不带 WHERE 子句的查询,从而返回所有记录。这种方法高效且类型安全,避免了 SQL 注入风险。

当输入参数包含特殊字符或空值时如何处理

在实际使用中,用户可能输入包含 SQL 特殊字符的字符串,或者传递空字符串而非 null。Spring 的 StringUtils.hasText() 方法可以很好地处理空字符串和空白字符的情况,确保只有非空内容才触发筛选。对于特殊字符,由于使用的是 JPA Criteria API,参数会被自动转义为预编译语句的参数,因此无需手动处理转义问题。然而,如果业务逻辑要求对空字符串进行特殊处理(例如视为“无筛选”),则需要在 Controller 或 Service 层显式判断。此外,如果希望区分“未传参”和“传了空值”,可以使用 @RequestParam 的 defaultValue 属性,但通常推荐统一将空值视为无筛选条件,以保持接口行为的一致性。

热门AI工具

更多
DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

小橡皮AI

一款AI工具,主要用于小橡皮一键去AI味,将机器味重的内容改得更有活人感,防止因为 AI 内容被平台打上 AI 标签,以及限流,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

12777

2023.06.15

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

9862

2023.07.05

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

8372

2023.07.31

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

1344

2023.08.01

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

1068

2023.08.02

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

1596

2023.08.02

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

3349

2023.08.02

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

20571

2023.08.03

Go-Zero API开发使用教程
Go-Zero API开发使用教程

本专题聚焦Go-Zero的API开发,拆解.api描述文件的语法结构、路由与分组定义、参数绑定与校验规则,说明统一响应体、JWT鉴权、跨域与接口文档生成的落地方式,并给出网关聚合与接口测试的实践建议。

140

2026.11.12

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Spring Boot 官方快速入门指南
Spring Boot 官方快速入门指南

共0课时 | 0人学习

Spring Boot 官方参考文档
Spring Boot 官方参考文档

共0课时 | 0人学习

尚硅谷新版SpringBoot3教程
尚硅谷新版SpringBoot3教程

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn