Jmix 中 REST API 的兩種實現

来源:https://www.cnblogs.com/abmcode/archive/2022/09/28/16738772.html
-Advertisement-
Play Games

你知道嗎,在 Jmix 中,REST API 有兩種實現方式! 很多應用是採取前後端分離的方式進行開發。這種模式下,對前端的選擇相對靈活,可以根據團隊的擅長技能選擇流行的 Angular/React/Vue 之一,或者前端為App/小程式等手機應用。Jmix 的一種典型應用場景就是作為這種類型應用程 ...


你知道嗎,在 Jmix 中,REST API 有兩種實現方式!

很多應用是採取前後端分離的方式進行開發。這種模式下,對前端的選擇相對靈活,可以根據團隊的擅長技能選擇流行的 Angular/React/Vue 之一,或者前端為App/小程式等手機應用。Jmix 的一種典型應用場景就是作為這種類型應用程式的高級別管理 UI 和後端。為此,Jmix 提供了強大的通用 REST API 功能,支持包括開箱即用的實體、文件、元數據、用戶會話的 API 以及經過簡單配置就能支持的業務邏輯(服務)REST API。

由於 Jmix 是基於 Spring Boot 框架,因此也支持 Spring 的 RestController。那麼對於 Spring 的 REST API 機制和 Jmix 提供機制,究竟有什麼不同,而我們在開發時又該如何選擇呢?本文將通過具體的代碼示例,介紹這兩種 API 的區別,相信看完之後,該如何選擇您心裡應該有數了。

數據模型和服務

我們假設一個簡單的場景,為了給用戶提供湊單功能,我們在後端寫一個服務用於查詢低於某個價格的產品(Product),並將滿足條件的產品列表返回給客戶端。

數據模型

首先我們構建一個簡單的 JPA 實體:Product 類,包含名稱和價格兩個屬性:

@JmixEntity
@Table(name = "SLS_PRODUCT")
@Entity(name = "sls_Product")
public class Product {
    @JmixGeneratedValue
    @Column(name = "ID", nullable = false)
    @Id
    private UUID id;

    @InstanceName
    @Column(name = "NAME")
    private String name;

    @Column(name = "PRICE")
    private Double price;

    ... // 其他屬性
}

實體通過 Jmix Studio 創建可以選擇其他實體特性,比如版本、實體審計、軟刪除屬性等。

服務

可以像普通 Spring Boot 應用那樣,自己手動創建一個 @Service 類。也可以通過 Jmix Studio 提供的創建 bean 的功能創建 Service。這裡我們用 Jmix Studio 創建一個 Bean,該功能預設創建帶 @Component 註解的類,我們手動將類註解修改為 @Service

@Service("sls_ProductService")
public class ProductService {

    @Autowired
    private DataManager dataManager; // 插入代碼段時,預設註入帶有許可權檢查的 DataManager

    public List<Product> getProductsCheaperThan(Double price){

        // 註意,這裡我們並沒有對輸入參數 price 做檢查

        List<Product> productList = dataManager.load(Product.class)
                .query("select p from sls_Product p " +
                        "where p.price < :priceInput")
                .parameter("priceInput", price)
                .list();

        return productList;
    }
}

這裡的載入實體列表代碼,我們通過 Studio 的代碼段功能自動添加。

服務中,我們使用了 Jmix 的 DataManager 和 JPQL 查詢語句載入實體,並使用方法的輸入參數作為 JPQL 的參數。Jmix 的持久層也支持 Spring Data Repository 或者 MyBatis。而使用 DataManager 的一個好處是可以利用 Jmix 的安全機制,控制 API 調用方對實體的訪問許可權。

Jmix 服務 API

Jmix 服務(Service) API 可以將任意 Spring bean 作為 HTTP 介面開放。Jmix 負責 HTTP 交互,例如,提供 HTTP 響應編碼、進行錯誤處理等。下圖是 Jmix 服務 API 的流程圖:

Jmix 服務 API 流程

可以看到,作為應用程式開發者,僅需要編寫服務代碼。另外,還需做一些配置:

  1. 在項目的 resources 目錄添加 rest-services.xml,用於配置可作為 REST API 使用的服務及其方法,內容如下:
<?xml version="1.0" encoding="UTF-8"?>
  <services xmlns="http://jmix.io/schema/rest/services">
      <service name="sls_ProductService"> <!-- 指定服務名稱 -->
          <method name="getProductsCheaperThan"> <!-- 指定方法名稱 -->
              <param name="price" type="java.lang.Double"/> <!-- 指定方法參數和類型 -->
          </method>
          <!-- 可以添加服務中其他方法 -->
      </service>
      <!-- 可以添加其他服務 -->
  </services>
  1. 在項目的 application.properties 文件中,設置 jmix.rest.services-config 參數,指定上面配置的 xml 文件:
