Java SDK

数据引擎提供不跨网络，通过模型访问数据的 Java SDK。为开发者提供易用的访问数据的接口，通过接口访问 DBRest 的数据查询功能、插入/更新及删除功能。

• com.justep.tools.mybatis.DbrestWrapper：用于生成查询的过滤条件，完全基于 MyBatis-Plus 的 QueryWrapper，并扩展了关联查询和子查询的部分。DbrestWrapper扩展的部份需要Dbrest的支持，当前DbrestWrapper不支持实体类，如：qw.lambda().eq(User::getName, "1")。
• com.justep.tools.mybatis.DbrestUtil：用于查询、插入、更新、删除数据。虽然DbrestWrapper不支持实体类，但DbrestUtil中是可以以实体类为参数或返回值的。
• com.justep.tools.DbrestResult：返回结果

使用前先添加依赖设置

引入系统工具类

QueryWrapper 方法

查询方法

条件操作符

目前不支持的操作符有：func、apply、last、exists、notExists。

DbrestWrapper 方法

DbrestWrapper 接口提供与 QueryWrapper 类似的接口，目的是为用户提供一个易用的访问数据的接口，通过这个接口访问 DbRest 的数据查询功能

构造方法

定义如下

方法：
    DbrestWrapper(final String serviceName, final String moduleName, final String dataModelName)
参数：
    serviceName：{String} - 服务名
    moduleName：{String} - 模块名
    dataModelName：{String} - 数据模型名
返回值：
    DbrestWrapper 对象

例：查询订单金额大于100，订单编号等于123或22的数据，返回 fid。orderDate，orderNo 三列，先按 orderNo 排升序，再按 orderDate 排降序，代码如下：

    DbrestWrapper<?> wrapper = (DbrestWrapper<?>)new DbrestWrapper <String>("order", "main", "saleOrder");
    wrapper.select("fid", "orderDate", "orderNo");
    wrapper.gt("totalMoney",100);
    wrapper.and(i->i.eq("orderNo","123").or().eq("orderNo","22"));
    wrapper.orderByAsc("orderNo").orderByDesc("orderDate");

例：以订单日期分组，统计订单总金额，代码如下：

    DbrestWrapper<?> wrapper = (DbrestWrapper<?>)new DbrestWrapper <String>("order", "main", "saleOrder");
    wrapper.select("orderDate", "sum(totalMoney)" );
    wrapper.groupBy("orderDate");

例：以订单日期分组，统计count(creatorID)为1的订单总金额，代码如下：

    DbrestWrapper<?> wrapper = (DbrestWrapper<?>)new DbrestWrapper <String>("order", "main", "saleOrder");
    wrapper.select("orderDate", "sum(totalMoney)" );
    wrapper.groupBy("orderDate");
    wrapper.having("count(creatorID)=eq.1");

关联查询方法

例：通过销售订单的客户 id 列左关联客户的 id 列，查询出客户名称列，代码如下：

    DbrestWrapper<?> wrapper = (DbrestWrapper<?>)new DbrestWrapper <String>("order", "main", "saleOrder");
    wrapper.select("fid", "orderDate", "orderNo", "name");
    wrapper.setMainTableAlias("A");
    wrapper.leftJoin("customer").alias("B").on("customId.eq.id");

例：通过销售订单的客户 id 列左关联客户的 id 列，再通过客户的项目 id 列左关联项目的 id 列,查询出客户名称、项目名称列，代码如下：

    DbrestWrapper<?> wrapper = (DbrestWrapper<?>)new DbrestWrapper <String>("order", "main", "saleOrder");
    wrapper.select("fid", "orderDate", "orderNo", "name", "projectName");
    wrapper.setMainTableAlias("A");
    wrapper.leftJoin("customer").alias("B").on("customId.eq.id");
    wrapper.leftJoin("project").alias("C").on("projectId.eq.id");

例：通过 orgs 的 org_id 列左关联 authorize 的 subject_id 列，再通过 authorize 的 role_id 列左关联 role 的 id 列，代码如下：

    DbrestWrapper<?> wrapper = (DbrestWrapper<?>) new DbrestWrapper("entry","uaa","orgs");
    wrapper.select("A.fid as fid","A.code as code","A.name as name","C.code as rolecode","C.name as rolename");
    wrapper.setMainTableAlias("A");
    wrapper.leftJoin("comp/authorize/authorize").alias("B").on("org_id.eq.subject_id");
    wrapper.setLeftAliasUsed("B");
    wrapper.leftJoin("comp/authorize/role").alias("C").on("role_id.eq.id");

