SQLite-net
使用以下其中一个包:
版本 | 包 | 描述 |
---|---|---|
sqlite-net-pcl | .NET 标准库 | |
sqlite-net-sqlcipher | 支持加密 | |
sqlite-net-static | 使用 P/Invoke 调用平台提供的 sqlite3 的特殊版本 | |
sqlite-net-base | 不含 SQLitePCLRaw 包,您可以选择自己的提供程序 |
SQLite-net 是一个开源的、最小化的库,允许 .NET、.NET Core 和 Mono 应用程序在 SQLite 3 数据库 中存储数据。它最初设计用于 Xamarin.iOS,但现在已经发展到可以在所有平台(Xamarin.*、.NET、UWP、Azure 等)上使用。
SQLite-net 被设计为快速且方便的数据库层。它的设计遵循以下目标:
-
与现有项目非常容易集成,并且可在所有 .NET 平台上运行。
-
对 SQLite 进行轻量级封装,快速高效。(本库不应成为您查询的性能瓶颈。)
-
提供非常简单的方法来安全地执行 CRUD 操作和查询(使用参数),并以强类型方式检索这些查询的结果。
-
适用于您的数据模型,无需强制您更改类。(包含一个小型的反射驱动 ORM 层。)
NuGet 安装
从 NuGet 安装 sqlite-net-pcl。
**重要提示:**您需要将 NuGet 包同时添加到 .NET Standard 库项目 和 平台相关的应用项目 中。
源代码安装
SQLite-net 全部包含在一个文件中(我知道,很酷对吧?),很容易添加到您的项目中。只需将 SQLite.cs 添加到您的项目中,就可以开始创建表了。异步实现可以在 SQLiteAsync.cs 中找到。
欢迎贡献!
这是一个开源项目,欢迎使用者提供贡献/建议/错误报告。如果您有任何改进库的想法,请在 GitHub 上提交问题。请查看如何贡献。
示例时间!
请查阅 Wiki 以获取,咳咳,完整文档。
该库包含简单的属性,您可以用它们来控制表的构建。在一个简单的股票程序中,您可能会使用:
public class Stock
{
[PrimaryKey, AutoIncrement]
public int Id { get; set; }
public string Symbol { get; set; }
}
public class Valuation
{
[PrimaryKey, AutoIncrement]
public int Id { get; set; }
[Indexed]
public int StockId { get; set; }
public DateTime Time { get; set; }
public decimal Price { get; set; }
[Ignore]
public string IgnoreField { get; set; }
}
一旦您定义了模型中的对象,您就有了 API 的选择。您可以使用"同步 API",其中调用一次阻塞一次,或者您可以使用"异步 API",其中调用不会阻塞。您可能会考虑在移动应用程序中使用异步 API 以提高响应性。
两种 API 都在下面两个部分中进行了解释。
同步 API
一旦您定义了实体,就可以通过调用 CreateTable
自动在数据库中生成表:
// 获取数据库文件的绝对路径
var databasePath = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.MyDocuments), "MyData.db");
var db = new SQLiteConnection(databasePath);
db.CreateTable<Stock>();
db.CreateTable<Valuation>();
您可以使用 Insert
在数据库中插入行。如果表包含自增主键,那么插入后该键的值将对您可用:
public static void AddStock(SQLiteConnection db, string symbol) {
var stock = new Stock() {
Symbol = symbol
};
db.Insert(stock);
Console.WriteLine("{0} == {1}", stock.Symbol, stock.Id);
}
类似的方法还有Update
和Delete
。
查询数据最直接的方式是使用Table
方法。这可以使用谓词来通过WHERE子句进行约束和/或添加ORDER BY子句:
var query = db.Table<Stock>().Where(v => v.Symbol.StartsWith("A"));
foreach (var stock in query)
Console.WriteLine("Stock: " + stock.Symbol);
你也可以使用Query
方法在底层查询数据库:
public static IEnumerable<Valuation> QueryValuations (SQLiteConnection db, Stock stock) {
return db.Query<Valuation> ("select * from Valuation where StockId = ?", stock.Id);
}
Query
方法的泛型参数指定了为每一行创建的对象类型。它可以是你的表类之一,或者任何其他公共属性与查询返回的列匹配的类。例如,我们可以将上面的查询重写为:
public class Val
{
public decimal Money { get; set; }
public DateTime Date { get; set; }
}
public static IEnumerable<Val> QueryVals (SQLiteConnection db, Stock stock) {
return db.Query<Val> ("select \"Price\" as \"Money\", \"Time\" as \"Date\" from Valuation where StockId = ?", stock.Id);
}
你可以使用Execute
方法执行数据库的底层更新。
异步API
异步库使用任务并行库(TPL)。因此,正常使用Task
对象以及async
和await
关键字对你来说是可行的。
一旦你定义了实体,你可以通过调用CreateTableAsync
自动生成表:
// 获取数据库文件的绝对路径
var databasePath = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.MyDocuments), "MyData.db");
var db = new SQLiteAsyncConnection(databasePath);
await db.CreateTableAsync<Stock>();
Console.WriteLine("Table created!");
你可以使用Insert
在数据库中插入行。如果表包含自增主键,那么该键的值将在插入后可用:
var stock = new Stock()
{
Symbol = "AAPL"
};
await db.InsertAsync(stock);
Console.WriteLine("Auto stock id: {0}", stock.Id);
类似的方法还有UpdateAsync
和DeleteAsync
。
查询数据最直接的方式是使用Table
方法。这将返回一个AsyncTableQuery
实例,你可以在其上添加谓词以通过WHERE子句进行约束和/或添加ORDER BY。在调用特殊检索方法 - ToListAsync
、FirstAsync
或FirstOrDefaultAsync
之前,数据库不会被实际触及。
var query = db.Table<Stock>().Where(s => s.Symbol.StartsWith("A"));
var result = await query.ToListAsync();
foreach (var s in result)
Console.WriteLine("Stock: " + s.Symbol);
有许多底层方法可用。你也可以通过QueryAsync
方法直接查询数据库。除了InsertAsync
等提供的更改操作外,你还可以使用ExecuteAsync
方法直接在数据库中更改数据集。
另一个有用的方法是ExecuteScalarAsync
。这允许你轻松地从数据库返回标量值:
var count = await db.ExecuteScalarAsync<int>("select count(*) from Stock");
Console.WriteLine(string.Format("Found '{0}' stock items.", count));
手动SQL
sqlite-net通常作为一个轻量级ORM(对象关系映射器)使用,使用CreateTable
和Table
方法。
然而,你也可以将其用作方便的方式来手动执行查询。
以下是一个创建表、插入数据(使用参数化命令)和查询表的示例,而不使用ORM功能。
db.Execute ("create table Stock(Symbol varchar(100) not null)");
db.Execute ("insert into Stock(Symbol) values (?)", "MSFT");
var stocks = db.Query<Stock> ("select * from Stock");
使用SQLCipher
你可以通过使用sqlite-net-sqlcipher NuGet包来使用加密数据库。
数据库密钥在传递给连接构造函数的SqliteConnectionString
中设置:
var options = new SQLiteConnectionString(databasePath, true,
key: "password");
var encryptedDb = new SQLiteAsyncConnection(options);
如果你需要设置pragmas来控制加密,可以将操作传递给连接字符串:
var options2 = new SQLiteConnectionString (databasePath, true,
key: "password",
preKeyAction: db => db.Execute("PRAGMA cipher_default_use_hmac = OFF;"),
postKeyAction: db => db.Execute ("PRAGMA kdf_iter = 128000;"));
var encryptedDb2 = new SQLiteAsyncConnection (options2);
感谢!
感谢.NET社区对这个项目的欢迎,也感谢所有为使这个项目变得更好而做出贡献的贡献者们。
同时也要感谢Tirza van Dijk (@tirzavdijk)设计的精美logo!