0
代码
代码
Issues
Pull Requests
讨论
Wiki
分析
0
canonical-entropycanonical-entropyfix(tcc): 重命名Repository为Store并修复超时处理逻辑
64b72489创建于 2月22日历史提交

基本使用方式

QueryBean提供了复杂查询条件封装，它所支持的查询操作符可以参考filter.xdef 元模型中的定义。

1. 复杂查询条件

// MyBatisPlus
LambdaQueryWrapper<User> wrapper = new LambdaQueryWrapper<>();
wrapper.eq(User::getUsername, "张三")
        .and(w -> w.between(User::getAge, 18, 30)
                .or().eq(User::getGender, 1))
        .orderByDesc(User::getCreateTime);
List<User> userList = userMapper.selectList(wrapper);

// NopORM

QueryBean query = new QueryBean();
query.addFilter(eq(PROP_Name_username,"张三"))
    .addFilter(and(
      or(
        between(PROP_NAME_age, 18,30),
        eq(PROP_NAME_gender, 1)
      )))
     .addOrderField(PROP_NAME_createTime, true);

IEntityDao<User> dao = daoProvider.daoFor(User.class);
List<User> usreList = dao.findAllByQuery(query);

// 如果分页查询
query.setOffset(100);
queyr.setLimit(20);
List<User> userList = dao.findPageByQuery(query);

// 如果只查询一条记录
User user = dao.findFirstByQuery(query);

2. 仅根据等于条件进行查询

User example = new User();
user.setStatus(10);

IEntityDao<User> dao = daoProvider.daoFor(User.class);
List<User> userList = dao.findAllByExample(example);
User user = dao.findFirstbyExample(example);
long count = dao.countByExample(example);

3. 嵌入子查询

QueryBean query = new QueryBean();
query.addFilter(SQL.begin("o.id in (select y.xx from tbl y where y.id=?", 3).end().asFilter());
dao.findPageByQuery(query);

4. 联表查询

如果按照主表上的字段进行查询，可以直接使用复合属性，在NopORM引擎中，o.product.productType.name这种复合属性会自动根据主外键关联配置生成关联表查询语句

QueryBean query = new QueryBean();
query.addFiler(eq("product.productType.name","abc"));
dao.findFirstByQuery(query);

如果需要按照子表中的属性查找主表对象，可以使用上一节中介绍的子查询过滤，也可以直接使用EQL查询语言

select distinct o.book from BookAuthor o where o.author.name like '张%'

以上查询语句根据作者的名称查找他所写过的书, BookAuthor是一个关联表，通过o.author.name实现对author表的关联查询，而通过o.book返回关联的书籍对象。

如果不写distinct关键字，则因为是多对多关系，返回的集合中可能会包含重复元素。

5. 在sql-lib等标签库中的查询条件

Nop平台非常强调同一种模型信息存在多种表达形式，并且这些形式之间可以自由的转换。作为一个典型用例，Filter提供了一种标准的复杂判断条件表达形式。 它的信息结构由filter.xdef 元模型来定义。

  1. 在Java中我们可以通过FilterBeans类上的and/or/eq/gt等帮助函数来构建TreeBean对象。
  2. 在XML和Xpl模板语言中，我们可以用<eq name="status" value="1" />这种XML语法来表达同样的判断条件
  3. FilterBeanToSQLTransformer类可以将Filter信息转换为SQL查询语句，例如 o.status = 1
  4. FilterBeanToPredicateTransformer类可以将Filter信息转换为Java中的Predicate接口，在内存中执行判断

在规则引擎中我们使用的判断条件也是由Filter模型来定义。 rule-model.png

我们在xpl模板语言中更加自由的使用Filter过滤

  • 在xbiz模型中实现查询函数

<query name="active_findPage">
  <source>
    <bo:FindPage>
      <filter>
        <eq name="status" value="1"/>
      </filter>
    </bo:FindPage>
  </source>
</query>

