IOS开发之sqlite封装

上一节实现了最基本的增删改查，所有操作数据库的方法都写在控制器里，这样会有一个问题，如果修改CURD（增删改查）操作方法会非常麻烦，这一节我们对CURD进行封装，在控制器里直接调用封装好的工具。

下面将做一个简单的学生表单本地查询数据的界面，输入学生姓名可以查出相匹配的数据，本示例将对SQL进行工具类封装，对学生进行模型数据封装（注：学生表包含学生ID，姓名name，年龄age三个字段）。

一、实现思路

1.创建数据模型（如学生模型，其属性即为学生表对应的字段）
2.创建操作sqlite工具类（如添加，只需传学生模型对象即可）

二、代码实现

1.封装学生模型数据
IWStudent.h

//  IWStudent.h
//  sqlite编码学习
//
//  Created by Corwien on 16-6-30.
//  Copyright (c) 2016年 Corwien. All rights reserved.
#import <Foundation/Foundation.h>

@interface IWStudent : NSObject
@property (nonatomic, assign) int ID;
@property (nonatomic, copy) NSString *name;
@property (nonatomic, assign) int age;
@end

2.sqlite工具类
IWStudentTool.h

//  IWStudentTool.h
//  学生数据的CRUD（增删改查）

#import <Foundation/Foundation.h>
@class IWStudent;

@interface IWStudentTool : NSObject

/**
 *  添加学生
 *
 *  @param student 需要添加的学生
 */
+ (BOOL)addStudent:(IWStudent *)student;

/**
 *  获得所有的学生
 *
 *  @return 数组中装着都是IWStudent模型
 */
+ (NSArray *)students;

/**
 *  根据搜索条件获得对应的学生
 *
 *  @param condition 搜索条件
 */
+ (NSArray *)studentsWithCondition:(NSString *)condition;

@end

IWStudentTool.m

//  具体实现
//  IWStudentTool.m

#import "IWStudentTool.h"
#import "IWStudent.h"
#import <sqlite3.h>

@implementation IWStudentTool

// static的作用：能保证_db这个变量只被IWStudentTool.m直接访问
static sqlite3 *_db;

// 初始化数据库（这个方法只在首次调用该类时调用）
+ (void)initialize
{
    // 0.获得沙盒中的数据库文件名
    NSString *filename = [[NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) lastObject] stringByAppendingPathComponent:@"student.sqlite"];
    
    // 1.创建(打开)数据库（如果数据库文件不存在，会自动创建）
    int result = sqlite3_open(filename.UTF8String, &_db);
    if (result == SQLITE_OK) {
        NSLog(@"成功打开数据库");
        
        // 2.创表
        const char *sql = "create table if not exists t_student (id integer primary key autoincrement, name text, age integer);";
        char *errorMesg = NULL;
        int result = sqlite3_exec(_db, sql, NULL, NULL, &errorMesg);
        if (result == SQLITE_OK) {
            NSLog(@"成功创建t_student表");
        } else {
            NSLog(@"创建t_student表失败:%s", errorMesg);
        }
    } else {
        NSLog(@"打开数据库失败");
    }
}

+ (BOOL)addStudent:(IWStudent *)student
{
    NSString *sql = [NSString stringWithFormat:@"insert into t_student (name, age) values('%@', %d);", student.name, student.age];

    char *errorMesg = NULL;
    // sql.UTF8String: 将OC的sql转为C语句
    int result = sqlite3_exec(_db, sql.UTF8String, NULL, NULL, &errorMesg);
    
    return result == SQLITE_OK;
}

+ (NSArray *)students
{
    // 0.定义数组
    NSMutableArray *students = nil;
    
    // 1.定义sql语句
    const char *sql = "select id, name, age from t_student;";
    
    // 2.定义一个stmt存放结果集
    sqlite3_stmt *stmt = NULL;
    
    // 3.检测SQL语句的合法性
    int result = sqlite3_prepare_v2(_db, sql, -1, &stmt, NULL);
    if (result == SQLITE_OK) {
        NSLog(@"查询语句是合法的");
        students = [NSMutableArray array];
        
        // 4.执行SQL语句，从结果集中取出数据
        while (sqlite3_step(stmt) == SQLITE_ROW) { // 真的查询到一行数据
            // 获得这行对应的数据
            
            IWStudent *student = [[IWStudent alloc] init];
            
            // 获得第0列的id
            student.ID = sqlite3_column_int(stmt, 0);
            
            // 获得第1列的name
            const unsigned char *sname = sqlite3_column_text(stmt, 1);
            
            // stringWithUTF8String：将C语句转为OC语句
            student.name = [NSString stringWithUTF8String:(const char *)sname];
            
            // 获得第2列的age
            student.age = sqlite3_column_int(stmt, 2);
            
            // 添加到数组
            [students addObject:student];
        }
    } else {
        NSLog(@"查询语句非合法");
    }
    
    return students;
}

