XSql--Orm数据库框架，轻量，自动升级，自动降级的数据库框架。

XSql 自动 升级/降级 的数据库框架

还在为数据库各种升级要写一堆代码而头疼吗，版本迭代，数据库维护难受的要死，每次增加字段，删除字段都要自己手动写代码处理？

那么你看到这篇文章后这些烦恼都不是问题！！！

故事：鄙人写项目时用了目前网上最流行的Orm数据库框架。先简单介绍一下greendao和ormlite。 greendao: 性能很强大，读写数据快，代码自动生成，确实好用，（学习成本可能高一点，比较难理解）。 ormlite: 性能可能要差一点，但是简单，入手很快。 缺点： 1、greendao确实好，但是升级数据库的代码还要用户自己实现，否则默认是删除所有的表，并重新创建，用户的数据很容易丢失。 2、ormlite也不错，需要用户集成OrmliteSQLOpenHelper并且自己写Dao类操作数据库，很麻烦。而且数据库升级也是要用户自己实现。 思来想去，网上就没有一个框架可以自动升级数据库吗，可以满足大部分情况的数据库升级的框架，搜了一大堆，然而并没什么卵用，没有开源的。所以查了许多资料看了许多框架的源码，搞出了这个性能还行，又可以**自动升级的数据库框架**。

秉承着开源的精神，将次框架开源，希望有兴趣的开发者共同完善优化此框架！

下面介绍一下次框架：
传送门：https://github.com/pichsy/xsql

XSql 自动 升级/降级 的数据库框架

1、项目介绍

• 最新版本 : new 1.3
• 这是一个Sqlite数据库框架，基于SqliteDatabseOpenHelper.
• 这是一个面对对象的数据库框架，使用起来非常简单，易上手。
• 增删改查，分页查询，简单方便。
• 自动升级数据库，无需开发者关心，增加删除字段，随心所欲。
• 性能强悍，支持大批量数据的并发，支持事务。

新版本已传至mavenCentral仓库，引用起来比老版本舒服一点

老版本: v1.1.3文档传送门

2、快速接入（两种方式任选其一）

2.1、直接导包 (推荐使用这种)

使用module级别的build.gradle导包

dependencies {
    implementation 'com.github.pichsy:xsql:1.3'
    annotationProcessor 'com.github.pichsy:xsql-processor:1.3'
}

注意：annotationProcessor 必须加上，注解处理器。

2.2、使用脚本导入

project级别的build.gradle中添加：

 dependencies {
     classpath 'com.github.pichsy:xsql-plugin:1.3'
 }

module级别的build.gradle <顶部> 中添加：

apply plugin: 'xsql-plugin'

即可，同步一下项目，即可使用xsql框架了。

3、如何使用？

3.1、使用注解

使用 @SqlTable(“xxxTableName”) 注解一个表名
使用 @SqlField(“xxxColumnName”) 注解一个字段
使用 @SqlGeneratedId 注解一个字段标志为自增长型，字段类型为long或int
使用 @SqlUnique 注解一个字段，标志字段对应存储内容唯一性
不添加@SqlField(“xxxColumnName”) 注解的字段，不添加到数据库

例如：

@SqlTable("tb_user")
public class User {
	
	// id自增长
	@SqlGeneratedId
	@SqlField("_id")
	long id;
	
	// 名字唯一
	@SqlUnique
	@SqlField("tb_name")
	String name;
	
	// 正常注解
	@SqlField("bt_age")
	String age;
	
	// 不注解字段不写入数据库
	String other
}

3.2、获取BaseDao

简单一行代码获取BaseDao

    private IBaseDao<User> mBaseDao;
    // 也可以使用BaseDao接收，(好处）多了几个方法。
    // private BaseDao<User> mBaseDao;  
   
    private void initSql() {
        //可以使用默认的数据库名字和版本（数据库名字为包名('.'被'-'替换).db, 版本默认为1）
        mBaseDao = XSql.getDBManager(this).getBaseDao(SqlModel.class);
    }  
    
    // 当然也可以自定义
    private void initSql() {
        // 使用DBConfig来自定义数据库的名字和版本
        DBConfig dbConfig = new DBConfig().setDBName("my_app.db");
        mBaseDao = XSql.getDBManager(this,dbConfig).getBaseDao(SqlModel.class);
    }  

