Add the following Gradle configuration to your Android project:
// In your root build.gradle file:
buildscript {
repositories {
jcenter()
mavenCentral() // add repository
}
dependencies {
classpath 'com.android.tools.build:gradle:2.3.3'
classpath 'org.greenrobot:greendao-gradle-plugin:3.2.2' // add plugin
}
}
// In your app projects build.gradle file:
apply plugin: 'com.android.application'
apply plugin: 'org.greenrobot.greendao' // apply plugin
dependencies {
compile 'org.greenrobot:greendao:3.2.2' // add library
}
Note that this hooks up the greenDAO Gradle plugin to your build process. When you build your project, it generates classes like DaoMaster, DaoSession and DAOs.
- 第一步:在app的gradle文件中配置数据库信息:
greendao {
schemaVersion 1
daoPackage 'com.zgl.greentest.gen'
targetGenDir 'src/main/java'
}
schemaVersion 对应当前数据库版本
daoPackage 由GreenDao自动生成代码所在的包名,默认的是在项目包下面新建一个gen。
targetGenDir 设置自动生成代码的目录。
- 第二步:在项目中定义一个实体类,并且使用@Entity和@Id标注
@Entity
public class User extends BaseBean
{
@Id
private Long id;
private int memberSex;//性别
private String memberLastX;//X币
@Property(nameInDb = "sex")
private String memberNickname;//昵称
private String memberIcon;//头像地址链接
private String memberMobile;//手机号
private int memberId;//用户ID
@Transient
private String memberDetailAddr;//用户的详细地址
private String memberLastExperience;//用户经验值
private String memberLevelName;//用户等级昵称
private long memberBirthday;//用户生日
private String memberProvince;//用户所在地
}
@Entity 标识实体类,GreenDao会映射成sqlite中的一个表
@Id 标识主键
@Property 标识该属性在表中对应的列名称
@Transient 标识该属性将不会映射到表中,也就是没有这列
还有很多的注释,大家可以参考[注释帮助文档]http://greenrobot.org/files/greendao-api/javadoc/current/
- 第三步:定义好之后按ctrl+F9,也就是工具栏build下面的Make Project对项目进行重新构建,然后就在daoPackage 'com.zgl.greentest.gen'去看自动生成的代码了。
由GreenDao插件生成的代码
- 第四步:使用部分,就是在别的地方怎么使用api来存取对象。首先是实例化GreenDao所需要的几个关键对象,DaoMaster,DaoSession,代码如下:
public class GreenDaoManager
{
private DaoMaster mDaoMaster;
private DaoSession mDaoSession;
private GreenDaoManager()
{
init();
}
/**
* 静态内部类,实例化对象使用
*/
private static class SingleInstanceHolder
{
private static final GreenDaoManager INSTANCE = new GreenDaoManager();
}
/**
* 对外唯一实例的接口
*
* @return
*/
public static GreenDaoManager getInstance()
{
return SingleInstanceHolder.INSTANCE;
}
/**
* 初始化数据
*/
private void init()
{
DaoMaster.DevOpenHelper devOpenHelper = new DaoMaster.DevOpenHelper(App.getmAppContext(),
"shopping_guide");
mDaoMaster = new DaoMaster(devOpenHelper.getWritableDatabase());
mDaoSession = mDaoMaster.newSession();
}
public DaoMaster getmDaoMaster()
{
return mDaoMaster;
}
public DaoSession getmDaoSession()
{
return mDaoSession;
}
public DaoSession getNewSession()
{
mDaoSession = mDaoMaster.newSession();
return mDaoSession;
}
}
还要记着在Application中去初始化:
//GreenDao的初始化
GreenDaoManager.getInstance();
这些工作做完了之后就可以在正式使用了
public UserDao getUserDao()
{
return GreenDaoManager.getInstance().getmDaoSession().getUserDao();
}
public User getUser(Long id)
{
return getUserDao().load(id);
}