在上一篇文章中,我们提到了Titan框架集成的MongoDB功能内部一些比较重要的顶级接口,但我们平时接触到比较多的还是Curd和Finder这两个类,他们是Titan中对MongoDB直接操作的类,下面来对这两个类的方法进行一些讲解。
首先我们需要知道,我们用于存储的实体类必须对每一个属性进行注解映射,使用org.titan.framework.facade.annotations.MapperKey这一个类型的注解进行映射,@MapperKey(),参数为映射该属性对应的数据库字段属性名,比如说我有一个[private String name;],我给他添加一个@MapperKey("Name"),那么它在Mongo中存储的Key就为Name。
第二点需要知道的是对于用于CRUD进行操作的Repository需要添加Spring的Repository提供注入,并且实现StorageDataProcessor.Mongo类。
之后该Respository就能获取到由该顶级接口提供的Curd对象和Finder对象,进行业务逻辑操作。
第三点是因为实体类继承了DataEntity这个框架提供的BaseEntity,在存储时会拥有额外的默认属性,分别是Id,version,CreateTime,logicalDel,它们分别是:框架内唯一主键,在某些方法内会使用;版本号标记;创建时间;数据删除标记。
1.Curd
Curd中有很多的重载方法,没有重载的方法只有withConverter和load,前者是默认的提供给用户使用自定义转换器的方法,而后者是根据表名和唯一Id以及该类类型去读取这个mongo节点的数据。
add()方法是该类内的插入数据方法,基础的使用方式参数为表名以及一个泛型类型,框架会将表名作为mongo中存储的表名字,而泛型类型会通过转换器转换为一个mongo节点类型进行存储。add()拥有一个重载方法,参数为表名和一个list类型,规定需要指明list中的泛型类型,框架会将该list中所有的对象根据该类型转化为mongo节点进行存储。
delete()方法是该类内的删除数据方法,基础使用方式参数为表名和一个泛型类型,框架会查找表名所对应的表数据,并将泛型类型对象通过转换器转换为mongo节点对象,删除表数据中和该mongo节点对象相同的数据。delete()有一个重载方法,参数为表名和唯一主键ID,这个唯一主键就是我们上边提到的框架持久化类自动生成的ID,在调用该方法后,框架会查找表名中ID相同的数据进行删除。
update()方法是该类内的修改方法,参数为表名,泛型类型(source),泛型类型(target),框架会根据表名查找对应的表数据,转换source对象为mongo节点类型,并匹配表中拥有该节点类型特征的所有数据,更新为target,做一个说明,如果有数据在mongo中为{"name":"小张","age":"12"},{"name":"小李","age":"12"},此时传入source为{"name":"小张"},则会将小张对应的数据修改为传入的target,如果传入的source为{"age":"12"},则会将小张,小李两个数据都修改为传入的target。
totalCount()方法是该类内提供的一个查找存在数量的方法,很多业务逻辑有时候不需要查询完整的数据,而只需要查询是否存在(验证)或查询存在的数量(分页),此时前者可以使用参数为表名,泛型类型(condition),该方法会将泛型类型转换为mongo节点类型,并查找表中是否存在该数据,返回查找到的条数;而后者可以使用该方法的重载方法,参数为一个MongoDBQueryCondition类型,该类型是框架内的一个条件类型,我们将在下一篇文章中介绍该类的具体使用方式,传入该类型后,会返回查找到的所有符合条件的条数。
queryByCondition()方法是该类内的条件查询方法,传入的参数是MonDBQueryCondition类型,会返回所有符合条件的数据集合,这里不做过多介绍,将在下一章展示具体的使用方法。
queryAll()方法是该类内的查询全表数据的方法,参数为表名,类类型,这里类类型指定了该数据对应的映射对象,框架会将返回的数据通过转换器转换为该java对象,若映射失败则会抛出异常,所以一般会使用存储的类型去接收这些数据。
2.Finder
Finder类主要是用于查询数据,若一个Repository只需要完成查询任务,那么请使用readOnly()方法初始化一个Finder对象。
withConverter()方法和Curd类中一样,不再重复赘述。
find()方法是该类内提供的查询方法,基础使用参数为表名,唯一主键ID(String),一个类类型,框架会查找与表名相匹配的表,并匹配ID相同的数据,之后通过转换器转换为传入类类型对应的java对象,若未映射则会抛出相关异常,重载方法参数为MonDBQueryCondition类型,会返回查找到匹配条件的数据集合,这里暂时略过。
totalCount()方法和Curd中的方法一样,不过在该类中只存在参数为MonDBQueryCondition类型的方法,没有其他重载方法。