Android ORMLite 框架的入門用法

時間 2019-11-07

標籤 android ormlite 框架入門用法欄目 Android 简体版

原文原文鏈接

你們在Android項目中或多或少的都會使用數據庫，爲了提升咱們的開發效率，固然少不了數據庫ORM框架了，尤爲是某些數據庫操做特別頻繁的app；本篇博客將詳細介紹ORMLite的簡易用法。java

下面開始介紹ORMLite的入門用法~android

一、下載 ORMLite Jar

首先去ORMLite官網下載jar包，對於Android爲：ormlite-android-4.48.jar 和 ormlite-core-4.48.jar ；sql

ps:訪問不了的朋友，文章末尾會把jar、源碼、doc與本篇博客例子一塊兒打包提供給你們下載。數據庫

二、配置Bean類

有了jar,咱們直接新建一個項目爲：zhy_ormlite，而後把jar拷貝到libs下。app

而後新建一個包：com.zhy.zhy_ormlite.bean專門用於存放項目中的Bean，首先新建一個User.java框架

[java] view plain copy ide

package com.zhy.zhy_ormlite.bean; 測試
import com.j256.ormlite.field.DatabaseField; this
import com.j256.ormlite.table.DatabaseTable; spa
@DatabaseTable(tableName = "tb_user")
public class User
{
@DatabaseField(generatedId = true)
private int id;
@DatabaseField(columnName = "name")
private String name;
@DatabaseField(columnName = "desc")
private String desc;
public User()
{
}
public User(String name, String desc)
{
this.name = name;
this.desc = desc;
}
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 getDesc()
{
return desc;
}
public void setDesc(String desc)
{
this.desc = desc;
}
}

首先在User類上添加@DatabaseTable(tableName = "tb_user")，標明這是數據庫中的一張表，標明爲tb_user

而後分別在屬性上添加@DatabaseField(columnName = "name") ，columnName的值爲該字段在數據中的列名

@DatabaseField(generatedId = true) ，generatedId 表示id爲主鍵且自動生成

三、編寫DAO類

原生的數據庫操做，須要繼承SQLiteOpenHelper，這裏咱們須要繼承OrmLiteSqliteOpenHelper，看代碼：

[java] view plain copy

package com.zhy.zhy_ormlite.db;
import java.sql.SQLException;
import android.content.Context;
import android.database.sqlite.SQLiteDatabase;
import com.j256.ormlite.android.apptools.OrmLiteSqliteOpenHelper;
import com.j256.ormlite.dao.Dao;
import com.j256.ormlite.support.ConnectionSource;
import com.j256.ormlite.table.TableUtils;
import com.zhy.zhy_ormlite.bean.User;
public class DatabaseHelper extends OrmLiteSqliteOpenHelper
{
private static final String TABLE_NAME = "sqlite-test.db";
/**
* userDao ，每張表對於一個
*/
private Dao<User, Integer> userDao;
private DatabaseHelper(Context context)
{
super(context, TABLE_NAME, null, 2);
}
@Override
public void onCreate(SQLiteDatabase database,
ConnectionSource connectionSource)
{
try
{
TableUtils.createTable(connectionSource, User.class);
} catch (SQLException e)
{
e.printStackTrace();
}
}
@Override
public void onUpgrade(SQLiteDatabase database,
ConnectionSource connectionSource, int oldVersion, int newVersion)
{
try
{
TableUtils.dropTable(connectionSource, User.class, true);
onCreate(database, connectionSource);
} catch (SQLException e)
{
e.printStackTrace();
}
}
private static DatabaseHelper instance;
/**
* 單例獲取該Helper
*
* @param context
* @return
*/
public static synchronized DatabaseHelper getHelper(Context context)
{
if (instance == null)
{
synchronized (DatabaseHelper.class)
{
if (instance == null)
instance = new DatabaseHelper(context);
}
}
return instance;
}
/**
* 得到userDao
*
* @return
* @throws SQLException
*/
public Dao<User, Integer> getUserDao() throws SQLException
{
if (userDao == null)
{
userDao = getDao(User.class);
}
return userDao;
}
/**
* 釋放資源
*/
@Override
public void close()
{
super.close();
userDao = null;
}
}

這裏咱們須要繼承OrmLiteSqliteOpenHelper，其實就是間接繼承了SQLiteOpenHelper

