一、简介
Sugar是一个提供非常简便的方式来操作 Android 数据库的ORM框架…..(此处省略1000个字)
简单的说就是,自从用了Sugar框架,我处理数据库的时候,腰不酸腿不疼了,女朋友也找到了!
二、特性
- 一个简单,简洁,干净的一体化进程以最小的配置。
- 通过反射自动命名表和列。
- 支持不同模式版本之间迁移。
三、使用步骤
1. 依赖Sugar库
compile 'com.github.satyan:sugar:1.5'
- 1
或者下载jar包之后导入到你的工程里面。。。
下载地址:http://t.cn/R5raIUg
2. 新建一个实体类,继承于SugarRecord
一个SugarRecord 子类代表一张表
public class User extends SugarRecord {
@Unique
String name;
String password;
String sex;
public User(){}
public User(String name, String password, String sex){
this.name = name;
this.password = password;
this.sex = sex;
}
public String getName() {
return name;
}
public String getPassword() {
return password;
}
public String getSex() {
return sex;
}
}
- 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
这个实体类一共有三个属性,一个属性代表着数据表中的一个字段,使用@Unique 注解指定name字段是唯一键
3. 新建一个类,继承于Application
public class MyApplication extends Application {
@Override
public void onCreate() {
super.onCreate();
SugarContext.init(this);
}
@Override
public void onTerminate() {
super.onTerminate();
SugarContext.terminate();
}
}
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
重写onCreate,onTerminate方法,分别调用SugarContext.init(this)与SugarContext.terminate()方法,这两个方法一看名字就知道干啥的了,init用来初始化的,terminate用来释放资源的。
4. 在AndroidManifest.xml的application标签中添加配置
<application android:label="@string/app_name" android:icon="@drawable/ic_logo"
android:name="com.example.sugardemo.MyApplication">
.
.
.
<meta-data android:name="DATABASE" android:value="sugar_example.db"/>
<meta-data android:name="VERSION" android:value="3"/>
<meta-data android:name="QUERY_LOG" android:value="true"/>
<meta-data android:name="DOMAIN_PACKAGE_NAME" android:value="com.example.bean"/>
.
.
</application>
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- com.example.sugardemo.MyApplication是指第3步中新建的Application类
- 四个meta-data分别表示的意义
元数据 | 含义 |
---|---|
DATABASE | 新建的sqlite数据库名称 |
VERSION | 数据库的版本。通过数据库的版本决定是否对数据库进行更新 |
QUERY_LOG | 在处理数据库过程中,是否在Logcat显示日志 |
DOMAIN_PACKAGE_NAME | 第2步新建的类所在的包名 |
至此,运行工程,程序会自动创建名为sugar_example.db的数据库,数据库的版本是3。并在数据库中创建User表,该表中的字段有name, password, sex, 其中name字段是唯一键。
5. 数据库增删查改操作
(1)添加数据
User user = new User("奥巴马","123abc","男");
user.save();
- 1
- 2
(2)查询数据
- 简单查询
返回一条数据:
User user = User.findById(User.class,1);
String name = user.getName();
String password = user.getPassword();
String sex = user.getSex();
- 1
- 2
- 3
- 4
- 5
查询所有数据:
List<User > user = User.listAll(User .class);
...
...
...
- 1
- 2
- 3
- 4
- 条件查询
查询名字为奥巴马,并且是男性的代码是这样的:
User user = User.find(User.class, "name = ? and sex= ?", "奥巴马", "男");
...
...
...
- 1
- 2
- 3
- 4
(3) 删除数据
删除一条数据:
User user = User.findById(User.class,1);
user.delete();
- 1
- 2
删除所有:
User.deleteAll(User.class);
- 1
(4)更新数据
User user= User.findById(User.class, 1);
user.setName("希拉里");
user.save();
- 1
- 2
- 3
6. 常见问题
你以为这样就完事了吗?使用Android Studio 2.0的同学一般都是出现”no such table xxxx”的错误,这其实是一个bug,解决的办法是禁用Android Studio的Instant Run功能,具体方法是Setting -> Build -> Instant Run, 把Enable Instant Run to hot swap code…..勾选去掉。重新编译运行即可!