bo.xlib中提供了对CrudBizModel中doFindPage等函数的封装

  • 在sql-lib中定义SQL语句 sql-lib提供了类似MyBatis的SQL管理功能，可以通过SqlMapper接口来调用sql-lib中管理的sql语句，也可以直接通过SqlLibManager来调用

@SqlLibMapper("/app/mall/sql/LitemallGoods.sql-lib.xml")
public interface LitemallGoodsMapper {
  void syncCartProduct(@Name("product") LitemallGoodsProduct product);
}

在LitmallGoods.sql-lib.xml中


<sql-lib>
  <sqls>
    <eql name="syncCartProduct" sqlMethod="execute">
      <arg name="product"/>

      <source>
        update LitemallCart o
        set o.price = ${product.price},
        o.goodsName = ${product.goods.name},
        o.picUrl = ${product.url},
        o.goodsSn = ${product.goods.goodsSn}
        where o.productId = ${product.id}
      </source>
    </eql>
  </sqls>
</sql-lib>

其中eql表示使用EQL对象查询语法，它使用实体名、属性名来访问数据，语法与SQL类似，但是支持复合属性，例如 o.product.type 会自动识别外键关联，并转换为关联查询条件。

如果使用sql标签，则表示使用原生SQL语法。也就是说sql-lib中是同时管理SQL查询语句和EQL查询语句。

  • 在数据权限配置中使用 在/nop/main/auth/app.data-auth.xml文件中配置数据权限

<data-auth>
  <objs>
    <obj name="MyEntity">
      <role-auths>
        <role-auth roleId="manager">
          <filter>
            <eq name="type" value="1"/>
          </filter>
        </role-auth>
      </role-auths>
    </obj>
  </objs>
</data-auth>

在xpl模板语言中，我们引入自定义标签来简化Filter的编写，例如


<and>
  <eq name="status" value="1"/>
  <app:FilterByTask/>
</and>

<app:FilterByTask>是一个自定义标签，它只要能够输出一个符合格式要求的XML节点即可（实际上是XNode类型，它实现了ITreeBean接口）。

也可以增加动态判断条件

<bo:FindPage>
  <filter>
     <c:if test="${request.status}">
        <eq name="status" value="${request.status}" />
     </c:if>
  </filter>
</bo:FindPage>

也可以利用元编程机制简化标签编写,例如 <sql:filter>是一个宏标签，它在编译期执行，相当于是对源码结构进行变换


<sql:filter>and o.classId = :myVar</sql:filter>

等价于手写如下代码


<c:if test="${!_.isEmpty(myVar)}">
  and o.classId = ${myVar}
</c:if>

SingleSession支持

IEntityDao上的方法是调用底层的ormTemplate来实现的，而OrmTemplate采用了类似Spring的模板模式，每个函数都会自动开启session来使用，如果上下文环境中已经有session对象，则自动复用.

NopGraphQL引擎执行时已经自动开启了OrmSession，所以一般的业务代码中不需要考虑手动打开session。

如果要在GraphQL引擎之外使用ORM，可以在函数上标注 @SingleSession和 @Transactional( 注意使用Nop平台内定义的Transactional)注解， 它们会自动打开OrmSession和事务管理器。

public class TccRecordRepository implements ITccRecordRepository {
  // 这里强制设置开启新的事务，一般情况下设置propagation，会自动继承上下文中已有的事务
  @Transactional(propagation = TransactionPropagation.REQUIRES_NEW)
  @Override
  public CompletionStage<Void> saveTccRecordAsync(ITccRecord record, TccStatus initStatus) {
    return FutureHelper.futureCall(() -> {
      NopTccRecord tccRecord = (NopTccRecord) record;
      tccRecord.setStatus(initStatus.getCode());
      recordDao().saveEntityDirectly(tccRecord);
      return tccRecord;
    });
  }
  // ...
}

所有使用@Transctional这样的注解的bean，都需要在NopIoC的beans.xml 文件中注册。因为AOP是使用NopIoC的内置能力实现的。参见aop.md