+ (NSArray *)studentsWithCondition:(NSString *)condition
{
    // 0.定义数组
    NSMutableArray *students = nil;
    
    // 1.定义sql语句
    const char *sql = "select id, name, age from t_student where name like ?;";
    
    // 2.定义一个stmt存放结果集
    sqlite3_stmt *stmt = NULL;
    
    // 3.检测SQL语句的合法性
    int result = sqlite3_prepare_v2(_db, sql, -1, &stmt, NULL);
    if (result == SQLITE_OK) {
        NSLog(@"查询语句是合法的");
        students = [NSMutableArray array];
        
        // 填补占位符的内容
        NSString *newCondition = [NSString stringWithFormat:@"%%%@%%", condition];
//        NSLog(@"%@", newCondition);
        sqlite3_bind_text(stmt, 1, newCondition.UTF8String, -1, NULL);
        
        // 4.执行SQL语句，从结果集中取出数据
        while (sqlite3_step(stmt) == SQLITE_ROW) { // 真的查询到一行数据
            // 获得这行对应的数据
            
            IWStudent *student = [[IWStudent alloc] init];
            
            // 获得第0列的id
            student.ID = sqlite3_column_int(stmt, 0);
            
            // 获得第1列的name
            const unsigned char *sname = sqlite3_column_text(stmt, 1);
            student.name = [NSString stringWithUTF8String:(const char *)sname];
            
            // 获得第2列的age
            student.age = sqlite3_column_int(stmt, 2);
            
            // 添加到数组
            [students addObject:student];
        }
    } else {
        NSLog(@"查询语句非合法");
    }
    
    return students;
}
@end

3、控制器
IWViewController.m

//
//  IWViewController.m

#import "IWViewController.h"
#import "IWStudent.h"
#import "IWStudentTool.h"

@interface IWViewController () <UISearchBarDelegate>

@property (nonatomic, strong) NSArray *students;
@end

@implementation IWViewController

- (NSArray *)students
{
    if (_students == nil) {
        _students = [IWStudentTool students];
    }
    return _students;
}

- (void)viewDidLoad
{
    [super viewDidLoad];
    
    UISearchBar *searchBar = [[UISearchBar alloc] initWithFrame:CGRectMake(0, 0, 320, 44)];
    searchBar.delegate = self;
    self.tableView.tableHeaderView = searchBar;
}

#pragma mark - 搜索框代理
- (void)searchBar:(UISearchBar *)searchBar textDidChange:(NSString *)searchText
{
    self.students = [IWStudentTool studentsWithCondition:searchText];
    [self.tableView reloadData];
}

#pragma mark - tableView代理方法
- (NSInteger)tableView:(UITableView *)tableView numberOfRowsInSection:(NSInteger)section
{
    return self.students.count;
}

- (UITableViewCell *)tableView:(UITableView *)tableView cellForRowAtIndexPath:(NSIndexPath *)indexPath
{
    // 1.创建cell
    static NSString *ID = @"student";
    UITableViewCell *cell = [tableView dequeueReusableCellWithIdentifier:ID];
    if (cell == nil) {
        cell = [[UITableViewCell alloc] initWithStyle:UITableViewCellStyleSubtitle reuseIdentifier:ID];
    }
    
    // 2.设置cell的数据
    IWStudent *stu = self.students[indexPath.row];
    cell.textLabel.text = stu.name;
    cell.detailTextLabel.text = [NSString stringWithFormat:@"%d", stu.age];
    
    return cell;
}

@end

三、SQLite函数总结

1.打开数据库
int sqlite3_open(
    const char *filename,   // 数据库的文件路径
    sqlite3 **ppDb          // 数据库实例
);

2.执行任何SQL语句
int sqlite3_exec(
    sqlite3*,                                  // 一个打开的数据库实例
    const char *sql,                           // 需要执行的SQL语句
    int (*callback)(void*,int,char**,char**),  // SQL语句执行完毕后的回调
    void *,                                    // 回调函数的第1个参数
    char **errmsg                              // 错误信息
);

3.检查SQL语句的合法性（查询前的准备）
int sqlite3_prepare_v2(
    sqlite3 *db,            // 数据库实例
    const char *zSql,       // 需要检查的SQL语句
    int nByte,              // SQL语句的最大字节长度
    sqlite3_stmt **ppStmt,  // sqlite3_stmt实例，用来获得数据库数据
    const char **pzTail
);

4.查询一行数据
int sqlite3_step(sqlite3_stmt*); // 如果查询到一行数据，就会返回SQLITE_ROW

5.利用stmt获得某一字段的值（字段的下标从0开始）
double sqlite3_column_double(sqlite3_stmt*, int iCol);  // 浮点数据
int sqlite3_column_int(sqlite3_stmt*, int iCol); // 整型数据
sqlite3_int64 sqlite3_column_int64(sqlite3_stmt*, int iCol); // 长整型数据
const void *sqlite3_column_blob(sqlite3_stmt*, int iCol); // 二进制文本数据
const unsigned char *sqlite3_column_text(sqlite3_stmt*, int iCol);  // 字符串数据

四、数据库查询框架介绍

Core Data: 苹果官方自带的框架，可以让程序员不用写SQL语句，即可通过对象模型查询，但是比较耗性能，如查询比较简单的一条语句，可能需要加载很多不必要的东西。

FMDB：第三方框架，以面向对象的方式存储数据。

所以，以后的项目中可以使用框架，也可以自己进行SQLite封装工具类操作数据。