首页
/ ArchUnit中精确控制EntityManager访问权限的最佳实践

ArchUnit中精确控制EntityManager访问权限的最佳实践

2025-06-24 11:54:47作者:苗圣禹Peter

背景介绍

在Java企业级应用开发中,EntityManager作为JPA的核心接口,通常需要遵循特定的使用规范。大多数架构设计都要求EntityManager仅能在Repository层使用,以确保数据访问逻辑的集中管理。然而,实际开发中偶尔会遇到需要打破这一规则的例外情况。

问题分析

假设我们有一个架构约束:EntityManager只能在com.myapp.repository包下的Repository类中使用。但存在一个例外情况:EventService类中需要调用entityManager.detach()方法。如何用ArchUnit实现这种精确的访问控制呢?

解决方案

ArchUnit提供了强大的DSL(领域特定语言)来定义架构规则。针对上述需求,我们可以利用accessTargetWhere方法结合自定义谓词来实现精细化的访问控制。

基础实现方案

首先,我们来看基础实现,它允许整个EventService类访问EntityManager:

@ArchTest
static final ArchRule onlyRepositoriesMayUseEntityManager = noClasses()
    .that().resideOutsideOfPackage("com.myapp.repository..")
    .and(are(not(equivalentTo(EventService.class))))
    .should().accessClassesThat().areAssignableTo(EntityManager.class);

这个方案虽然简单,但过于宽松,允许EventService访问EntityManager的所有方法。

精确控制方案

更精确的方案是只允许EventService访问detach方法:

@ArchTest
ArchRule onlyRepositoriesMayUseEntityManager = noClasses()
    .that().resideOutsideOfPackage("com.myapp.repository..")
    .should().accessTargetWhere(describe("owner is assignable to EntityManager", access ->
        access.getTargetOwner().isAssignableTo(EntityManager.class) &&
        !(access.getOriginOwner().isEquivalentTo(EventService.class) &&
        access.getTarget().getName().equals("detach"))
    ));

这个方案的关键点在于:

  1. 使用accessTargetWhere方法对访问目标进行精细过滤
  2. 通过getTargetOwner()判断目标类是否为EntityManager
  3. 通过getOriginOwner()判断调用来源是否为EventService
  4. 通过getTarget().getName()判断调用的方法名是否为"detach"

技术原理

这种实现利用了ArchUnit的访问控制模型:

  • JavaAccess表示一个类对另一个类的访问
  • AccessTarget表示被访问的目标(类、方法、字段等)
  • DescribedPredicate允许我们自定义复杂的过滤条件

通过组合这些元素,我们可以构建出非常精确的架构约束规则。

最佳实践建议

  1. 明确例外情况:在架构设计中,应该尽量减少例外情况。如果必须存在例外,要明确记录原因。

  2. 规则文档化:为ArchUnit规则添加详细的描述,说明为什么需要这个规则以及例外情况的原因。

  3. 分层控制:考虑将EntityManager的访问控制规则分层实现,先定义基础规则,再添加例外情况。

  4. 定期审查:随着项目演进,定期审查例外情况是否仍然必要。

总结

通过ArchUnit的高级API,我们可以实现非常精细的架构约束控制。对于EntityManager这样的核心组件,精确控制其访问权限有助于维护良好的代码结构和数据访问模式。本文展示的技术方案不仅适用于EntityManager,也可以推广到其他需要精确访问控制的场景中。

登录后查看全文
热门项目推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
149
1.95 K
kernelkernel
deepin linux kernel
C
22
6
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
980
395
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
274
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
931
555
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
190
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
75
66
openHiTLS-examplesopenHiTLS-examples
本仓将为广大高校开发者提供开源实践和创新开发平台,收集和展示openHiTLS示例代码及创新应用,欢迎大家投稿,让全世界看到您的精巧密码实现设计,也让更多人通过您的优秀成果,理解、喜爱上密码技术。
C
65
518
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.11 K
0