3.3、数据库的增、删、改、查 ，分页查询操作

增删改查提供了非常简单的api，一行代码，轻松搞定。当然也提供了复杂的查询——WhereBuilder 来创建查询条件，后面有详细介绍。

3.3.1 增----插入数据

  User user = new User();
  user.setName("小李子");
  user.setAge(18);
  mBaseDao.insert(user);

3.3.2 删----删除数据

  mBaseDao.delete(user);

3.3.3 改----修改数据

  mBaseDao.update(user);

3.3.4 查----查询数据

 List<User> userList = mBaseDao.queryAll();

3.3.5 查----条件查询数据

WhereBuilder wb = new WhereBuilder().eq("name", "张三");
List<User> userList = mBaseDao.query(wb);

3.3.6 查----条件分页排序查询数据

int page = 0; // page： 页数是从0页开始
int size = 5; // size： 最小值是1
WhereBuilder wb = new WhereBuilder()
 		 .startWith("name","张")
 		 .page(page, size)
 		 .orderByDesc("_id");
List<User> userList = mBaseDao.query(wb);

3.4、数据库WhereBuilder创建条件，进行删除和查询

• 注：（不支持修改，原因：修改传入修改后的对象即可，用不到条件）

3.4.1 使用

 WhereBuilder wb = new WhereBuilder().eq(XSqlProperties.User.age, 19);
 mBaseDao.query(wb);
 // 或者
 mBaseDao.delete(wb);

注释：XSqlProperties.User.age,这个是哪里来的呢？
注解处理器自动生成的类，此类为用户创建的实体字段名和表中的字段的映射，为了方便调用者使用

当然用户也可以不使用此类，直接使用 @SqlField 注解上的字段也行

 例：
 WhereBuilder wb = new WhereBuilder().eq("tb_age", 19);
 mBaseDao.query(wb);
 // 或者
 mBaseDao.delete(wb);

3.4.2 分页查询

 // 普通用法 ，单纯的分页
 int page = 0; // page： 页数是从0页开始
 int size = 5; // size： 最小值是1
 WhereBuilder wb = new WhereBuilder().page(page, size);
 mBaseDao.query(wb);	
 // 高级用法，条件查询+分页,page()方法必须放在最后。
  WhereBuilder wb = new WhereBuilder()
 		 .startWith("name","张").page(page, size);
 mBaseDao.query(wb);
 
 // 高级用法，条件分页+排序。
 WhereBuilder wb = new WhereBuilder()
   		 .page(page, size). orderByDesc("_id");
 mBaseDao.query(wb);
 

3.4.3 分页查询

 // 普通用法 ，单纯的分页
 int page = 0; // page： 页数是从0页开始
 int size = 5; // size： 最小值是1
 WhereBuilder wb = new WhereBuilder().page(page, size);
 mBaseDao.query(wb);	
 // 高级用法，条件查询+分页,page()方法必须放在最后。
  WhereBuilder wb = new WhereBuilder()
 		 .startWith("name","张").page(page, size);
 mBaseDao.query(wb);
 
 // 高级用法，条件分页+排序。
 WhereBuilder wb = new WhereBuilder()
   		 .page(page, size).orderByDesc("_id");
 mBaseDao.query(wb);
 

3.4.4 WhereBuilder方法介绍

*注：此字段：为传入的字段（column），此值：为传入的值（value）

方法	说明
eq(String,obj)	相等 ，匹配数据库中此字段与此值相等的数据。
notEq(String,obj)	不相等 ，匹配数据库中此字段与此值不相等的数据。
and()	连接下一个条件，同时满足
or()	连接下一个条件，满足其一即可
gt(obj,obj)	> 大于，数据库中此字段 > 此值的数据
lt(obj,obj)	< 小于，数据库中此字段 < 此值的数据
ge(obj,obj)	>= 大于等于，数据库中此字段 >= 此值的数据
le(obj,obj)	<= 小于等于，数据库中此字段 <= 此值的数据
like(String,String)	模糊查询，数据库中此字段 包含 此值的数据
notLike(String,String)	模糊查询，数据库中此字段 不包含 此值的数据
startWith(String,String)	模糊查询，数据库中此字段 以 此值 开头 的数据
endWith(String,String)	模糊查询，数据库中此字段 以 此值 结尾 的数据
between(String,obj,obj)	在两个数之间，数据库中此字段 在 值1 和 值2 之间 的数据
page(int,int)	分页查询
orderByDesc(String)	倒序，查询的数据以此字段 倒序排序（从大到小排序）
orderByAsc(String)	正序，查询的数据以此字段 正序排序（从小到大排序）

