SQLite使用筆記

前言

客戶端存儲信息的方法有好多種，在以往的項目中采用的是序列化記錄到文件中的方式，即時通信項目中客戶端的一些系統配置的保存也使用的這種方式，然而客戶端保存聊天記錄就不能使用這種方式（保存、讀取、修改都需要進行序列化操作比較費時，不同會話聊天記錄到不同文件中，將需要創建大量的文件），調研相關技術后，決定使用SQLite。

 

SQLite

我的認知如下：
SQLite是一款輕量級文件數據庫，無需部署安裝，特點是嵌入式與事務（原子性、一致性、隔離性和持久性）。使用時只需創建一個db文件（db文件即代表一個數據庫），然后利用ADO.NET進行連接庫、創建、插入、查詢、修改表就可以了，非常的簡單方便。

 

步驟

1.添加引用
右鍵項目引用選擇 管理Nuget程序包 搜索SQLite,選擇第一個進行安裝

2.創建數據庫文件

string dbPath = AppDomain.CurrentDomain.BaseDirectory + "local.db";
SQLiteConnection.CreateFile(dbPath);

注意需要添加引用：using System.Data.SQLite;
3.連接SQLite

SQLiteConnection conn = new SQLiteConnection();
SQLiteConnectionStringBuilder connstr = new SQLiteConnectionStringBuilder();
connstr.DataSource = datasource;
connstr.Password = "123456";//設置密碼，SQLite ADO.NET實現了數據庫密碼保護
conn.ConnectionString = connstr.ToString();
conn.Open();

4.創建表

SQLiteCommand cmd = new SQLiteCommand();
string sql = "CREATE TABLE FirstTable(ID varchar(36),UserName varchar(30),PassWord varchar(30))";
cmd.CommandText = sql;
cmd.Connection = conn;
cmd.ExecuteNonQuery();

5.增刪改查
增：

SQLiteCommand cmd = new SQLiteCommand();
string sql = "INSERT INTO FirstTable VALUES('1','ading3','123')";
cmd.Connection = conn;
cmd.CommandText = sql; 
cmd.ExecuteNonQuery();

刪：

string sql = "DELETE FROM FirstTable WHERE ID = @ID";
SQLiteParameter[] parms =
{
new SQLiteParameter("@ID",id)
};
command.CommandText = sql;
command.Parameters.AddRange(parameters);
int counts = command.ExecuteNonQuery();

改：

string sql= @"UPDATE FirstTable
SET UserName=@UserName,
PassWord=@PassWord 
WHERE UserName='admin'
";
SQLiteParameter[] parms1 =
{
new SQLiteParameter("@UserName","adminading"),
new SQLiteParameter("@PassWord","2622020")
};
command.CommandText = sql;
command.Parameters.AddRange(parameters);
int counts = command.ExecuteNonQuery();

查：

string query = "SELECT * FROM FirstTable"; 
DataTable dt = SQLiteHelper.ExecuteQuery(query, null);
List<Test> tlist = new List<Test>();
foreach (var item in dt1.Rows)
{
Test tt = new Test();
tt.ID=(item as DataRow)["ID"].ToString();
tt.UserName = (item as DataRow)["UserName"].ToString();
tt.PassWord = (item as DataRow)["PassWord"].ToString();

tlist.Add(tt);
}
public class Test
{
public string ID { get; set; }
public string UserName { get; set; }
public string PassWord { get; set; }
}

 

