2.3.2 java SDK

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

• com.justep.tools.mybatis.DbrestWrapper：用于生成查询的过滤条件，完全基于MyBatis-Plus的QueryWrapper，并扩展了关联查询和子查询的部分。与QueryWrapper不同的是，它不支持实体类
• com.justep.tools.mybatis.DbrestUtil：用于查询、插入、更新、删除数据
• com.justep.tools.mybatis.DbrestResult：返回结果

使用前先添加依赖设置

引入系统工具类

2.3.2.1 QueryWrapper的方法

• 支持的查询方法

• 支持的条件操作符

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

2.3.2.2 DbrestWrapper的方法

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

• 构造方法

DbrestWrapper(final String serviceName, final String moduleName, final String dataModelName) 3个参数分别是：serviceName 服务名、moduleName 模块名、dataModelName 数据模型名

例：查询订单金额大于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");

• 为关联查询JOIN增加的方法

例：通过销售订单的客户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");

• 为子查询subquery增加的方法和常量

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

    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);

2.3.2.3 DbrestUtil的方法

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

• 查询全部数据，返回List

public static List selectAll(final DbrestWrapper queryWrapper, final Class entityType);

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

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

• 查询分页数据，返回Page

public static \ Page\ selectPage(final DbrestWrapper queryWrapper, final Class\ entityType, final PageRequest pageRequest);

例：一页取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");
    com.justep.cloud.data.PageRequest pageRequest = new com.justep.cloud.data.PageRequest(0, 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);

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

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

• 查询附件流

public static Stream getStream(final DbrestWrapper queryWrapper);

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

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

• 插入/更新数据

public static \ DbrestResult upsert(final String serviceName, final String moduleName, final String dataModelName, final List\ data);

public static DbrestResult upsert(final String serviceName, final String moduleName, final String dataModelName, final JSONArray data);

例：给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);

• 删除数据

public static \ DbrestResult delete(final String serviceName, final String moduleName, final String dataModelName, final List\ data);

public static DbrestResult delete(final String serviceName, final String moduleName, final String dataModelName, final JSONArray data);

public static DbrestResult deleteByCondition(final String serviceName, final String moduleName, final String dataModelName, final String dbrestCondition)

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

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

• 支持传入headers

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

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

2.3.2.4 DbrestResult的方法

• 获取执行结果，返回字符串

public String getResult();

例: 获取查询结果数据，并转为String，代码如下：

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

• 获取响应头

public Map> getResponseHeaders();

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

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

• 将执行结果转为JSONObject

public JSONObject toJson();

例：将查询请求结果转为JSON对象，代码如下：

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