Ngbatis内置函数与变量 ​

如何使用内置函数与变量 ​

package your.domain;

public interface PersonDao {
  void insertPerson( Person person );
}

<mapper namespace="your.domain.PersonDao">

  <insert id="insertPerson">
        @var kv = ng.kv( ng_args[0], '', true, true );
        @var id = ng.id( ng_args[0] );
        @var tagName = ng.tagName( ng_args[0] );
        INSERT VERTEX `${ tagName }` (
            ${ ng.join( @kv.columns, ",", "ng.schemaFmt" ) }
        )
        VALUES ${ id } : (
            ${ ng.join( @kv.values ) }
        );
  </insert>

</mapper>

此出用到了 ng.kv、ng.id、ng.tagName、ng.join、ng.schemaFmt等内置函数，用到了ng_args内置参数。 了解了使用的地方之后，咱们在往下的内容中，将对函数进一步介绍。

内置变量 ​

• ng_cm ClassModel Dao接口的类模型，便于在xml中拿到更多类信息 (1.1.0-rc)
• ng_mm MethodModel Dao接口中某个方法的模型，便于在xml中拿到方法信息，包括入参类型。(1.1.0-rc)
• ng_args 传入Dao接口的原始参数，未序列化前。(1.1.0-rc)

内置函数 ​

• ng.valueFmt

  对不定类型的数据值进行格式化，忽略是否追加单引号及日期格式化，直接传原始 java类型即可

  参数位	参数说明	类型	是否必传	默认值
  1	值	Object	Y
  2	如果是字符串是否在前后追加 .* 形成模糊查询	boolean	N	false

  自 v1.1.2 起，默认对字符串类型进行转义，可使用：ValueFmtFn.setEscape( false ) 进行关闭

• ng.schemaFmt

  对模式名前后追加 `，以避免与数据库关键字冲突

  参数位	参数说明	类型	必传	默认值
  1	模式名，如 tagName, edgeName, propertyName	Object	Y

• ng.tagName

  用于从实体类或Dao接口获取 tag name

  参数位	参数说明	类型	必传	默认值
  1	与Schema对应的实体类对象	Object	Y
  2	类模型，使用 ng_cm 传入	ClassModel	N	null

• ng.pkField

  用于获取 主键属性，java.lang.reflect.Field

  参数位	参数说明	类型	必传	默认值
  1	实体类类型	Class<?>	Y
  2	如果不存在主键是否报错中断	Boolean	N	false

• ng.pkName

  用于获取 主键名，String

  参数位	参数说明	类型	必传	默认值
  1	实体类对象	Object	Y
  2	true 时使用列名，false 时使用属性名	Boolean	N	true

• ng.entityType

  用于获取实体类类型

  参数位	参数说明	类型	必传	默认值
  1	实体类对象	Object	Y

• ng.fieldNames

  获取属性名集合（不包括主键）

  参数位	参数说明	类型	必传	默认值
  1	实体类对象	Object	Y
  2	true 时使用列名，false 时使用属性名	Boolean	N	true

• ng.id

  获取id值

  参数位	参数说明	类型	必传	默认值
  1	实体类对象	Object	Y
  2	如果不存在主键是否报错中断	Boolean	N	true
  3	如果值为空，true会通过主键生成器返回新值，false 时 返回空	Boolean	N	true

• ng.kv

  通过实体对象或者获取多个集合

  • columns 列名集合
  • valueNames 属性名集合
  • values 值集合
  • types 属性类型

  参数位	参数说明	类型	必传	默认值
  1	实体类对象	Object	Y
  2	参数名前缀	String	N	null
  3	是否排除主键	Boolean	N	true
  4	是否排除空值	Boolean	N	true
  5	如无主键，是否报错中断	Boolean	N	true

• ng.join

  对集合进行格式化

  参数位	参数说明	类型	必传	默认值
  1	待格式化的集合	Iterable	Y
  2	元素间的分隔符	String	N	,
  3	函数名，各元素拼接前，可进行函数名指定的格式化函数先行格式化，再拼接	String	N	null

• ng.ifStringLike

  类型为字符串时，前后拼接 .*

  参数位	参数说明	类型	必传	默认值
  1	值	Object	Y
  2	属性类型	Object	N	null
  3	属性名，用于不将值明文写在 ngql 中，而使用参数名，让 nebula 在参数中取值	String	N	null

• ng.include

  引用nGQL片段

  参数位	参数说明	类型	必传	默认值
  1	要引用的nGQL片段ID. 引用其他mapper的nGQL片段，片段ID前需要加上片段所在的namespace，例：your.domain.TestDao.nGQL-ID	String	Y
  2	引用nGQL片段时额外的参数，在生成语句时优先使用额外参数	Object	N	null