例：通过 main 服务模块中 info 的 code 列左关联 oa 服务模块中 basedata 的 no 列，代码如下：

    DbrestWrapper<?> wrapper = (DbrestWrapper<?>) new DbrestWrapper("vuedemo","main","info");
    wrapper.select("A.fid as fid","A.title as title","A.content as content","A.person as person","B.name as typename");
    wrapper.setMainTableAlias("A");
    wrapper.leftJoin("oa/basedata").alias("B").on("code.eq.no");

例：通过users的id列左关联orgs的id列，然后在通过orgs的code列like查询users的username列,即关联查询后再设置其他的条件，代码如下：

    DbrestWrapper<?> userListWrapper = (DbrestWrapper<?>) new DbrestWrapper("entry","uaa","users");
    userListWrapper.select("o.fid as fid","u.name as name","u.username as username");
    userListWrapper.setMainTableAlias("u");
    userListWrapper.leftJoin("orgs").alias("o").on("id.eq.id");
    userListWrapper.like("o.code","field:u.username");

子查询方法和常量

例：使用一个子查询，查询订单明细中包括办公桌的订单，代码如下：

    DbrestWrapper<?> wrapper = (DbrestWrapper<?>)new DbrestWrapper <String>("order", "main", "saleOrder");
    DbrestWrapper<?> subquery0 = new DbrestWrapper <String>("order", "main", "saleOrderDetail");
    subquery0.select("saleOrder");
    subquery0.eq("product","办公桌");
    wrapper.in("fid", DbrestWrapper.SubQueryPrefix + "subquery0");
    wrapper.addSubQueryWrapper("subquery0", subquery0);

例：使用两个子查询，查询订单明细中包括办公桌的，且客户类型为 vip 的订单，代码如下:

    DbrestWrapper<?> wrapper = (DbrestWrapper<?>)new DbrestWrapper <String>("order", "main", "saleOrder");
    DbrestWrapper<?> subquery0 = new DbrestWrapper <String>("order", "main", "saleOrderDetail");
    subquery0.select("saleOrder");
    subquery0.eq("product","办公桌");
    wrapper.in("fid", DbrestWrapper.SubQueryPrefix + "subquery0");
    wrapper.addSubQueryWrapper("subquery0", subquery0);

    DbrestWrapper<?> subquery1 = new DbrestWrapper<String>("order", "main", "customer");
    subquery1.select("id");
    subquery1.eq("customType","vip");
    wrapper.in("customId", DbrestWrapper.SubQueryPrefix + "subquery1");
    wrapper.addSubQueryWrapper("subquery1", subquery1);

DbrestUtil 方法

DbrestUtil 类，为用户提供查询数据、插入/更新数据、删除数据的方法。

查询全部数据

查询全部数据，返回 List

方法：
    public static <T> List <T> selectAll(final DbrestWrapper queryWrapper, final Class <T> entityType);
描述：
    查询全部数据
参数：
    queryWrapper：{DbrestWrapper} - DbrestWrapper 对象
    entityType：{Class} - 返回对象类型
返回值：
    List

例：查询 saleOrder 数据集的数据，代码如下：

    DbrestWrapper<?> wrapper = (DbrestWrapper<?>)new DbrestWrapper <String>("order", "main", "saleOrder");
    List <SaleOrder> list = DbrestUtil.selectAll(wrapper, SaleOrder.class);

查询分页数据

查询分页数据，返回 Page

方法：
    public static <T> Page<T> selectPage(final DbrestWrapper queryWrapper, final Class<T> entityType, final PageRequest pageRequest);
描述：
    查询分页数据
参数：
    queryWrapper：{DbrestWrapper} - DbrestWrapper 对象
    entityType：{Class} - 返回对象类型
    pageRequest：{PageRequest} - 分页对象
返回值：
    Page

例：一页取20条记录，查询第一页的数据，代码如下：

    import org.springframework.data.domain.Page;
    import org.springframework.data.domain.PageImpl;
    import org.springframework.data.domain.PageRequest;

    public Page<SaleOrder> selectPage() throws Exception {
        DbrestWrapper <?> wrapper = (DbrestWrapper<?>)new DbrestWrapper <String>("order", "main", "saleOrder");
        // 1. mybatis plus 从1开始 2. spring data jpa 从0开始 3. 平台是从1开始 4. 前端是从1开始
        com.justep.cloud.data.PageRequest pageRequest = new com.justep.cloud.data.PageRequest(1, 20);
        com.justep.cloud.data.Page <SaleOrder> page = DbrestUtil.selectPage( wrapper, SaleOrder.class, pageRequest);
        return new PageImpl<>(page.getContent(), new PageRequest(0, 20), page.getTotal());
    }

查询数据