jmix.rest.services-config = com/abmcode/sales/rest-services.xml

完成這些配置之後,就可以通過 REST 客戶端調用了,URL 為 /rest/services/<service_name>/<method_name>。例如,通過 Postman 調用:

Postman 調用服務 API

服務 API 會預設使用 Jmix 的安全機制:API 埠需要使用認證 token 進行訪問,而且用戶需要有訪問 REST API 和所查詢實體的許可權。另外,Jmix 的服務 API 也支持匿名訪問

Spring 控制器 API

然後我們再看看 Spring 的 RestController 方式。首先,我們定義一個控制器:

@RestController("sls_ProductController")
@RequestMapping("/products")
public class ProductController {
    @Autowired
    private ProductService productService;

    @GetMapping("priceunder")
    public List<Product> getPriceUnder(@RequestParam Double price) throws Throwable {

        if (price < 0) {
            throw new ResponseStatusException(HttpStatus.BAD_REQUEST, "價格參數必須大於 0"); // 自定義控制器層的參數檢查,拋出請求異常。
        }

        return productService.getProductsCheaperThan(price);
    }
}

Jmix 中的控制器介面預設都是匿名的,但是為匿名用戶配置能訪問實體信息又不夠安全,Jmix 提供了一個應用程式屬性,支持使用 Jmix 安全機制對自定義控制器進行保護:

# 支持逗號分隔的多個 pattern
jmix.rest.authenticatedUrlPatterns=/products/**

然後,重啟服務就可以通過 Postman 進行調用。註意,這裡的 URL 與服務 URL 不同,直接使用了控制器中定義的路徑:

Postman 調用控制器 API

結論

通過上面的代碼,我們可以看到,在 Jmix 中使用兩種類型的 REST API 其實都不複雜,但是,也是各有優勢:

Jmix 服務 API

  • 不用編寫控制器代碼,僅通過 XML 配置即可使用
  • 預設使用 Jmix 的安全機制
  • 可以使用 Fetch plan 定義返回實體的欄位

Spring 控制器

  • 更加靈活,可以使用 Spring 控制器自定義 HTTP 狀態碼、響應類型或者異常錯誤
  • 除了使用服務層的實體控制外,還可以在控制器層使用自定義的 DTO 對返回實體的信息做進一步控制

因此,在大多數情況下,我們僅使用 Jmix 的服務 API 就能夠滿足使用要求。針對部分複雜場景可以使用 Spring 控制器 API。

文中使用的 Jmix 版本:1.3.1


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • nacos 依賴 mysql 先安裝mysql ,這裡使用的是8+版本,原因在於原本的 5.7 版本中並沒有對 m1 的良好支持,如果啟動會有報錯說查詢不到對應版本信息(雖然可以通過自定義 mirror 實現) mysql 配置參考(docker-compose): mysql: image: my ...
  • 參考自《硬體架構的藝術》。 思路:產生具有50%占空比的奇數分頻時鐘,最簡單的方式是以期望輸出頻率的一半(即輸出周期的兩倍)生成兩個正交相位時鐘,這兩個正交時鐘之間有90°的相位差(即相差四分之一個周期),然後將這兩個時鐘異或,就得到了奇數的50%占空比時鐘。 本次內容針對的是3分頻。具體的思路按照 ...
  • 在內核編程中字元串有兩種格式`ANSI_STRING`與`UNICODE_STRING`,這兩種格式是微軟推出的安全版本的字元串結構體,也是微軟推薦使用的格式,通常情況下`ANSI_STRING`代表的類型是`char *`也就是ANSI多位元組模式的字元串,而`UNICODE_STRING`則代表的... ...
  • 2.Class類 2.1基本介紹 Class類也是類,因此也繼承Object類 Class類對象不是new出來的,而是系統創建的 對於某個類的Class類對象,在記憶體中只有一份,因為類只載入一次 每個類的實例都會記得自己是由哪個Class實例所生成 通過Class對象可以得到一個類的完整結構(通過一 ...
  • 綜述下關鍵點,代碼規範檢查基本原理可以基於AST語法樹來進行實現;AST結合Xpath可以方便進行相關規範規則的編寫;通過 PMD-Designer 能可視化的幫助我們實現 XPath 的相關代碼規範規則以及驗證相關規則;給出了一個例子... ...
  • 概念 線程死鎖描述的是這樣一種情況:多個線程同時被阻塞,它們中的一個或者全部都在等待某個資源被釋放。由於線程被無限期地阻塞,因此程式不可能正常終止。 我和同學都打掃衛生,我拿著掃帚等他的簸箕,他拿著簸箕等我的掃帚 產生條件 互斥條件:同一時刻一線程只能占用一個資源。 同一時刻,我拿著掃帚,他拿著簸箕 ...
  • 面向過程與函數式 面向過程 ”面向過程“核心是“過程”二字,“過程”指的是解決問題的步驟,即先乾什麼再乾什麼......,基於面向過程開發程式就好比在設計一條流水線,是一種機械式的思維方式,這正好契合電腦的運行原理:任何程式的執行最終都需要轉換成cpu的指令流水按過程調度執行,即無論採用什麼語言、 ...
  • java基礎-集合 以下內容為本人的學習筆記,如需要轉載,請聲明原文鏈接 https://www.cnblogs.com/lyh1024/p/16738857.html 1.集合框架概述 1.1集合框架 的作用 在實際開發中,我們經常會對一組相同類型的數據進行統一管理操作。到目前為止,我們可以使用數 ...
一周排行
    -Advertisement-
    Play Games
  • 1. 說明 /* Performs operations on System.String instances that contain file or directory path information. These operations are performed in a cross-pla ...
  • 視頻地址:【WebApi+Vue3從0到1搭建《許可權管理系統》系列視頻:搭建JWT系統鑒權-嗶哩嗶哩】 https://b23.tv/R6cOcDO qq群:801913255 一、在appsettings.json中設置鑒權屬性 /*jwt鑒權*/ "JwtSetting": { "Issuer" ...
  • 引言 集成測試可在包含應用支持基礎結構(如資料庫、文件系統和網路)的級別上確保應用組件功能正常。 ASP.NET Core 通過將單元測試框架與測試 Web 主機和記憶體中測試伺服器結合使用來支持集成測試。 簡介 集成測試與單元測試相比,能夠在更廣泛的級別上評估應用的組件,確認多個組件一起工作以生成預 ...
  • 在.NET Emit編程中,我們探討了運算操作指令的重要性和應用。這些指令包括各種數學運算、位操作和比較操作,能夠在動態生成的代碼中實現對數據的處理和操作。通過這些指令,開發人員可以靈活地進行算術運算、邏輯運算和比較操作,從而實現各種複雜的演算法和邏輯......本篇之後,將進入第七部分:實戰項目 ...
  • 前言 多表頭表格是一個常見的業務需求,然而WPF中卻沒有預設實現這個功能,得益於WPF強大的控制項模板設計,我們可以通過修改控制項模板的方式自己實現它。 一、需求分析 下圖為一個典型的統計表格,統計1-12月的數據。 此時我們有一個需求,需要將月份按季度劃分,以便能夠直觀地看到季度統計數據,以下為該需求 ...
  • 如何將 ASP.NET Core MVC 項目的視圖分離到另一個項目 在當下這個年代 SPA 已是主流,人們早已忘記了 MVC 以及 Razor 的故事。但是在某些場景下 SSR 還是有意想不到效果。比如某些靜態頁面,比如追求首屏載入速度的時候。最近在項目中回歸傳統效果還是不錯。 有的時候我們希望將 ...
  • System.AggregateException: 發生一個或多個錯誤。 > Microsoft.WebTools.Shared.Exceptions.WebToolsException: 生成失敗。檢查輸出視窗瞭解更多詳細信息。 內部異常堆棧跟蹤的結尾 > (內部異常 #0) Microsoft ...
  • 引言 在上一章節我們實戰了在Asp.Net Core中的項目實戰,這一章節講解一下如何測試Asp.Net Core的中間件。 TestServer 還記得我們在集成測試中提供的TestServer嗎? TestServer 是由 Microsoft.AspNetCore.TestHost 包提供的。 ...
  • 在發現結果為真的WHEN子句時,CASE表達式的真假值判斷會終止,剩餘的WHEN子句會被忽略: CASE WHEN col_1 IN ('a', 'b') THEN '第一' WHEN col_1 IN ('a') THEN '第二' ELSE '其他' END 註意: 統一各分支返回的數據類型. ...
  • 在C#編程世界中,語法的精妙之處往往體現在那些看似微小卻極具影響力的符號與結構之中。其中,“_ =” 這一組合突然出現還真不知道什麼意思。本文將深入剖析“_ =” 的含義、工作原理及其在實際編程中的廣泛應用,揭示其作為C#語法奇兵的重要角色。 一、下劃線 _:神秘的棄元符號 下劃線 _ 在C#中並非 ...