DoytoQuery中的查詢映射方案詳解

更新時間：2022年12月27日 16:17:56 作者：DOYToWin

這篇文章主要為大家介紹了DoytoQuery中的查詢映射方案詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪

引言

DoytoQuery作為一個ORM框架，在研發(fā)過程中積累了很多全新的思路和解決方案，其中一個核心方案就是將查詢對象的字段映射為SQL語句中的WHERE條件進行動態(tài)查詢，目前支持四種字段映射方式。

讓我們看看如何為以下UserEntity編寫查詢對象：

@Getter
@Setter
@Entity
public class UserEntity extends AbstractPersistable<Integer> {
    private String username;
    private String email;
    private String mobile;
    private String password;
    private String nickname;
    private Boolean valid;
}

四種字段映射方式詳解

1. 后綴映射

先定義一個類UserQuery, 對于一些常見的查詢條件，比如id = ?, username = ? and valid = ?等，我們只需要在UserQuery類中定義如下字段即可。

@Getter
@Setter
@SuperBuilder
@NoArgsConstructor
@AllArgsConstructor
public class UserQuery extends PageQuery {
    private Integer id;
    private String username;
    private Boolean valid;
}

像其他一些常用的比較符號. [NOT] LIKE, >, <, !=, >=, <=, IS [NOT] NULL, [NOT] IN, 我們需要在列名后加一些特定的后綴作為字段名稱來標識對應的條件符號。比如，將idIn映射為id IN (?,?,?), 將idGt映射為id > ?, 將usernameLike映射為username LIKE ?, 還需要定義好對應的類型。

public class UserQuery extends PageQuery {
    private Integer id;
    private String username;
    private Boolean valid;
    private List<Integer> idIn;
    private Integer idGt;
    private String usernameLike;
}

只有值不為NULL的字段才會被映射，并且多個條件由AND連接。

UserQuery userQuery = UserQuery.builder().usernameLike("test").valid(true).build();

這個userQuery會被映射為如下查詢語句以及對應的參數(shù)。

SELECT id, username, email, mobile, password, nickname, valid FROM user WHERE username LIKE ? and valid = ?
-- With parameters: ["%test%", true]

所有支持的后綴詳見附錄I。

2. OR映射

OR語句也是SQL里一種常用的查詢方式，DoytoQuery支持的方式有兩種。

2.1 將含Or的字段映射為OR語句

像usernameOrEmailOrMobile這樣多個字段由Or連接的字段會被映射為username = ? OR email = ? OR mobile = ?。

2.2 將實現(xiàn)了Or的對象映射為OR語句

public interface Or {
}
public class AccountOr implements Or {
    private String username;
    private String email;
    private String mobile;
}
public class UserQuery {
    private AccountOr account;
}

遍歷AccountOr中的字段可以得到[username, email, mobile]，然后使用關鍵字OR相連而得username = ? OR email = ? OR mobile = ?.

3. 嵌套查詢映射

嵌套查詢是SQL的另一個常用特性。在管理菜單樹的menu表的常見定義中，我們通常定義一個外鍵parentId來引向父菜單實體的id。

要查詢擁有子菜單的父菜單，我們可以執(zhí)行以下SQL：

SELECT * FROM menu WHERE id IN (SELECT parentId FROM menu WHERE ...)

要查詢某些菜單的子菜單，我們可以執(zhí)行以下SQL：

SELECT * FROM menu WHERE parentId IN (SELECT id FROM menu WHERE ...)

這條語句用于查詢指定用戶擁有的菜單：

SELECT * FROM menu WHERE id IN (
    SELECT menu_id FROM a_perm_and_menu WHERE perm_id IN (
        SELECT perm_id FROM a_role_and_perm WHERE role_id IN (
            SELECT role_id FROM a_user_and_role WHERE user_id IN (
                SELECT id FROM t_user WHERE id = ?
))))

這些都是ERM模型里常見的一對多/多對一/多對多關系. DoytoQuery定義了一個新的@DomainPath注解來映射這種嵌套查詢。

@Target(FIELD)
@Retention(RUNTIME)
public @interface DomainPath {
    // To describe how to route from the host domain to the target domain.
    String[] value();
    String localField() default "id";
    String foreignField() default "id";
}

這里有一個@DomainPath注解用法介紹。

public class MenuQuery extends PageQuery {
    // 多對一: 根據(jù)父菜單的條件查詢他們的子菜單
    @DomainPath(localField = "parentId", foreignField = "id", value = "menu")
    MenuQuery parent;      // parentId   IN (SELECT      id   FROM     menu  WHERE ... )
    // 一對多: 根據(jù)子菜單的條件查詢父菜單
    @DomainPath(localField = "id", foreignField = "parentId", value = "menu")
    MenuQuery children;    // id   IN (SELECT      parentId   FROM     menu  WHERE ... )
    // 多對多: 查詢滿足條件的用戶被授予的菜單
    @DomainPath({"menu", "~", "perm",  "~", "role", "~", "user"})
    UserQuery user;
}

4. 直接映射

當上述方法都不使用時，還有最后一種將字段映射到條件的方法，就是使用注解@QueryField定義查詢條件后直接映射。這是DoytoQuery創(chuàng)建時的第一種映射方式，但是是最后一種推薦的方式，用法如下：

public class MenuQuery extends PageQuery {
    @QueryField(and = "id = (SELECT parent_id FROM menu WHERE id = ?)")
    private Integer childId;
}

嵌套查詢的這種映射方式在@DomainPath發(fā)明后就已棄用。

總結(jié)

在本文中，我們介紹了DoytoQuery中的四種字段映射方式。前三種方式不需要編寫任何SQL語句，并且可以涵蓋到關系數(shù)據(jù)庫開發(fā)中大部分涉及單表查詢的場景。

附錄I: 后綴支持列表

后綴名稱	比較符號	占位符	類型	值處理
(No matching suffix)	=	？
Not	!=	?
NotLike	NOT LIKE	?	String	%value%
Like	LIKE	?	String	%value%
Start	LIKE	?	String	%value
End	LIKE	?	String	value%
NotIn	NOT IN	非空集合: (?[, ?]); 空集合則忽略	Collection
In	IN	非空集合(?[, ?]); 空集合: (null)	Collection
NotNull	IS NOT NULL	-	boolean
Null	IS NULL	-	boolean
Gt	>	?
Ge	>=	?
Lt	<	?
Le	<=	?
Eq	=	?