一个轻量级的数据库条件检索引擎，专门设计来简化后端查询逻辑的开发，专注高级查询的只读 ORM 工具（附源码）

news2024/9/22 15:41:21

前言

在软件开发过程中，后端开发者经常面临着复杂多变的数据库查询需求。产品经理和项目经理可能会频繁地提出新的查询条件，要求支持各种模糊查询、直接查询，甚至需要在用户界面上提供下拉列表等元素，以增强用户体验。

然而，使用传统的ORM工具和方法来实现这些需求，不仅代码量大，而且难以应对需求的快速变化。

介绍

为了处理这一问题，Bean Searcher应运而生。它是一个轻量级的数据库条件检索引擎，专门设计来简化后端查询逻辑的开发。

一句话囊括：

Bean Searcher —— 用一行代码解锁数据库查询的新境界。

特点

不依赖具体Web框架：可与任何Java Web框架无缝集成。
不依赖具体ORM框架：可独立使用或与现有ORM框架协同工作。
专注高级查询：提供强大的多表关联、动态字段运算符等高级查询功能。

技术架构

Bean Searcher采用简洁的架构设计，通过注解和API的方式，使得复杂的数据库查询变得简单直观。

部署方式

在项目中集成Bean Searcher，只需添加相应的依赖即可。无论是Spring Boot、Grails还是Solon，都可以通过简单的依赖配置快速集成。

Maven依赖

<!-- 对于通用Java Web项目 -->
<dependency>
    <groupId>cn.zhxu</groupId>
    <artifactId>bean-searcher</artifactId>
    <version>4.3.0</version>
</dependency>

Spring Boot集成

<!-- Spring Boot项目 -->
<dependency>
    <groupId>cn.zhxu</groupId>
    <artifactId>bean-searcher-boot-starter</artifactId>
    <version>4.3.0</version>
</dependency>

开源协议

Bean Searcher遵循Apache License 2.0协议，这意味着它完全开源，可以自由地用于商业和非商业项目。

即刻体验一波

使用示例

在业务代码中，通过注入BeanSearcher的检索器，可以轻松实现复杂的查询逻辑：

@RestController
@RequestMapping("/user")
public class UserController {

    @Autowired
    private BeanSearcher beanSearcher;

    @GetMapping("/index")
    public SearchResult<User> index(HttpServletRequest request) {
        // 一行代码实现复杂查询
        return beanSearcher.search(User.class, MapUtils.flat(request.getParameterMap()));
    }
}

多表关联示例

Bean Searcher支持多表关联查询，例如内连接：

@SearchBean(tables = "user u, role r", joinCond = "u.role_id = r.id")
public class User {
    @DbField("u.name")
    private String username;

    @DbField("r.name")
    private String roleName;
}

业务场景示例

Bean Searcher的强大功能在多种业务场景中都能得到充分发挥。以下是一些常见的业务场景示例，展示Bean Searcher如何在实际开发中被应用：

用户管理：在用户管理界面，经常需要根据不同的条件（如用户名、邮箱、注册日期等）进行筛选。Bean Searcher可以轻松实现这些动态查询。

@GetMapping("/users")
public SearchResult<User> searchUsers(HttpServletRequest request) {
    // 根据请求参数动态构建查询条件
    return beanSearcher.search(User.class, MapUtils.flat(request.getParameterMap()));
}

订单查询：在电商平台中，订单查询功能需要支持按订单号、用户ID、订单状态等进行搜索。Bean Searcher的多条件查询能力在这里非常有用。

@GetMapping("/orders")
public SearchResult<Order> searchOrders(HttpServletRequest request) {
    // 构建订单查询
    Map<String, Object> params = MapUtils.builder()
        .field(Order::getOrderId, request.getParameter("orderId"))
        .field(Order::getStatus, request.getParameter("status"))
        .build();
    return beanSearcher.search(Order.class, params);
}

库存管理：库存查询可能需要考虑商品ID、库存数量、商品状态等多个维度。Bean Searcher的多维筛选功能可以帮助快速检索库存数据。

@GetMapping("/inventory")
public SearchResult<Inventory> searchInventory(HttpServletRequest request) {
    // 根据商品ID和库存阈值查询库存信息
    Map<String, Object> params = MapUtils.builder()
        .field(Inventory::getProductId, request.getParameter("productId"))
        .field(Inventory::getQuantity, request.getParameter("minQuantity"), null).op(Op.GT)
        .build();
    return beanSearcher.search(Inventory.class, params);
}

财务管理：在财务管理系统中，可能需要根据不同的时间段、金额范围、交易状态等条件查询交易记录。Bean Searcher的排-序和分页功能可以提供高-效的数据检索。

@GetMapping("/transactions")
public SearchResult<Transaction> searchTransactions(HttpServletRequest request) {
    // 根据时间范围和金额查询交易记录
    Map<String, Object> params = MapUtils.builder()
        .range(Transaction::getTransactionDate, request.getParameter("startDate"), request.getParameter("endDate"))
        .field(Transaction::getAmount, request.getParameter("minAmount"), request.getParameter("maxAmount"))
        .orderBy(Transaction::getTransactionDate, "desc")
        .page(0, 10)
        .build();
    return beanSearcher.search(Transaction.class, params);
}

内容管理系统(CMS)：在CMS中，编辑和检索文章、博客或新闻等内容时，可能需要按分类、标签、发布日期等进行筛选。Bean Searcher的多表关联查询可以轻松实现这些需求。

@GetMapping("/articles")
public SearchResult<Article> searchArticles(HttpServletRequest request) {
    // 构建文章查询，关联分类和标签信息
    return beanSearcher.search(Article.class, MapUtils.flat(request.getParameterMap()));
}

Bean Searcher支持的业务场景远不止这些。无论是简单的单表查询，还是复杂的多表联合查询，Bean Searcher都能以其简洁的API和强大的功能，帮助开发者快速构建出高-效、灵活的数据库查询接口。通过Bean Searcher，开发者可以更加专注于业务逻辑的实现，而不是查询细节的处理。