幫助類

 /// <summary>
    /// SQLite幫助類
    /// 說明：使用SQLite很簡單，只需要Nuget搜SQLite 使用第一個System.Data.SQLite安裝即可
    /// 使用CreateDB方法 創建一個數據庫文件 傳入路徑即可  （注意：一個數據庫文件代表一個數據庫）
    /// 使用前請先指定連接字符串 使用SetConnectionString()方法
    /// SQLite作為本地文件數據庫 具有獨立運行、無服務器、零配置、支持事務、低內存、原子性等特點
    /// </summary>
    public class SQLiteHelper
    {
        #region 屬性
        /// <summary>
        /// 連接字符串
        /// </summary>
        private static string connectionString = string.Empty;
        #endregion 屬性

        #region 設置連接字符串與創建數據庫文件
        /// <summary>
        /// 根據數據源、密碼、版本號設置連接字符串。
        /// </summary>
        /// <param name="datasource">數據源。</param>
        /// <param name="password">密碼。</param>
        /// <param name="version">版本號（缺省為3）。</param>
        public static void SetConnectionString(string datasource, string password, int version = 3)
        {
            connectionString = string.Format("Data Source={0};Version={1};password={2}",
                datasource, version, password);
        }

        /// <summary>
        /// 創建一個數據庫文件。如果存在同名數據庫文件，則會覆蓋。
        /// </summary>
        /// <param name="dbName">數據庫文件名。為null或空串時不創建。</param>
        /// <param name="password">（可選）數據庫密碼，默認為空。</param>
        /// <exception cref="Exception"></exception>
        public static void CreateDB(string dbName)
        {
            if (!string.IsNullOrEmpty(dbName))
            {
                try
                {
                    CreateDirectory(dbName);
                    SQLiteConnection.CreateFile(dbName);
                }
                catch (Exception ex)
                {
                    string errormes = ex.Message;
                    errormes += "\r\n";
                    errormes += LogHelper.ToMessage(ex);
                    string path = string.Empty;
                    path += AppDomain.CurrentDomain.BaseDirectory;
                    path += @"Unlog\SQLiteError";
                    path += DateTime.Now.ToString("yyyyMMddHHmm");
                    path += ".txt";
                    LogHelper.Instance.WriteLog(path, errormes);
                }
            }
        }

        #region 輔助方法
        /// <summary>
        /// 創建父級路徑
        /// </summary>
        /// <param name="infoPath"></param>
        private static void CreateDirectory(string infoPath)
        {
            DirectoryInfo directoryInfo = Directory.GetParent(infoPath);
            if (!directoryInfo.Exists)
            {
                directoryInfo.Create();
            }
        }
        #endregion 輔助方法
        #endregion 設置連接字符串與創建數據庫文件

        #region 命令參數封裝
        // <summary>
        /// 准備操作命令參數
        /// </summary>
        /// <param name="cmd">SQLiteCommand</param>
        /// <param name="conn">SQLiteConnection</param>
        /// <param name="cmdText">Sql命令文本</param>
        /// <param name="data">參數數組</param>
        private static void PrepareCommand(SQLiteConnection conn, SQLiteCommand cmd, string cmdText, params SQLiteParameter[] parms)
        {
            if (conn.State != ConnectionState.Open)
                conn.Open();
            cmd.Parameters.Clear();
            cmd.Connection = conn;
            cmd.CommandText = cmdText;
            cmd.CommandType = CommandType.Text;
            cmd.CommandTimeout = 30;
            if (parms != null && parms.Length > 0)
            {
                foreach (SQLiteParameter parameter in parms)
                {
                    if ((parameter.Direction == ParameterDirection.Input || parameter.Direction == ParameterDirection.InputOutput) && (parameter.Value == null))
                    {
                        parameter.Value = DBNull.Value;
                    }
                }
                cmd.Parameters.AddRange(parms);
            }
        }

        #endregion 命令參數封裝

        #region 數據庫操作
        #region 創建表
        /// <summary>
        /// 創建表
        /// </summary>
        /// <param name="sql"></param>
        /// <returns></returns>
        public static bool CreateTable(string sql)
        {
            bool rr = true;
            try
            {
                using (SQLiteConnection connection = new SQLiteConnection(connectionString))
                {
                    using (SQLiteCommand command = new SQLiteCommand(connection))
                    {
                        try
                        {
                            PrepareCommand(connection, command, sql, null);
                            int count = command.ExecuteNonQuery();
                            if (count > 0) rr = true;
                            else rr = false;
                        }
                        catch (Exception ex)
                        {
                            return false;
                        }
                    }
                }
            }
            catch (Exception ex)
            {

                return false;
            }
            return rr;
        }
        #endregion 創建表

        #region 增刪改操作
        /// <summary> 
        /// 對SQLite數據庫執行增刪改操作，返回受影響的行數。 
        /// </summary> 
        /// <param name="sql">要執行的增刪改的SQL語句。</param> 
        /// <param name="parameters">執行增刪改語句所需要的參數，參數必須以它們在SQL語句中的順序為准。</param> 
        /// <returns></returns> 
        /// <exception cref="Exception"></exception>
        public static int ExecuteNonQuery(string sql, params SQLiteParameter[] parameters)
        {
            int affectedRows = 0;
            using (SQLiteConnection connection = new SQLiteConnection(connectionString))
            {
                using (SQLiteCommand command = new SQLiteCommand(connection))
                {
                    try
                    {
                        PrepareCommand(connection, command, sql, parameters);
                        //connection.Open();
                        //command.CommandText = sql;
                        //if (parameters.Length != 0)
                        //{
                        //    command.Parameters.AddRange(parameters);
                        //}
                        affectedRows = command.ExecuteNonQuery();
                    }
                    catch (Exception) { throw; }
                }
            }
            return affectedRows;
        }
        #endregion 增刪改操作

        #region 批量操作
        /// <summary>
        /// 批量處理數據操作語句。
        /// </summary>
        /// <param name="list">SQL語句集合。</param>
        /// <exception cref="Exception"></exception>
        public static void ExecuteNonQueryBatch(List<KeyValuePair<string, SQLiteParameter[]>> list)
        {
            using (SQLiteConnection conn = new SQLiteConnection(connectionString))
            {
                try { conn.Open(); }
                catch { throw; }
                using (SQLiteTransaction tran = conn.BeginTransaction())
                {
                    using (SQLiteCommand cmd = new SQLiteCommand(conn))
                    {
                        try
                        {
                            foreach (var item in list)
                            {
                                PrepareCommand(conn, cmd, item.Key, item.Value);
                                //cmd.CommandText = item.Key;
                                //if (item.Value != null)
                                //{
                                //    cmd.Parameters.AddRange(item.Value);
                                //}
                                cmd.ExecuteNonQuery();
                            }
                            tran.Commit();
                        }
                        catch (Exception) { tran.Rollback(); throw; }
                    }
                }
            }
        }
        #endregion 批量操作

        #region 查詢 返回第一個
        /// <summary>
        /// 執行查詢語句，並返回第一個結果。
        /// </summary>
        /// <param name="sql">查詢語句。</param>
        /// <returns>查詢結果。</returns>
        /// <exception cref="Exception"></exception>
        public static object ExecuteScalar(string sql, params SQLiteParameter[] parameters)
        {
            using (SQLiteConnection conn = new SQLiteConnection(connectionString))
            {
                using (SQLiteCommand cmd = new SQLiteCommand(conn))
                {
                    try
                    {
                        PrepareCommand(conn, cmd, sql, parameters);
                        //conn.Open();
                        //cmd.CommandText = sql;
                        //if (parameters.Length != 0)
                        //{
                        //    cmd.Parameters.AddRange(parameters);
                        //}
                        return cmd.ExecuteScalar();
                    }
                    catch (Exception) { throw; }
                }
            }
        }
        #endregion 查詢 返回第一個

        #region 查詢 返回DT
        /// <summary> 
        /// 執行一個查詢語句，返回一個包含查詢結果的DataTable。 
        /// </summary> 
        /// <param name="sql">要執行的查詢語句。</param> 
        /// <param name="parameters">執行SQL查詢語句所需要的參數，參數必須以它們在SQL語句中的順序為准。</param> 
        /// <returns></returns> 
        /// <exception cref="Exception"></exception>
        public static DataTable ExecuteQuery(string sql, params SQLiteParameter[] parameters)
        {
            using (SQLiteConnection connection = new SQLiteConnection(connectionString))
            {
                using (SQLiteCommand command = new SQLiteCommand(sql, connection))
                {
                    PrepareCommand(connection, command, sql, parameters);
                    //if (parameters != null)
                    //{
                    //    if (parameters.Length != 0)
                    //    {
                    //        command.Parameters.AddRange(parameters);
                    //    }
                    //}

                    SQLiteDataAdapter adapter = new SQLiteDataAdapter(command);
                    DataTable data = new DataTable();
                    try { adapter.Fill(data); }
                    catch (Exception) { throw; }
                    return data;
                }
            }
        }
        #endregion 查詢 返回DT

        #region 查詢 返回SQLiteDataReader
        /// <summary> 
        /// 執行一個查詢語句，返回一個關聯的SQLiteDataReader實例。 
        /// </summary> 
        /// <param name="sql">要執行的查詢語句。</param> 
        /// <param name="parameters">執行SQL查詢語句所需要的參數，參數必須以它們在SQL語句中的順序為准。</param> 
        /// <returns></returns> 
        /// <exception cref="Exception"></exception>
        public static SQLiteDataReader ExecuteReader(string sql, params SQLiteParameter[] parameters)
        {
            SQLiteConnection connection = new SQLiteConnection(connectionString);
            SQLiteCommand command = new SQLiteCommand(sql, connection);
            try
            {
                PrepareCommand(connection, command, sql, parameters);
                //if (parameters.Length != 0)
                //{
                //    command.Parameters.AddRange(parameters);
                //}
                //connection.Open();
                return command.ExecuteReader(CommandBehavior.CloseConnection);
            }
            catch (Exception) { throw; }
        }
        #endregion 查詢 返回SQLiteDataReader

        #region 查詢數據庫中的所有數據類型信息
        /// <summary> 
        /// 查詢數據庫中的所有數據類型信息。
        /// </summary> 
        /// <returns></returns> 
        /// <exception cref="Exception"></exception>
        public static DataTable GetSchema()
        {
            using (SQLiteConnection connection = new SQLiteConnection(connectionString))
            {
                try
                {
                    connection.Open();
                    return connection.GetSchema("TABLES");
                }
                catch (Exception) { throw; }
            }
        }

        #endregion 查詢數據庫中的所有數據類型信息

        #region 判斷表是否存在
        public static bool IsTableExist(string tableName)
        {
            bool isTableExist = true;
            using (SQLiteConnection connection = new SQLiteConnection(connectionString))
            {
                string sql = "SELECT name FROM sqlite_master WHERE type='table' AND name = '";
                sql += tableName;
                sql += "'";
                using (SQLiteCommand command = new SQLiteCommand(sql, connection))
                {
                    PrepareCommand(connection, command, sql, null);
                    int count = command.ExecuteNonQuery();
                    if (count <= 0) isTableExist = false;
                }
            }
            return isTableExist;

        }
        #endregion 判斷表是否存在

        #endregion 數據庫操作

        #region 整理數據庫
        /// <summary>
        /// 重新組織數據庫
        /// SQLite 的自帶命令 VACUUM。用來重新整理整個數據庫達到緊湊之用，比如把刪除的徹底刪掉等等
        /// </summary>
        public static void ResetDataBass()
        {
            using (SQLiteConnection conn = new SQLiteConnection(connectionString))
            {
                var cmd = new SQLiteCommand();

                if (conn.State != ConnectionState.Open)
                    conn.Open();
                cmd.Parameters.Clear();
                cmd.Connection = conn;
                cmd.CommandText = "vacuum";
                cmd.CommandType = CommandType.Text;
                cmd.CommandTimeout = 30;
                cmd.ExecuteNonQuery();
            }
        }
        #endregion 整理數據庫
    }

可視化工具

分享一個可視化工具，個人感覺非常好用：

SQLiteStudio ：http://sqlitestudio.pl/

 

問題

 在項目中使用，不可能是直接在客戶端的項目中直接寫ADO那套，一般都會封裝SQLite調用層，在調用層中添加相關的引用，這樣就會有一個問題，客戶端項目直接調用，會報一個錯誤：

解決方法為：
在客戶端項目中添加兩個文件夾，內部添加SQLite.Interop.dll(從SQLite調用層的Debug中拷貝)

然后，右鍵兩個dll，選擇屬性，更改輸出目錄為始終復制。

問題解決。

 

總結

SQLite在本地存儲方面使用非常廣泛，不得不說真的很好用。