四、版本升级说明

Version: 1.1.3

• SqlProperties（注解自动生成的类）改为XSqlProperties。包名也变了，更新时请注意。见3.4.1
• 增加WhereBuilder分页查询写法。
• WhereBuilder wb = new WhereBuilder().page(page, size);
• page方法再有条件查询或排序查询时：需写在条件查询之后，排序查询之前。详见3.4.3

Version: 1.1.2

• 增加WhereBuilder可以直接排序的写法。
• new WhereBuilder().orderByDesc("name")
• 注：以前的写法为 new WhereBuilder().eq("1",1).orderByDesc("name"),此法不合理故修之

Version: 1.1.1

• 修复bug并支持float类型

Version: 1.1.0

• 使用说明见上文。
• 版本升级内容：
  1. 自动升级数据库。（变动最大…，详见：五、数据库自动升级说明）
  2. 优化了一些增删改查，更安全。
  3. 新增了api，XSql类。
  4. 修改了旧的一些api，DBManager的Api.
  5. 增加了一些方法。

Version: 1.0.4

• api相比 1.1.0 有所不同。
• 变化1:

private IBaseDao<User> mBaseDao;
 
   private void initSql() {
       // 此处调用api变化
       mBaseDao = DBManager.getInstance(this).getBaseDao(User.class);
   }  

五、数据库自动升级说明

• 数据库自动升级：
• 支持升级，降级。
• 升降级支持：
• 新增字段，不会删除原本有的数据。
• 删除字段，会删除删掉字段的数据，其他数据会保留。
• 修改字段，会丢失修改的那个字段的数据（相当于，新增了一个字段 + 删除了一个字段）
• 注意：升级数据库时：在没有删除某一（或多）个字段的情况下，不支持原有的字段上添加约束或者删除约束，即使在 原有字段上添加了约束（@SqlUnique注解）也不会生效。但是 新增的字段 上可以增加约束。
• 注意：升级数据库时：在删除某一(或多)个字段的时候，可以删除另个一（或多）个字段的@SqlUnique注解。原因：删除字段时需要重新创建新的数据库，并且将原来的数据备份，并拷贝到新数据库中，这样符合sqlite数据操作数据原里，不会产生数据冲突。
• 注意：升级数据库时：在删除某一(或多)个字段的时候，强行给原有字段添加约束（如：@SqlUnique注解）会导致程序崩溃，原因：数据库原有的数据不一定是唯一的（属于危险操作）。
• 简单点说：在有删除某些字段的情况下，支持删除原有字段的约束，不支持原有字段增加约束。
• 数据库升级是自动升级，可以不用修改verion。只需要增加或删除字段就行
• 注：这里的约束一般指 @SqlUnique注解。没有**@SqlField(“xxx”)**注解的字段，可随便改，不会影响数据库。
• 当然最重要的，开发者要保持良好的习惯，尽量不要经常做修改字段，删除字段这些危险的操作。
• 此框架为了快速开发而建，无需关心数据库升级和创建的问题。随心所欲的添加字段，删除字段。（约束增加与删除，仔细看上面的三个“注意”）

结束语

• 感谢广大的开源开发者。
• 如此 帅气 的你，给我一颗 小小的 Star 吧。
• 项目正在进一步维护，增加更多的功能。
• 感谢许多开源框架的支持，greendao，ream，butterkinfe等。
• 有问题的童鞋邮箱@我 sywubo789@163.com 。

看到这里，老铁赶紧去试试吧，简单的不要要的。就是这么爽。记得Star！