0

0

JPA Repository 方法名中正确处理含保留字(如 “And”)的列名

霞舞

霞舞

发布时间:2026-03-13 11:32:33

|

251人浏览过

|

来源于php中文网

原创

JPA Repository 方法名中正确处理含保留字(如 “And”)的列名

本文详解如何在 JPA Repository 方法命名中安全使用含 SQL 保留字(如 And、Or、Order 等)的实体属性名,避免因 PropertyPath 解析歧义导致的 IllegalArgumentException,并提供命名规范、@Query 替代方案及最佳实践。

本文详解如何在 jpa repository 方法命名中安全使用含 sql 保留字(如 `and`、`or`、`order` 等)的实体属性名,避免因 `propertypath` 解析歧义导致的 `illegalargumentexception`,并提供命名规范、`@query` 替代方案及最佳实践。

在 Spring Data JPA 中,Repository 接口支持通过方法名自动解析查询逻辑(如 findByUsernameAndStatus()),其底层依赖 PropertyPath 类对方法名进行分词与属性映射。但当实体字段名本身包含 And、Or、Between、OrderBy 等关键字时(例如 dateAndTimeOfEstimation),PropertyPath 会错误地将 And 视为逻辑连接符而非字段名的一部分,导致解析中断——它仅截取 date 作为属性名,进而抛出 PropertyReferenceException: No property date found for type XxxEntity。

✅ 正确解决方案

方案一:使用下划线命名 + @Column(name = "...") 显式映射(推荐)

遵循 Java 命名规范的同时规避解析歧义,将驼峰字段转为下划线风格,并通过 @Column 明确指定数据库列名:

@Entity
public class Estimation {
    @Column(name = "date_and_time_of_estimation")
    private LocalDateTime dateAndTimeOfEstimation;

    // getter/setter...
}

此时可安全定义 Repository 方法:

public interface EstimationRepository extends JpaRepository<Estimation, Long> {
    List<Estimation> findAllByDateAndTimeOfEstimation(LocalDateTime dateTime);
    // ✅ 解析成功:PropertyPath 将整个 "dateAndTimeOfEstimation" 视为单一属性名
}

⚠️ 注意:该方案生效的前提是 字段名中不出现连续大写字母触发误切分(如 XMLData 可能被切为 XML + Data)。若存在此类情况,建议改用方案二。

Mokker AI
Mokker AI

AI产品图添加背景

下载

方案二:显式声明 JPQL 查询(最稳妥)

彻底绕过方法名解析机制,使用 @Query 注解编写类型安全的 JPQL:

public interface EstimationRepository extends JpaRepository<Estimation, Long> {
    @Query("SELECT e FROM Estimation e WHERE e.dateAndTimeOfEstimation = :dateTime")
    List<Estimation> findAllByDateAndTimeOfEstimation(@Param("dateTime") LocalDateTime dateTime);

    // 或使用原生 SQL(需注意数据库兼容性)
    @Query(value = "SELECT * FROM estimation WHERE date_and_time_of_estimation = ?", nativeQuery = true)
    List<Estimation> findAllByDateAndTimeOfEstimationNative(LocalDateTime dateTime);
}

方案三:使用 @NamedQuery(适合复用复杂查询)

在实体类中定义命名查询,保持 Repository 接口简洁:

@Entity
@NamedQuery(
    name = "Estimation.findByDateAndTimeOfEstimation",
    query = "SELECT e FROM Estimation e WHERE e.dateAndTimeOfEstimation = :dateTime"
)
public class Estimation { /* ... */ }
public interface EstimationRepository extends JpaRepository<Estimation, Long> {
    List<Estimation> findByDateAndTimeOfEstimation(@Param("dateTime") LocalDateTime dateTime);
    // Spring Data 会自动匹配 @NamedQuery 名称(去掉前缀 "Estimation.")
}

? 关键注意事项

  • ❌ 避免在方法名中强行使用 And/Or 作为字段一部分(如 findByDateAndTimeOfEstimation)而不做适配——这是设计陷阱,非临时 workaround。
  • ✅ 始终优先采用方案一(下划线映射),它兼顾可读性、约定一致性与零额外开销。
  • ? 调试技巧:在 PropertyPath.from(String, TypeInformation<?>) 处设置断点,观察实际解析出的属性路径,验证是否符合预期。
  • ? 若项目已上线且列名不可变更,方案二(@Query)是最安全、可立即落地的选择。

综上,JPA 方法名解析的“保留字冲突”本质是命名约定与解析器能力的边界问题。通过合理设计实体字段名、善用注解或显式查询,即可在保持代码清晰的同时,完全规避这一常见障碍。

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
数据分析工具有哪些
数据分析工具有哪些

数据分析工具有Excel、SQL、Python、R、Tableau、Power BI、SAS、SPSS和MATLAB等。详细介绍:1、Excel,具有强大的计算和数据处理功能;2、SQL,可以进行数据查询、过滤、排序、聚合等操作;3、Python,拥有丰富的数据分析库;4、R,拥有丰富的统计分析库和图形库;5、Tableau,提供了直观易用的用户界面等等。

1134

2023.10.12

SQL中distinct的用法
SQL中distinct的用法

SQL中distinct的语法是“SELECT DISTINCT column1, column2,...,FROM table_name;”。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

340

2023.10.27

SQL中months_between使用方法
SQL中months_between使用方法

在SQL中,MONTHS_BETWEEN 是一个常见的函数,用于计算两个日期之间的月份差。想了解更多SQL的相关内容,可以阅读本专题下面的文章。

381

2024.02.23

SQL出现5120错误解决方法
SQL出现5120错误解决方法

SQL Server错误5120是由于没有足够的权限来访问或操作指定的数据库或文件引起的。想了解更多sql错误的相关内容,可以阅读本专题下面的文章。

2174

2024.03.06

sql procedure语法错误解决方法
sql procedure语法错误解决方法

sql procedure语法错误解决办法:1、仔细检查错误消息;2、检查语法规则;3、检查括号和引号;4、检查变量和参数;5、检查关键字和函数;6、逐步调试;7、参考文档和示例。想了解更多语法错误的相关内容,可以阅读本专题下面的文章。

380

2024.03.06

oracle数据库运行sql方法
oracle数据库运行sql方法

运行sql步骤包括:打开sql plus工具并连接到数据库。在提示符下输入sql语句。按enter键运行该语句。查看结果,错误消息或退出sql plus。想了解更多oracle数据库的相关内容,可以阅读本专题下面的文章。

1703

2024.04.07

sql中where的含义
sql中where的含义

sql中where子句用于从表中过滤数据,它基于指定条件选择特定的行。想了解更多where的相关内容,可以阅读本专题下面的文章。

586

2024.04.29

sql中删除表的语句是什么
sql中删除表的语句是什么

sql中用于删除表的语句是drop table。语法为drop table table_name;该语句将永久删除指定表的表和数据。想了解更多sql的相关内容,可以阅读本专题下面的文章。

440

2024.04.29

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

3

2026.03.13

热门下载

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

精品课程

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号