SqlGenerator

APP比較簡(jiǎn)單或者APP數(shù)據(jù)庫操作比較少, 簡(jiǎn)單的幾張表, 少量的數(shù)據(jù)存儲(chǔ)阻肩。 這個(gè)時(shí)候其實(shí)沒有必要去使用第三方的ORM庫

• 需要去學(xué)習(xí)第三方ORM庫, 增加學(xué)習(xí)成本, 也會(huì)一定程度上增加APP的復(fù)雜度
• 如果使用或者選擇不當(dāng)?shù)脑? 可能影響APP整體的性能, 好多ORM庫其實(shí)是用運(yùn)行時(shí)注解和反射來實(shí)現(xiàn)的, 對(duì)性能會(huì)有一定的影響

SqlGenerator致力于在不使用ORM庫的情況下, 通過生成一些boilerplate code方式簡(jiǎn)化數(shù)據(jù)庫操作, 從而減輕工作量

現(xiàn)在SqlGenerator已經(jīng)支持根據(jù)Model的定義自動(dòng)生成相應(yīng)的Table定義, 避免編寫枯燥的代碼

• 根據(jù)Model的屬性名生成Table的列名, 并且可以配置列的約束
• 根據(jù)Model的定義生成建表SQL, 支持外鍵
• 生成建索引SQL
• 支持復(fù)雜類型的映射

Model定義如下

@Table(name = "User")
@Index(name = "name_age_index", columns = {"name", "age"}, unique = true)
public class User {

    @PrimaryKey
    public long id;

    @Column(unique = true, notNULL = true)
    public String name;

    @Serializer(
            serializedTypeCanonicalName = String.class,
            serializerCanonicalName = FileSerializer.class)
    public File avtar;

    @Column(check = "age>16")
    public int age;

    @Column(name = "address_id")
    public Address address;

    @ForeignKey(referenceTableName = "Group", referenceColumnName = "id", action = "ON UPDATE CASCADE")
    public long groupId;
}

最終會(huì)生成表的外觀類

public final class UserContract {
    public static final String TABLE_NAME = "User";
    public static final String ID_COLUMN = "id";
    public static final String NAME_COLUMN = "name";
    public static final String AVTAR_COLUMN = "avtar";
    public static final String AGE_COLUMN = "age";
    public static final String ADDRESS_ID_COLUMN = "address_id";
    public static final String GROUPID_COLUMN = "groupId";
    public static final String CREATE_TABLE_SQL = "CREATE TABLE IF NOT EXISTS User(id INTEGER PRIMARY KEY AUTOINCREMENT,name TEXT NOT NULL UNIQUE,avtar TEXT,age INTEGER CHECK(age>16),address_id TEXT,groupId INTEGER,FOREIGN KEY(groupId) REFERENCES Group(id) ON UPDATE CASCADE)";
    public static final String CREATE_NAME_AGE_INDEX_SQL = "CREATE INDEX name_age_index ON User(name,age)";

    public UserContract() {
    }

    public static void createTable(SQLiteDatabase db) {
        db.execSQL("CREATE TABLE IF NOT EXISTS User(id INTEGER PRIMARY KEY AUTOINCREMENT,name TEXT NOT NULL UNIQUE,avtar TEXT,age INTEGER CHECK(age>16),address_id TEXT,groupId INTEGER,FOREIGN KEY(groupId) REFERENCES Group(id) ON UPDATE CASCADE)");
    }

    public static void createIndex(SQLiteDatabase db) {
        db.execSQL("CREATE INDEX name_age_index ON User(name,age)");
    }

    public static void dropTable(SQLiteDatabase db) {
        db.execSQL("DROP TABLE IF EXISTS User");
    }
}

Download

buildscript {
  repositories {
    mavenCentral()
   }
  dependencies {
    classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'
  }
}

apply plugin: 'com.neenbedankt.android-apt'

dependencies {
  compile 'com.github.tubb.sqlgenerator:sqlgenerator-annotations:0.0.3-SNAPSHOT'
  apt 'com.github.tubb.sqlgenerator:sqlgenerator-compiler:0.0.3-SNAPSHOT'
}

Usage

定義好Model類之后重新構(gòu)建應(yīng)用, 會(huì)生成以ModelNameContract命名的表外觀類, 可以在moduleName/build/intermediates/classes目錄下查看

./gradlew clean build

Note

SqlGenerator還處于開發(fā)階段, 功能不是很穩(wěn)定, 正式項(xiàng)目請(qǐng)謹(jǐn)慎使用蜘醋。非常希望有興趣的朋友來一起完善這個(gè)library