Spring-Boot-项目中-Query-后缀对象的放置位置

2025-03-08 约 430 字预计阅读 1 分钟

https://bing.ee123.net/img/rand?artid=146123973

Spring Boot 项目中 `Query` 后缀对象的放置位置

在 Spring Boot 项目中，带有 Query 后缀的查询对象通常属于 请求参数 或 数据传输层 ，推荐将其放置在以下位置之一：

推荐目录结构

src
 └── main
     └── java
         └── com
             └── example
                 ├── controller
                 ├── dto            # ✅ 推荐，DTO/Query 对象统一管理
                 │   ├── request    # ✅ 查询对象 (UserQuery, OrderSearchRequest)
                 │   ├── response   # ✅ 响应对象 (UserDTO, OrderDetailDTO)
                 │   └── common     # 可选：通用DTO
                 ├── entity
                 ├── mapper
                 ├── service
                 └── util

最佳实践说明

✅ dto/request ➔ 放置查询参数对象 ( UserQuery )，明确标识为请求数据

✅ dto/response ➔ 放置响应数据对象 ( UserDTO )，区分不同数据流向

✅ dto/common ➔ 放置通用数据对象（如 PageInfoDTO 、 ResultDTO 等）

示例代码

`UserQuery.java` （放在 `dto/request` 文件夹）

package com.example.dto.request;

import lombok.Data;

@Data
public class UserQuery {
    private String username;
    private String email;
    private Integer age;
}

`UserDTO.java` （放在 `dto/response` 文件夹）

package com.example.dto.response;

import lombok.Data;

@Data
public class UserDTO {
    private String username;
    private String email;
    private String roleName;
}

🚨 为什么推荐这种结构？

✅ 清晰的职责分离 ：将查询、返回、通用数据分类，项目结构更直观。

✅ 易于维护 ：项目扩展时，新增 DTO 类更有条理。

✅ 符合主流实践 ：Spring Boot 项目中较为常见的目录规范。

这种方法更利于项目的长期维护，尤其是当项目规模扩大时，目录清晰度会大幅提升。