Android ORMLite 框架的入門用法

轉載請標明出處：http://blog.csdn.net/lmj623565791/article/details/39121377

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

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

1、下載 ORMLite Jar

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

ps:訪問不了的朋友，文章末尾會把jar、源碼、doc與本篇博客例子一起打包提供給大家下載。

2、配置Bean類

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

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

package com.zhy.zhy_ormlite.bean;

import com.j256.ormlite.field.DatabaseField;
import com.j256.ormlite.table.DatabaseTable;

@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爲主鍵且自動生成

3、編寫DAO類

原生的數據庫操作，需要繼承SQLiteOpenHelper，這裏我們需要繼承OrmLiteSqliteOpenHelper，看代碼：

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

然後需要實現兩個方法：

1、onCreate(SQLiteDatabase database,ConnectionSource connectionSource)

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

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

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

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

然後使用單例公佈出一個創建實例的方法，getHelper用於獲取我們的help實例；

最後我們可能會有很多表嘛，每個表一般我們都會單獨寫個Dao用於操作，這裏爲了簡單我並沒有抽取出來，直接寫在helper中：

比如UserDao的獲取：

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

然後通過獲取到的Dao就可以進行User的一些常用的操作了。

4、測試

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

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，如下：

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 框架的使用 將對其用法進行深入的介紹。

源碼點擊下載