查询数据，返回 DbrestResult

方法：
    public static DbrestResult get(final DbrestWrapper queryWrapper, final PageRequest pageRequest);
描述：
    查询数据
参数：
    queryWrapper：{DbrestWrapper} - DbrestWrapper 对象
    pageRequest：{PageRequest} - 分页对象
返回值：
    DbrestResult

例：查询 saleOrder 数据集的数据，代码如下：

    DbrestWrapper<?> wrapper = (DbrestWrapper<?>)new DbrestWrapper <String>("order", "main", "saleOrder");
    DbrestResult ret = DbrestUtil.get(wrapper, null);

查询附件流

方法：
    public static Stream getStream(final DbrestWrapper queryWrapper);
描述：
    查询附件流
参数：
    queryWrapper：{DbrestWrapper} - DbrestWrapper 对象
返回值：
    Stream

例：获取订单编号22的附件（列标识：files）中的第一个文件的文件流，代码如下：

    DbrestWrapper<?> wrapper = (DbrestWrapper<?>)new DbrestWrapper <String>("order", "main", "saleOrder");
    wrapper.eq("orderNo","22");
    wrapper.stream("files", "0");
    DbrestUtil.getStream(wrapper);

插入/更新数据

方法：
    public static <T> DbrestResult upsert(final String serviceName, final String moduleName, final String dataModelName, final List<T> data);
    public static DbrestResult upsert(final String serviceName, final String moduleName, final String dataModelName, final JSONArray data);
描述：
    插入/更新数据，当主键值不存在时执行新增，否则执行更新
参数：
    serviceName：{String} - 服务名
    moduleName：{String} - 模块名
    dataModelName：{String} - 数据集名
    data：{List | JSONArray} - 插入或更新的数据
返回值：
    DbrestResult 对象

例：给 saleOrder 插入新数据，代码如下：

    SaleOrder so = new SaleOrder();
    so.setFid("java1");
    so.setOrderNo("java2");

    List<SaleOrder> soList = new ArrayList <SaleOrder>();
    soList.add(so);
    DbrestResult ret = DbrestUtil.upsert("order", "main", "saleOrder", soList);

删除数据

提供两种删除数据的方法：delete 方法根据数据删除；deleteByCondition 方法根据条件删除，分别说明如下

方法：
    public static <T> DbrestResult delete(final String serviceName, final String moduleName, final String dataModelName, final List<T> data);
    public static DbrestResult delete(final String serviceName, final String moduleName, final String dataModelName, final JSONArray data);
描述：
    删除数据
参数：
    serviceName：{String} - 服务名
    moduleName：{String} - 模块名
    dataModelName：{String} - 数据集名
    data：{List | JSONArray} - 删除的数据
返回值：
    DbrestResult 对象

方法：
    public static DbrestResult deleteByCondition(final String serviceName, final String moduleName, final String dataModelName, final String dbrestCondition)
描述：
    根据条件删除数据
参数：
    serviceName：{String} - 服务名
    moduleName：{String} - 模块名
    dataModelName：{String} - 数据集名
    dbrestCondition：{String} - 删除条件
返回值：
    DbrestResult 对象

例：删除 saleOrder 中 fid 等于5的数据，代码如下：

    DbrestResult ret = DbrestUtil.deleteByCondition("order", "main", "saleOrder","fid=eq.5");

传入请求头

上面的方法都支持最后加一个参数 Map<String, String> headers，用于传入请求头。例如：不校验数据权限

    Map<String, String> headers = new HashMap<String,String>();
    headers.put("X-DbProxy-DisableSqlPermissions", "true");
    DbrestUtil.selectAll(wrapper, SaleOrder.class, headers);

DbrestResult 方法

获取执行结果 String 类型

方法：
    public String getResult();
描述：
    获取执行结果，返回字符串
返回值：
    String

例: 获取查询结果数据，返回 String，代码如下：

    DbrestResult ret = DbrestUtil.get(wrapper, null);
    return ret.getResult();

获取执行结果 JSON 类型

方法：
    public JSONObject toJson();
描述：
    获取执行结果，返回 JSONObject
返回值：
    JSONObject

例：获取查询结果数据，返回 JSON 对象，代码如下：

    DbrestResult ret = DbrestUtil.get(wrapper, null);
    JSONObject json = ret.toJson();

获取响应头

方法：
    public Map<String,List<String>> getResponseHeaders();
描述：
    获取响应头
返回值：
    Map<String,List<String>>

例：获取查询请求响应头中的 Content-Range 的值，代码如下：

    DbrestResult ret = DbrestUtil.get(wrapper, null);
    return ret.getResponseHeaders().get("Content-Range").get(0);