<beans x:schema="/nop/schema/beans.xdef" xmlns:x="/nop/schema/xdsl.xdef">
  <bean id="nopTccRecordRepository" class="io.nop.tcc.dao.store.TccRecordStore"/>
</beans>

如果要手工打开session，可以采用如下方法


@Inject
IOrmTemplate ormTemplate;

ormTemplate.runInSession(session->{
  ...
})

事务管理类似


@Inject
ITransactionTemplate transactionTemplate;

transactionTemplate.runInTransaction(txn->{
   ...
})

OrmEntity实体属性

NopORM中的所有实体类都从OrmEntity类继承。OrmEntity不支持JSON序列化，但是提供了帮助函数可以获取实体上的字段值。

实体上当前的字段值是 entity.orm_initedValues(), 修改前的值是 orm_dirtyOldValues()。

与MyBatis的区别

NopORM是一个类似JPA的完整的ORM引擎，因此它使用OrmSession来管理所有加载到内存中的实体，整体使用类似于JPA和Hibernate，相比于MyBatis要少很多手工调用步骤。

1. 修改的时候不需要调用update方法。

一般情况下我们是使用IEntityDao接口来实现实体的增删改查。它内部使用OrmTemplate来调用底层的NopORM引擎。 OrmTemplate类似于Spring中的HibernateTemplate，调用它上面的方法时会自动打开OrmSession，并在操作完毕后调用session.flush() 来将内存中的修改刷新到数据库中。

因此从数据库中加载到实体之后，我们只需要调用set方法即可，不需要调用任何update方法，引擎会负责检测实体是否已经被修改，如果已经被修改，则自动更新数据库。 更新数据库的时候与MyBatis不同，NopORM会自动根据修改了的字段生成对应的update语句，因此即使调用了set方法，但是如果实际并没有修改实体属性，则最后实体的状态不会转化为dirty，也就不会更新数据库。

@SingleSession
@Transactional
public void changeEntityStatus(String id, int status){
  IEntityDao<MyEntity> dao = daoProvider.daoFor(MyEntity.class);
  MyEntity entity = dao.requireEntity(id);
  entity.setStatus(3);

  // 这里不需要调用dao.updateEntity(entity);
}

如果是在BizModel的函数中调用，则不需要使用@SingleSession和@Transactional注解, NopGraphQL引擎会负责统一处理。

2. 新增的时候也不一定需要调用save方法

只要把新增实体和OrmSession中已经存在的其他实体关联在一起，NopORM引擎flush的时候就会自动沿着对象关联遍历到该实体。如果发现该实体还没有保存，则会自动生成insert语句。

 MyEntity entity = dao.newEntity();
 entity.setName("ssS");
 parent.getChildren().add(entity);

3. 一般情况下不要调用updateDirectly这样的方法

为了实现性能最大化，NopORM也提供了updateDirectly等绕过OrmSession直接生成SQL的更新方式。但是这相当于是一种性能后门，一般不要使用。

4. 尽量使用EQL而不是SQL

NopORM提供了类似MyBatis XML的SQL语句管理机制，在sql-lib.xml可以使用EQL、SQL和DQL等多种查询语法。

EQL类似于Hibernate中的HQL查询语言，可以使用entity.parent.name这种属性关联语法，但是EQL比HQL强大得多。在EQL中可以自由使用各种join语法， with子句、limit子句、update returning子句等，

  • 从设计层面上说 EQL = SQL + AutoJoin，原则上一切SQL语言具有的语法EQL语法都支持，而且在此基础上， EQL语法增加了根据属性关联自动推导得到表关联的特性。
  • 实际实现中，EQL语法支持大部分标准SQL92语法，但是它为了数据库兼容性，只支持多个主流数据库都具有的语法特性，不支持专属于某个数据库的专有语法。对于SQL函数，通过dialect配置实现了兼容转换。
  • EQL支持GIS相关的st_contains等函数