smartdb

简介

SmartDB (Room 鸿蒙版本)持久性库在 SQLite 的基础上提供了一个抽象层，让用户能够在充分利用 SQLite 的强大功能的同时，获享更强健的数据库访问机制

下载安装

ohpm install @liushengyi/smartdb --save

使用

1 创建UserDao

import sql from "@liushengyi/smartdb"

export class User {
  @sql.SqlColumn(sql.ColumnType.INTEGER)
  id: number
  @sql.SqlColumn(sql.ColumnType.TEXT)
  name: string

  constructor(id: number, name: string) {
    this.id = id
    this.name = name
  }
}

class UserDao {
  constructor() {
  }

  @sql.Sql("create table if not exists db_user ( id INTEGER  PRIMARY KEY AUTOINCREMENT ,name TEXT not null)")
  createDb(): Promise<void> {
    return sql.PromiseNull()
  }

  @sql.SqlInsert("replace into db_user (id,name) values (#{id},#{name}) ")
  insert(@sql.Param("id") id: number, @sql.Param("name") name: string): Promise<void> {
    return sql.PromiseNull()
  }

  @sql.SqlInsert("replace into db_user (name) values (#{name}) ",{ table: "db_user", id: "id" })
  insertReturnRowId(@sql.Param("name") name: string): Promise<number> {
    return sql.PromiseNull()
  }

  @sql.SqlInsert("replace into db_user (id,name) values (#{user.id},#{user.name}) ")
  insertUser(@sql.Param("user") user: User): Promise<void> {
    return sql.PromiseNull()
  }

  @sql.SqlQuery("select * from db_user where id=#{id}")
  @sql.ReturnType(User)
  findUser(@sql.Param("id") id: number): Promise<User> {
    return sql.PromiseNull()
  }

  @sql.SqlQuery("select name from db_user where id=#{id}")
  @sql.ReturnType(String)
  findUserName(@sql.Param("id") id: number): Promise<string> {
    return sql.PromiseNull()
  }

  @sql.SqlQuery("select * from db_user")
  @sql.ReturnType([User])
  findAll(): Promise<Array<User>> {
    return sql.PromiseNull()
  }

  @sql.SqlQuery("select id from db_user")
  @sql.ReturnType([Number])
  findAllIds(): Promise<Array<number>> {
    return sql.PromiseNull()
  }

  @sql.SqlQuery("select count(*) from db_user")
  @sql.ReturnType(Number)
  findAllCount(): Promise<Number> {
    return sql.PromiseNull()
  }

  @sql.SqlDelete("delete from db_user ")
  deleteAll(): Promise<void> {
    return sql.PromiseNull()
  }
  
  @sql.SqlQuery("select * from db_user where #{cond} ")
  @sql.ReturnListType(User)
  searchUser(@sql.Param("cond",true) cond: string): Promise<Array<User>> {
    return sql.PromiseNull()
  }
}

export const userDao = new UserDao()

2 创建数据库管理

import sql from '@liushengyi/smartdb';
import { userDao } from './UserDao';
import relationalStore from '@ohos.data.relationalStore';

class AppDB {
  static DB_VERSION: number = 3

  initDb(context: Context) {
    sql.dbHelper.initDb(context, "test.db", AppDB.DB_VERSION, new AppDbOpenHelper())
    //配置RdbStore属性
    //sql.dbHelper.initDbWithConfig
  }
}

class AppDbOpenHelper extends sql.DbOpenHelper {
  constructor() {
    super()
  }

  async onCreate(db: relationalStore.RdbStore) {
    //用户表
    await userDao.createDb()
  }

  async onUpgrade(db: relationalStore.RdbStore, oldVersion: number, newVersion: number) {
    if (oldVersion <= 2) {
      //升级操作
    }
  }
}

export default new AppDB()

3 UIAbility里初始化

import appDB from '../AppDB';

  onCreate(want: Want, launchParam: AbilityConstant.LaunchParam): void {
    appDB.initDb(this.context)
  }

4 使用sql

import { userDao } from '../UserDao'
userDao.insert(100, "name100")

5 支持事务

import sql from '@liushengyi/smartdb'
import { User, userDao } from '../UserDao'

@sql.Transactional()
  async insertTr() {
    await userDao.insert(1, "name1")
    await userDao.insert(2, "name2")
    throw new Error("插入错误")
  }

6 支持多数据源

• @sql.DbNameClass 支持整个class配置
• @sql.DbName 支持单个method配置

二者选择其一，同时配置优先使用@sql.DbName

 initDb(context: Context) {
    sql.Logger.setLogLevel(hilog.LogLevel.DEBUG)
    //初始化默认数据库
    sql.dbHelper.initDb(context, "test.db", AppDB.DB_VERSION, new AppDbOpenHelper())
    //初始化第二个数据库
    sql.createDbHelper("test2").initDb(context, "test2.db", AppDB.DB_VERSION, new AppDbOpenHelper2())
  }
  
@sql.DbNameClass("test2")
class UserDao2 {
  constructor() {
  }

  @sql.DbName("test2") //和@sql.DbNameClass选其一
  @sql.SqlInsert("replace into db_user (id,name) values (#{id},#{name}) ")
  insert(@sql.Param("id") id: number, @sql.Param("name") name: string): Promise<void> {
    return sql.PromiseNull()
  }
}  
  

7 传递自定义条件

@sql.Param("cond",true)

 @sql.SqlQuery("select * from db_user where #{cond} ")
  @sql.ReturnListType(User)
  searchUser(@sql.Param("cond",true) cond: string): Promise<Array<User>> {
    return sql.PromiseNull()
  }
  
 let result = await userDao.searchUser("name like 'id%'")
 this.message = `${JSON.stringify(result)}`

开源协议

本项目基于 Apache License 2.0 ，请自由地享受和参与开源。