原文链接
xUtils是一款快速开发Android移动应用的框架,其包含了很多实用的android工具.
目前xUtils主要有四大模块：
- DbUtils模块
- ViewUtils模块
- HttpUtils模块
- BitmapUtils模块
xUtils项目github请见:xUtils
由于xUtils3 api变化较多,已转至xUtils3
- 本文使用的xUtils版本为v3.1.22
DbUtils
- android中的orm框架，一行代码就可以进行增删改查；
- 支持事务，默认关闭；
- 可通过注解自定义表名，列名，外键，唯一性约束，NOT NULL约束，CHECK约束等（需要混淆> - 的时候请注解表名和列名）；
- 支持绑定外键，保存实体时外键关联实体自动保存或更新；
- 自动加载外键关联实体，支持延时加载；
- 支持链式表达查询，更直观的查询语义
xutils3_db
通过androidStudio新建工程xutils3_db,引入xUtils3依赖:
在${project_dir}/build.gradle(Module:app)的dependencies函数内添加compile ‘org.xutils:xutils:3.1.22’ 。然后构建一下就引入了xUtils3框架
添加相关权限
在清单文件src/main/AndroidManifest.xml的manifest节点下添加
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />xUtil的初始化
新建android.app.Application继承类me.kevingo.xutils3_db.MyApplication,复写onCreate()方法:
@Override
public void onCreate() {
super.onCreate();
x.Ext.init(this);
x.Ext.setDebug(true);
} 在清单文件src/main/AndroidManifest.xml的Application节点添加属性android:name=”me.kevingo.xutils3_db.MyApplication”
通过以上的操作,就可以在代码中使用xUtils3的相关Api了
Entity
xUtils3中的DB模块提供了两个核心注解即org.xutils.db.annotation.Column和org.xutils.db.annotation.Table注解
- 加注了@Table的实体类将被映射到sqlite中的数据库表,@Table注解有属性name和onCreated两个属性,name属性决定了该实体类映射的数据库表名,而onCreated属性则可以用来添加表一级的属性或约束,例如创建联和唯一索引等
- 加注了@Column的实体类属性将会映射到sqlite数据库中的字段,@Column注解有name、property、isId、autoGen属性,name属性决定了实体类属性对应的数据库字段名;property属性可以用来添加数据库中字段一级的属性或约束条件例如not null,索引等;isId属性表示该字段是否是主键,默认为false;autoGen则表示如果一个字段为主键,是否自增长,默认为true,所以该字段只有在isId属性为true时有效.
- 未加注@Column注解的字段将不映射sqlite字段
新建User类
在me.kevingo.xutils3_db.entity包下新建User类,并添加@Table和@Column注解进行ORM映射
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
@Table(name =
"user",onCreated =
"CREATE UNIQUE INDEX realative_unique ON user(NAME,EMAIL)")
public class User {
@Column(
name =
"ID",isId =
true,autoGen =
true
)
private int id;
@Column(name =
"NAME",property =
"NOT NULL")
private String name;
@Column(name =
"EMAIL",property =
"NOT NULL")
private String email;
@Column(name =
"MOBILE")
private String mobile;
@Column(name =
"REGTIME")
private Date regTime;
public User(){
}
public User(String name,String email,String mobile,Date regTime){
this.name = name;
this.email = email;
this.mobile = mobile;
this.regTime = regTime;
}
public int getId() {
return id;
}
public void setId(
int id) {
this.id = id;
}
public String
getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String
getEmail() {
return email;
}
public void setEmail(String email) {
this.email = email;
}
public String
getMobile() {
return mobile;
}
public void setMobile(String mobile) {
this.mobile = mobile;
}
public Date
getRegTime() {
return regTime;
}
public void setRegTime(Date regTime) {
this.regTime = regTime;
}
public String
toString(){
return "{id="+id+
",name="+name+
",email="+email+
",mobile="+mobile+
",regTime="+regTime+
"}";
}
}
- 如果需要添加联合唯一索引则可以在@Table注解加上onCreated = “CREATE UNIQUE INDEX unique_name ON table_name(column1,column2)”) 为表创建column1,column2联合唯一索引
获取DbManager
org.xutils.DbManager集成了所有对数据库表的操作,类似于SpringJDBC,hibernate等服务端ORM框架的SessionTemplate,DaoTemplate类,我们可以通过如下获取该对象
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
protected DbManager db;
protected void initDb(){
DbManager.DaoConfig daoConfig =
new DbManager.DaoConfig()
.setDbName(
"xutils3_db")
.setDbVersion(
1)
.setAllowTransaction(
true)
.setTableCreateListener(
new DbManager.TableCreateListener() {
@Override
public void onTableCreate(DbManager db,TableEntity<?> table) {
}
})
.setDbUpgradeListener(
new DbManager.DbUpgradeListener() {
@Override
public void onUpgrade(DbManager db,
int oldVersion,
int newVersion) {
}
});
db = x.getDb(daoConfig);
}
新增实体记录
新增实体记录或者实体记录List可以通过org.xutils.DbManager#save或者#saveOrUpdate或者#saveBindingId方法,这三个方法内部会判断传入的是一个List<T>还是一个扁平化的Object来做相应的处理,但这三个方法虽然都能保存对象或者对象List,但又有区别:
- db.save(entity);//保存成功之后【不会】对user的主键进行赋值绑定
- db.saveOrUpdate(entity);//如果一个对象主键为null则会新增该对象,成功之后【会】对user的主键进行赋值绑定,否则根据主键去查找更新
- db.saveBindingId(entity);//保存成功之后【会】对user的主键进行赋值绑定,并返回保存是否成功
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
protected void dbAdd()
throws DbException {
List<User> users =
new ArrayList<User>();
for (
int i =
0; i <
10; i++) {
User user =
new User(
"Kevingo" + System.currentTimeMillis()+i,
"caolbmail@gmail.com",
"13299999999",
new Date());
users.add(user);
}
db.saveBindingId(users);
showDbMessage(
"【dbAdd】第一个对象:" + users.get(
0).toString());
}
如果要查询某张表内的所有对象,可以通过org.xutils.DbManager#findAll(Class<T> class),根据对象的主键id来查找org.xutils.DbManager#findById(Class<T> entityType,Object idValue),当然如果只有这么几个方法来提供查找实体对象显然是不足以满足需求的,所以xUtil的作者还提供了了一个更加灵活的查询对象org.xutils.db.Selector.该对象提供了where(),and(),or(),orderBy(),groupBy(),limit(),offset(),count()等方法来实现灵活的复杂查询,而且这些方法都返回对象本身,所以可以进行链式操作.
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
protected void dbFind()
throws DbException {
List<User> users = db.selector(User.class)
.where(
"name",
"like",
"%kevin%")
.and(
"email",
"=",
"caolbmail@gmail.com")
.orderBy(
"regTime",
true)
.limit(
2)
.offset(
2)
.findAll();
if(users ==
null || users.size() ==
0){
return;
}
showDbMessage(
"【dbFind#selector】复合条件数目:" + users.size());
}
删除一个对象或者对象List通过org.xutils.DbManager#deleteById(Class<T> entityType,Object idValue)来删除某个主键对应的记录,org.xutils.DbManager#delete(Object entity)方法删除某个已经存在表中的对象,org.xutils.DbManager#delete(Class<T> entityType)则会删除表中所有记录,相当于清空表数据.但如果只有以上方法来提供删除操作显然还不够灵活,如果需要根据where条件来删除符合条件的记录,则可以使用org.xutils.db.sqlite.WhereBuilder对象来达到目的,WhereBuilder对象提供了类似Selector对象的and(),expr()等方法来链式操作该对象本身.复写的toString方法可以返回其对应的where条件语句.代码如下:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
protected void dbDelete()
throws DbException {
List<User> users = db.findAll(User.class);
if(users ==
null || users.size() ==
0){
return;
}
WhereBuilder whereBuilder = WhereBuilder.b();
whereBuilder.and(
"id",
">",
"5").or(
"id",
"1").expr(
" and mobile > '2015-12-29 00:00:01' ");
db.delete(User.class,whereBuilder);
users = db.findAll(User.class);
showDbMessage(
"【dbDelete#delete】数据库中还有user数目:" + users.size());
}
更新对象
更新对象除了几个update方法外还可以通过replace方法实现.
/** * 保存或更新实体类或实体类的List到数据库,根据id和其他唯一索引判断数据是否存在. * @param entity * @throws DbException */
void replace(Object entity)
throws DbException;
通过update方法传入WhereBuilder对象和org.xutils.common.util.KeyValue对象实现对复合条件的记录更新指定的列和值
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
protected void dbUpdate()
throws DbException {
List<User> users = db.findAll(User.class);
if(users ==
null || users.size() ==
0){
return;
}
User user = users.get(
0);
user.setEmail(System.currentTimeMillis() /
1000 +
"@email.com");
WhereBuilder whereBuilder = WhereBuilder.b();
whereBuilder.and(
"id",
"1").expr(
" and mobile > '2015-12-29 00:00:01' ");
db.update(User.class,whereBuilder,
new KeyValue(
"email",System.currentTimeMillis() /
1000 +
"@email.com"),
new KeyValue(
"mobile",
"18988888888"));
}
通过org.xutils.DbManager对象中的一系列exec前缀的方法可以实现sql语句查询
db.execQuery(
"select * from user where id>=5");
一对多关系的实现
假如一个User对象对应多个Oder对象我们该如何实现映射呢?
Order实体类
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
@Table(name =
"order")
public class Order {
@Column(name =
"ID",autoGen =
true)
private int id;
@Column(name =
"NUMBER")
private String number;
@Column(name =
"SUBJECT")
private String subject;
@Column(name =
"USERID")
private int userId;
public User
getUser(DbManager db)
throws DbException {
return db.findById(User.class,userId);
}
public int getId() {
return id;
}
public void setId(
int id) {
this.id = id;
}
public String
getNumber() {
return number;
}
public void setNumber(String number) {
this.number = number;
}
public String
getSubject() {
return subject;
}
public void setSubject(String subject) {
this.subject = subject;
}
public int getUserId() {
return userId;
}
public void setUserId(
int userId) {
this.userId = userId;
}
@Override
public String
toString() {
return this.getClass().getName() +
"{id=" + id +
",number=" + number +
",subject=" + subject +
",userId=" + userId +
"}";
}
}
在User对象增加getOrders方法:
public List<Order>
getOrders(DbManager db)
throws DbException {
return db.selector(Order.class).where(
"USERID",
this.id).findAll();
}
一对多的查询:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
protected void one2Money()
throws DbException {
User user = db.findById(User.class,
1);
if(user ==
null){
user =
new User(
"Kevingo" + System.currentTimeMillis(),
"13299999990",
new Date());
db.saveBindingId(user);
}
for (
int i=
0;i<
5;i++){
Order order =
new Order();
long timeStamp = System.currentTimeMillis() /
1000;
order.setNumber(timeStamp +
"");
order.setSubject(
"this is a oder-->" + timeStamp);
order.setUserId(user.getId());
db.save(order);
}
List<Order> orders = user.getOrders(db);
showDbMessage(
"共有订单"+orders.size()+
"个");
}
总结
xUitls3中DB模块的简单使用差不多就是这些,文中如有谬误,欢迎各位指正.最后,感谢xUtils框架作者wyouflf带来如此简单实用的android开发必备良药.
本文源码下载xUtils3中对Sqlite数据库的操作
(function(){
('pre.prettyprint code').each(function () {
var lines =
(thi@H_301_2580@s).text().split(′\n′).length;var
numbering = $('
').addClass('pre-numbering').hide();
(this).addClass(′has−numbering′).parent().append(
numbering);
for (i = 1; i <= lines; i++) {
numbering.append(
(' ').text(i)); }; $numbering.fadeIn(1700); }); });
