3 Star 0 Fork 0

Gitee 极速下载 / easydao

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
此仓库是为了提升国内下载速度的镜像仓库,每日同步一次。 原始仓库: https://github.com/smuyyh/easyDAO
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

easyDAO

Platform API

easyDAO是一个快速&轻量级的Android SQLite ORM映射框架,尽可能的简化数据库操作。

English Doc

特征

  1. easyDAO简化了数据库的增删改查操作.
  2. 通过注解的方式进行数据库对象映射.

依赖

dependencies {
    compile 'com.yuyh.easydao:easydao:1.1.0'
}

简介

1. 定义一个公共类,继承于{@link com.yuyh.easydao.base.BaseEntity}.
2. 使用'@Column'注解属性以便在数据库表创建一个列, 列名和属性名会保持一致.
3. 每一个带有'@Column'注解的属性都必须有getter/setter方法.
4. 调用{@link IDb#getDb(int, String, String, Class, IDbListener)}方法来创建数据库和表, 用返回值来操作数据库.

注意事项(重要!!!)

  1. getter/setter方法必须严格遵循以下规则: getElement, setElement (即: get/set + 首字母大写的属性名).这里需要注意的是,通过eclipse或as自动生成的Bool类型的getter/setter方法也是遵循该规律的,请勿手动再改。如下:

    @Column
    private boolean isOk;
    
    public boolean isOk(){
        return isOk;
    }
    
    public void setOk(boolean isOk){
        this.isOk = isOk;
    }
  2. 对于类型为Boolean/boolean的属性来说, 他们在数据库内部表示是用INTEGER类型, 1 代表true, 0 代表false. 所以如果要通过条件语句操作,就要注意这个地方了.

  3. 默认情况下,列的值是不能为null的(如果为null,将不会保存到数据库), 必要的话可以用'@Column(canBeNull = true)'注解来允许该字段为null.

使用方式

1. 下载easydao module并添加到工程或者直接添加依赖

xxx

2. 获取DB单例对象

    IDAO<UserBean> dao = DB.getInstance(mContext).getDatabase(1, database, listener);

上面这个方法没有传入tableName和entityClass参数, 故无法进行表数据相关操作,比如增删改查。可再调用IDAO.initTable(String, Class) 方法来进行初始化.

或者直接使用下面这个方法。注:数据库和表不存在的时候,会自动创建!

    IDAO<UserBean> dao = DB.getInstance(mContext)
                           .getDatabase(1, databaseName, tablename, UserBean.class, listener);

3. 增删改查

IDAO提供了以下方法进行数据库的增删改查等操作。

/**
 * 获取数据库操作对象
 *
 * @return
 */
SQLiteDatabase getDatabase();

/**
 * 初始化表映射关系
 *
 * @param tableName
 * @param clazz
 */
void initTable(String tableName, Class<T> clazz);

/**
 * 获取表数据量
 *
 * @return
 * @throws DBException
 */
long getCount() throws DBException;

boolean isTableExist(String tableName) throws DBException;

/**
 * 检查表是否存在
 *
 * @return
 * @throws DBException
 */
boolean isTableExist() throws DBException;

/**
 * 建表
 *
 * @throws DBException
 */
void createTable() throws DBException;

/**
 * 建表
 *
 * @param tableName 表名
 * @throws DBException
 */
<T> void createTable(Class<T> entityClass, String tableName) throws DBException;

/**
 * 删除表
 *
 * @throws DBException
 */
void dropTable() throws DBException;

/**
 * 删除数据库所有的表
 *
 * @throws DBException
 */
void dropAllTable() throws DBException;

/**
 * 保存数据
 *
 * @param entity
 * @throws DBException
 */
void save(T entity) throws DBException;

/**
 * 通过id(主键)删除数据
 *
 * @param id
 * @throws DBException
 */
void delete(int id) throws DBException;

/**
 * 通过多个id(主键)删除数据
 *
 * @param ids
 * @throws DBException
 */
void delete(int[] ids) throws DBException;

/**
 * 删除所有数据
 *
 * @throws DBException
 */
void deleteAll() throws DBException;

/**
 * 更新一条数据
 *
 * @param entity
 * @throws DBException
 */
void update(T entity) throws DBException;

/**
 * 通过条件语句更新数据
 *
 * @param condition 是更新语句在'WHERE'后面的一部分
 *                  (即:"UPDATE Person SET age = 35 WHERE condition")
 *                  (举个栗子: condition -- "name = 'Richard' OR name = 'Jefferson'")
 * @param entity
 * @throws DBException
 */
void updateByCondition(String condition, T entity) throws DBException;

/**
 * 通过id查找数据
 *
 * @param id
 * @return
 * @throws DBException
 */
T find(int id) throws DBException;

/**
 * 查找表中最后一条数据
 *
 * @return
 * @throws DBException
 */
T findLastEntity() throws DBException;

/**
 * 通过条件语句查询数据
 *
 * @param condition 是查询语句在'WHERE'后面的这部分
 *                  (即:"SELECT * FROM Person WHERE condition")
 *                  (举个栗子: condition -- "name = 'Richard' OR name = 'Jefferson'")
 * @return
 */
List<T> findByCondition(String condition) throws DBException;

/**
 * 查询所有数据
 *
 * @return
 * @throws DBException
 */
List<T> findAll() throws DBException;

License

Copyright (c) 2016 smuyyh

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "{}" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright {yyyy} {name of copyright owner} Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

暂无描述 展开 收起
Java
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/mirrors/easydao.git
git@gitee.com:mirrors/easydao.git
mirrors
easydao
easydao
master

搜索帮助