jActiveRecord入门

原创
2014/04/01 23:15
阅读数 988

jActiveRecord

jActiveRecord是我根据自己的喜好用Java实现的对象关系映射(ORM)库,灵感来自Ruby on RailsActiveRecord。它拥有以下特色:

  1. 零配置:无XML配置文件、无Annotation注解。
  2. 零依赖:不依赖任何第三方库,运行环境为Java 6或以上版本。
  3. 动态性:和其他库不同,无需为每张表定义一个相对应的静态类。表、表对象、行对象等都能动态创建和动态获取。
  4. 简化:jActiveRecord虽是模仿ActiveRecord,它同时做了一些简化。例如让HasMany、HasAndBelongsToMany等关联对象职责单一化,方便理解。

项目已经托管到OSC Git:http://git.oschina.net/redraiment/jactiverecord。欢迎大家一起参与维护。

入门

参考Rails For Zombies,我们一步一步创建一套僵尸微博系统的数据层。

连接数据库

jActiveRecord的入口是me.zzp.ar.DB类,通过open这个静态方法创建数据库对象,open方法的参数与java.sql.DriverManager#getConnection兼容。

DB sqlite3 = DB.open("jdbc:sqlite::memory:");

作为演示,此处用sqlite创建一个内存数据库。

创建表

首先要创建一张用户信息表,此处的用户当然是僵尸(Zombie),包含名字(name)和墓地(graveyard)两个信息。

Table Zombie = sqlite3.createTable("zombies", "name text", "graveyard text");

createTable方法的第一个参数是数据库表的名字,之后可以跟随任意个描述字段的参数,格式是名字+类型,用空格隔开。

createTable方法会自动添加一个自增长(auto increment)的id字段作为主键。由于各个数据库实现自增长字段的方式不同,目前jActiveRecord的“创建表”功能支持如下数据库:

  • DB2
  • Derby
  • HyperSQL
  • MySQL
  • Oracle 12c
  • PostgreSQL
  • SQLite
  • Sybase

如果你使用的数据库不在上述列表中,可以自己实现me.zzp.ar.d.Dialect接口,并添加到META-INF/services/me.zzp.ar.d.DialectjActiveRecord采用Java 6ServiceLoader自动加载实现Dialect接口的类。注意 如果你不通过jActiveRecord创建表,则不用担心兼容性问题。

此外jActiveRecord还会额外添加created_atupdated_at两个字段,分别保存记录被创建和更新的时间。因此,上述代码总共创建了5个字段:idnamegraveyardcreated_atupdated_at

添加

Zombie.create("name:", "Ash", "graveyard:", "Glen Haven Memorial Cemetery");
Zombie.create("name", "Bob", "graveyard", "Chapel Hill Cemetery");
Zombie.create("graveyard", "My Fathers Basement", "name", "Jim");

使用Table#create就能新增一条记录(并且返回刚刚创建的记录)。该方法使用“命名参数”,来突显每个值的含义。由于Java语法不支持命名参数,因此列名末尾允许带一个冗余的冒号,即“name:”与“name”是等价的;此外键值对顺序无关,因此第三条名为“Jim”的僵尸记录也能成功创建。

查询

jActiveRecord提供了下列查询方法:

  • Record first():根据id顺序返回第一条记录。
  • Record last():根据id顺序返回最后一条记录。
  • Record find(int id):返回指定id的记录。
  • List<Record> findBy(String key, Object value):根据指定列的值查询(允许为null)
  • List<Record> all():返回所有记录。
  • List<Record> where(String condition, Object... args):指定负责的过滤条件,兼容java.sql.PreparedStatement

firstlastfind仅返回一条记录;其他方法可能返回多条记录,因此返回按id排序的List

例如,获得id为3的僵尸有以下方法:

Zombie.find(3);
Zombie.findBy("name", "Jim");
Zombie.where("graveyard like ?", "My Father%");

数据库返回的记录被包装成Record对象,使用Record#get获取数据。借助泛型,能根据左值自动转换数据类型:

Record jim = Zombie.find(3);
int id = jim.get("id");
String name = jim.get("name");
Timestamp createdAt = jim.get("created_at");

此外,Record同样提供了诸如getIntgetStr等常用类型的强制转换接口。

jActiveRecord不使用Bean,因为Bean不通用,你不得不为每张表创建一个相应的Bean类;使用Bean除了能在编译期检查gettersetter的名字是否有拼写错误,没有任何好处;

更新

通过查询获得目标对象,接着可以做一些更新操作。例如将编号为3的僵尸的目的改成“Benny Hills Memorial”。

调用Record#set方法可更新记录中的值,然后调用Record#saveTable#update保存修改结果;或者调用Record#update一步完成更新和保存操作,该方法和create一样接受任意多个命名参数。

