5.1 概述
ActiveRecord 是 JFinal 最核心的组成部分之一,通过 ActiveRecord 来操作数据库,将极大地减少代码量,极大地提升开发效率。
5.2 ActiveRecordPlugin
ActiveRecord 是作为 JFinal 的 Plugin 而存在的,所以使用时需要在 JFinalConfig 中配置ActiveRecordPlugin。
以下是 Plugin 配置示例代码:
public class DemoConfig extends JFinalConfig {
public void configPlugin(Plugins me) {
C3p0Plugincp=newC3p0Plugin("jdbc:mysql://localhost/db_name", "userName", "password");
me.add(cp);
ActiveRecordPlugin arp = new ActiveRecordPlugin(cp);
me.add(arp);
arp.addMapping("user", User.class);
arp.addMapping("article", "article_id", Article.class);
}
}
以上代码配置了两个插件:C3p0Plugin 与ActiveRecordPlugin,前者是c3p0 数据源插件, 后者是ActiveRecrod 支持插件。ActiveReceord 中定义了addMapping(String tableName, Class<? extends Model> modelClass>)方法,该方法建立了数据库表名到Model 的映射关系。
另外,以上代码中 arp.addMapping(“user”, User.class),表的主键名为默认为“id”,如果主 键名称为 “user_id”则需要手动指定,如:arp.addMapping(“user”, “user_id”, User.class)。
5.3 Model
Model 是 ActiveRecord 中最重要的组件之一,它充当 MVC 模式中的 Model 部分。以下是
Model 定义示例代码:
public class User extends Model<User> {
public static final User dao = new User();
}
以上代码中的 User 通过继承 Model,便立即拥有的众多方便的操作数据库的方法。在 User 中声明的 dao 静态对象是为了方便查询操作而定义的,该对象并不是必须的。基于 ActiveRecord 的 Model 无需定义属性,无需定义 getter、setter 方法,无需 XML 配置,无需 Annotation 配置, 极大降低了代码量。
以下为 Model 的一些常见用法:
// 创建name属性为James,age属性为25的User对象并添加到数据库
new User().set("name", "James").set("age", 25).save();
// 删除id值为25的User
User.dao.deleteById(25);
// 查询id值为25的User将其name属性改为James并更新到数据库
User.dao.findByIdLoadColumns (25).set("name", "James").update();
// 查询id值为25的user,且仅仅取name与age两个字段的值
User user = User.dao.findByIdLoadColumns (25, "name, age");
// 获取user的name属性
String userName = user.getStr("name");
// 获取user的age属性
Integer userAge = user.getInt("age");
// 查询所有年龄大于18岁的user
List<User>users=User.dao.find("select*fromuserwhereage>18");
// 分页查询年龄大于18的user,当前页号为1,每页10个user
Page<User>userPage=User.dao.paginate(1,10,"select*","fromuser where age > ?",18);
特别注意:User 中定义的 public static final User dao 对象是全局共享的,只能用于数据库查询, 不能用于数据承载对象。数据承载需要使用new User().set(…)来实现。
5.4 JavaBean 与 Model 合体
JFinal 2.1 版本提供了 ModelGenerator 、BaseModelGenerator 、MappingKitGernator 、 DataDictionaryGenerator,分别生成Model、BaseModel、MappingKit、DataDictionary 四类文件。 可根据数据表自动化生成这四类文件。
相对于 JFinal 2.1 之前的版本,生成后的 Model 继承自 BaseModel 而非继承自 Model, BaseModel 中拥有getter、setter 方法遵守传统java bean 规范,Model 继承自BaseModel 即完成了JavaBean 与Model 合体,拥有了传统JavaBean 所有的优势, 并且所有的getter、setter 方法完全无需人工干预,数据表有任何变动一键重新生成即可。
具体用法可在jfinal 官网下载相关GeneratorDemo,用法极度简单。
5.5 JFinal 独创 Db + Record 模式(无需映射、Record相当于通用Model、Db操作)
Db 类及其配套的 Record 类,提供了在 Model 类之外更为丰富的数据库操作功能。使用 Db 与Record 类时,无需对数据库表进行映射,Record 相当于一个通用的Model。以下为Db + Record 模式的一些常见用法:
// 创建name属性为James,age属性为25的record对象并添加到数据库
Record user = new Record().set("name", "James").set("age", 25);
Db.save("user", user);
// 删除id值为25的user表中的记录
Db.deleteById("user", 25);
// 查询id值为25的Record将其name属性改为James并更新到数据库
user = Db.findById("user", 25).set("name", "James");
Db.update("user", user);
// 获取user的name属性
String userName = user.getStr("name");
// 获取user的age属性
Integer userAge = user.getInt("age");
// 查询所有年龄大于18岁的user
List<Record> users = Db.find("select * from user where age > 18");
// 分页查询年龄大于18的user,当前页号为1,每页10个user
Page<Record>userPage=Db.paginate(1,10,"select*","fromuserwhere age > ?", 18);
以下为事务处理示例:
boolean succeed = Db.tx(new IAtom(){
public boolean run() throws SQLException {
intcount=Db.update("updateaccountsetcash=cash-?where id = ?", 100,123);
intcount2=Db.update("updateaccountsetcash=cash+?where id = ?", 100, 456);
return count == 1 && count2 == 1;
}
}
);
以上两次数据库更新操作在一个事务中执行,如果执行过程中发生异常或者invoke()方法 返回false,则自动回滚事务。
5.6 声明式事务
ActiveRecord 支持声名式事务,声明式事务需要使用 ActiveRecordPlugin提供的拦截器来 实现,拦截器的配置方法见Interceptor 有关章节。以下代码是声明式事务示例:
// 本例仅为示例, 并未严格考虑账户状态等业务逻辑
@Before(Tx.class)
public void trans_demo() {
// 获取转账金额
Integer transAmount = getParaToInt("transAmount");
// 获取转出账户id
Integer fromAccountId = getParaToInt("fromAccountId");
// 获取转入账户id
Integer toAccountId = getParaToInt("toAccountId");
// 转出操作
Db.update("update account set cash = cash - ? where id = ?", transAmount, fromAccountId);
// 转入操作
Db.update("update account set cash = cash + ? where id = ?", transAmount, toAccountId);
}
以上代码中,仅声明了一个Tx拦截器即为action 添加了事务支持。除此之外ActiveRecord 还配备了 TxByActionKeys、TxByActionKeyRegex、TxByMethods、TxByMethodRegex,分别 支持actionKeys、actionKey正则、actionMethods、actionMethod正则声明式事务,以下是示例代码:
public void configInterceptor(Interceptors me) {
me.add(new TxByMethodRegex("(.*save.*|.*update.*)"));
me.add(new TxByMethods("save", "update"));
me.add(new TxByActionKeyRegex("/trans.*"));
me.add(new TxByActionKeys("/tx/save","/tx/update"));
上例中的TxByRegex拦截器可通过传入正则表达式对action 进行拦截,当actionKey被正 则匹配上将开启事务。TxByActionKeys 可以对指定的 actionKey 进行拦截并开启事务, TxByMethods 可以对指定的method 进行拦截并开启事务。
注意:MySql 数据库表必须设置为InnoDB 引擎时才支持事务,MyISAM 并不支持事务。
5.7 Cache
ActiveRecord 可以使用缓存以大大提高性能,以下代码是Cache 使用示例:
public void list() {
List<Blog> blogList = Blog.dao.findByCache("cacheName", "key", "select * from blog");
setAttr("blogList", blogList).render("list.html");
}
上例 findByCache 方法中的 cacheName 需要在 ehcache.xml 中配置如:<cache name="cacheName" …> 。 此 外 Model.paginateByCache(…) 、 Db.findByCache(…) 、 Db.paginateByCache(…)方法都提供了cache 支持。在使用时,只需传入cacheName、key 以及 在ehccache.xml 中配置相对应的cacheName 就可以了。
5.8 Dialect 多数据库支持
目前 ActiveRecordPlugin 提供了 MysqlDialect、OracleDialect、AnsiSqlDialect 实现类。 MysqlDialect 与 OracleDialect 分别实现对 Mysql 与 Oracle 的支持,AnsiSqlDialect 实现对遵守 ANSI SQL 数据库的支持。以下是数据库 Dialect 的配置代码:
public class DemoConfig extends JFinalConfig {
public void configPlugin(Plugins me) {
ActiveRecordPlugin arp = new ActiveRecordPlugin(…); me.add(arp);
// 配置Postgresql方言
arp.setDialect(new PostgresqlDialect());
}
}
5.9 表关联操作
JFinal ActiveRecord 天然支持表关联操作,并不需要学习新的东西,此为无招胜有招。表 关联操作主要有两种方式:一是直接使用sql得到关联数据;二是在Model中添加获取关联数据的方法。
假定现有两张数据库表:user、blog,并且 user 到blog 是一对多关系,blog 表中使用user_id关联到user 表。如下代码演示使用第一种方式得到user_name:
public void relation() {
Stringsql="selectb.*,u.user_namefromblogbinner join user u on b.user_id=u.id where b.id=?";
Blog blog = Blog.dao.findFirst(sql, 123); String name = blog.getStr("user_name");
}
以下代码演示第二种方式在 Blog 中获取相关联的 User 以及在 User 中获取相关联的Blog:
public class Blog extends Model<Blog>{
public static final Blog dao = new Blog();
public User getUser() {
return User.dao.findById(get("user_id"));
}
}
public class User extends Model<User>{
public static final User dao = new User();
public List<Blog> getBlogs() {
returnBlog.dao.find("select*fromblogwhereuser_id=?", get("id"));
}
}
5.10 复合主键
JFinal ActiveRecord 从 2.0 版本开始,采用极简设计支持复合主键,对于 Model 来说需要 在映射时指定复合主键名称,以下是具体例子:
ActiveRecordPlugin arp = new ActiveRecordPlugin(c3p0Plugin);
// 多数据源的配置仅仅是如下第二个参数指定一次复合主键名称
arp.addMapping("user_role", "userId, roleId", UserRole.class);
//同时指定复合主键值即可查找记录 UserRole.dao.findById(123, 456);
//同时指定复合主键值即可删除记录 UserRole.dao.deleteById(123, 456);
如上代码所示,对于 Model 来说,只需要在添加 Model映射时指定复合主键名称即可开 始使用复合主键,在后续的操作中JFinal 会对复合主键支持的个数进行检测,当复合主键数量 不正确时会报异常,尤其是复合主键数量不够时能够确保数据安全。复合主键不限定只能有两 个,可以是数据库支持下的任意多个。
对于 Db + Record模式来说,复合主键的使用不需要配置,直接用即可:
Db.findById("user_role", "roleId, userId", 123, 456);
Db.deleteById("user_role", "roleId, userId", 123, 456);
5.11 Oracle 支持
Oracle 数据库具有一定的特殊性,JFinal 针对这些特殊性进行了一些额外的支持以方便广 大的Oracle 使用者。以下是一个完整的Oracle 配置示例:
public class DemoConfig extends JFinalConfig {
public void configPlugin(Plugins me) { C3p0Plugin cp = new C3p0Plugin(……);
//配置Oracle驱动
cp.setDriverClass("oracle.jdbc.driver.OracleDriver"); me.add(cp);
ActiveRecordPlugin arp = new ActiveRecordPlugin(cp); me.add(arp);
// 配置Oracle方言
arp.setDialect(new OracleDialect());
// 配置属性名(字段名)大小写不敏感容器工厂 arp.setContainerFactory(newCaseInsensitiveContainerFactory()); arp.addMapping("user", "user_id", User.class);
}
由于Oracle 数据库会自动将属性名(字段名)转换成大写,所以需要手动指定主键名为大写, 如:arp.addMaping(“user”, “ID”, User.class)。如果想让 ActiveRecord 对属性名(字段名)的大 小写不敏感可以通过设置 CaseInsensitiveContainerFactory 来达到,有了这个设置,则 arp.addMaping(“user”, “ID”, User.class)不再需要了。
另外,Oracle 并未直接支持自增主键,JFinal 为此提供了便捷的解决方案。要让Oracle 支 持自动主键主要分为两步:一是创建序列,二是在model 中使用这个序列,具体办法如下:
1:通过如下办法创建序列,本例中序列名为:MY_SEQ
CREATE SEQUENCE MY_SEQ INCREMENT BY 1
MINVALUE 1
MAXVALUE 9999999999999999
START WITH 1
CACHE 20;
2:在YourModel.set(…)中使用上面创建的序列
// 创建User并使用序列
User user = new User().set("id", "MY_SEQ.nextval").set("age", 18); user.save();
// 获取id值
Integer id = user.get("id");
序列的使用很简单,只需要 yourModel.set(主键名, 序列名 + “.nextval”)就可以了。特别注意这里的 “.nextval” 后缀一定要是小写,OracleDialect 对该值的大小写敏感。
5.12 多数据源支持
ActiveRecordPlugin 可同时支持多数据源、多方言、多缓存、多事务级别等特性,对每个 ActiveRecordPlugin 可进行彼此独立的配置。简言之 JFinal 可以同时使用多数据源,并且可 以针对这多个数据源配置独立的方言、缓存、事务级别等。
当使用多数据源时,只需要对每个 ActiveRecordPlugin 指定一个 configName 即可,如下是代码示例:
public void configPlugin(Plugins me) {
// mysql 数据源
C3p0Plugin dsMysql = new C3p0Plugin(…); me.add(dsMysql);
// mysql ActiveRecrodPlugin 实例,并指定configName为 mysql ActiveRecordPlugin arpMysql = new ActiveRecordPlugin("mysql", dsMysql); me.add(arpMysql);
arpMysql.setCache(new EhCache()); arpMysql.addMapping("user", User.class);
// oracle 数据源
C3p0Plugin dsOracle = new C3p0Plugin(…); me.add(dsOracle);
// oracle ActiveRecrodPlugin 实例,并指定configName为 oracle ActiveRecordPluginarpOracle=newActiveRecordPlugin("oracle",dsOracle); me.add(arpOracle);
arpOracle.setDialect(new OracleDialect()); arpOracle.setTransactionLevel(8); arpOracle.addMapping("blog", Blog.class);
}
以上代码创建了创了两个ActiveRecordPlugin 实例arpMysql 与arpOrace,特别注意创建实 例的同时指定其configName 分别为mysql 与oracle。arpMysql 与arpOracle 分别映射了不同的Model,配置了不同的方言。
对于Model 的使用,不同的Model 会自动找到其所属的ActiveRecrodPlugin 实例以及相关 配置进行数据库操作。假如希望同一个Model 能够切换到不同的数据源上使用,也极度方便, 这种用法非常适合不同数据源中的 table 拥有相同表结构的情况,开发者希望用同一个 Model 来操作这些相同表结构的table,以下是示例代码:
public void multiDsModel() {
// 默认使用arp.addMapping(...)时关联起来的数据源
Blog blog = Blog.me.findById(123);
// 只需调用一次use方法即可切换到另一数据源上去
blog.use("backupDatabase").save();
}
上例中的代码,blog.use(“backupDatabase”)方法切换数据源到backupDatabase 并直接将数 据保存起来。
特别注意:只有在同一个Model 希望对应到多个数据源的table 时才需要使用use 方法,如果 同一个 Model 唯一对应一个数据源的一个 table,那么数据源的切换是自动的,无需使用 use 方法。
对于 Db + Record 的使用,数据源的切换需要使用Db.use(cnfigName)方法得到数据库操作 对象,然后就可以进行数据库操作了,以下是代码示例:
// 查询 dsMysql数据源中的 user
List<Record> users = Db.use("mysql").find("select * from user");
// 查询 dsOracle数据源中的 blog
List<Record> blogs = Db.use("oracle").find("select * from blog");
以上两行代码,分别通过configName为mysql、oracle得到各自的数据库操作对象,然后 就可以如同单数据完全一样的方式来使用数据库操作 API 了。简言之,对于 Db + Record 来 说,多数据源相比单数据源仅需多调用一下Db.use(configName),随后的API使用方式完全一 样。
注意最先创建的 ActiveRecrodPlugin 实例将会成为主数据源,可以省略configName。最先创建的 ActiveRecrodPlugin实例中的配置将默认成为主配置,此外还可以通过设置configName为 DbKit.MAIN_CONFIG_NAME 常量来设置主配置。
5.13 非 web 环境下使用 ActiveRecord
ActiveRecordPlugin 可以独立于 java web 环境运行在任何普通的 java 程序中,使用方式极 度简单,相对于 web 项目只需要手动调用一下其start() 方法即可立即使用。以下是代码示例:
public class ActiveRecordTest {
public static void main(String[] args) {
DruidPlugin dp = new DruidPlugin("localhost", "userName", "password"); ActiveRecordPlugin arp = new ActiveRecordPlugin(dp); arp.addMapping("blog", Blog.class);
// 与web环境唯一的不同是要手动调用一次相关插件的start()方法
dp.start();
arp.start();
// 通过上面简单的几行代码,即可立即开始使用
new Blog().set("title", "title").set("content", "cxt text").save(); Blog.me.findById(123);
}
}
注意:ActiveRecordPlugin 所依赖的其它插件也必须手动调用一下 start()方法,如上例中的 dp.start()。