当前位置:

首页 > 系统应用 > Jmix的数据访问层:将JPA用到极致

Jmix的数据访问层:将JPA用到极致

简介 对任何企业及应用来说,数据模型都是应用的基石之一。在设计数据模型时,除了需要考虑业务数据的要求之外,还应该思考一些有可能会影响应用程序设计的问题。比如,是否需要数据库表行级的安全机制?是否需要使用软删除?是否需要 CRUD API,如果需要的话,谁来干这个枯燥的活? 事实上,JPA 已经是 J

本文目录

    简介

    对任何企业及应用来说,数据模型都是应用的基石之一。在设计数据模型时,除了需要考虑业务数据的要求之外,还应该思考一些有可能会影响应用程序设计的问题。比如,是否需要数据库表行级的安全机制?是否需要使用软删除?是否需要 CRUD API,如果需要的话,谁来干这个枯燥的活?

    事实上,JPA 已经是 Ja va 应用程序中创建数据模型的标准了。但是 JPA 不提供能实现高级安全机制的接口,也没有软删除,所以有需求的程序员只能自己实现。

    Jmix 框架提供了通用的引擎,可以为使用 JPA 的应用程序增加额外的功能。在不破坏 JPA 兼容性的情况下,Jmix 框架可以让您愉快的使用高级数据安全机制,无感的使用软删除,并且为 CRUD 操作提供通用 REST API 以及其他的功能。

    本文将讨论 Jmix 中的数据访问层,谈谈使用该框架及其工具到底能做什么,还会讨论数据访问层的一些底层原理。

    数据模型,JPA 和@JmixEntity

    对于熟悉 JPA 的 Ja va 开发者来说,使用 Jmix 不需要学习任何新的知识。只需要创建 JPA 实体即可。Jmix 也提供了可视化设计器可以帮助完成这一工作。

    在 Jmix 的可视化设计器中,您需要提供实体名称,选择 ID 类型(UUID、Long、Integer、String 或者嵌入类),然后选择需要支持的功能:

    • 实体版本 - 支持乐观锁
    • 创建时审计 - 增加创建时间、创建人
    • 更新时审计 - 增加更新时间、更新人
    • 软删除 - 增加删除时间、删除人

    最后,您会得到类似如下的 JPA 类:

    @JmixEntity
    @Table(name = "SPEAKER")
    @Entity(name = "Speaker")
    public class Speaker {

    @JmixGeneratedValue
    @Column(name = "ID", nullable = false)
    @Id
    private UUID id;

    @Email
    @Column(name = "EMAIL", unique = true)
    private String email;

    @Column(name = "NAME", nullable = false)
    @NotNull
    private String name;

    @Column(name = "VERSION", nullable = false)
    @Version
    private Integer version;

    @CreatedBy
    @Column(name = "CREATED_BY")
    private String createdBy;

    @LastModifiedBy
    @Column(name = "LAST_MODIFIED_BY")
    private String lastModifiedBy;

    @DeletedDate
    @Column(name = "DELETED_DATE")
    @Temporal(TemporalType.TIMESTAMP)
    private Date deletedDate;

    // 此处省略部分字段
    }

    注意,Jmix 并非侵入式的影响你的代码。生成的实体只是添加了一些注解,不需要实现任何框架特有的接口,更不需要继承某个类。这样的非侵入式设计,在实现您应用程序特有的实体关系和架构时,能保持足够的灵活度以适应你的业务需求。

    Jmix所采用的大部分注解,要么源自JPA,要么来自Spring Boot JPA库,例如:@Entity、@Versioned、@CreatedBy、@LastModifiedBy,这些注解您或许并不陌生。Jmix框架对乐观锁以及创建和更新审计的支持,依靠的是Spring Boot的具体实现。

    下面看看数据模型中几个 Jmix 特有的注解:

    • @JmixEntity- 引导 Jmix 数据访问层将此类添加至实体仓库(Entities repository)
    • @JmixGeneratedValue- 表示实体的ID属性必须由 Jmix 生成并指定
    • @DeletedBy和@DeletedDate- 标记字段,当使用软删除方案时用来标记实体的删除状态

    您可能会疑惑:“Jmix数据访问层里的实体仓库是什么?你们是不是有自己的数据访问引擎?”其实,答案是“是也不是”。Jmix框架会存储应用程序数据模型的额外信息——元模型(metamodel),并且添加了一个特殊工具——DataManager,用于数据访问,但它的底层依旧是JPA。

    Metamodel 和 DataManager

    Jmix 基于 Spring boot 框架构建。Boot 以广泛使用 IoC 模式而闻名天下,该模式意味着将有关 bean 的所有数据存储在特殊的存储库中 -ApplicationContext。除了这个存储之外,Jmix 将关于应用程序数据模型的所有数据(比如 metadata)存储在另一个存储库中 -Metadata。

    Jmix 中Metadata是数据访问层的核心。包含关于实体、属性、实体关系等等所有的信息。这些信息是在应用程序启动时对类进行扫描的过程中一次收集的,Jmix 用这些信息来实现神奇的功能:从行级数据安全机制到自动生成的管理界面 UI 的双向数据绑定。

    为了有效的使用 Jmix 数据访问层,需要使用 DataManager 组件。该组件是 JPA 中著名EntityManager的包装类。与EntityManager类似,DataManager能使用 JPQL 查询语句或者 ID 加载实体,保存或删除实体以及对所选实例进行计数。

    下面是DataManager的一些示例用法。

    通过ID加载一个实体,使用 Ja va 类作为参数:

      Speaker loadSpeakerById(UUID speakerId) {
    return dataManager.load(Speaker.class)
    .id(speakerId)
    .one();
    }

    使用 JPQL 查询加载数据:

      List loadSpeakesByCompanyEmail() {
    return dataManager.load(Speaker.class)
    .query("select s from Speaker s where s.email like :email")
    .parameter("email", "%@company.com")
    .list();
    }

    DataManager使用Metamodel提供一些额外的功能。是这样实现的:在对应用程序数据库的请求交由EntityManager执行之前,对请求进行拦截并修改。

    我们仔细看看 Jmix 提供的这些功能。

    高级数据安全

    首先需要提到的是 Jmix 的数据安全子系统。框架使用基于角色的安全机制并定义了两种类型的角色:

    1. 资源角色(Resource role)- 授予访问实体对象并在系统中执行特定操作的权限:对实体,实体属性进行 CURD 操作,使用 UI 界面等等。

    2. 行级角色(Row-level role)- 可以限制对表中特定数据行的访问,换句话说,即限制访问某些实体实例。

    下面是资源角色的示例,可以定义实体 CRUD 操作的策略,甚至可以定义针对实体属性操作的策略:

      @ResourceRole(name = "Speaker Admin", code = "speaker-admin-role")
    public interface SpeakerAdminRole {

    @EntityPolicy(entityName = "Speaker",
    actions = {EntityPolicyAction.ALL})
    @EntityAttributePolicy(entityName = "Speaker",
    attributes = "{name, email}",
    action = EntityAttributePolicyAction.MODIFY)
    void speakersAccess();
    }

    为了实现这个功能,DataManager会分析 JPQL,然后依据策略的定义限制该 JPQL 的执行或修改 JPQL 中的属性列表以符合安全策略。

    如需定义行级角色,您需要制定一个 JPQL 策略,该 JQPL 策略由where以及可选的join子句组成,用来限制从数据库表中选取的数据:

      @RowLevelRole(name = "Speaker's Talks",
    code = "speakers-talks-role")
    public interface SpeakersTalksRole {

    @JpqlRowLevelPolicy(entityClass = Talk.class,
    where = "{E}.speaker.id = :current_user_id")
    void accessibleTalks();
    }

    因此,带有行级角色用户发起的所有查询都会通过这种方式进行转换:where子句会用 AND 操作符添加在现有的条件之后,join子句也会添加在现有的之后。如果 JPQL 中没有这两个关键字,相应的子句会直接添加在后面。

    Metadata存储库在这里扮演了重要的角色。它能帮助我们正确的解析并修改 JPQL 并能找出受限的属性和实体,无论使用的是 JPQL 还是 Ja va 类来定义 DB 查询。

    软删除

    某些情况下,有必要在企业级应用中使用软删除。我们发布了 CUBA 博客“是否实施软删除,这是个问题!” 专门讨论了软删除模式的优缺点。Jmix 是下一代 CUBA,因此也支持软删除。

    如果实体中有@DeletedBy和@DeletedDate注解的字段,则该实体会自动启用软删除模式。对于这些实体,所有DataManager中调用的remove()都会被转换成UPDATE语句,而所有的find()请求都会被修改,添加一个合适的where子句用来过滤那些被 “删除” 的实体。

    @JmixEntity
    @Table(name = "SPEAKER")
    @Entity(name = "Speaker")
    public class Speaker {

    @JmixGeneratedValue
    @Column(name = "ID", nullable = false)
    @Id
    private UUID id;

    @DeletedBy
    @Column(name = "DELETED_BY")
    private String deletedBy;

    @DeletedDate
    @Column(name = "DELETED_DATE")
    @Temporal(TemporalType.TIMESTAMP)
    private Date deletedDate;

    // 此处省略部分字段
    }

    这里我们需要Metadata来找出哪一列需要更新或者添加到 where 子句中。与 CUBA 不同,Jmix 不要求实体实现一个特定的接口才能支持软删除。而只需要将两个注解添加至实体的两个字段即可。

    尽管我们用了软删除,但是数据并没有删掉,因此您还是可以使用 “硬删除”,如果想看到软删除的数据,可以使用 JPA 的EntityManager和原生 SQL 查询。

    REST 和 GraphQL

    自动创建 CRUD API 是 Jmix metamodel 的亮点。当您拥有应用程序中所有实体的信息时,创建实体操作的 API 就非常容易了。

    比如,如果有数据模型的元数据,那么处理下面这个 HTTP 请求将不是难事:

      GET  'http://server:8080/rest/entities/Speaker'

    比如,CRUD 操作的 endpoints 列表是这样的:

    使用 Jmix 的好处就是您不需要手动实现这些枯燥的 endpoints。由于有 metamodel,所有这些都能自动生成。在开发 “为前端服务的后端” 时,可以从自动生成的代码开始逐步构建您自己的特定 REST API。

    如果您的要求比通用 CRUD REST API 更灵活,可以使用 GraphQL。GraphQL 的一个核心概念就是 schema。使用 Jmix 的 metamodel,我们毫不费力就能获得 GraphQL schema 所需的所有数据。

    也就是说,Jmix 应用程序使用 GraphQL API是和 REST API 类似,能以通用的方式实现(很快将发布)。因此,在您的 Jmix 应用程序中添加 GraphQL endpoint,只需在构建脚本中简单增加一个 starter 即可:

    implementation 'io.jmix.graphql:jmix-graphql-starter'

    然后就可以使用类似这样的查询了:

    {
    speakerCount
    speakerList(limit: 10, offset: 0, orderBy: {name: ASC}) {
    id
    name
    email
    }
    }

    结论

    只需在 Jmix 中使用熟悉的 JPA 注解定义数据模型,您就能创建一个可用的应用程序。借助 Jmix 的 metamodel,无需进行额外的编码即可使用下列功能:

    1. 行级安全机制

    2. 软删除

    3. CRUD REST API

    4. GraphQL API

    如您所见,使用 Jmix 创建一个简单的以数据为中心的应用程序,并带有高级功能和管理界面将变得非常容易。

    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
    作者最新文章
    系统应用
    相关文章 更多
    悟空浏览器怎么彻底清理浏览器配置文件
    悟空浏览器怎么彻底清理浏览器配置文件

    彻底清理悟空浏览器的数据,通常有三个路径:通过手机系统设置能一次性清除所有配置和用户信息;利用浏览器内置功能,可以只清理缓存而保留个性化设置;最彻底的则是卸载重装,让应用回到初始状态。 悟空浏览器用久了,是不是偶尔会感觉变慢,或者出现一些难以解释的小毛病?有时候,与其一个个排查问题,不如来一次彻底的

    漫蛙漫画官网首页登录入口
    漫蛙漫画官网首页登录入口

    漫蛙漫画首页登录入口https://www.manwamh.top/:一触即达的漫画世界核心枢纽 对于漫画迷而言,找到那个可靠的资源门户至关重要。漫蛙漫画的首页登录入口,正是这样一个核心渠道。通过它,你可以直接跳转到漫蛙2漫画APP的下载页面,轻松几步完成安装,马上就能投入到精彩纷呈的漫画之旅中。 漫蛙漫画首页登录入口: 官方入口地址已经为你备好

    漫蛙漫画官方入口
    漫蛙漫画官方入口

    漫蛙漫画官方入口与核心功能解析 寻找一个稳定、资源丰富的漫画在线阅读平台,是许多漫画爱好者的共同需求。其中,漫蛙漫画官方入口及其免费全集服务,受到了不少关注。那么,这个平台究竟如何?下面,我们就来深入了解一下它的具体信息与特色功能。 平台的官方访问地址是:https://www.manwa123.c

    漫蛙动漫APP最新版本下载
    漫蛙动漫APP最新版本下载

    对于动漫爱好者而言,找到一个资源全、体验佳的追番平台,常常是件头疼事。漫蛙动漫APP的定位很明确:就是要打造一个聚合全球正版动漫资源的专属乐园。无论是当季火爆的日漫新番、值得回味的经典国创,还是那些小众却精彩的优质动画,在这里基本都能一网打尽。平台底层采用了智能缓冲技术,最大程度保证了播放的流畅度,

    漫蛙官网入口免费下载最新版
    漫蛙官网入口免费下载最新版

    想要获取正版manwa漫蛙APP?官方指定下载渠道就是漫蛙官网入口。 对于漫画迷而言,找到一款心仪的阅读神器至关重要。漫蛙APP正是这样一款专为全球漫画爱好者打造的平台,它汇聚了从日韩人气连载到本土原创精品的海量资源。说它“应有尽有”毫不为过。更重要的是,其界面设计清爽直观,搭配智能检索功能,能让用

    漫蛙漫画在线观看入口
    漫蛙漫画在线观看入口

    想要畅享海量正版漫画资源?漫蛙漫画平台不容错过 对于漫画迷来说,找到一个资源丰富、体验流畅的正版平台实属幸事。漫蛙漫画凭借其优质的在线阅读服务,已经成为了许多资深读者的心头好。今天,我们就来详细拆解一下平台的访问方法与实用技巧,助你轻松开启漫画之旅。 漫蛙漫画网页入口页面指南 想立刻体验?官方在线观

    漫蛙如何下载最新版本
    漫蛙如何下载最新版本

    漫蛙漫画网APP官方下载方法全解析 对于资深漫画迷来说,找到一个资源全、更新快、体验佳的阅读平台,就像淘到了宝藏。漫蛙漫画网APP,正是这样一个专为爱好者打造的精品集散地。它汇聚了全球优质的正版漫画,从火爆的日漫连载到崛起的国创佳作,平台都能做到实时同步更新。当然,第一步得先把它装到设备上。接下来,

    漫蛙漫画APP最新版本下载
    漫蛙漫画APP最新版本下载

    漫蛙漫画APP:专业漫画阅读工具的全面革新 作为一款专业的漫画阅读工具,漫蛙漫画APP整合了全球优质漫画资源,其升级版漫蛙2在功能与体验上可谓全面革新。这款应用不仅囊括日漫经典与国漫新作,更通过简洁直观的界面设计和流畅操作,为用户打造沉浸式阅读环境,充分满足各类漫画爱好者的多样化需求。 漫蛙漫画特色

    卖茶叶妈妈3d漫蛙安卓版下载
    卖茶叶妈妈3d漫蛙安卓版下载

    当下动漫圈热议的卖茶叶妈妈3d漫蛙下载,凭借其突破性的3D视觉技术成为焦点 最近动漫爱好者们都在讨论一个现象级产品——卖茶叶妈妈3d漫蛙下载。这款由漫蛙漫画平台倾力打造的3D作品专区,用立体建模与动态分镜彻底颠覆了传统二维漫画的阅读模式。你猜怎么着?现在只需通过专区提供的便捷下载通道,无论是热血冒险

    漫蛙下载最新版本
    漫蛙下载最新版本

    漫蛙APP:资深漫画迷的移动图书馆与阅读利器 对于漫画爱好者来说,找到一个资源全、体验好的阅读平台,从来都不是件容易的事。而漫蛙APP,恰恰就是为这个需求而生的。它凭借海量的正版漫画库和极其便捷的离线下载功能,在圈内积累了相当不错的口碑。更重要的是,从经典的日本热血漫到新兴的国产原创作品,它几乎一网

    查看更多
    精品专题 更多
    装机必备
    装机必备

    正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

    Windows
    Windows

    正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

    PDF教程
    PDF教程

    正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

    Mac软件 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    Aperty macOS版
    Aperty macOS版
    macOS

    Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

    WINDOWS 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    PixTV 网页版
    PixTV 网页版
    Windows

    PixTV 是一款在浏览器中使用的 AI 视觉内容创作平台,提供图片、视频、音频、文字生成、AI 分镜、局部重绘、提示词反推和无限画布等工具,适合短剧、漫剧、广告及社交媒体内容制作。