Record jim = Zombie.find(3);
jim.set("graveyard", "Benny Hills Memorial").save();
jim.update("graveyard:", "Benny Hills Memorial"); // Same with above

删除

Table#deleteRecord#destroy都能删除一条记录,Table#purge能删除当前约束下所有的记录。

Zombie.find(1).destroy();
Zombie.delete(Zombie.find(1)); // Same with above

上述代码功能相同:删除id为1的僵尸。

关联

到了最精彩的部分了!ORM库除了将记录映射成对象,还要将表之间的关联信息面向对象化。

jActiveRecord提供与RoR一样的四种关联关系,并做了简化:

  • Table#belongsTo
  • Table#hasOne
  • Table#hasMany
  • Table#hasAndBelongsToMany

每个方法接收一个字符串参数name作为关系的名字,并返回Association关联对象,拥有以下三个方法:

  • by:指定外键的名字,默认使用name + "_id"作为外键的名字。
  • in:指定关联表的名字,默认与name相同。
  • through:关联组合,参数为其他已经指定的关联的名字。即通过其他关联实现跨表访问(join多张表)。

一对多

回到僵尸微博系统的问题上,上面的章节仅创建了一张用户表,现在创建另一张表tweets保存微博信息:

Table Tweet = sqlite3.create("tweets", "zombie_id int", "content text");

其中zombie_id作为外键与zombies表的id像关联。即每个僵尸有多条相关联的微博,而每条微博仅有一个相关联的僵尸。jActiveRecord中用hasManybelongsTo来描述这种“一对多”的关系。其中hasMany在“一”方使用,belongsTo在“多”放使用(即外键所在的表)。

Zombie.hasMany("tweets").by("zombie_id");
Tweet.belongsTo("zombie").by("zombie_id").in("zombies");

接着,就能通过关联名从Record中获取关联对象了。例如,获取Jim的所有微博:

Record jim = Zombie.find(3);
Table jimTweets = jim.get("tweets");
for (Record tweet : jimTweets.all()) {
  // ...
}

或者根据微博获得相应的僵尸信息:

Record zombie = Tweet.find(1).get("zombie");

你可能已经注意到了:hasMany会返回多条记录,因此返回Table类型;belongsTo永远只返回一条记录,因此返回Record。此外,还有一种特殊的一对多关系:hasOne,即“多”方有且仅有一条记录。hasOne的用法和hasMany相同,只是返回值是Record而不是Table

关联组合

让我们再往微博系统中加入“评论”功能:

Table Comment = sqlite3.create("comments", "zombie_id int", "tweet_id", "content text");

一条微博可以收到多条评论;而一个僵尸有多条微博。因此,僵尸和收到的评论是一种组合的关系:僵尸hasMany微博hasMany评论。jActiveRecord提供through描述这种组合的关联关系。

Zombie.hasMany("tweets").by("zombie_id"); // has defined above
Zombie.hasMany("receive_comments").by("tweet_id").through("tweets");
Zombie.hasMany("send_comments").by("zombie_id").in("comments");

上面的规则描述了Zombie首先能找到Tweet,借助Tweet.tweet_id又能找到Comment。第三行代码描述Zombie通过Commentzombie_id可直接获取发出去的评论。

事实上,through可用于组合容易类型的关联,例如hasAndBelongsToMany依赖hasOnebelongsTo依赖另一条belongsTo……

多对多

RoR中多对多关联有has_many throughhas_and_belongs_to_many两种方法,且功能上有重叠之处。jActiveRecord仅保留hasAndBelongsToMany这一种方式来描述多对多关联。多对多关联要求有一张独立的映射表,记录映射关系。即两个“多”方都没有包含彼此的外键,而是借助第三张表同时保存它们的外键。

例如,微博能包含所在城市的信息,而城市信息又是单独的一张表。

Table City = sqlite3.create("cities", "name text");
Table TweetsCities = sqlite3.create("tweets_cities", "tweet_id int", "city_id int");

其中表cities包含所有城市的信息,tweets_cities记录微博和城市的关联关系。Tweet为了连接到City,它首先要连接到表tweets_cities,再通过它访问cities

Tweet.hasMany("tweets_cities").by("tweet_id");
Tweet.hasAndBelongsToMany("cities").by("city_id").through("tweets_cities");

顾名思义,多对多的关联返回的类型一定是Table而不是Record

关联总结

  • 一对一:有外键的表用belongsTo;无外键的表用hasOne
  • 一对多:有外键的表用belongsTo;无外键的表用hasMany
  • 多对多:两个多方都用hasAndBelongsToMany;映射表用belongsTo

通过through可以任意组合其他关联。

总结

本文通过一个微博系统的例子,介绍了jActiveRecord的常用功能。

展开阅读全文
加载中
点击加入讨论🔥(7) 发布并加入讨论🔥
打赏
7 评论
19 收藏
2
分享
返回顶部
顶部