而後須要實現兩個方法：

一、onCreate(SQLiteDatabase database,ConnectionSource connectionSource)

建立表，咱們直接使用ormlite提供的TableUtils.createTable(connectionSource, User.class);進行建立~

二、onUpgrade(SQLiteDatabase database, ConnectionSource connectionSource, int oldVersion, int newVersion)

更新表，使用ormlite提供的TableUtils.dropTable(connectionSource, User.class, true);進行刪除操做~

刪除完成後，別忘了，建立操做：onCreate(database, connectionSource);

而後使用單例公佈出一個建立實例的方法，getHelper用於獲取咱們的help實例；

最後咱們可能會有不少表嘛，每一個表通常咱們都會單獨寫個Dao用於操做，這裏爲了簡單我並無抽取出來，直接寫在helper中：

好比UserDao的獲取：

[java] view plain copy

/**
* 得到userDao
*
* @return
* @throws SQLException
*/
public Dao<User, Integer> getUserDao() throws SQLException
{
if (userDao == null)
{
userDao = getDao(User.class);
}
return userDao;
}

而後經過獲取到的Dao就能夠進行User的一些經常使用的操做了。

四、測試

最後是測試，咱們直接建立了一個測試類進行測試~~~

[java] view plain copy

package com.zhy.zhy_ormlite.test;
import java.sql.SQLException;
import java.util.List;
import com.zhy.zhy_ormlite.bean.User;
import com.zhy.zhy_ormlite.db.DatabaseHelper;
import android.test.AndroidTestCase;
import android.util.Log;
public class OrmLiteDbTest extends AndroidTestCase
{
public void testAddUser()
{
User u1 = new User("zhy", "2B青年");
DatabaseHelper helper = DatabaseHelper.getHelper(getContext());
try
{
helper.getUserDao().create(u1);
u1 = new User("zhy2", "2B青年");
helper.getUserDao().create(u1);
u1 = new User("zhy3", "2B青年");
helper.getUserDao().create(u1);
u1 = new User("zhy4", "2B青年");
helper.getUserDao().create(u1);
u1 = new User("zhy5", "2B青年");
helper.getUserDao().create(u1);
u1 = new User("zhy6", "2B青年");
helper.getUserDao().create(u1);
testList();
} catch (SQLException e)
{
e.printStackTrace();
}
}
public void testDeleteUser()
{
DatabaseHelper helper = DatabaseHelper.getHelper(getContext());
try
{
helper.getUserDao().deleteById(2);
} catch (SQLException e)
{
e.printStackTrace();
}
}
public void testUpdateUser()
{
DatabaseHelper helper = DatabaseHelper.getHelper(getContext());
try
{
User u1 = new User("zhy-android", "2B青年");
u1.setId(3);
helper.getUserDao().update(u1);
} catch (SQLException e)
{
e.printStackTrace();
}
}
public void testList()
{
DatabaseHelper helper = DatabaseHelper.getHelper(getContext());
try
{
User u1 = new User("zhy-android", "2B青年");
u1.setId(2);
List<User> users = helper.getUserDao().queryForAll();
Log.e("TAG", users.toString());
} catch (SQLException e)
{
e.printStackTrace();
}
}
}

簡單測試了下CURD，使用AndroidTestCase記得配置下環境~~~

用起來是否是仍是很是方便的，不過仍是建議你們例如User的數據庫操做，單獨抽取出來爲UserDao，以下：

[java] view plain copy

package com.zhy.zhy_ormlite.db;
import java.sql.SQLException;
import android.content.Context;
import com.zhy.zhy_ormlite.bean.User;
public class UserDao
{
private Context context;
public UserDao(Context context)
{
this.context = context;
}
public void add(User user)
{
try
{
DatabaseHelper.getHelper(context).getUserDao().create(user);
} catch (SQLException e)
{
}
}//......
}

注：ORMLite還提供了一些基類ORMLiteBaseActivity，ORMLiteBaseService之類的，便於數據庫操做的，這裏不作考慮，畢竟項目中很大可能本身也須要繼承本身的BaseActvity之類的。

上面簡單介紹瞭如何使用ORMLite框架，Android 快速開發系列 ORMLite 框架的使用將對其用法進行深刻的介紹。

相關標籤/搜索

每日一句

每一个你不满意的现在，都有一个你没有努力的曾经。